Python 各类测试框架简介（二）：unittest

unittest 与 doctest 同样也是 Python 发行版自带的包。若是你据说过 PyUnit（OSC 开源项目页面中就有 PyUnit 的页面），那么这俩实际上是同一个东西——PyUnit 是 unittest 的曾用名，由于 PyUnit 最先也是来源于 Kent 和 Erich 的 JUnit（xUnit 测试框架系列的 Java 版本） <br /> ##unittest 概览

上一篇介绍的 doctest 无论是看起来仍是用起来都显得十分简单，能够与源码写在一块儿，比较适合用做验证性的功能测试。而本篇的 unittest 从名字上看，它是一个单元测试框架；从官方文档的字数上看，它的能力应该比 doctest 强一些。

使用 unittest 的标准流程为：

1. 从 unittest.TestCase 派生一个子类
2. 在类中定义各类以 “test_” 打头的方法
3. 经过 unittest.main() 函数来启动测试

unittest 的一个颇有用的特性是 TestCase 的 setUp() 和 tearDown() 方法，它们提供了为测试进行准备和扫尾工做的功能，听起来就像上下文管理器同样。这种功能很适合用在测试对象须要复杂执行环境的状况下。 <br /> ##举个例子

这里依旧使用上篇中那个极简的例子：unnecessary_math.py 文件中有一个 multiply() 函数，功能与 * 操做符彻底同样。

test_um_test.py：

lang:python
import unittest
from unnecessary_math import multiply

class TestUM(unittest.TestCase):
	def setUp(self):
		pass
	def test_number_3_4(self):
		self.assertEqual(multiply(3,4),12)
	def test_string_a_3(self):
		self.assertEqual(multiply('a',3),'aaa')

if __name__ == '__main__':
	unittest.main()

这个例子里，咱们使用了 assertEqual() 方法。unittest 中还有不少相似的 assert 方法，好比 NotEqual、Is(Not)None、True(False)、Is(Not)Instance 等针对变量值的校验方法；另外还有一些如 assertRaises()、assertRaisesRegex() 等针对异常、警告和 log 的检查方法；以及如 assertAlmostEqual() 等一些奇怪的方法。

较详细的 assert 方法能够参考 unittest 的文档页面。

##启动测试

上例中的结尾处，咱们定义了一个对 unittest.main() 的调用，所以这个脚本是能够直接运行的：

$ python test_um_test.py
..
--------------------------------------
Ran 2 tests in 0.01s

OK

一样 -v 参数是可选的，也能够在 unittest.main() 函数里直接指定：verbosity=1。 <br /> ##Test Discovery

这个分段标题我暂时没想到好的翻译方法，就先不翻了。

Test Discovery 的做用是：假设你的项目文件夹里面四散分布着不少个测试文件。当你作回归测试的时候，一个一个地执行这些测试文件就太麻烦了。TestLoader.discover() 提供了一个能够在项目目录下自动搜索并运行测试文件的功能，并能够直接从命令行调用：

$ cd project_directory
$ python -m unittest discover

discover 可用的参数有 4 个（-v -s -p -t），其中 -s 和 -t 都与路径有关，如上例中提早 cd 到项目路径的话这俩参数均可以无视；-v 喜闻乐见；-p 是 --pattern 的缩写，可用于匹配某一类文件名。 <br /> ##测试环境

当类里面定义了 setUp() 方法的时候，测试程序会在执行每条测试项前先调用此方法；一样地，在所有测试项执行完毕后，tearDown() 方法也会被调用。验证以下：

lang:python
import unittest

class simple_test(unittest.TestCase):
	def setUp(self):
    	self.foo = list(range(10))

	def test_1st(self):
    	self.assertEqual(self.foo.pop(),9)

	def test_2nd(self):
    	self.assertEqual(self.foo.pop(),9)

if __name__ == '__main__':
	unittest.main()

注意这里两次测试均对同一个实例属性 self.foo 进行了 pop() 调用，但测试结果均为 pass，即说明，test_1st 和 test_2nd 在调用前都分别调用了一次 setUp()。

那若是咱们想全程只调用一次 setUp/tearDown 该怎么办呢？就是用 setUpClass() 和 tearDownClass() 类方法啦。注意使用这两个方法的时候必定要用 @classmethod 装饰器装饰起来：

lang:python
import unittest

class simple_test(unittest.TestCase):
	@classmethod
	def setUpClass(self):
    	self.foo = list(range(10))

	def test_1st(self):
    	self.assertEqual(self.foo.pop(),9)

	def test_2nd(self):
    	self.assertEqual(self.foo.pop(),8)

if __name__ == '__main__':
	unittest.main()

这个例子里咱们使用了一个类级别的 setUpClass() 类方法，并修改了第二次 pop() 调用的预期返回值。运行结果显示依然是所有经过，即说明此次在所有测试项被调用前只调用了一次 setUpClass()。

再往上一级，咱们但愿在整个文件级别上只调用一次 setUp/tearDown，这时候就要用 setUpModule() 和 tearDownModule() 这两个函数了，注意是函数，与 TestCase 类同级：

lang:python
import unittest

def setUpModule():
	pass

class simple_test(inittest.TestCase):
	...

通常 assert*() 方法若是抛出了未被捕获的异常，那么这条测试用例会被记为 fail，测试继续进行。但若是异常发生在 setUp() 里，就会认为测试程序自身存在错误，后面的测试用例和 tearDown() 都不会再执行。即，tearDown() 仅在 setUp() 成功执行的状况下才会执行，并必定会被执行。

最后，这两个方法的默认实现都是什么都不作（只有一句 pass），因此覆盖的时候直接写新内容就能够了，没必要再调用父类的此方法。