Python unittest单元测试框架总结
什么是单元测试
单元测试是用来对一个模块、一个函数或者一个类来进行正确性检验的测试工作。
比如对于函数abs(),我们可以编写的测试用例为:
(1)输入正数,比如1、1.2、0.99,期待返回值与输入相同
(2)输入复数,比如-1、-1.2、-0.99,期待返回值与输入相反
(3)输入0,期待返回0
(4)输入非数值类型,比如None、[]、{}、期待抛出TypeError
把上面这些测试用例放到一个测试模块里,就是一个完整的单元测试
unittest工作原理
unittest中最核心的四部分是:TestCase,TestSuite,TestRunner,TestFixture
(1)一个TestCase的实例就是一个测试用例。测试用例就是指一个完整的测试流程,包括测试前准备环境的搭建(setUp),执行测试代码(run),以及测试后环境的还原(tearDown)。元测试(unittest)的本质也就在这里,一个测试用例是一个完整的测试单元,通过运行这个测试单元,可以对某一个问题进行验证。
(2)而多个测试用例集合在一起,就是TestSuite,而且TestSuite也可以嵌套TestSuite。
(3)TestLoader是用来加载TestCase到TestSuite中的。
(4)TextTestRunner是来执行测试用例的,其中的run(test)会执行TestSuite/TestCase中的run(result)方法
(5)测试的结果会保存到TextTestResult实例中,包括运行了多少测试用例,成功了多少,失败了多少等信息。
综上,整个流程就是首先要写好TestCase,然后由TestLoader加载TestCase到TestSuite,然后由TextTestRunner来运行TestSuite,运行的结果保存在TextTestResult中,整个过程集成在unittest.main模块中。
pythonunittest简介
unittest是python下的单元测试框架,是javaJUnit的python版本,跟其它语言下的单元测试框架风格类似,unittest支持自动化测试、共享setup和teardown代码、测试聚合成集、独立于报告框架。unittest模块提供了一个丰富的工具集用于构建和执行用例,先看一个入门的例子:
importunittest classTestStringMethods(unittest.TestCase): deftest_upper(self): self.assertEqual('foo'.upper(),'FOO') deftest_isupper(self): self.assertTrue('FOO'.isupper()) self.assertFalse('Foo'.isupper()) deftest_split(self): s='helloworld' self.assertEqual(s.split(),['hello','world']) #checkthats.splitfailswhentheseparatorisnotastring withself.assertRaises(TypeError): s.split(2) if__name__=='__main__': unittest.main()
可以通过继承unittest.TestCase创建一个测试用例TestStringMethods,在这个用例中定义了测试函数,这些函数名字都以”test”开头,在执行测试用例TestStringMethods时,这些方法会被自动调用。每个测试函数中都调用了assertTrue()和assertFalse()方法检查预期结果,或者使用assertRaises()确认产生了一个特定异常。现在来看一下这段代码的运行结果:
...
----------------------------------------------------------------------
Ran3testsin0.000sOK
有时我们需要在用例执行前后做一些工作如初始化和清理,这就需要实现setUp()和tearDown()方法
importunittest classWidgetTestCase(unittest.TestCase): defsetUp(self): print("setUp()") deftest_1(self): print("test_1") deftest_2(self): print("test_2") deftearDown(self): print("tearDown()") if__name__=='__main__': unittest.main()
运行结果:
setUp()
.test_1
tearDown()
setUp()
.test_2
tearDown()
----------------------------------------------------------------------
Ran2testsin0.000sOK
注:如果setUp()执行成功(没有异常发生),那么无论测试方法是否通过,tearDown()都会被执行
根据所测的特性测试用例被组合在一起,通过调用unittest.main(),unittest测试框架会自动收集所有模块的测试用例然后执行。
importunittest classWidgetTestCase(unittest.TestCase): defsetUp(self): print("WidgetTestCasesetUp()") deftest_Widget(self): print("test_Widget") deftearDown(self): print("WidgetTestCasetearDown()") classFuncTestCase(unittest.TestCase): defsetUp(self): print("FuncTestCasesetUp()") deftest_func(self): print("test_func") deftearDown(self): print("FuncTestCasetearDown()") if__name__=='__main__': unittest.main()
运行结果:
FuncTestCasesetUp()
test_func
FuncTestCasetearDown()
.WidgetTestCasesetUp()
test_Widget
WidgetTestCasetearDown()
.
----------------------------------------------------------------------
Ran2testsin0.003sOK
如果想构建自已的用例集,只需要这么做:
importunittest classWidgetTestCase(unittest.TestCase): defsetUp(self): print("WidgetTestCasesetUp()") deftest_Widget(self): print("test_Widget") deftearDown(self): print("WidgetTestCasetearDown()") classFuncTestCase(unittest.TestCase): defsetUp(self): print("FuncTestCasesetUp()") deftest_func(self): print("test_func") deftearDown(self): print("FuncTestCasetearDown()") defsuite(): suite=unittest.TestSuite() suite.addTest(FuncTestCase('test_func')) returnsuite if__name__=='__main__': runner=unittest.TextTestRunner() runner.run(suite())
运行结果:
FuncTestCasesetUp()
test_func
FuncTestCasetearDown()
.
----------------------------------------------------------------------
Ran1testin0.001sOK
unittest中相关类和函数
在unittest中TestCase类的实例代表逻辑测试单元,这个类通常被当作测试类的基类使用,TestCase类实现了许多测试相关的接口,主要是以下三组方法:
1.执行测试用例的方法
setUp() #在每个测试方法之前执行,这个方法引发的异常会被认为是错误,而非测试失败,默认实现是不做任何事 tearDown() #在每个测试方法之后执行,即使测试方法抛出异常tearDown()方法仍会执行,并且只有setUp()成功执行时tearDown()才会执行, #同样这个方法引发的异常会被认为是错误,而非测试失败。默认实现是不做任何事 setUpClass() #在一个测试类的所有测试方法执行之前执行,相当于googletest中的SetUpTestCase()方法,setUpClass()必须被装饰成一个classmethod() @classmethod defsetUpClass(cls): ... tearDownClass() #在一个测试类的所有测试方法执行之后执行,相当于googletest中的TearDownTestCase()方法,tearDownClass()必须被装饰成一个classmethod() @classmethod deftearDownClass(cls): ...
2.检查条件和报告错误的方法
Method
Checksthat
Newin
assertEqual(a,b)
a==b
assertNotEqual(a,b)
a!=b
assertTrue(x)
bool(x)isTrue
assertFalse(x)
bool(x)isFalse
assertIs(a,b)
aisb
3.1
assertIsNot(a,b)
aisnotb
3.1
assertIsNone(x)
xisNone
3.1
assertIsNotNone(x)
xisnotNone
3.1
assertIn(a,b)
ainb
3.1
assertNotIn(a,b)
anotinb
3.1
assertIsInstance(a,b)
isinstance(a,b)
3.2
assertNotIsInstance(a,b)
notisinstance(a,b)
3.2
assertRaises(exc,fun,*args,**kwds)
fun(*args,**kwds)raisesexc
assertRaisesRegex(exc,r,fun,*args,**kwds)
fun(*args,**kwds)raisesexcandthemessagematchesregexr
3.1
assertWarns(warn,fun,*args,**kwds)
fun(*args,**kwds)raiseswarn
3.2
assertNotAlmostEqual(a,b)
round(a-b,7)!=0
assertGreater(a,b)
a>b
3.1
assertGreaterEqual(a,b)
a>=b
3.1
assertLess(a,b)
a
3.1
assertLessEqual(a,b)
a<=b
3.1
assertRegex(s,r)
r.search(s)
3.1
assertNotRegex(s,r)
notr.search(s)
3.2
assertCountEqual(a,b)
aandbhavethesameelementsinthesamenumber,regardlessoftheirorder
3.2
assertWarnsRegex(warn,r,fun,*args,**kwds)
fun(*args,**kwds)raiseswarnandthemessagematchesregexr
3.2
assertLogs(logger,level)
Thewithblocklogsonloggerwithminimumlevel
3.4
assertMultiLineEqual(a,b)
strings
3.1
assertSequenceEqual(a,b)
sequences
3.1
assertListEqual(a,b)
lists
3.1
assertTupleEqual(a,b)
tuples
3.1
assertSetEqual(a,b)
setsorfrozensets
3.1
assertDictEqual(a,b)
dicts
3.1