Python单元测试框架 — unittest详解

一、unittest核心工作原理

unittest中最核心的四个概念是：test case, test suite, test runner, test fixture。

unittest的静态类图：

1. 一个TestCase的实例就是一个测试用例。什么是测试用例呢？就是一个完整的测试流程，包括测试前准备环境的搭建(setUp)，执行测试代码(run)，以及测试后环境的还原(tearDown)。元测试(unit test)的本质也就在这里，一个测试用例是一个完整的测试单元，通过运行这个测试单元，可以对某一个问题进行验证。
2. 多个测试用例集合在一起，就是TestSuite，而且TestSuite也可以嵌套TestSuite。
3. TestLoader是用来加载TestCase到TestSuite中的，其中有几个loadTestsFrom__()方法，就是从各个地方寻找TestCase，创建它们的实例，然后add到TestSuite中，再返回一个TestSuite实例。
4. TextTestRunner是来执行测试用例的，其中的run(test)会执行TestSuite/TestCase中的run(result)方法。测试的结果会保存到TextTestResult实例中，包括运行了多少测试用例，成功了多少，失败了多少等信息。
5. 而对一个测试用例环境的搭建和销毁，是一个fixture。通过覆盖TestCase的setUp()和tearDown()方法来实现。这个有什么用呢？比如说在这个测试用例中需要访问数据库，那么可以在setUp()中建立数据库连接以及进行一些初始化，在tearDown()中清除在数据库中产生的数据，然后关闭连接。注意tearDown的过程很重要，要为以后的TestCase留下一个干净的环境。

一个class继承了unittest.TestCase，便是一个测试用例，但如果其中有多个以 test 开头的方法，那么每有一个这样的方法，在load的时候便会生成一个TestCase实例，如：一个class中有四个test_xxx方法，最后在load到suite中时也有四个测试用例。

到这里整个流程就清楚了：

写好TestCase，然后由TestLoader加载TestCase到TestSuite，然后由TextTestRunner来运行TestSuite，运行的结果保存在TextTestResult中，我们通过命令行或者unittest.main()执行时，main会调用TextTestRunner中的run来执行，或者我们可以直接通过TextTestRunner来执行用例。这里加个说明，在Runner执行时，默认将执行结果输出到控制台，我们可以设置其输出到文件，在文件中查看结果（测试报告）

二、unittest实例

准备一些待测方法：

mathfunc.py

def add(a, b):
return a+b

def minus(a, b):
return a-b

def multi(a, b):
return a*b

def divide(a, b):
return a/b

接下来我们为这些方法写一个测试:

test_mathfunc.py

import unittest
from mathfunc import *

class TestMathFunc(unittest.TestCase):
"""Test mathfuc.py"""

def test_add(self):
"""Test method add(a, b)"""
self.assertEqual(3, add(1, 2))
self.assertNotEqual(3, add(2, 2))

def test_minus(self):
"""Test method minus(a, b)"""
self.assertEqual(1, minus(3, 2))

def test_multi(self):
"""Test method multi(a, b)"""
self.assertEqual(6, multi(2, 3))

def test_divide(self):
"""Test method divide(a, b)"""
self.assertEqua
109d6
l(2, divide(6, 3))
self.assertEqual(3, divide(5, 2))

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

执行结果：

.F..
======================================================================
FAIL: test_divide (__main__.TestMathFunc)
Test method divide(a, b)
----------------------------------------------------------------------
Traceback (most recent call last):
File "E:/AutomaticTest/Test_Framework/temp/test_mathfunc.py", line 24, in test_divide
self.assertEqual(3, divide(5, 2))
AssertionError: 3 != 2.5

----------------------------------------------------------------------
Ran 4 tests in 0.001s

FAILED (failures=1)

能够看到一共运行了4个测试，失败了1个，并且给出了失败原因，3 != 2.5

这就是一个简单的测试，有几点需要说明的：

在第一行给出了每一个用例执行的结果的标识，成功是 .，失败是 F，出错是 E，跳过是 S。从上面也可以看出，测试的执行跟方法的顺序没有关系，test_divide写在了第4个，但是却是第2个执行的。

每个测试方法均以 test 开头，否则是不被unittest识别的。

在unittest.main()中加 verbosity 参数可以控制输出的错误报告的详细程度，默认是 1，如果设为 0，则不输出每一用例的执行结果，即没有上面的结果中的第1行；如果设为 2，则输出详细的执行结果，如下：

import unittest
from mathfunc import *

class TestMathFunc(unittest.TestCase):
"""Test mathfuc.py"""

def test_add(self):
"""Test method add(a, b)"""
self.assertEqual(3, add(1, 2))
self.assertNotEqual(3, add(2, 2))

def test_minus(self):
"""Test method minus(a, b)"""
self.assertEqual(1, minus(3, 2))

def test_multi(self):
"""Test method multi(a, b)"""
self.assertEqual(6, multi(2, 3))

def test_divide(self):
"""Test method divide(a, b)"""
self.assertEqual(2, divide(6, 3))
self.assertEqual(3, divide(5, 2))

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

输出：

test_add (__main__.TestMathFunc)
Test method add(a, b) ... ok
test_divide (__main__.TestMathFunc)
Test method divide(a, b) ... FAIL
test_minus (__main__.TestMathFunc)
Test method minus(a, b) ... ok
test_multi (__main__.TestMathFunc)
Test method multi(a, b) ... ok

======================================================================
FAIL: test_divide (__main__.TestMathFunc)
Test method divide(a, b)
----------------------------------------------------------------------
Traceback (most recent call last):
File "E:/AutomaticTest/Test_Framework/temp/test_mathfunc.py", line 24, in test_divide
self.assertEqual(3, divide(5, 2))
AssertionError: 3 != 2.5

----------------------------------------------------------------------
Ran 4 tests in 0.001s

FAILED (failures=1)

可以看到，每一个用例的详细执行情况以及用例名，用例描述均被输出了出来（在测试方法下加代码示例中的”“”Doc String”“”，在用例执行时，会将该字符串作为此用例的描述，加合适的注释能够使输出的测试报告更加便于阅读

三、组织TestSuite

上面的代码示例了如何编写一个简单的测试，但有两个问题：

问题一、我们怎么控制用例执行的顺序呢？（这里的示例中的几个测试方法并没有一定关系，但之后你写的用例可能会有先后关系，需要先执行方法A，再执行方法B），我们就要用到TestSuite了。我们添加到TestSuite中的case是会按照添加的顺序执行的。

问题二、我们现在只有一个测试文件，我们直接执行该文件即可，但如果有多个测试文件，怎么进行组织，总不能一个个文件执行吧

下面来个例子：

在文件夹中我们再新建一个文件，test_suite.py：

import unittest
from test_mathfunc import TestMathFunc

if __name__ == '__main__':
suite = unittest.TestSuite()

tests = [TestMathFunc("test_add"), TestMathFunc("test_minus"), TestMathFunc("test_divide")]
suite.addTests(tests)

runner = unittest.TextTestRunner(verbosity=2)
runner.run(suite)

执行结果：

test_add (test_mathfunc.TestMathFunc)
Test method add(a, b) ... ok
test_minus (test_mathfunc.TestMathFunc)
Test method minus(a, b) ... ok
test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b) ... FAIL

======================================================================
FAIL: test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b)
----------------------------------------------------------------------
Traceback (most recent call last):
File "E:\AutomaticTest\Test_Framework\temp\test_mathfunc.py", line 24, in test_divide
self.assertEqual(3, divide(5, 2))
AssertionError: 3 != 2.5

----------------------------------------------------------------------
Ran 3 tests in 0.001s

FAILED (failures=1)

可以看到，执行情况跟我们预料的一样：执行了三个case，并且顺序是按照我们添加进suite的顺序执行的。

上面用了TestSuite的 addTests() 方法，并直接传入了TestCase列表，我们还可以：

# 直接用addTest方法添加单个TestCase
suite.addTest(TestMathFunc("test_multi"))

# 用addTests + TestLoader
# loadTestsFromName()，传入'模块名.TestCase名'
suite.addTests(unittest.TestLoader().loadTestsFromName('test_mathfunc.TestMathFunc'))
suite.addTests(unittest.TestLoader().loadTestsFromNames(['test_mathfunc.TestMathFunc']))  # loadTestsFromNames()，类似，传入列表

# loadTestsFromTestCase()，传入TestCase
suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestMathFunc))

注意，用TestLoader的方法是无法对case进行排序的，同时，suite中也可以套suite。

四、将测试结果输出到文件中

用例组织好了，但结果只能输出到控制台，这样没有办法查看之前的执行记录，我们想将结果输出到文件。很简单，看示例：

修改test_suite.py：

import unittest
from test_mathfunc import TestMathFunc

if __name__ == '__main__':
suite = unittest.TestSuite()

suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestMathFunc))
with open(r'D:\UnittestTextReport.txt', 'a') as f:
runner = unittest.TextTestRunner(stream=f,verbosity=2)
runner.run(suite)

执行此文件，可以看到，在D盘生成了UnittestTextReport.txt，所有的执行报告均输出到了此文件中，这下我们便有了txt格式的测试报告了。

五、test fixture之setUp() tearDown()

上面整个测试基本跑了下来，但可能会遇到点特殊的情况：如果我的测试需要在每次执行之前准备环境，或者在每次执行完之后需要进行一些清理怎么办？比如执行前需要连接数据库，执行完成之后需要还原数据、断开连接。总不能每个测试方法中都添加准备环境、清理环境的代码吧。

这就要涉及到我们之前说过的test fixture了，修改test_mathfunc.py：

import unittest
from mathfunc import *

class TestMathFunc(unittest.TestCase):
"""Test mathfuc.py"""

def setUp(self):
print("do something before test.Prepare environment.")

def tearDown(self):
print("do something after test.Clean up.")

def test_add(self):
"""Test method add(a, b)"""
self.assertEqual(3, add(1, 2))
self.assertNotEqual(3, add(2, 2))

def test_minus(self):
"""Test method minus(a, b)"""
self.assertEqual(1, minus(3, 2))

def test_multi(self):
"""Test method multi(a, b)"""
self.assertEqual(6, multi(2, 3))

def test_divide(self):
"""Test method divide(a, b)"""
self.assertEqual(2, divide(6, 3))
self.assertEqual(3, divide(5, 2))

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

我们添加了 setUp() 和 tearDown() 两个方法（其实是重写了TestCase的这两个方法），这两个方法在每个测试方法执行前以及执行后执行一次，setUp用来为测试准备环境，tearDown用来清理环境，已备之后的测试。

我们再执行一次：

test_add (test_mathfunc.TestMathFunc)
do something before test.Prepare environment.
Test method add(a, b) ... ok
do something after test.Clean up.
test_divide (test_mathfunc.TestMathFunc)
do something before test.Prepare environment.
Test method divide(a, b) ... FAIL
do something after test.Clean up.
test_minus (test_mathfunc.TestMathFunc)
do something before test.Prepare environment.
Test method minus(a, b) ... ok
do something after test.Clean up.
test_multi (test_mathfunc.TestMathFunc)
do something before test.Prepare environment.
Test method multi(a, b) ... ok
do something after test.Clean up.

======================================================================
FAIL: test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b)
----------------------------------------------------------------------
Traceback (most recent call last):
File "E:\AutomaticTest\Test_Framework\temp\test_mathfunc.py", line 30, in test_divide
self.assertEqual(3, divide(5, 2))
AssertionError: 3 != 2.5

----------------------------------------------------------------------
Ran 4 tests in 0.001s

FAILED (failures=1)

可以看到setUp和tearDown在每次执行case前后都执行了一次。

如果想要在所有case执行之前准备一次环境，并在所有case执行结束之后再清理环境，我们可以用 setUpClass() 与 tearDownClass():

import unittest
from mathfunc import *

class TestMathFunc(unittest.TestCase):
"""Test mathfuc.py"""

@classmethod
def setUpClass(cls):
print("This setUpClass() method only called once.")

@classmethod
def tearDownClass(cls):
print("This tearDownClass() method only called once too.")

def test_add(self):
"""Test method add(a, b)"""
self.assertEqual(3, add(1, 2))
self.assertNotEqual(3, add(2, 2))

def test_minus(self):
"""Test method minus(a, b)"""
self.assertEqual(1, minus(3, 2))

def test_multi(self):
"""Test method multi(a, b)"""
self.assertEqual(6, multi(2, 3))

def test_divide(self):
"""Test method divide(a, b)"""
self.assertEqual(2, divide(6, 3))
self.assertEqual(3, divide(5, 2))

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

执行结果如下：

This setUpClass() method only called once.
This tearDownClass() method only called once too.
test_add (test_mathfunc.TestMathFunc)
Test method add(a, b) ... ok
test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b) ... FAIL
test_minus (test_mathfunc.TestMathFunc)
Test method minus(a, b) ... ok
test_multi (test_mathfunc.TestMathFunc)
Test method multi(a, b) ... ok

======================================================================
FAIL: test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b)
----------------------------------------------------------------------
Traceback (most recent call last):
File "E:\AutomaticTest\Test_Framework\temp\test_mathfunc.py", line 32, in test_divide
self.assertEqual(3, divide(5, 2))
AssertionError: 3 != 2.5

----------------------------------------------------------------------
Ran 4 tests in 0.001s

FAILED (failures=1)

可以看到setUpClass以及tearDownClass均只执行了一次。

六、跳过每个case

如果我们临时想要跳过某个case不执行怎么办？unittest也提供了几种方法：

1、skip装饰器

import unittest
from mathfunc import *

class TestMathFunc(unittest.TestCase):
"""Test mathfuc.py"""

def test_add(self):
"""Test method add(a, b)"""
self.assertEqual(3, add(1, 2))
self.assertNotEqual(3, add(2, 2))

def test_minus(self):
"""Test method minus(a, b)"""
self.assertEqual(1, minus(3, 2))

def test_multi(self):
"""Test method multi(a, b)"""
self.assertEqual(6, multi(2, 3))

@unittest.skip("I don't want to run this case.")
def test_divide(self):
"""Test method divide(a, b)"""
self.assertEqual(2, divide(6, 3))
self.assertEqual(3, divide(5, 2))

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

执行结果：

test_add (test_mathfunc.TestMathFunc)
Test method add(a, b) ... ok
test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b) ... skipped "I don't want to run this case."
test_minus (test_mathfunc.TestMathFunc)
Test method minus(a, b) ... ok
test_multi (test_mathfunc.TestMathFunc)
Test method multi(a, b) ... ok

----------------------------------------------------------------------
Ran 4 tests in 0.000s

OK (skipped=1)

可以看到总的test数量还是4个，但divide()方法被skip了。

skip装饰器一共有三个 unittest.skip(reason)、unittest.skipIf(condition, reason)、unittest.skipUnless(condition, reason)，skip无条件跳过，skipIf当condition为True时跳过，skipUnless当condition为False时跳过。

2、TestCase.skipTest()方法

import unittest
from mathfunc import *

class TestMathFunc(unittest.TestCase):
"""Test mathfuc.py"""

def test_add(self):
"""Test method add(a, b)"""
self.assertEqual(3, add(1, 2))
self.assertNotEqual(3, add(2, 2))

def test_minus(self):
"""Test method minus(a, b)"""
self.assertEqual(1, minus(3, 2))

def test_multi(self):
"""Test method multi(a, b)"""
self.assertEqual(6, multi(2, 3))

def test_divide(self):
"""Test method divide(a, b)"""
self.skipTest('Do not run this.')
self.assertEqual(2, divide(6, 3))
self.assertEqual(3, divide(5, 2))

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

执行结果：

test_add (test_mathfunc.TestMathFunc)
Test method add(a, b) ... ok
test_divide (test_mathfunc.TestMathFunc)
Test method divide(a, b) ... skipped 'Do not run this.'
test_minus (test_mathfunc.TestMathFunc)
Test method minus(a, b) ... ok
test_multi (test_mathfunc.TestMathFunc)
Test method multi(a, b) ... ok

----------------------------------------------------------------------
Ran 4 tests in 0.000s

OK (skipped=1)

效果跟上面的装饰器一样，跳过了divide方法。

七、用HTMLTestRunner输出漂亮的HTML报告

HTMLTestRunner是一个第三方的unittest HTML报告库

修改我们的 test_suite.py：

import unittest
from test_mathfunc import TestMathFunc
from HTMLTestRunner import HTMLTestRunner

if __name__ == '__main__':
suite = unittest.TestSuite()

suite.addTests(unittest.TestLoader().loadTestsFromTestCase(TestMathFunc))
with open(r'D:\HTMLReport.html', 'wb') as f:
runner = HTMLTestRunner(stream=f,
title='MathFunc Test Report',
description='generated by HTMLTestRunner.',
verbosity=2
)
runner.run(suite)

这样，在执行时，在控制台我们能够看到执行情况，如下：

ok test_add (test_mathfunc.TestMathFunc)
F  test_divide (test_mathfunc.TestMathFunc)
ok test_minus (test_mathfunc.TestMathFunc)
ok test_multi (test_mathfunc.TestMathFunc)
Time Elapsed: 0:00:00.002000

并且输出了HTML测试报告，HTMLReport.html，如图：