pytest 基础教程

由于 unittest 重复代码太多(如setUp tearDown)、数据驱动支持不好、case 一多就容易乱、有一定学习成本(如 assertIn* 语法是 unittest 特有的)等缺点，我们可以使用 pytest 这个更成熟的测试框架。

相比 unittest，pytest 支持更多、更全面的功能，有着以下特色和优势。

• 直接使用纯粹的 python 语言， 不需要你过多学习框架特定的语法，例如 self.assert* 等，以此减少你的学习成本；

• pytest 框架不需要写诸如 setUp()、tearDown() 这样的方法，它可以直接开始测试；

• pytest 可以自动识别测试用例，无须像 unittest 一样将测试用例放进 TestSuite 里组装；

• test fixtures 包括数据参数化测试非常好用；

• pytest 支持错误重试；

• pytest 支持并发测试；

• pytest 完全兼容 unittest。

文档：https://docs.pytest.org/en/latest/contents.html#toc

第三方库：https://pypi.org/search/?q=pytest

pytest 简单使用

import pytest

def func(x):
	return x + 1

class TestSample(object):
	# 测试用例默认以test开头
	def test_equal(self):
		assert func(0) == 1
	def test_not_equal(self):
		assert func(0) != 0

pytest 运行方式

• 命令行运行

pytest 支持在命令行中以如下方式运行：

python -m pytest [...]

• pytest.main() 运行

pytest 支持在程序中运行，在程序中运行的命令如下：

pytest.main([...])

参数化使用

@pytest.mark.parametrize(argnames, argvalues)

• argnames:要参数化的变量, 可填 string, list, tuple

• argvalues:参数化的值, 可填 list, list[tuple]

@pytest.mark.parametrize("a, b", [(10, 20), (10, 30), (10, 40)])
def test_param(a, b):
	print(a + b)

• 与 yaml 结合使用

创建一个 data.yaml 文件，内容如下：

-
 - 10
 - 20
-
 - 10
 - 30
-
 - 10
 - 40

测试用例使用 yaml 文件进行参数化:

import pytest
import yaml

class TestData:
	@pytest.mark.parametrize("a, b", yaml.safe_load(open("./data.yaml")))
	def test_data(self, a, b):
		print(a + b)

常用插件

• pip install pytest-ordering 控制用例执行顺序
• pip install pytest-dependency 控制用例依赖关系
• pip install pytest-xdist 分布式并发执行测试用例
• pip install pytest-rerunfailures 失败重跑
• pip install pytest-assume 多重校验
• pip install pytest-random-order 用例随机执行
• pip install pytest-html 测试报告

简单设计一个加法器的测试用例

# calculator.py文件
def is_match_condition(a):
    '''
    判断输入参数是否满足条件
    :param a: 输入参数
    :return: 满足条件返回 "符合条件"，否则返回对应场景提示信息
    '''
    # 判断 a 的类型
    if not (isinstance(a, int) or isinstance(a, float)):
        return "参数为非数字"
    # 判断 a 的范围
    if a > 99 or a < -99:
        return "参数大小超出范围"
    return "符合条件"

def add(a, b):
    '''
    相加方法
    :param a: 加数
    :param b: 被加数
    :return: a + b 的结果，或者提示信息
    '''
    # 判断 a 参数类型与范围符合条件
    if is_match_condition(a) == "符合条件":
        # 判断 b 参数类型与范围符合条件
        if is_match_condition(b) == "符合条件":
            return a + b
        # b 不符合条件，返回提示信息
        else:
            return f"b{is_match_condition(b)}"
    # a 不符合条件，返回提示信息
    else:
        return f"a{is_match_condition(a)}"

# test_calculator.py文件
import pytest
from calculator import add

@pytest.fixture(autouse=True)
def start_end_add():
    print("=====开始计算=====")
    yield
    print("=====结束计算=====")

@pytest.fixture(scope='package', autouse=True)
def end_test():
    yield
    print("=========结束测试=========")

@pytest.mark.parametrize(
    "a, b, expected",
    [
        (50, 30, 80),                # 正常情况
        (-100, 50, "a参数大小超出范围"),  # a 超出范围
        (50, 100, "b参数大小超出范围"),   # b 超出范围
        (23.55, 55.13, 78.68),          # 浮点数情况
        ("50", 30, "a参数为非数字"),     # a 不是数字
        (50, "thirty", "b参数为非数字"), # b 不是数字
        (0, 0, 0),                   # 边界情况，零值相加
        (-99, 99, 0),                # 边界情况，负数与正数相加
    ]
)

def test_add(a, b, expected):
    result = add(a, b)
    assert result == expected