通过代码实例解析 Pytest 运行流程

Pytest 简介

Pytest 是一个 Python 测试框架，可以帮助我们轻松地编写高质量的、可维护的测试代码。Pytest 提供了大量的功能和插件，支持多种类型的测试，包括单元测试、功能测试、端到端测试等。

Pytest 运行流程

Pytest 运行流程主要分为以下几个步骤：

1. 收集测试文件和测试函数
2. 解析测试函数的参数和装饰器
3. 创建测试运行时环境
4. 执行测试函数并收集测试结果
5. 输出测试结果

下面我们将通过实际的代码示例来说明每个步骤的具体内容。

示例一：单元测试

下面是一个简单的单元测试示例，它测试了一个加法函数：

# test_math.py
def add(x, y):
    return x + y

def test_add():
    assert add(1, 2) == 3
    assert add(0, 0) == 0
    assert add(-1, 1) == 0

步骤一：收集测试文件和测试函数

Pytest 首先会扫描整个项目中的所有测试文件，找到所有符合命名规范的测试函数。在这个例子中，Pytest 会找到 test_math.py 文件，并检测到其中的 test_add() 函数。

步骤二：解析测试函数的参数和装饰器

在收集到测试函数之后，Pytest 会解析函数的参数和装饰器。在这个例子中，test_add() 函数没有参数，也没有任何装饰器。

步骤三：创建测试运行时环境

Pytest 接下来会为测试函数创建一个测试运行时环境。这个环境包括了一些初始化操作，例如导入需要的模块和设置测试超时时间等。

步骤四：执行测试函数并收集测试结果

Pytest 会执行每个测试函数，并记录测试结果。在这个例子中，test_add() 函数包含了三个 assert 语句，每个语句都测试了一个不同的输入。如果其中任何一个 assert 语句失败，Pytest 会记录测试失败的原因。

步骤五：输出测试结果

最后，Pytest 会输出测试结果。如果所有测试都通过了，Pytest 会输出一条 === PASSED X test(s) === 的信息，其中 X 是测试用例数。如果有测试失败，Pytest 会输出一个详细的失败信息，以便我们找到问题并修复。

示例二：参数化测试

参数化测试是一种常见的测试方法，可以使用相同的测试函数测试多个输入。Pytest 提供了 @pytest.mark.parametrize 装饰器来实现参数化测试。下面是一个简单的参数化测试示例：

# test_math.py
def add(x, y):
    return x + y

import pytest

@pytest.mark.parametrize('x,y,result', [
    (1, 2, 3),
    (0, 0, 0),
    (-1, 1, 0),
])
def test_add(x, y, result):
    assert add(x, y) == result

步骤一：收集测试文件和测试函数

Pytest 会找到 test_math.py 文件，并检测到其中的 test_add() 函数。

步骤二：解析测试函数的参数和装饰器

Pytest 会解析函数的参数和装饰器。在这个例子中，test_add() 函数使用了 @pytest.mark.parametrize 装饰器，并将参数 x、y、result 作为输入值传递到测试函数中。其中，x、y、result 分别对应三个元组 (1, 2, 3)、(0, 0, 0)、(-1, 1, 0) 中的三个值。

步骤三：创建测试运行时环境

Pytest 会为测试函数创建一个测试运行时环境。

步骤四：执行测试函数并收集测试结果

Pytest 会执行每个测试函数和参数组合，并记录测试结果。在这个例子中，test_add() 函数被执行了三次，分别使用了不同的输入参数。如果任何一个测试失败，Pytest 会记录失败的原因。

步骤五：输出测试结果

最后，Pytest 会输出测试结果。在这个例子中，Pytest 会输出一条 === PASSED X test(s) === 的信息，其中 X 是测试用例数。如果有测试失败，Pytest 会输出一个详细的失败信息，以便我们找到问题并修复。

总结

以上是 Pytest 的运行流程及两个示例。通过这两个示例，我们可以看到 Pytest 最基本的测试流程和用法，包括单元测试和参数化测试。在实际使用 Pytest 进行测试时，我们还可以通过使用更多的插件和高级功能来扩展其功能和使用。