原文博客:https://www.cnblogs.com/superhin/p/10338993.html
官方文档:https://docs.python.org/zh-cn/2/library/unittest.html
一、unittest简介
使用print(help(unittest))
查看源码解析,对unittest的描述是:python的单元测试框架,是基于java的junit测试框架。下面是源码中的一个简单使用例子:
Simple usage: import unittest # 1.导入unittest # 2.继承自unittest.TestCase,表明这是一个测试类。接口测试中通常是某个接口的用例类。 class IntegerArithmeticTestCase(unittest.TestCase): def testAdd(self): # 3.一条用例,用例的名称要以test开头 self.assertEqual((1 + 2), 3) # 4.断言,可以是一个也可以是多个 self.assertEqual(0 + 1, 1) def testMultiply(self): self.assertEqual((0 * 10), 0) self.assertEqual((5 * 8), 40) if __name__ == '__main__': # 如果是直接从当前模块执行(非别的模块调用本模块) unittest.main() # 5.运行本测试类的所有用例
一个Testcase的实例就是一个测试用例,测试用例就是一个完整的测试流程,包括初始化setUp、运行run、测试后的还原tearDown。
为什么要使用unittest?
在编写接口自动化用例时,我们一般针对一个接口建立一个.py文件,一条测试用例封装为一个函数(方法),但是在批量执行的过程中,如果其中一条出错,后面的用例就无法执行。使用测试框架可以互不影响的用例执行及更灵活的执行控制。
unittest特点
-
python自带的单元测试框架,无需安装
-
用例执行互不干扰
-
提供不同范围的setUp(测试准备)和tearDown(测试清理)方法
-
提供丰富的断言方法
-
可以通过discover批量执行所有模块的用例
-
可以通过TestSuite(测试集)灵活的组织用例
unittest几大组成部分
-
TestCase: 所有测试用例类需继承的基本类,以具有TestCase的属性和方法
-
TestSuite: 测试集或测试套件,测试用例的集合,用来组织用例,支持嵌套。常用addTest()方法添加用例。
-
TestLoader: 用例加载器,用于向TestSuite中添加用例
-
TextTestRunner: 用例执行器,用来执行TestSuite/TestCase,一般以TestSuite为单位执行用例。测试的结果会保存在TextTestResult实例中。
-
TestResult: 测试结果
-
Test Fixtures:即setUp(用例准备)及tearDown(测试清理)方法,用于分别在测试前及测试后执行。按照不同的作用范围分为:
-
setUp()/tearDown(): 每个用例执行前/后执行一次
-
setUpClass()/tearDownClass(): 每个测试类加载时/结束时执行一次
-
setUpMoudle()/tearDownMoudle(): 每个测试模块(一个py文件为一个模块)加载/结束时执行一次
-
二、接口用例编写示例
新建一个test*
开头的.py文件:test_user_login.py
import unittest import requests class TestUserLogin(unittest.TestCase): url = 'http://115.28.108.130:5000/api/user/login/' def test_user_login_normal(self): # 一条测试用例,必须test_开头 data = {"name": "张三", "password": "123456"} res = requests.post(url=self.url, data=data) self.assertIn('登录成功', res.text) # 断言 def test_user_login_password_wrong(self): data = {"name": "张三", "password": "1234567"} res = requests.post(url=self.url, data=data) self.assertIn('登录失败', res.text) # 断言 if __name__ == '__main__': # 如果是直接从当前模块执行(非别的模块调用本模块) unittest.main(verbosity=2) # 运行本测试类所有用例,verbosity为结果显示级别
用例断言
unittest提供了丰富的断言方法,常用为以下几种:
# 判断相等 assertEqual(a,b)/assertNotEqual(a,b) # 断言值是否相等 assertIs(a,b)/assertIsNot(a,b) # 断言是否同一对象(内存地址一样) assertListEqual(list1, list2)/assertItemNotEqual(list1, list2) # 断言列表是否相等 assertDictEqual(dict1, dict2)/assertDictNotEqual(dict1, dict2) # 断言字典是否相等 # 是否为空 assertIsNone(a)/assertIsNotNone(a) # 判断真假 assertTrue(a)/assertFalse(a) # 是否包含 assertIn(a,b)/assertNotIn(a,b) # b中是否包含a # 大小判断 assertGreater(a,b)/assertLess(a,b) # 断言a>b / 断言a<b assertGreaterEqual(a,b)/assertLessEqual # 断言a>=b / 断言a<=b # 类型判断 assertIsInstance(a,dict)/assertNotIsInstance(a,list) # 断言a为字典 / 断言a非列表
完整的接口测试用例
一条完整的测试接口用例需要包含:
-
数据准备:准备测试数据,可手工准备,也可使用代码准备(通常涉及数据库操作)
-
环境检查:如果手工准备的数据,连接数据库进行环境检查会使用例更健壮
-
发送请求:发送接口请求
-
响应断言/数据库断言:响应断言后,还需要进行数据库断言,以确保接口数据库操作的正确性
-
数据清理:如果接口有更数据库操作,断言结束后需要还原更改
# test_user_reg.py import unittest import requests from db import * # 导入db.py文件,源码见下篇 # 数据准备 NOT_EXIST_USER = '范冰冰' EXIST_USER = '张三' class TestUserReg(unittest.TestCase): url = 'http://127.0.0.1:5000/api/user/reg/' def test_user_reg_normal(self): # 环境检查 if check_user(NOT_EXIST_USER): del_user(NOT_EXIST_USER) # 发送请求 data = {'name': NOT_EXIST_USER, 'password': '123456'} res = requests.post(url=self.url, json=data) # 期望响应结果,注意字典格式和json格式的区别(如果有true/false/null要转化为字典格式) except_res = { "code": "100000", "msg": "成功", "data": { "name": NOT_EXIST_USER, "password": "e10adc3949ba59abbe56e057f20f883e" } } # 响应断言(整体断言) self.assertDictEqual(res.json(), except_res) # 数据库断言 self.assertTrue(check_user(NOT_EXIST_USER)) # 环境清理(由于注册接口向数据库写入了用户信息) del_user(NOT_EXIST_USER) def test_user_reg_exist(self): # 环境检查 if not check_user(EXIST_USER): add_user(EXIST_USER) # 发送请求 data = {'name': EXIST_USER, 'password': '123456'} res = requests.post(url=self.url, json=data) # 期望响应结果,注意字典格式和json格式的区别(如果有true/false/null要转化为字典格式) except_res = { "code": "100001", "msg": "失败,用户已存在", "data": { "name": EXIST_USER, "password": "e10adc3949ba59abbe56e057f20f883e" } } # 响应断言(整体断言) self.assertDictEqual(res.json(), except_res) # 数据库断言(没有注册成功,数据库没有添加新用户) # 环境清理(无需清理) if __name__ == '__main__': unittest.main(verbosity=2) # 运行所有用例
三、用例组织及运行
除了使用 unittest.main() 运行整个测试类之外,我们还可以通过 TestSuite 来灵活的组织要运行的测试集
-
使用 unittest.main():可以将一个单元测试模块变为可直接运行的测试脚本,main() 方法使用 TestLoader 类来搜索所有包含在该模块中以 “test” 开头的测试方法,并自动执行。执行方法的默认顺序是:根据 ASCII 码的顺序加载测试用例,数字与字母的顺序为:0-9,A-Z,a-z。注意:并非按用例书写顺序执行。
-
新建 TestSuite 并添加测试用例
import unittest from test_user_login import TestUserLogin from test_user_reg import TestUserReg # 导入测试类 suite = unittest.TestSuite() suite.addTest(TestUserLogin('test_user_login_normal')) # 添加单个用例 suite.addTests([TestUserReg('test_user_reg_normal'),TestUserReg('test_user_reg_exist')]) # 添加多个用例 # 运行测试集 unittest.TextTestRunner(verbosity=2).run(suite) # verbosity显示级别,运行顺序为添加到suite中的顺序
-
使用 makeSuite 来制作用例集
import unittest from test_user_login import TestUserLogin suite1 = unittest.makeSuite(TestUserLogin, 'test_user_login_normal') # 使用测试类的单条用例制作测试集 suite2 = unittest.makeSuite(TestUserLogin) # 使用整个测试类制作测试集合(包含该测试类所有用例) unittest.TextTestRunner(verbosity=2).run(suite1)
-
使用TestLoader(用例加载器)生成测试集
improt unittest from test_user_login import TestUserLogin suite = unittest.TestLoader().loadTestsFromTestCase(TestUserLogin) # 加载该测试类所有用例并生成测试集 unittest.TextTestRunner(verbosity=2).run(suite)
-
使用 discover(用例发现)遍历所有的用例(推荐!!)
import unittest suite = unittest.defaultTestLoader.discover("./", pattern='test*.py') # 遍历筛选出./(当前目录)及子包中的测试用例文件test_*.py,并组装到测试套件 unittest.TextTestRunner(verbosity=2).run(suite)
注意:
-
子目录中需要包含
__init__.py
文件,及应为的Python包 -
所有用例因为
test_*.py
,包含测试类应以Test开头,并继承unittest.TestCase, 用例应以test_
开头
-
测试集嵌套
import unittest from test_user_login import TestUserLogin suite1 = unittest.TestSuite() suite1.addTest(TestUserLogin('test_user_login_normal')) suite2 = makeSuite(TestUserLogin, 'test_user_login_password_wrong') suite = unittest.TestSuite([suite1, suite2]) # 将两个测试集组合为一个 unittest.TextTestRunner(verbosity=2).run(suite)