如何测试pytest夹具本身?

时间:2019-06-17 12:45:47

标签: python unit-testing pytest fixtures

测试pytest固定装置本身的正确方法是什么?请不要将其与在测试中使用夹具混淆。我只想自己测试灯具的正确性。

在测试中尝试调用并执行它们时,我将面临:

Fixture "app" called directly. Fixtures are not meant to be called directly

对此表示感谢。有关此主题的文档没有给我有意义的指导:https://docs.pytest.org/en/latest/deprecations.html#calling-fixtures-directly

测试治具本身的动机就在于我,因为当我们的测试由于治具中的错误而失败时,这在我们的TAP文件中无法正确跟踪,这促使我独自测试治具。

1 个答案:

答案 0 :(得分:2)

pytest有一个pytester插件,该插件是用于测试pytest本身和插件的;它在不影响当前测试运行的隔离运行中执行测试。示例:

# conftest.py

import pytest

pytest_plugins = ['pytester']

@pytest.fixture
def spam(request):
    yield request.param

夹具spam有一个问题,它仅适用于参数化测试;一旦在非参数化测试中要求它,它将引发AttributeError。这意味着我们无法通过这样的常规测试来对其进行测试:

def test_spam_no_params(spam):
    # too late to verify anything - spam already raised in test setup!
    # In fact, the body of this test won't be executed at all.
    pass

相反,我们使用testdir插件提供的pytester夹具在隔离的测试运行中执行测试:

import pathlib
import pytest


# an example on how to load the code from the actual test suite
@pytest.fixture
def read_conftest(request):
    return pathlib.Path(request.config.rootdir, 'conftest.py').read_text()


def test_spam_fixture(testdir, read_conftest):
    # you can create a test suite by providing file contents in different ways, e.g.
    testdir.makeconftest(read_conftest)
    testdir.makepyfile(
        """
        import pytest

        @pytest.mark.parametrize('spam', ('eggs', 'bacon'), indirect=True)
        def test_spam_parametrized(spam):
            assert spam in ['eggs', 'bacon']

        def test_spam_no_params(spam):
            assert True
""")
    result = testdir.runpytest()
    # we should have two passed tests and one failed (unarametrized one)
    result.assert_outcomes(passed=3, error=1)
    # if we have to, we can analyze the output made by pytest
    assert "AttributeError: 'SubRequest' object has no attribute 'param'" in ' '.join(result.outlines)

为测试加载测试代码的另一个方便方法是testdir.copy_example方法。在pytest.ini中设置根路径,例如:

[pytest]
pytester_example_dir = samples_for_fixture_tests
norecursedirs = samples_for_fixture_tests

现在使用以下内容创建文件samples_for_fixture_tests/test_spam_fixture/test_x.py

import pytest

@pytest.mark.parametrize('spam', ('eggs', 'bacon'), indirect=True)
def test_spam_parametrized(spam):
    assert spam in ['eggs', 'bacon']

def test_spam_no_params(spam):
    assert True

(与之前作为字符串传递给testdir.makepyfile的代码相同)。上面的测试更改为:

def test_spam_fixture(testdir, read_conftest):
    testdir.makeconftest(read_conftest)
    # pytest will now copy everything from samples_for_fixture_tests/test_spam_fixture
    testdir.copy_example()
    testdir.runpytest().assert_outcomes(passed=3, error=1)

这样,您不必在测试中将Python代码维护为字符串,还可以通过使用pytester运行现有的测试模块来重用它们。您还可以通过pytester_example_path标记配置测试数据根:

@pytest.mark.pytester_example_path('fizz')
def test_fizz(testdir):
    testdir.copy_example('buzz.txt')

将相对于项目根目录查找文件fizz/buzz.txt

有关更多示例,请务必查看pytest文档中的Testing plugins部分;同样,您可能会发现问题my other answerHow can I test if a pytest fixture raises an exception?很有帮助,因为它包含了该主题的另一个有效示例。我还发现直接研究Testdir code非常有帮助,因为遗憾的是pytest并没有提供广泛的文档,但是代码几乎可以自我记录。