unittest框架及原理
做过自动化测试的同学应该都知道python中的unittest框架,它是python自带的一套测试框架,学习起来也相对较容易,unittest框架最核心的四个概念:
🍊 test case:就是我们的测试用例,unittest中提供了一个基本类TestCase,可以用来创建新的测试用例,一个TestCase的实例就是一个测试用例;unittest中测试用例方法都是以test开头的,且执行顺序会按照方法名的ASCII值排序。
🍅 test fixure:测试夹具,用于测试用例环境的搭建和销毁。即用例测试前准备环境的搭建(SetUp前置条件),测试后环境的还原(TearDown后置条件),比如测试前需要登录获取token等就是测试用例需要的环境,运行完后执行下一个用例前需要还原环境,以免影响下一条用例的测试结果。
🍋 test suite:测试套件,用来把需要一起执行的测试用例集中放到一块执行,相当于一个篮子。我们可以使用TestLoader来加载测试用例到测试套件中。
🍇 test runner:用来执行测试用例的,并返回测试用例的执行结果。它还可以用图形或者文本接口,把返回的测试结果更形象的展现出来,如:HTMLTestRunner。
unittest的断言
在python基础中,我们有讲过一个assert断言,使用方法比较简单,即assert 表达式, 提示信息
,而unittest框架中也提供了一个自带的断言方式,主要有以下几种:
方法 | 检查 |
---|---|
assertEqual(a, b,msg=None) | a ==b |
assertNotEqual(a, b) | a !=b |
assertTrue(x) | bool(x) is True |
assertFalse(x) | Bool(x) is False |
assertIs(a, b) | a is b |
assertIsNot(a, b) | a is not b |
assertIsNone(x) | x is None |
assertIsNotNone(x) | x is not None |
assertIn(a, b) | a in b |
assertNotIn(a, b) | a not in b |
assertIsInstance(a, b) | isinstance(a,b) |
assertNotIsInstance(a, b) | not isinstance(a,b) |
总结:
TestCase测试用例
编写测试用例前,我们需要建一个测试类继承unittest里面的TestCase类,继承这个类之后我们才是真正的使用unittest框架去写测试用例,编写测试用例的步骤如下:
- 导入unittest模块
- 创建一个测试类,并继承
unittest.TestCase()
- 定义测试方法,方法名必须以test_开头
- 调用
unittest.main()
方法来运行测试用例,unittest.main()方法会搜索该模块下所有以test开头的测试用例方法,并自动执行
下面以注册功能为例,这个register.py就是注册功能的代码,没有前端界面,功能比较简单,只是方便用于演示,直接导入就可以使用。
# -*- coding: utf-8 # register.py users = [{'username': 'test', 'password': '123456'}] def register(username, password1, password2): if not all([username, password1, password2]): return {"code": 0, "msg": "argument cannot empty!"} # 注册功能 for user in users: if username == user['username']: return {"code": 0, "msg": "该用户名已存在!"} elif password1 != password2: return {"code": 0, "msg": "password undeference!"} elif ((6 <= len(username) <= 18)): users.append({'username': username, 'password': password2}) return {"code": 1, "msg": "register success!"} else: return {"code": 0, "msg": "password worlds must in 6-18!"}
下面是编写测试用例例子:
python
# -*- coding: utf-8 # test_register.py import unittest from register import register # 导入被测试的代码 class TestRegister(unittest.TestCase): """注册接口测试用例类""" def test_register_success(self): """注册成功""" # print '注册成功' data = ("mikitest", "miki123", "miki123") # 测试数据 expected = {"code": 1, "msg": "register success!"} # 预期结果 result = register(*data) # 把测试数据传到被测的代码,接收实际结果 self.assertEqual(expected, result) # 断言,预期和实际是否一致,一致即用例通过 def test_username_isnull(self): """注册失败-用户名为空""" # print '注册失败-用户名为空' data = ("", "miki123", "miki123") expected = {"code": 0, "msg": "argument cannot empty!"} result = register(*data) self.assertEqual(expected, result) def test_username_lt6(self): """注册失败-用户名大于18位""" # print '注册失败-用户名大于18位' data = ("mikitestmikitestmikitest", "miki123", "miki123") expected = {"code": 0, "msg": "password worlds must in 6-18!"} result = register(*data) self.assertEqual(expected, result) # 这条用例应该是不通过的,注册代码bug def test_pwd1_not_pwd2(self): """注册失败-两次密码不一致""" # print '注册失败-两次密码不一致' data = ("miki123", "test123", "test321") expected = {"code": 0, "msg": "password undeference!"} result = register(*data) self.assertEqual(expected, result) # 如果直接运行这个文件,需要使用unittest中的main函数来执行测试用例 if __name__ == '__main__': unittest.main()
测试用例运行结果如下,一共4条用例,其中通过4条,不通过0条
TestFixure测试夹具
unittest的测试夹具有两种使用方式,一种是以测试方法为维度的setUp()
和tearDown()
,一种是以测试类为维度的setUpClass()
和tearDownClass()
。以注册功能为例,但这个注册代码比较简单,没有真正需要用到测试夹具的地方,因此这只是个用法演示。
python
# -*- coding: utf-8 # test_register.py import unittest from register import register # 导入被测试的代码 class TestRegister(unittest.TestCase): """注册接口测试用例类""" def setUp(self): # 每条用例执行之前都会执行 print("用例{}开始执行--".format(self)) def tearDown(self): # 每条用例执行之后都会执行 print("用例{}执行结束--".format(self)) @classmethod # 指明这是个类方法以类为维度去执行的 def setUpClass(cls): # 整个测试用例类中的用例执行之前,会先执行此方法 print("-----setup---class-----") @classmethod def tearDownClass(cls): # 整个测试用例类中的用例执行完之后,会执行此方法 print("-----teardown---class-----") def test_register_success(self): """注册成功""" # print '注册成功' data = ("mikitest", "miki123", "miki123") # 测试数据 expected = {"code": 1, "msg": "register success!"} # 预期结果 result = register(*data) # 把测试数据传到被测的代码,接收实际结果 self.assertEqual(expected, result) # 断言,预期和实际是否一致,一致即用例通过 def test_username_isnull(self): """注册失败-用户名为空""" # print '注册失败-用户名为空' data = ("", "miki123", "miki123") expected = {"code": 0, "msg": "argument cannot empty!"} result = register(*data) self.assertEqual(expected, result) def test_username_lt6(self): """注册失败-用户名大于18位""" # print '注册失败-用户名大于18位' data = ("mikitestmikitestmikitest", "miki123", "miki123") expected = {"code": 0, "msg": "password worlds must in 6-18!"} result = register(*data) self.assertEqual(expected, result) # 这条用例应该是不通过的,注册代码bug def test_pwd1_not_pwd2(self): """注册失败-两次密码不一致""" # print '注册失败-两次密码不一致' data = ("miki123", "test123", "test321") expected = {"code": 0, "msg": "password undeference!"} result = register(*data) self.assertEqual(expected, result) # 如果直接运行这个文件,需要使用unittest中的main函数来执行测试用例 if __name__ == '__main__': unittest.main()
运行结果:
-----setup---class-----
用例test_pwd1_not_pwd2 (test_register.TestRegister)开始执行--
用例test_pwd1_not_pwd2 (test_register.TestRegister)执行结束--
用例test_register_success (test_register.TestRegister)开始执行--
用例test_register_success (test_register.TestRegister)执行结束--
用例test_username_isnull (test_register.TestRegister)开始执行--
用例test_username_isnull (test_register.TestRegister)执行结束--
用例test_username_lt6 (test_register.TestRegister)开始执行--
用例test_username_lt6 (test_register.TestRegister)执行结束--
-----teardown---class-----
Ran 4 tests in 0.006sOK
Process finished with exit code 0
TestSuite测试套件
unittest.TestSuite()类来表示一个测试用例集,把需要执行的用例类或模块存到一起,常用的方法如下:
- 🍊 unittest.TestSuite()
addTest()
:添加单个测试用例方法addTest([..])
:添加多个测试用例方法,方法名存在一个列表
- 🍊 unittest.TestLoader()
loadTestsFromTestCase(测试类名)
:添加一个测试类loadTestsFromModule(模块名)
:添加一个模块discover(测试用例的所在目录)
:指定目录去加载,会自动寻找这个目录下所有符合命名规则的测试用例
python
# -*- coding: utf-8 # run_test.py,与test_register.py、register.py同一目录下 import os.path import sysconfig import unittest import test_register import HTMLTestRunner #在将中文encode(UTF-8)的时候出现了UnicodeDecodeError: 'ascii' codec can't decode byte 0xe6 in position 0: ordinal not in range(128)的问题 import sys reload(sys) sys.setdefaultencoding('utf8') # 第一步,创建一个测试套件 suite = unittest.TestSuite() # 第二步:将测试用例,加载到测试套件中 # 方式1,添加单条测试用例 # case = test_register.TestRegister("test_register_success") # 创建一个用例对象,注意:通过用例类去创建测试用例对象的时候,需要传入用例的方法名(字符串类型) # suite.addTest(case) # 添加用例到测试套件中 # 方式2,添加多条测试用例 # case1 = test_register.TestRegister("test_register_success") # case2 = test_register.TestRegister("test_username_isnull") # suite.addTest([case1, case2]) # 添加用例到测试套件中 # 方式3,添加一个测试用例类 # loader = unittest.TestLoader() # 创建一个加载对象 # suite.addTest(loader.loadTestsFromTestCase(test_register.TestRegister)) # 方式4,添加一个模块 loader = unittest.TestLoader() # 创建一个加载对象 suite.addTest(loader.loadTestsFromModule(test_register)) # 方式5,指定测试用例的所在的目录路径,进行加载 # loader = unittest.TestLoader() #suite.addTest(loader.discover(start_dir = r"d:\learn\python", pattern="test_case*.py"))
通常我们使用方式4、5比较多,你可以根据实际情况来运用。其中方式5,还可以自定义匹配规则,默认是会寻找目录下test*.py
文件,即所有以test开头命名的py文件
TestRunner执行用例
test runner顾名思义就是用来执行测试用例的,并且可以生成相应的测试报告。测试报告有两种展示形式,一种是text文本,一种是html格式。
html格式的就是HTMLTestRunner了,HTMLTestRunner
是 Python 标准库的 unittest 框架的一个扩展,它可以生成一个直观清晰的 HTML 测试报告。使用的前提就是要下载 HTMLTestRunner.py,下载完后,python2+,放在安装目录Lib目录下;python3+的安装目录下的scripts目录下即可。
下载地址:http://tungwaiyip.info/software/HTMLTestRunner.html
text文本相对于html来说过于简陋,与控制台输出的没有什么区别,也几乎没有人使用,这里不作演示,使用方法是一样的。我们结合前面的测试套件来演示一下如何生成html格式的测试报告:
python,# run_test.py下增加如下代码
# 创建测试运行程序启动器 # 打开一个报告文件,将句柄传给stream # 报告中显示的描述信息 # 报告的标题 #runner=HTMLTestRunner.HTMLTestRunner(stream=open('report.html','wb'),title='unittest 自动化报告',description='描述') filename='D:/pythonProject1/report/myreport.html' fp=file(filename,'wb') runner=HTMLTestRunner.HTMLTestRunner(fp,title='我的报告',description='这是unitest框架生成的自动化报告') # 使用启动器去执行测试套件里的用例 runner.run(suite)
相关参数说明:
stream
:指定输出的方式description
:报告中要显示的面熟信息title
:测试报告的标题verbosity
:表示测试报告信息的详细程度,一共三个值,默认是2- 0 (静默模式):你只能获得总的测试用例数和总的结果,如:总共100个 失败10 成功90
- 1 (默认模式):类似静默模式,只是在每个成功的用例前面有个. 每个失败的用例前面有个F
- 2 (详细模式):测试结果会显示每个测试用例的所有相关的信息
运行完毕如下表示成功,在目录D:/pythonProject1/report/myreport.html目录下已经生成了一个myreport.html文件,在浏览器中打开,就可以查看测试报告了。