Pytest-ordering：自定义 Pytest 测试用例执行顺序的指南

更多软件测试学习资料戳

在使用 Pytest 进行单元测试或集成测试时，通常测试用例的执行顺序是自动排序的。不过在某些情况下，特别是当测试用例存在依赖关系时，我们可能希望自定义测试的执行顺序。为了解决这一需求，Pytest 提供了一个实用插件——pytest-ordering。本文将介绍如何使用该插件来控制测试用例的执行顺序。

一、什么是 pytest-ordering？

pytest-ordering 是 Pytest 的一个插件，允许我们自定义测试用例的执行顺序。通过为测试用例指定顺序标记，可以在确保测试独立性的同时，满足特定的执行需求。

二、安装 pytest-ordering

在终端中使用 pip 命令安装 pytest-ordering 插件：

pip install pytest-ordering

三、pytest-ordering 的使用方法

在安装插件后，可以使用 @pytest.mark.run 标记来为测试用例设置执行顺序。常用的执行顺序标记有以下几种：

1. @pytest.mark.run(order=N)：使用具体的整数值 N 定义执行顺序，数字越小，优先级越高。

2. @pytest.mark.run(before='test_name')：表示当前测试用例应在指定测试 test_name 之前运行。

3. @pytest.mark.run(after='test_name')：表示当前测试用例应在指定测试 test_name 之后运行。

四、示例：使用 pytest-ordering 设置执行顺序

示例 1：基于 order 的执行顺序

假设我们有如下的测试用例文件 test_sample.py，希望自定义执行顺序：

import pytest
@pytest.mark.run(order=2)def test_case_1():    assert True
@pytest.mark.run(order=1)def test_case_2():    assert True
@pytest.mark.run(order=3)def test_case_3():    assert True

执行顺序将按照 order 的值来确定，因此运行顺序为：test_case_2 -> test_case_1 -> test_case_3。

示例 2：基于 before/after 的执行顺序

在实际应用中，有时更适合使用 before 和 after 来控制测试顺序。例如，确保某个初始化测试在其他测试之前运行：

import pytest
@pytest.mark.run(before="test_case_2")def test_initial_setup():    assert True
def test_case_1():    assert True
@pytest.mark.run(after="test_case_1")def test_case_2():    assert True

在此示例中，执行顺序为 test_initial_setup -> test_case_1 -> test_case_2。

五、pytest-ordering 的最佳实践

1. 优先保持测试独立性：即使可以使用顺序控制，测试用例仍应尽量保持独立。避免过多依赖执行顺序，以便提高代码的可维护性和测试的稳定性。

2. 为关键性测试用例设置顺序：对于一些需要特定初始化或清理操作的测试，可以使用 before 或 after 确保它们在其他测试用例之前或之后执行。

3. 谨慎使用 order 值：在大型测试文件中，过多的 order 值会让代码难以管理。可以使用 10、20、30 等顺序递增的方法来保持代码清晰性，以便以后插入新的测试用例。

六、测试执行与验证

在配置好执行顺序后，可以直接运行测试文件来验证效果：

pytest test_sample.py -v

通过 -v 参数可以查看每个测试用例的执行顺序，确保符合预期。

总结

pytest-ordering 插件让我们能够灵活控制测试用例的执行顺序，适合在某些测试间具有轻微依赖的情况下使用。不过，在设计测试时，仍应遵循测试用例独立原则，尽量减少对执行顺序的依赖。