pytest fixture-参数化fixture

​​fixture​​函数可以被参数化，在这种情况下，它们将被多次调用，每次执行一组依赖于该​​fixture​​的测试。测试函数通常不需要知道它们的重新运行。夹具参数化有助于为组件编写详尽的功能测试，这些组件本身可以以多种方式配置。

扩展前面的示例，我们可以标记​​fixture​​来创建两个​​smtp_connection fixture​​实例，这将导致使用该​​fixture​​的所有测试运行两次。​​fixture​​函数通过特殊的​​request​​对象访问每个参数:

# content of conftest.py
import pytest
import smtplib


@pytest.fixture(scope="module", params=["smtp.gmail.com", "mail.python.org"])
def smtp_connection(request):
    smtp_connection = smtplib.SMTP(request.param, 587, timeout=5)
    yield smtp_connection
    print("finalizing {}".format(smtp_connection))
    smtp_connection.close()

主要的变化是用​​@pytest​​声明​​params​​。​​Fixture​​，一个值列表，​​Fixture​​函数将执行其中的每个值，并可以通过​​request.param​​访问一个值。不需要更改测试函数代码。我们再运行一次

$ pytest -q test_module.py
FFFF                                                                 [100%]
================================= FAILURES =================================
________________________ test_ehlo[smtp.gmail.com] _________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0004>

    def test_ehlo(smtp_connection):
        response, msg = smtp_connection.ehlo()
        assert response == 250
        assert b"smtp.gmail.com" in msg
>       assert 0  # for demo purposes
E       assert 0

test_module.py:7: AssertionError
________________________ test_noop[smtp.gmail.com] _________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0004>

    def test_noop(smtp_connection):
        response, msg = smtp_connection.noop()
        assert response == 250
>       assert 0  # for demo purposes
E       assert 0

test_module.py:13: AssertionError
________________________ test_ehlo[mail.python.org] ________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0005>

    def test_ehlo(smtp_connection):
        response, msg = smtp_connection.ehlo()
        assert response == 250
>       assert b"smtp.gmail.com" in msg
E       AssertionError: assert b'smtp.gmail.com' in b'mail.python.org\nPIPELINING\nSIZE 51200000\nETRN\nSTARTTLS\nAUTH DIGEST-MD5 NTLM CRAM-MD5\nENHANCEDSTATUSCODES\n8BITMIME\nDSN\nSMTPUTF8\nCHUNKING'

test_module.py:6: AssertionError
-------------------------- Captured stdout setup ---------------------------
finalizing <smtplib.SMTP object at 0xdeadbeef0004>
________________________ test_noop[mail.python.org] ________________________

smtp_connection = <smtplib.SMTP object at 0xdeadbeef0005>

    def test_noop(smtp_connection):
        response, msg = smtp_connection.noop()
        assert response == 250
>       assert 0  # for demo purposes
E       assert 0

test_module.py:13: AssertionError
------------------------- Captured stdout teardown -------------------------
finalizing <smtplib.SMTP object at 0xdeadbeef0005>
========================= short test summary info ==========================
FAILED test_module.py::test_ehlo[smtp.gmail.com] - assert 0
FAILED test_module.py::test_noop[smtp.gmail.com] - assert 0
FAILED test_module.py::test_ehlo[mail.python.org] - AssertionError: asser...
FAILED test_module.py::test_noop[mail.python.org] - assert 0
4 failed in 0.12s

我们看到，我们的两个测试函数针对不同的​​smtp_connection​​实例运行了两次。还要注意，对于​​mail.python.org​​连接，第二个测试在​​test_ehlo​​中失败，因为预期的服务器字符串与到达的服务器字符串不同。

pytest将构建一个字符串，它是参数化​​fixture​​中每个​​fixture​​值的测试ID，例如上面示例中的​​test_ehlo[smtp.gmail.com]​​和​​test_ehlo[mail.python.org]​​。这些ids可以与​​-k​​一起使用，以选择要运行的特定案例，并且它们还将在某个案例失败时标识特定案例。使用​​——collect-only​​运行pytest将显示生成的id。

数字、字符串、布尔值和None将在测试ID中使用它们通常的字符串表示。对于其他对象，pytest将根据参数名生成一个字符串。通过使用​ids​关键字参数，可以定制测试ID中用于特定​​fixture​​值的字符串:

# content of test_ids.py
import pytest


@pytest.fixture(params=[0, 1], ids=["spam", "ham"])
def a(request):
    return request.param


def test_a(a):
    pass


def idfn(fixture_value):
    if fixture_value == 0:
        return "eggs"
    else:
        return None


@pytest.fixture(params=[0, 1], ids=idfn)
def b(request):
    return request.param


def test_b(b):
    pass

上面展示了如何将ids作为一个字符串列表来使用，或者作为一个函数来调用​​fixture​​值，然后返回一个字符串来使用。在后一种情况下，如果函数返回​None​，那么将使用pytest自动生成的ID。

运行上述测试会在以下正在使用的测试ids中产生结果:

$ pytest --collect-only
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-7.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 11 items

<Module test_anothersmtp.py>
  <Function test_showhelo[smtp.gmail.com]>
  <Function test_showhelo[mail.python.org]>
<Module test_emaillib.py>
  <Function test_email_received>
<Module test_ids.py>
  <Function test_a[spam]>
  <Function test_a[ham]>
  <Function test_b[eggs]>
  <Function test_b[1]>
<Module test_module.py>
  <Function test_ehlo[smtp.gmail.com]>
  <Function test_noop[smtp.gmail.com]>
  <Function test_ehlo[mail.python.org]>
  <Function test_noop[mail.python.org]>

======================= 11 tests collected in 0.12s ========================