Unittest详解-快速入门
Unittest是Python内部自带的一个单元测试的模块,它设计的灵感来源于Junit,具有和Junit类似的结构,有过Junit经验的朋友可以很快上手。Unittest具备完整的测试结构,支持自动化测试的执行,对测试用例集进行组织,并且提供了丰富的断言方法,最后生成测试报告。Unittest框架的初衷是用于单元测试,但也不限于此,在实际工作中,由于它强大的功能,提供的完整的测试流程,
所谓知己知彼百战不殆,首先我们来一起看下Unittest大家庭里的成员。首先导入unittest模块,使用dir()函数获取Unittest的所有成员,并输出到界面上。
1 import unittest
2 print(dir(unittest))
执行结果如下。
1 ['BaseTestSuite', 'FunctionTestCase', 'SkipTest', 'TestCase', 'TestLoader', 'TestProgram', 'TestResult', 'TestSuite', 'TextTestResult', 'TextTestRunner', '_TextTestResult', '__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '__unittest', 'case', 'defaultTestLoader', 'expectedFailure', 'findTestCases', 'getTestCaseNames', 'installHandler', 'load_tests', 'loader', 'main', 'makeSuite', 'registerResult', 'removeHandler', 'removeResult', 'result', 'runner', 'signals', 'skip', 'skipIf', 'skipUnless', 'suite', 'util']
结果里显示了unittest模块的各个成员,看起来非常多,不知道如何下手。其实一个模块里往往包含了大量的成员,很大一部分我们使用的频率并不高,这时需要有重点的去攻克核心的部分,其他的稍作了解即可。下面先简单介绍最常用的一些成员,后续的章节中我们会详细剖析。
(1)TestCase:可以说是unittest中最重要的一个类,也是测试用例类的父类,通过对其继承,使子类具备了执行测试的能力。下例中MainTest是需要执行的测试类。
1 class MyTest(unittest.TestCase):
(2)TestSuite: TestSuite类用于创建测试套件。最常见的用法是,使用该类将多个测试用例添加到用例集,通过运行用例集,实现多个测试用例的执行。
1 import unittest
2
3 from test5 import MyTest
4
5 if __name__ == '__main__':
6 # 生成一个测试套件
7 suite = unittest.TestSuite()
8 # 向套件中添加要执行的测试用例
9 suite.addTest(MyTest("test_a_eq_2"))
10 suite.addTests([MyTest("test_a_gt_1_x_le_1"), MyTest("test_a_le_1_x_gt_1")]) # addTests参数为一个列表,可以添加多个测试用例
11 # 执行套件内用例
12 unittest.main(defaultTest='suite')
(3)main:调用unittest.main()方法可以方便的将测试类里的以“test”命名开头的测试方法以脚本的形式自动执行。
1 if __name__ == '__main__':
2 print('main')
3 unittest.main()
# 命令行执行测试用例 也是默认的执行方式
# python -m unittest -v test5.py
# -m表示以命令行的方式,-v表示打印详细信息
# 使用main的方式执行测试用例
# 需要配置运行方式,并且必须点击运行按钮运行,不能右键运行
配置步骤如下:
点击edit configuration:
添加完成后运行文件时选择刚刚添加的运行方式:
(4)TextTestRunner:主要使用该类的run()方法来运行TestSuite添加好的测试用例。
1 if __name__ == '__main__':
2 # 通过TestLoader加载并执行测试用例,defaultTestLoader
3 suite = unittest.defaultTestLoader.discover('./', 'test5.py')
4 # 通过unittest自带的文本运行运行测试用例
5 unittest.TextTestRunner().run(suite)
(5)skipXX:装饰器。有时我们的测试只想运行其中的一部分用例,那么我们可以使用skip装饰器来跳过执行。最常见的场景是:在不同的系统环境上运行时,某些用例是不能通过的,但这并不是我们的产品或用例导致,而是环境的不兼容等问题,此时我们可以使用skip装饰器来处理。
1 @unittest.skip("强制跳过")
1 @unittest.skipIf(3 > 2, '符合条件就跳过')
1 @unittest.skipUnless(3 > 2, '除非符合指定条件,否则跳过')
1 @unittest.expectedFailure # 预期标记失败,如果执行时真的失败or报错,则会被认为测试通过Pass(因为符合预期)
2. 重要概念
在继续学习之前,我们需要掌握四个Unittest的重要概念。以下是官方网站上通过面向对象大的方式进行的解释。
(1)test fixture:翻译过来是测试固定装置的意思。形象的说,把整个测试过程看作大的装置,这个装置里不仅具有测试执行部件,还有测试之前环境准备和测试之后环境清理的部件,有机的结合起来就是一个更大的测试装置,即test fixture。
它包括一些固定的执行方法:
1 @classmethod
2 def setUpClass(cls) -> None:
3 print('类前执行')
4
5 @classmethod
6 def tearDownClass(cls) -> None:
7 print('类后执行')
8
9 def setUp(self) -> None: # 测试用例之前执行的方法
10 pass
11
12 def tearDown(self) -> None: # 测试用例之后执行的方法
13 pass
(2)test case:测试用例,注意与前面的TestCase类不是同一个概念。一个完整的测试流程就是一个测试用例,通过一些特定的输入得到响应,并对响应进行校验的过程。我们通过去继承TestCase这个父类,可以创建新的测试用例。
注意测试用例必须以“test_”开头
1 def test_a_eq_2(self):
2 """测试情况一""" # 添加三引号的字符串可以在生成HTMLTestRunner测报告时增加用例注释
3 self.assertEqual(Do(2, 0, 2), 3)
4
5 @unittest.skip("强制跳过")
6 def test_a_gt_1_x_le_1(self):
7 """测试情况二"""
8 self.assertEqual(Do(3, 0, 0.5), 1 / 6)
注意:setUpclass、tearDownclass使用是必须添加类方法装饰器@classmethod
1 @classmethod
2 def setUpClass(cls) -> None:
3 print('类前执行')
4
5 @classmethod
6 def tearDownClass(cls) -> None:
7 print('类后执行')
这里-> None的部分是可以去掉的,意思是这个函数建议返回None。
(3)test suite:测试套件,也称为测试集合。多个测试用例组合在一起就形成了测试集,当然测试集里不仅能包含测试用例,也可以再次嵌套测试集,测试集可以用于代码的组织和运行。
定义测试集可以一个一个添加:
1 if __name__ == '__main__':
2 # 生成一个测试套件
3 suite = unittest.TestSuite()
4 # 向套件中添加要执行的测试用例
5 suite.addTest(MyTest("test_a_eq_2"))
6 suite.addTests([MyTest("test_a_gt_1_x_le_1"), MyTest("test_a_le_1_x_gt_1")]) # addTests参数为一个列表,可以添加多个测试用例
7 # 执行套件内用例
8 unittest.main(defaultTest='suite')
也可以通过TestLoader加载并执行测试用例,同时添加多个py文件中的测试用例:
1 if __name__ == '__main__':
2 # 通过TestLoader加载并执行测试用例,defaultTestLoader
3 suite = unittest.defaultTestLoader.discover('./', 'test5.py')
4 unittest.TextTestRunner().run(suite)
(4)test runner:是Unittest中的重要组成部分,主要职责为执行测试,通过图形、文本或者返回一些特殊值的方式来呈现最终的运行结果。例如执行的用例数、成功和失败的用例数。
执行结果:
. 表示pass,用例通过
F 表示false,用例执行失败
E 表示error,用例出错
S 表示skip,用例执行跳过
下图展示了他们之间的关系,test fixture是包含了以test case为核心的整个组件,多个test case可以集合到一个test suite中,最后调用test runner执行并生成结果。
unittest断言方式:
assertEqual 等于 assertNotEqual
assertTrue 为True
assertIn 在..之中
一般我们使用HTMLTestRunner来生成html形式的测试报告。
使用HTMLTestRunner步骤如下:
1、在对应python文件的Lib目录下添加HTMLTestRunner.py文件
这个文件可以在:http://tungwaiyip.info/software/HTMLTestRunner.html 。这里下载:
将文件保存到python的Lib目录下后,需要修改几个地方,因为这个py文件中的一些地方可能和python3有不兼容之处:
第94行,将import StringIO修改成import io
第539行,将self.outputBuffer = StringIO.StringIO()修改成self.outputBuffer= io.StringIO()
第642行,将if not rmap.has_key(cls):修改成if not cls in rmap:
第766行,将uo = o.decode(‘latin-1‘)修改成uo = e
第775行,将ue = e.decode(‘latin-1‘)修改成ue = e
第631行,将print >> sys.stderr, ‘\nTime Elapsed: %s‘ %(self.stopTime-self.startTime)修改成print(sys.stderr, ‘\nTimeElapsed: %s‘ % (self.stopTime-self.startTime))
修改完成后,就可以使用HTMLTestRunner来生成测试报告了
1 from HTMLTestRunner import HTMLTestRunner
2
3 if __name__ == '__main__':
4 suite = unittest.defaultTestLoader.discover('./', pattern='test5.py')
5 # 为了避免每次运行生成的报告名称都相同,可以使用时间作为文件名称的一部分
6 now = time.strftime('%Y_%m_%d %H_%M_%S', time.localtime())
7 file = open('reports_' + now + '.html', 'wb')
8
9 # unittest.TextTestRunner().run(suite)
10 htmlrunner = HTMLTestRunner(stream=file, title='自动化测试报告', description='测试报告内容描述如下:')
11 htmlrunner.run(suite)
生成html文件后,用浏览器打开: