Pytest 测试框架入门

本文作者:刘春明
原文链接:http://blog.csdn.net/liuchunming033/

1、 Pytest 介绍

pytest 是 python 的一种单元测试框架,与 python 自带的 unittest 测试框架类似,但是比 unittest 框架使用起来更简洁,效率更高。根据 pytest 的官方网站介绍,它具有如下特点:

  • 非常容易上手,入门简单,文档丰富,文档中有很多实例可以参考

  • 能够支持简单的单元测试和复杂的功能测试

  • 支持参数化

  • 执行测试过程中可以将某些测试跳过,或者对某些预期失败的 case 标记成失败

  • 支持重复执行失败的 case

  • 支持运行由 nose , unittest 编写的测试 case

  • 具有很多第三方插件,并且可以自定义扩展

  • 方便的和持续集成工具集成

由于网上 pytest 的中文文档比较少,自己学习过程中,基本上看的就是英文的官方文档,对于不想看英文的同学们,本系列文章希望能够帮大家一马。

2、安装 pytest

与安装其他的 python 软件无异,直接使用 pip 安装。

pip install - U pytest

安装完成后,可以验证安装的版本:

py.test - -version

3、一个实例

我们可以通过下面的实例,看看使用 py.test 进行测试是多么简单。

## content of test_sample.py

def func(x):    return x + 1
ef
test_func():
   assert func(3) == 5

这里我们定义了一个被测试函数 func ,该函数将传递进来的参数加1后返回。我们还定义了一个测试函数 test_func 用来对 func 进行测试。 test_func 中我们使用基本的断言语句 assert 来对结果进行验证。

下面来运行这个测试:

$ py.test
== == == == == == == == == == == == == = test session starts == == == == == == == == == == == == == ==
platform linux - - Python 3.4.1 - - py - 1.4.27 - - pytest - 2.7.1rootdir:
    /tmp / doc - exec - 101, inifile:
collected 1 items
test_sample.py F
== == == == == == == == == == == == == == == == = FAILURES == == == == == == == == == == == == == == == == =
_______________________________ test_answer ________________________________
def test_answer():
> assert func(3) == 5E
assert 4 == 5E + where 4 = func(3) test_sample.py:    5:        AssertionError == == == == == == == == == == == == = 1 failed in 0.01 seconds == == == == == == == == == == == == =

执行测试的时候,我们只需要在测试文件 test_sample 所在的目录下,运行 py.test 即可。 pytest 会在当前的目录下,寻找以 test 开头的文件(即测试文件),找到测试文件之后,进入到测试文件中寻找 test_ 开头的测试函数并执行。

通过上面的测试输出,我们可以看到该测试过程中,一个收集到了一个测试函数,测试结果是失败的(标记为 F ),并且在 FAILURES 部分输出了详细的错误信息,帮助我们分析测试原因,我们可以看到” assert
func(3) == 5”这条语句出错了,错误的原因是 func(3)=4,然后我们断言 func(3) 等于 5。

4、再一个实例

当需要编写多个测试样例的时候,我们可以将其放到一个测试类当中,如:

## content of test_class.py

class TestClass:    def test_one(self):        x = "this"        assert 'h' in x    

   def test_two(self):        x = "hello"        assert hasattr(x, 'check')

我们可以通过执行测试文件的方法,执行上面的测试:

$ py.test - q test_class.py
.F
== == == == == == == == == == == == == == == == = FAILURES == == == == == == == == == == == == == == == == =
____________________________ TestClass.test_two ____________________________
self = <test_class.TestClass object at 0x7fbf54cf5668 >
def test_two(self):x = "hello"> assert hasattr(x, 'check') E assert hasattr('hello', 'check') test_class.py:    8:        AssertionError1 failed, 1 passed in 0.01 seconds

从测试结果中可以看到,该测试共执行了两个测试样例,一个失败一个成功。同样,我们也看到失败样例的详细信息,和执行过程中的中间结果。

5、如何编写 pytest 测试样例

通过上面2个实例,我们发现编写 pytest 测试样例非常简单,只需要按照下面的规则:

  • 测试文件以 test_ 开头(以 _test 结尾也可以)

  • 测试类以 Test 开头,并且不能带有 __init__ 方法

  • 测试函数以 test_ 开头

  • 断言使用基本的 assert 即可

6、如何执行 pytest 测试样例

执行测试样例的方法很多种,上面第一个实例是直接执行 py.test ,第二个实例是传递了测试文件给 py.test 。其实 py.test 有好多种方法执行测试:

py.test               ## run all tests below current dir
py.test test_mod.py   # run tests in module
py.test somepath      # run all tests below somepath
py.test - k stringexpr  # only run tests with names that match the# the "string expression", e.g. "MyClass and not method"# will select TestMyClass.test_something# but not TestMyClass.test_method_simple
py.test test_mod.py:    :        test_func  # only run tests that match the "node ID",        # e.g "test_mod.py::test_func" will select        # only test_func in test_mod.py

7、测试报告

pytest 可以方便的生成测试报告,即可以生成 HTML 的测试报告,也可以生成 XML 格式的测试报告用来与持续集成工具集成。

生成 HTML 格式报告:

py.test - -resultlog = path

生成 XML 格式的报告:

py.test - -junitxml = path

8、如何获取帮助信息

py.test - -version  # shows where pytest was imported from
py.test - -fixtures  # show available builtin function arguments
py.test - h | --help  # show help on command line and config file options

9、最佳实践

其实对于测试而言,特别是在持续集成环境中,我们的所有测试最好是在虚拟环境中。这样不同的虚拟环境中的测试不会相互干扰的。

由于我们的实际工作中,在同一个 Jekins 中,运行了好多种不同项目册的测试,因此,各个测试项目运行在各自的虚拟环境中。

将 pytest 安装在虚拟环境中:

1、将当前目录创建为虚拟环境

virtualenv .        # create a virtualenv directory in the current directory

source bin/activate  # on unix

2、在虚拟环境中安装 pytest :

pip install pytest

点击阅读原文,查看更多 Python 教程和资源


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

推荐阅读更多精彩内容