如何编写接口自动化框架系列之unittest测试框架的详解（二）-Toy模板网

这篇具有很好参考价值的文章主要介绍了如何编写接口自动化框架系列之unittest测试框架的详解（二）。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

如何编写接口自动化框架系列之unittest测试框架的详解（二）

在编写自动化框架过程中，我们首先想到的就是选择一个合适的测试框架，目前常用的测试框架有unittest和pytest , unittest比较简单，适合入门着学习；而pytest比较强大，适合后期进阶。本文主要介绍的就是unittest框架。接下来，我们从以下三个问题开始说明：

unittest是什么？
unittest的作用是什么？它有那些功能？
unittest如何使用？

1.unittest是什么？

unittest是python自带的一个测试框架，所以你无需下载，直接导包使用，具体如下：

import unittest

当然作为测试人员，主要用它来做自动化测试，比如接口自动化、web自动化或app自动化测试。

在这里我们需要先搞清楚一个问题，无论做什么样的自动化，其目的就是为了做回归测试。在平时工作中，我们一般根据阶段的不同，往往选取的回归测试用例也不同，比如在一轮测试结束后往往会把出现bug的用例再回归一遍，在上线之前也会选取本次迭代的功能作为回归测试用例。而这些不同的选择其实就是选取的策略。而选取的用例集合往往会叫它测试套件，说白了测试套件就是用例的组合而已。比如下图如何编写接口自动化框架系列之unittest测试框架的详解（二）

所以，要想做回归测试，必须满足如下条件：

能进行测试断言，即测试功能的预期值和实际值的比对。
能将不同的测试用例添加到不同的套件中
能选择不同的测试套件进行运行
能统计最终测试用例运行结果。

2.unittest有哪些功能？

针对如上的条件，unittest包正好也实现了以上的功能，具体如下：

如何编写接口自动化框架系列之unittest测试框架的详解（二）

可以看到，上面的5个类主要实现了四个功能，分别是测试用例断言(TestCase) , 组装测试套件(TestSuite和TestLoader) ，运行测试套件(TextTestRunner)以及测试结果汇总TestResult . 当然每个类中又都包含了若干方法，下表列举出常用的方法，掌握如下测试方法，编写自动化测试框架就没有问题。如何编写接口自动化框架系列之unittest测试框架的详解（二）

3.unittest如何使用？

要想使用unittest ，需要有一个测试对象，我们咱先编写一段登录的代码，然后使用unittest对这个登录功能进行测试。

# 实现登录函数
def login(username,password):

    # 用户名为空或密码为空 ，给出提示
    if username is None or username == '':
        return {'code':1,'message':'用户名不能为空！'}
    if password is None or password == '':
        return {'code':2,'message':'密码不能为空！'}

    # 用户名和密码匹配登录成功
    if 'root' == username and '123456' == password:
        return {'code':0,'message':'登录成功！'}

    # 用户名和密码不匹配的情况
    return {'code':3,'message':'用户名或密码错误!'}

如果你对以上登录进行测试的话，会编写那些测试用例呢？你可能会列举出以下几条：

case1 : 输入正确的用户名和正确的密码进行登录
case2 : 输入正确的用户名和错误的密码进行登录
case3 : 输入正确的用户名和空的密码进行登录

3.1 TestCase使用

接下来让我们用unittest来进行测试，而通过上面可以看到，进行用例的测试就需要用到TestCase类。当然，你要想要使用这个类，还必须遵循一些unittest的原则：

unittest的编写原则：
1. 编写的测试用例必须是一个类 ，而且此类必须要继承TestCase 。继承写法 ：A(B)
2. 编写测试用例类必须是以大写的Test开头
3. 编写的测试用例方法是以小写test开头
4. 测试模块也最好是以小写的test开头
5. 每一条测试用例对应一个方法(建议)

可以参考如下图如何编写接口自动化框架系列之unittest测试框架的详解（二）

接下来使用TestCase中的断言方法进行断言：

1.测试用例断言方法：

如何编写接口自动化框架系列之unittest测试框架的详解（二）

所以，以上代码加入断言(测试)后就是下面这样的情况，这里就主要用到了assertEqual方法进行断言。

import unittest
from pack01_unittest.login import login


class TestLogin(unittest.TestCase):

    # case1 : 输入正确的用户名和正确的密码进行登录
    def test_login_success(self):
        # 实际结果 ：程序的输出
        login_result = login('root','123456')
        self.assertEqual(0,login_result.get('code'))
        self.assertEqual('登录成功！',login_result.get('message'))

    # case2 : 输入正确的用户名和错误的密码进行登录
    def test_password_is_wrong(self):
        login_result = login('root', '1234567')
        self.assertEqual(3, login_result.get('code'))
        self.assertEqual('用户名或密码错误!', login_result.get('message'))

    # case3 : 输入正确的用户名和空的密码进行登录
    def test_password_is_null(self):
        login_result = login('root', '')
        self.assertEqual(2, login_result.get('code'))
        self.assertEqual('密码不能为空！', login_result.get('message'))

2.初始化和清除方法 如何编写接口自动化框架系列之unittest测试框架的详解（二）

如何编写接口自动化框架系列之unittest测试框架的详解（二）

1.unittest是什么？

2.unittest有哪些功能？

3.unittest如何使用？

4.总结编辑

5.项目实践

在上面我们已经提过，TestSuite类其实就是将不同测试用例添加到一个套件中，仅仅只是添加，若想运行该套件，还必须借助于另外一个类，这个类我们在下面会介绍 ，具体见图

如何编写接口自动化框架系列之unittest测试框架的详解（二）

所以，此类下主要的两个方法都是用例做测试用例添加操作的。

1.主要使用方法

如何编写接口自动化框架系列之unittest测试框架的详解（二）

2.具体使用步骤

创建测试套件对象
添加测试用例到套件中
运行测试套件，需要借助于TextTestRunner类。

# 1. 创建一个测试套件
suite = unittest.TestSuite()

# 2. 将测试用例加入到套件中
suite.addTest(TestLogin('test_password_is_wrong'))	# 将测试用例test_password_is_wrong添加到suite套件中
suite.addTest(TestLogin('test_password_is_null'))	# 将测试用例test_password_is_null添加到套件中。
print(suite)

输出后的suite就是这样，它是一个列表对象：

<unittest.suite.TestSuite tests=[<main.TestLogin testMethod=test_password_is_wrong>, <main.TestLogin testMethod=test_password_is_null>]

因为目前还没有介绍到TextTestRunner此类，所以暂时还没法运行该套件的用例

和TestSuite类的作用一样，也是将不同测试用例添加到一个套件中，仅仅只是添加，若想运行该套件，还必须借助于另外一个类。

但是和TestSuite不同的是，TestSuite是一条一条的添加，每次添加一条用例就需要调用一次addTest方法，所以，当需要添加的用例很多时，添加起来就会很麻烦。

而TestLoader添加方式通过匹配进行批量添加，它是一批一批的添加，用例很多时，这种方式添加起来就会方便。

1.主要使用方法：discover(test_dir, pattern=匹配模式)

参数说明：

test_dir: 为指定的测试用例的目录,它会搜索该目录的所有文件
pattern：为匹配模式，如要查找所有的.py格式文件，你就可以写为'test*.py'，这样就会搜索test_dir目录下所有以test开头，以py结尾的文件。

2.具体使用步骤

创建测试套件对象
添加测试用例到套件中，匹配某一特征的用例添加，
运行测试套件，需要借助于TextTestRunner类。

   # 1. 创建套件
    suite = unittest.TestLoader()

    # 2. 通过特征匹配出相关用例,比如只匹配test_login的用例
    suite = suite.discover('.','test_login*.py')

3.4 TextTestRunner使用

此类的主要作用就是运行测试套件，所以它里面只有一个测试方法run() ,通过它就可以运行测试套件中的用例，而上面的TestSuite类和TestLoader类生成的套件就的需要这个方法去运行的。

1.主要使用方法：run(suite)，需要说明的是，suite就是通过TestSuite或者TestLoader创建的测试套件对象。

运行测试套件也比较简单，具体的代码如下：

# 1.通过TextTestRunner类生成runner对象
runner = unittest.TextTestRunner()

# 2.调用run方法运行测试套件
runner.run(suite)

2.运行套件流程，

知道了上面的方法，你就可以按照如下的流程进行运行测试套件了。

创建测试套件对象
通过逐一添加或匹配添加的方式将用例添加到套件中
运行测试套件。

以下为通过TestSuite方式添加：

# 1. 创建一个测试套件
suite = unittest.TestSuite()

# 2. 将测试用例加入到套件中
suite.addTest(TestLogin('test_password_is_wrong'))	# 将测试用例test_password_is_wrong添加到suite套件中
suite.addTest(TestLogin('test_password_is_null'))	# 将测试用例test_password_is_null添加到套件中。

# 3.通过run方法运行该测试套件
runner = unittest.TextTestRunner()
runner.run(suite)

以下为TestLoader方式添加：

# 1. 创建一个测试套件
suite = unittest.TestSuite()

# 2. 将测试用例加入到套件中
suite = suite.discover('.','test_login*.py')

# 3.通过run方法运行该测试套件
runner = unittest.TextTestRunner()
runner.run(suite)

3.5 TextTestResult

首先这个类主要是供TextTestRunner它使用的，通过TextTestRunner可以将测试结果简单的输出到文本中，显示结果也比较简单，所以我们一般也不会用它做测试报告，而使用其它的插件来生成测试报告，所以在测试过程中，无需关注这个类。

4.总结

5.项目实践

如果你看过第一篇文章，我们曾经搭建了一套接口自动化框架，如果你没看过，请移步到第一篇文章,传送门：软件自动化测试系列之从整体角度了解自动化测试框架(一) - 知乎 (zhihu.com)

建议你按照那个框架先搭建起来，接下来我们就可以在那个框架里面编写测试用例了，而编写用例所进行的断言就是使用的是unitest.

虽然，我们目前还不知道该如何请求接口，但是没关系，我们可以先假设已经将结果请求回来了。所以，你可以在测试用例中添加一个测试模块，专门用于测试登录接口

如何编写接口自动化框架系列之unittest测试框架的详解（二）

以下是test_login.py中的代码，需要说明的是，因为现在还没有介绍如何请求接口和查询数据库，故这里只能暂时将返回的结果写死，以方便说明，重点在说明返回的结果如何进行断言。文章来源地址https://www.toymoban.com/news/detail-465729.html

import unittest

# 模拟接口返回的结果
login_result = {
    "status": 1,
    "msg": "登陆成功",
    "result": {
        "user_id": 2638,
        "email": "",
        "password": "519475228fe35ad067744465c42a19b2",
        "paypwd": None,
        "sex": 0,
        "birthday": 0,
        "user_money": "2939.00",
        "frozen_money": "0.00",
        "distribut_money": "0.00",
        "underling_number": 0,
        "pay_points": 150,
        "address_id": 0,
        "reg_time": 1681047891,
        "last_login": 1681047891,
        "last_ip": "",
        "qq": "",
        "mobile": "15388888888",
        "mobile_validated": 1,
        "oauth": "",
        "openid": None,
        "unionid": None,
        "head_pic": None,
        "province": 0,
        "city": 0,
        "district": 0,
        "email_validated": 0,
        "nickname": "15388888888",
        "level": 2,
        "discount": "0.98",
        "total_amount": "10908.00",
        "is_lock": 0,
        "is_distribut": 1,
        "first_leader": 2636,
        "second_leader": 0,
        "third_leader": 0,
        "token": "10af0e236dedbc8ae00273b00be25ee3",
        "message_mask": 63,
        "push_id": "0",
        "distribut_level": 0,
        "level_name": "铜牌会员"
    },
    "url": ""
}


class TestLogin(unittest.TestCase):

    def setUp(self) -> None:
        # 这里的数据是模拟从数据库查询出来的结果
        self.user_money = "2939.00"
        self.mobile = "15388888888"
        self.pay_points = 150

    def tearDown(self) -> None:
        # 这里模拟关闭数据库
        pass

    # case1 : 测试登录
    def test_login(self):
        # 实际结果 ：这里的login_result是模拟接口返回的结果 ，暂时先将此结果写死直接拿过来用。
        self.assertEqual(1, login_result.get('status'))
        self.assertEqual('登陆成功', login_result.get('msg'))
        self.assertEqual(self.user_money, login_result.get('result').get('user_money'))	#断言用户余额
        self.assertEqual(self.mobile,login_result.get('result').get('mobile'))	# 断言用户手机号
        self.assertEqual(self.pay_points,login_result.get('result').get('pay_points'))	#断言用户积分

到了这里，关于如何编写接口自动化框架系列之unittest测试框架的详解（二）的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！