如何实现 xunit 样式的设置

How to implement xunit-style set-up

中文英文

本节描述了一种经典且流行的方式，您可以在每个模块/类/函数的基础上实现 fixtures（设置和拆卸测试状态）。

Note

虽然这些设置/拆卸方法对于来自 unittest 或 nose 背景的人来说简单且熟悉，但您也可以考虑使用 pytest 更强大的 fixture 机制，该机制利用依赖注入的概念，允许以更模块化和可扩展的方式管理测试状态，尤其适用于较大项目和功能测试。您可以在同一个文件中混合使用这两种 fixture 机制，但 unittest.TestCase 子类的测试方法不能接收 fixture 参数。

模块级别设置/拆卸

Module level setup/teardown

中文英文

如果您在单个模块中有多个测试函数和测试类，您可以选择实现以下 fixture 方法，这些方法通常会为所有函数调用一次：

def setup_module(module):
    """设置与给定模块的执行相关的任何状态。"""


def teardown_module(module):
    """拆卸之前通过 setup_module 方法设置的任何状态。
    """

从 pytest-3.0 开始，module 参数是可选的。

类级别设置/拆卸

Class level setup/teardown

中文英文

类似地，以下方法在所有测试方法调用之前和之后在类级别被调用：

@classmethod
def setup_class(cls):
    """设置与给定类的执行相关的任何状态（通常包含测试）。
    """


@classmethod
def teardown_class(cls):
    """拆卸之前通过调用 setup_class 设置的任何状态。
    """

方法和函数级别设置/拆卸

Method and function level setup/teardown

中文英文

类似地，以下方法在每个方法调用周围被调用：

def setup_method(self, method):
    """设置与给定方法在类中的执行相关的任何状态。
    setup_method 对类的每个测试方法都会被调用。
    """


def teardown_method(self, method):
    """拆卸之前通过调用 setup_method 设置的任何状态。
    """

从 pytest-3.0 开始， method 参数是可选的。

如果你更希望在模块级别直接定义测试函数，你也可以使用以下函数来实现 fixtures：

def setup_function(function):
    """设置与给定函数执行相关的任何状态。
    对模块中的每个测试函数调用。
    """


def teardown_function(function):
    """拆卸之前通过调用 setup_function 设置的任何状态。
    """

从 pytest-3.0 开始，function 参数是可选的。

备注：

• 每个测试进程可以多次调用 setup/teardown 配对。

• 如果对应的 setup 函数存在并且失败/被跳过，则不会调用 teardown 函数。

• 在 pytest-4.2 之前，xunit 风格的函数不遵循 fixtures 的作用域规则，因此，例如，可以在会话作用域的 autouse fixture 之前调用 setup_method。

  现在，xunit 风格的函数已与 fixture 机制集成，并遵循调用中涉及的 fixtures 的正确作用域规则。