Python 的单元测试之 unittest
Overview
Basic example
随着项目的不断扩大，单元测试在保证开发效率、可维护性和软件质量等方面的地位越发举足轻重，是一本万利的举措。Python 常用 unittest module 编写单元测试，它包含四个概念：
- test fixture：初始化和清理测试环境，比如创建临时的数据库，文件和目录等，其中 setUp() 和 setDown() 是最常用的方法
- test case：单元测试用例，TestCase 是编写单元测试用例最常用的类
- test suite：单元测试用例的集合，TestSuite 是最常用的类
- test runner：执行单元测试
例如：
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())
if __name__ == '__main__':
unittest.main()
执行结果如下：
$ python testdemo.py
..
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK
Add fixture
setUp() 和 setDown() 允许执行每个测试用例前分别初始化和清理测试环境，用法如下：
import unittest
class TestStringMethods(unittest.TestCase):
def setUp(self):
# Do something to initiate the test environment here.
pass
def tearDown(self):
# Do something to clear the test environment here.
pass
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
if __name__ == '__main__':
unittest.main()
Ignore some testcases
有时希望某些用例不被执行，unittest.skip() 提供了忽略某个测试用例的功能，用法如下：
import unittest
class TestStringMethods(unittest.TestCase):
def test_upper(self):
self.assertEqual('foo'.upper(), 'FOO')
@unittest.skip('skip is upper.')
def test_isupper(self):
self.assertTrue('FOO'.isupper())
self.assertFalse('Foo'.isupper())
if __name__ == '__main__':
unittest.main()
执行结果如下：
$ python testdemo.py
test_isupper (testdemo.TestStringMethods) ... skipped 'skip is upper.'
test_upper (testdemo.TestStringMethods) ... ok
----------------------------------------------------------------------
Ran 2 tests in 0.000s
OK (skipped=1)
Run your tests
Command Line Interface
unittest 提供了丰富的命令行入口，可以根据需要执行某些特定的用例。有了命令行的支持，上述例子的最后两行代码就显得冗余，应当被移除：
...
# 删除以下代码
if __name__ == '__main__':
unittest.main()
执行 testdemo.py 文件所有的测试用例：
$ python -m unittest testdemo
执行 testdemo.py 文件的 TestStringMethods 类的所有测试用例：
$ python -m unittest test_demo.TestStringMethods
执行 testdemo.py 文件 TestStringMethods 类的 test_upper：
$ python -m unittest test_demo.TestStringMethods.test_upper
Test Discovery
unittest 提供了自动匹配发现并执行测试用例的功能，随着项目代码结构越发庞大，势必有多个测试文件，自动匹配发现并测试用例的功能在此就显得非常有用，只要满足 load_tests protocol 的测试用例都会被 unittest 发现并执行，测试用例文件的默认匹配规则为 test*.py。通过一条命令即可执行所有的测试用例，如此就很容易被 tox 等测试工具所集成。使用如下：
python -m unittest discover
参数如下：
-v, --verbose
Verbose output
-s, --start-directory directory
Directory to start discovery (. default)
-p, --pattern pattern
Pattern to match test files (test*.py default)
-t, --top-level-directory directory
Top level directory of project (defaults to start directory)
假设现在要被测试的代码目录如下：
$ tree demo
demo
├── testdemo.py
└── testdemo1.py
$ python -m unittest discover -s demo -v
test_isupper (testdemo.TestStringMethods) ... ok
test_upper (testdemo.TestStringMethods) ... ok
test_is_not_prime (testdemo1.TestPrimerMethods) ... ok
test_is_prime (testdemo1.TestPrimerMethods) ... ok
----------------------------------------------------------------------
Ran 4 tests in 0.001s
OK
A Collection of Assertion
+--------------------------------+-------------------------------------------------------+-------+
| 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 | 2.7 |
| assertIsNot(a, b) | a is not b | 2.7 |
| assertIsNone(x) | x is None | 2.7 |
| assertIsNotNone(x) | x is not None | 2.7 |
| assertIn(a, b) | a in b | 2.7 |
| assertNotIn(a, b) | a not in b | 2.7 |
| assertIsInstance(a, b) | isinstance(a, b) | 2.7 |
| assertNotIsInstance(a, b) | not isinstance(a, b) | 2.7 |
| assertAlmostEqual(a, b) | round(a-b, 7) == 0 | |
| assertNotAlmostEqual(a, b) | round(a-b, 7) != 0 | |
| assertGreater(a, b) | a > b | 2.7 |
| assertGreaterEqual(a, b) | a >= b | 2.7 |
| assertLess(a, b) | a < b | 2.7 |
| assertLessEqual(a, b) | a <= b | 2.7 |
| assertRegexpMatches(s, r) | r.search(s) | 2.7 |
| assertNotRegexpMatches(s, r) | not r.search(s) | 2.7 |
| assertItemsEqual(a, b) | sorted(a) == sorted(b) and works with unhashable objs | 2.7 |
| assertDictContainsSubset(a, b) | all the key/value pairs in a exist in b | 2.7 |
| assertMultiLineEqual(a, b) | strings | 2.7 |
| assertSequenceEqual(a, b) | sequences | 2.7 |
| assertListEqual(a, b) | lists | 2.7 |
| assertTupleEqual(a, b) | tuples | 2.7 |
| assertSetEqual(a, b) | sets or frozensets | 2.7 |
| assertDictEqual(a, b) | dicts | 2.7 |
+--------------------------------+-------------------------------------------------------+-------+
Testtools
testtools is a set of extensions to the Python standard library’s unit testing framework.
testtools 是一个功能类似 unittest 的库，它集合众家标准测试库之所长，和 unittest 相比，功能更为强大，使用更为简单，OpenStack 广泛的利用它编写单元测试。由于在用法上 testtools 和 unittest 类似，所以本节简要介绍 testtols 的特点：
- Better assertion methods: 支持 assertIn, assertIs, assertIsInstance 等 assertion
- More debugging info: 更为详细的 debug 信息
- Extend unittest, but stay compatible and re-usable: 兼容 unittest
- Cross-Python compatibility: 支持多种 Python 版本 2.7, 3.3, 3.4, 3.5
更为详细的说明和用法请见 testtools: tasteful testing for Python。