分享

Python 单元测试框架:Pytest

 zZ华 2022-03-27

图片

大家好,我是J哥~

1、Pytest简介

1.1 入门阶段

1.1.1 运行测试用例

一切的理论,都是为了实战准备的, 所以,我们第一步,先上例子,直接实战!

编写简单的测试用例,文件名称为'test_sample.py'

# pytest test_sample.py
def inc(x):
    return x + 1

def test_answer():
    assert inc(3) == 5

这两个方法都非常的简单,

  • test_answer()对目标函数inc进行断言;- pytest test_sample.py 运行测试用例 我们看向运行结果图片

测试结果显示,运行了一个测试用例,结果是红色,表示失败。错误信息显示,在代码的第7行抛出AssertionError。可以更改一下代码,让测试用例绿色通过。

这个测试用例涉及pytest的3个简单的规则:

  • 测试模块以 test_ 前缀命名- 测试用例(函数)同样以 test_ 前缀命名- 结果判断使用 assert 断言即可

1.1.2. 异常处理

捕获异常,及异常处理,是每段代码中必要条件, 当然,pytest也支持异常的捕获, 方法为:使用 with + pytest.raises 捕获目标函数的异常:

# -*- coding:utf-8 -*-
# @Time   : 2021-09-05
# @Author : Carl_DJ

import pytest

def f():
    raise SystemExit(1)

def test_mytest():
 #捕获异常
    with pytest.raises(SystemExit):
        f()

1.1.3 测试类

当然,pytest也支持测试类, 测试类的作用:用来做测试用来分组

# -*- coding:utf-8 -*-
# @Time   : 2021-09-05
# @Author : Carl_DJ

class TestClass:
 #test_开头
    def test_one(self):
        x = 'this'
        assert 'h' in x
 #test_开头
    def test_two(self):
        x = 'hello'
        assert hasattr(x, 'check')

这里,都是以test_开头, 跟unittest都是一样。

如果不是test_开头,则无法被调用的

1.1.4 自动运行测试脚本

如果一个suit文件夹有多个测试用例脚本, 我们只需要输入一个 pytest,即可运行全部测试脚本。

如下图

图片

这就是开启了懒人模式

1.2 进阶技巧

1.2.1 parametrize

俗话说,代码不参数,变参泪两行! 所以,能参数的时候,就尽量参数,不管重构苦不苦。我们先看下parametrize的用法,如下:

在测试用例的前面加上:@pytest.mark.parametrize(“参数名”,列表数据) 参数名:用来接收每一项数据,并作为测试用例的参数。列表数据:一组测试数据。

看例子 不添加parametrize,看看咋写测试用例

def test_eval():
    assert eval('3+5') == 8
    assert eval(''2'+'4'') == '24'
    assert eval('6*9') == 54

看着很麻烦, 我们再用一下parametrize优化一下,看看是否简洁很多

#使用parametrize对测试用例参数化
@pytest.mark.parametrize('test_input,expected', [
    ('3+5', 8),
    (''2'+'4'''24'),
    ('6*9', 54)
])
def test_eval_1(test_input, expected):
    assert eval(test_input) == expected

看了这段代码,就很简洁了。我们来看看,parametrize做了什么。

  • 先调整测试函数的参数为输入和期望;- 然后在parametrize填写参数值;- 运行时候会自动进行函数参数赋值。这样再增加测试条件,不需要改动test_eval_1的函数体, 增加条件数组就可以了。

1.2.2. mark

mark就是一个标签,标记些测试用例执行,哪些不执行。

#标签
@pytest.mark.slow
def test_mark():
    print('test mark')
    # 模拟运行很耗时的测试用例
    time.sleep(10)
    assert 5 == 5

然后目录下增加 pytest.ini 文件,对pytest进行配置:

[pytest]
markers =
    slow: marks tests as slow (deselect with '-m 'not slow'')

使用下面命令可以跳过标记的函数,加快测试速度:

pytest test_sample.py -m 'not slow'

也可以仅仅运行标记的函数

pytest  -m slow

1.2.3 fixture

fixture 就类似于unittest的 setup/teardown,但是功能比这个强大一些。举个例子

# -*- coding:utf-8 -*-
# @Time   : 2021-09-05
# @Author : Carl_DJ

import pytest

#设置fixture
@pytest.fixture
def first_entry():
    return 'a'


#设置fixture
@pytest.fixture
def second_entry():
    return 2


#设置fixture
@pytest.fixture
def order(first_entry, second_entry):
    return [first_entry, second_entry]


#设置fixture
@pytest.fixture
def expected_list():
    return ['a', 2, 3.0]


def test_string(order, expected_list):
    order.append(3.0)

    # 断言
    assert order == expected_list

当然了,fixture还可以嵌套,order嵌套了first_entry和second_entry。

那测试数据库写入的用例,需要一个数据库链接,怎么办呢?这个,也不难,fixture也可以搞定。在测试用例目录编写conftest.py

@pytest.fixture
def database_connection():
    # coding...
    ...

1.2.4 plugin&&hook

可以编写pytest的插件plugin和hook对pytest进行扩展。先创建一个目录a,然后再目录a中创建conftest.py和test_sub.py 两个文件。

#在目录a下创建conftest.py
def pytest_runtest_setup(item):
        # 在目录a下运行每个用例
        print('setting up', item)
        
# 在目录a下创建test_sub.py
def test_sub():
    pass

使用 pytest a/test_sub.py --capture=no 会加载我们编写的pluging和hook,在console中可以看到下面字样:

...
a/test_sub.py setting up <Function test_sub>

敲黑板使用pytest_runtest_setup可以实现测试框架中的setup类似功能。

2、总结

以上就是总结的一些pytest常用的功能,是不是也很简单呢。

我们回顾一下,今天都讲了些知识!

测试目录一般使用 tests 命名和src同层级- 测试模块使用 test_ 前缀- 测试类使用 Test 前缀,不需要继承其它父类- 测试用例也使用 test_ 前缀- 可以使用parametrize进行参数化处理- 可以使用mark给测试用例加标签- 可以使用fixture模拟测试条件- 使用pytest.ini文件对pytest进行配置- 可以编写插件和hoo对pytest扩展 关于pytest更多的内容, 可以持续关注, 也可以阅读官方文档。

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多