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)。元测试(unit test)的本质也就在这里,一个测试用例是一个完整的测试单元,通过运行这个测试单元,可以对某一个问题进行验证。
(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模块中。
python unittest简介
unittest是python下的单元测试框架,是java junit的python版本, 跟其它语言下的单元测试框架风格类似,unittest支持自动化测试、共享setup和teardown代码、测试聚合成集、独立于报告框架。unittest模块提供了一个丰富的工具集用于构建和执行用例,先看一个入门的例子:
import unittest class teststringmethods(unittest.testcase): def test_upper(self): self.assertequal('foo'.upper(), 'foo') def test_isupper(self): self.asserttrue('foo'.isupper()) self.assertfalse('foo'.isupper()) def test_split(self): s = 'hello world' self.assertequal(s.split(), ['hello', 'world']) # check that s.split fails when the separator is not a string with self.assertraises(typeerror): s.split(2) if __name__ == '__main__': unittest.main()
可以通过继承unittest.testcase创建一个测试用例teststringmethods,在这个用例中定义了测试函数,这些函数名字都以”test”开头,在执行测试用例teststringmethods时,这些方法会被自动调用。每个测试函数中都调用了asserttrue()和assertfalse()方法检查预期结果,或者使用assertraises()确认产生了一个特定异常。现在来看一下这段代码的运行结果:
...
----------------------------------------------------------------------
ran 3 tests in 0.000sok
有时我们需要在用例执行前后做一些工作如初始化和清理,这就需要实现setup()和teardown()方法
import unittest class widgettestcase(unittest.testcase): def setup(self): print("setup()") def test_1(self): print("test_1") def test_2(self): print("test_2") def teardown(self): print("teardown()") if __name__ == '__main__': unittest.main()
运行结果:
setup()
.test_1
teardown()
setup()
.test_2
teardown()
----------------------------------------------------------------------
ran 2 tests in 0.000sok
注:如果setup()执行成功(没有异常发生),那么无论测试方法是否通过,teardown()都会被执行
根据所测的特性测试用例被组合在一起,通过调用unittest.main(),unittest测试框架会自动收集所有模块的测试用例然后执行。
import unittest class widgettestcase(unittest.testcase): def setup(self): print("widgettestcase setup()") def test_widget(self): print("test_widget") def teardown(self): print("widgettestcase teardown()") class functestcase(unittest.testcase): def setup(self): print("functestcase setup()") def test_func(self): print("test_func") def teardown(self): print("functestcase teardown()") if __name__ == '__main__': unittest.main()
运行结果:
functestcase setup()
test_func
functestcase teardown()
.widgettestcase setup()
test_widget
widgettestcase teardown()
.
----------------------------------------------------------------------
ran 2 tests in 0.003sok
如果想构建自已的用例集,只需要这么做:
import unittest class widgettestcase(unittest.testcase): def setup(self): print("widgettestcase setup()") def test_widget(self): print("test_widget") def teardown(self): print("widgettestcase teardown()") class functestcase(unittest.testcase): def setup(self): print("functestcase setup()") def test_func(self): print("test_func") def teardown(self): print("functestcase teardown()") def suite(): suite = unittest.testsuite() suite.addtest(functestcase('test_func')) return suite if __name__ == '__main__': runner=unittest.texttestrunner() runner.run(suite())
运行结果:
functestcase setup()
test_func
functestcase teardown()
.
----------------------------------------------------------------------
ran 1 test in 0.001sok
unittest中相关类和函数
在unittest中 testcase类的实例代表逻辑测试单元,这个类通常被当作测试类的基类使用, testcase类实现了许多测试相关的接口,主要是以下三组方法:
1.执行测试用例的方法
setup() #在每个测试方法之前执行,这个方法引发的异常会被认为是错误,而非测试失败,默认实现是不做任何事 teardown() #在每个测试方法之后执行,即使测试方法抛出异常teardown()方法仍会执行,并且只有setup()成功执行时teardown()才会执行, #同样这个方法引发的异常会被认为是错误,而非测试失败。默认实现是不做任何事 setupclass() #在一个测试类的所有测试方法执行之前执行,相当于google test中的setuptestcase()方法,setupclass()必须被装饰成一个classmethod() @classmethod def setupclass(cls): ... teardownclass() #在一个测试类的所有测试方法执行之后执行,相当于google test中的teardowntestcase()方法,teardownclass()必须被装饰成一个classmethod() @classmethod def teardownclass(cls): ...
2.检查条件和报告错误的方法
method | checks that | new in |
---|---|---|
assertequal(a, b) | 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 | 3.1 |
assertisnot(a, b) | a is not b | 3.1 |
assertisnone(x) | x is none | 3.1 |
assertisnotnone(x) | x is not none | 3.1 |
assertin(a, b) | a in b | 3.1 |
assertnotin(a, b) | a not in b | 3.1 |
assertisinstance(a, b) | isinstance(a, b) | 3.2 |
assertnotisinstance(a, b) | not isinstance(a, b) | 3.2 |
assertraises(exc, fun, *args, **kwds) | fun(*args, **kwds) raises exc | |
assertraisesregex(exc, r, fun, *args, **kwds) | fun(*args, **kwds) raises exc and the message matches regex r | 3.1 |
assertwarns(warn, fun, *args, **kwds) | fun(*args, **kwds) raises warn | 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 < b | 3.1 |
assertlessequal(a, b) | a <= b | 3.1 |
assertregex(s, r) | r.search(s) | 3.1 |
assertnotregex(s, r) | not r.search(s) | 3.2 |
assertcountequal(a, b) | a and b have the same elements in the same number, regardless of their order | 3.2 |
assertwarnsregex(warn, r, fun, *args, **kwds) | fun(*args, **kwds) raises warn and the message matches regex r | 3.2 |
assertlogs(logger, level) | the with block logs on logger with minimum level | 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) | sets or frozensets | 3.1 |
assertdictequal(a, b) | dicts | 3.1 |