Unittest 单元测试框架1 - 基本使用和命令行选项

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_somethingbar_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).

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,627评论 6 517
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 95,180评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 169,346评论 0 362
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,097评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,100评论 6 398
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,696评论 1 312
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,165评论 3 422
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,108评论 0 277
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,646评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,709评论 3 342
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,861评论 1 353
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,527评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,196评论 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,698评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,804评论 1 274
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,287评论 3 379
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,860评论 2 361

推荐阅读更多精彩内容