关于 fixture

pytest fixture 被设计为显式、模块化和可扩展的。

什么是 fixture

在测试中,fixture 为测试提供已定义、可靠且一致的上下文。这可以包括环境(例如,配置了已知参数的数据库)或内容(例如数据集)。

Fixture 定义了构成测试 arrange 阶段的步骤和数据(参见 测试的剖析)。在 pytest 中,它们是你定义的用于此目的的函数。它们也可以用于定义测试的 act 阶段;这是一种设计更复杂测试的强大技术。

由 fixture 设置的服务、状态或其他操作环境通过参数被测试函数访问。对于测试函数使用的每个 fixture,在测试函数的定义中通常都有一个参数(以 fixture 命名)。

我们可以通过使用 @pytest.fixture 装饰器来告诉 pytest 特定函数是 fixture。这是一个 pytest 中 fixture 可能是什么样子的简单示例

import pytest


class Fruit:
    def __init__(self, name):
        self.name = name

    def __eq__(self, other):
        return self.name == other.name


@pytest.fixture
def my_fruit():
    return Fruit("apple")


@pytest.fixture
def fruit_basket(my_fruit):
    return [Fruit("banana"), my_fruit]


def test_my_fruit_in_basket(my_fruit, fruit_basket):
    assert my_fruit in fruit_basket

测试也不必仅限于单个 fixture。它们可以依赖于任意数量的 fixture,并且 fixture 也可以使用其他 fixture。这就是 pytest 的 fixture 系统真正闪光的地方。

相对于 xUnit 风格的 setup/teardown 函数的改进

pytest fixture 相对于经典的 xUnit 风格的 setup/teardown 函数提供了显著的改进

  • fixture 具有显式名称,并通过从测试函数、模块、类或整个项目中声明其使用来激活。

  • fixture 以模块化方式实现,因为每个 fixture 名称都会触发一个 fixture 函数,该函数本身可以使用其他 fixture。

  • fixture 管理从简单的单元测试扩展到复杂的功能测试,允许根据配置和组件选项参数化 fixture 和测试,或者在函数、类、模块或整个测试会话范围内重用 fixture。

  • 可以轻松且安全地管理 teardown 逻辑,无论使用了多少 fixture,而无需手动仔细处理错误或微观管理添加清理步骤的顺序。

此外,pytest 继续支持 如何实现 xunit 风格的设置。你可以混合使用这两种风格,根据你的喜好从经典风格增量式地过渡到新风格。你也可以从现有的 unittest.TestCase 风格 开始。

Fixture 错误

pytest 尽力将给定测试的所有 fixture 按线性顺序排列,以便它可以查看哪个 fixture 首先发生,其次发生,第三个发生,等等。但是,如果较早的 fixture 出现问题并引发异常,pytest 将停止为该测试执行 fixture,并将测试标记为有错误。

当测试被标记为有错误时,但这并不意味着测试失败了。这只是意味着测试甚至无法尝试,因为它所依赖的某件事出现了问题。

这就是为什么尽可能减少给定测试的不必要依赖关系是个好主意的原因之一。这样,不相关的问题就不会导致我们对可能存在或可能不存在的问题的了解不完整。

这是一个快速示例,以帮助解释

import pytest


@pytest.fixture
def order():
    return []


@pytest.fixture
def append_first(order):
    order.append(1)


@pytest.fixture
def append_second(order, append_first):
    order.extend([2])


@pytest.fixture(autouse=True)
def append_third(order, append_second):
    order += [3]


def test_order(order):
    assert order == [1, 2, 3]

如果由于任何原因,order.append(1) 有一个 bug 并引发了异常,我们将无法知道 order.extend([2])order += [3] 是否也会有问题。在 append_first 抛出异常后,pytest 将不会为 test_order 运行更多 fixture,甚至不会尝试运行 test_order 本身。唯一会运行的将是 orderappend_first

共享测试数据

如果你想使文件中的测试数据可用于你的测试,一个好的方法是在 fixture 中加载这些数据以供你的测试使用。这利用了 pytest 的自动缓存机制。

另一个好方法是在 tests 文件夹中添加数据文件。还有社区插件可用于帮助管理测试的这方面,例如 pytest-datadirpytest-datafiles

关于 fixture 清理的注意事项

pytest 不会对 SIGTERMSIGQUIT 信号进行任何特殊处理(SIGINT 由 Python 运行时通过 KeyboardInterrupt 自然处理),因此,管理外部资源的 fixture 在 Python 进程被(这些信号)终止时需要被清除,否则可能会泄漏资源。

pytest 不处理这些信号来执行 fixture 清理的原因是信号处理程序是全局的,更改它们可能会干扰正在执行的代码。

如果你的套件中的 fixture 在这些情况下需要特别注意终止,请参阅问题跟踪器中 此评论 中可能的解决方法。