unittest --- 单元测试框架
源代码:https://github.com/python/cpython/tree/3.9/Lib/unittest/_init_.py
unittest 单元测试框架是受到Junit的启发,与其他语言中的主流单元测试框架有着相似的风格。其支持测试自动化,配置共享和关机代码测试。支持将测试样例聚合到测试集中,并将测试与报告框架独立。
为了实现这些,unittest通过面向对象的方式支持了一些重要的概念。
test fixture
test fixture表示为了开展一项或多项测试所需要进行的准备工作,以及所有相关的清理操作。举个例子,这可能包含创建临时或代理的数据库,目录,再或者启动一个服务器进程。test case
一个test case是一个独立的测试单元。它检查输入特定的数据时的响应。 unittest提供一个基类:TestCase ,用于新建测试用例。test suite
test suite是一系列的测试用例,或测试套件,或两者皆有。它用于归档需要一起执行的测试。test runner
test runner 是一个用于执行和输出测试结果的组件。这个云运行可能使用图形接口,文本接口,或返回一个特定的值表示运行测试的结果。
基本实例
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.assertRqual(s.split(), ['Hello', 'world'])
# check that s.split fails when the separator is not a string
with self.ssertRaises(TypeError):
s.split(2)
if __name__ == '__main__':
unittest.main()
集成unittest.TestCase 就创建了一个测试用例。上述三个独立的测试时三个类方法,这些方法的命名都以test
开头。 这个命名约定告诉test runner类的哪些方法表示测试。
每个测试的用例是:调用assertEqual()
来检查预期的输出; 调用assertTrue()
或assertFalse()
来验证一个条件;调用assertRaises()
来验证跑出了一个特定的异常。使用这些方法而不是assert
语句是为了让test runner 能聚合所有的测试结果并产生结果报告。
通过setUp()
和tearDown()
方法,可以设置测试开始前与完成后需要执行的指令。
最后的代码中演示了运行测试的一个简单的方法。unittest.main()
提供了一个测试脚本的命令行接口。当在命令行运行该测试脚本,上文的脚本生成如以下格式的输出:
# python script.py
...
----------------------------------------------------------------------
Ran 3 tests in 0.000s
OK
在调用测试脚本时添加-v
参数使unittest.main()
显示更为详细的信息,生成如以下形式的输入:
# python script.py -v
# python -m unittest -v script.py
test_isupper (__main__.TestStringMethods) ... ok
test_split (__main__.TestStringMethods) ... ok
test_upper (__main__.TestStringMethods) ... ok
----------------------------------------------------------------------
Ran 3 tests in 0.001s
OK
命令行界面
unitetst模块可以通过命令行运行模块,类和独立测试方法的测试:
python -m unitest test_module1 test_module2
python -m unitest test_module.TestClass
python -m unitest testmodule.TestClass.test_method
你可以传入模块名,类或方法名或他们的任意组合。
同样的,测试模块可以通过文件路径指定:
python -m unittest tests/test_something.py
这样就可以使用shell的文件名补全指定测试模块。所指定的文件仍需要可以被作为模块导入。路径通过去除'.py'、把分隔符转换为'.'转换为模块名。若你需要执行不能被作为模块导入的测试文件,你需要直接执行该测试文件。
在运行测试时,你可以通过添加-v
参数获取更详细(更多的冗余)的信息。
python -m unitest -v test module
当运行时不包含参数,开始测试发现
:
python -m unittest # 等价于 python -m unittest discover
用于获取命令行选项列表:
python -m unittest -h
在3.2版本中更改:在早期版本中,只支持运行独立的测试方法,而不支持模块和类。
命令行选项
uniitest支持以下命令行选项:
-b, --buffer
在测试运行时,标准输出流与标准错误流会被放入缓冲区。成功的测试的运行时输出会被丢弃;测试不通过时,测试运行中的输出会正常显示,错误会被加入到测试失败信息。-c, --catch
当测试正在运行时, Control-C(即Ctrl+C)会等待当前测试完成,并在完成后报告已执行的测试的结果。当再次按下Control-C时,引发平常的KeyboardInterrupt
异常。-f, --failfast
当出现第一个错误或者失败时,停止运行测试。-k
只运行匹配模式或子串的测试方法和类。可以多次使用这个选项,以便包含匹配子串的所有测试用例。
包含通配符(*)的模式使用fnmatch.fnmatchcase()
对测试名称进行匹配。另外,该匹配是大小写敏感的。
模式对testloader
导入的测试方法全名进行匹配。
例如,-k foo
可以匹配到foo_tests.SomeTest.test_something
和bar_tests.SomeTest.test_foo
,但是不能匹配到bar_tests.FooTest.test_something
。--locals
在回溯中显示局部变量。
3.2新版本功能:添加命令行选项 -b
,-c
和-f
。
3.5新版本功能:添加命令行选项 --locals
。
3.7新版本功能:添加命令行选项 -k
。
测试
3.2新版本功能
unittest 支持简单的测试发现。为了与测试发现兼容,所有测试文件必须是可从项目鼎城目录导入的模块
或者包
(包括名称空间包
)(这意味着他们的文件名必须是有效的标识符)。
Test discovery已经在TestLoader.discover()
中实现, 但也可以从命令行中使用。基本的命令行用法是:
cd project_directory
python -m unittest discover
笔记:方便起见,python -m unittest 等效于 python -m unittest discover . 如果你需要向test discover 传入参数,必须显式地使用discover 子命令 |
---|
discover 有一下选项:
-v, --verbose
更详细地输出结果。-s, --start-directory directory
开始进行搜索的目录(默认值为当前目录.
)-p, --pattern pattern
用于匹配测试文件的模式(默认为test*.py
)-t, --top-level-directory directory
指定项目的最上层目录(通常为开始时坐在目录)
-s
,-p
和-t
选项可以按顺序作为位置参数传入。以下两条命令是等价的
python -m unittest discover -s project_directory -p "*_test.py"
python -m unittest discover project_directory "*_test.py"
正如可以传入路径那样,传入一个包名作为起始目录也是可行的,如myproject.subprockage.test
。你提供的包名会被导入,它在文件系统中的位置会被作为起始目录。
警告: 测试发现通过导入测试对测试进行加载。在找到所有你指定的开始目录下的所有测试文件后,它把路径转换为包名并进行导入。如foo/bar/baz.py
会被导入为foo.bar.baz
。
如果你有一个全局安装的包,并尝试对这个包的副本进行测试发现。可能会从错误的地方开始导入。如果出现这种情况,测试会输出警告并退出。
如果你使用包名而不是路径作为开始目录,搜索时假定它导入的是你想要的目录,所以你不会收到警告。
在3.4版本更改:Test discovery support namespace packages
for start directory. Note that you need to the top level directory too.(e.g. python -m unittest discover -s root/namespace -t root
).