如何参数化Fixture方法及测试用例
pytest 在多个级别启用了测试参数化:
- :py
pytest.fixture
允许对parametrize fixture functions <fixture-parametrize>
进行参数化。 - @pytest.mark.parametrize 允许您在测试函数或类中定义多组参数和fixtures。
- pytest_generate_tests 允许自定义的参数化方案或扩展。
@pytest.mark.parametrize
: 参数化测试函数
一些改进。
内置的 pytest.mark.parametrize ref
装饰器允许对测试函数的参数进行参数化。以下是一个典型的示例,演示了一个测试函数,用于验证某个特定输入是否产生了预期的输出:
# content of test_expectation.py
import pytest
@pytest.mark.parametrize("test_input,expected", [("3+5", 8), ("2+4", 6), ("6*9", 42)])
def test_eval(test_input, expected):
assert eval(test_input) == expected
在这里,@parametrize
装饰器定义了三个不同的 (test_input, expected)
元组,以便 test_eval
函数将依次使用它们运行三次:
$ pytest
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-7.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 3 items
test_expectation.py ..F [100%]
================================= FAILURES =================================
____________________________ test_eval[6*9-42] _____________________________
test_input = '6*9', expected = 42
@pytest.mark.parametrize("test_input,expected", [("3+5", 8), ("2+4", 6), ("6*9", 42)])
def test_eval(test_input, expected):
> assert eval(test_input) == expected
E AssertionError: assert 54 == 42
E + where 54 = eval('6*9')
test_expectation.py:6: AssertionError
========================= short test summary info ==========================
FAILED test_expectation.py::test_eval[6*9-42] - AssertionError: assert 54...
======================= 1 failed, 2 passed in 0.12s ========================
参数值会原样传递给测试(不进行任何复制操作)。
例如,如果将列表或字典作为参数值传递,并且测试用例代码对其进行更改,那么这些更改将在后续的测试用例调用中得到反映。
默认情况下,pytest 会对参数化中的 Unicode 字符串中的非 ASCII 字符进行转义,因为这样做有一些缺点。然而,如果您希望在参数化中使用 Unicode 字符串,并在终端中按原样(不转义)显示它们,请在您的
pytest.ini
文件中使用以下选项:
[pytest]
disable_test_id_escaping_and_forfeit_all_rights_to_community_support = True
但请注意,根据所使用的操作系统和当前安装的插件,这可能会导致意外的副作用甚至错误,因此请谨慎使用。
如本示例所设计的,只有一个输入/输出值未能通过简单的测试函数。与测试函数参数一样,您可以在回溯信息中看到 input
和 output
值。
请注意,您还可以在类或模块上使用 parametrize 标记(请参阅 mark
),这将使用参数集调用多个函数,例如:
import pytest
@pytest.mark.parametrize("n,expected", [(1, 2), (3, 4)])
class TestClass:
def test_simple_case(self, n, expected):
assert n + 1 == expected
def test_weird_simple_case(self, n, expected):
assert (n * 1) + 1 == expected
要对模块中的所有测试进行参数化,您可以分配给 pytestmark
全局变量:
import pytest
pytestmark = pytest.mark.parametrize("n,expected", [(1, 2), (3, 4)])
class TestClass:
def test_simple_case(self, n, expected):
assert n + 1 == expected
def test_weird_simple_case(self, n, expected):
assert (n * 1) + 1 == expected
还可以在 parametrize 中标记单个测试实例,例如使用内置的 mark.xfail
:
# content of test_expectation.py
import pytest
@pytest.mark.parametrize(
"test_input,expected",
[("3+5", 8), ("2+4", 6), pytest.param("6*9", 42, marks=pytest.mark.xfail)],
)
def test_eval(test_input, expected):
assert eval(test_input) == expected
让我们运行一下这个:
$ pytest
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-7.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 3 items
test_expectation.py ..x [100%]
======================= 2 passed, 1 xfailed in 0.12s =======================
之前导致失败的一个参数集现在显示为 "xfailed"(预期失败)测试。
如果传递给 parametrize
的值导致一个空列表 - 例如,如果它们由某个函数动态生成 - pytest 的行为取决于 empty_parameter_set_mark
选项。
要获取多个参数化参数的所有组合,您可以叠加 parametrize
装饰器:
import pytest
@pytest.mark.parametrize("x", [0, 1])
@pytest.mark.parametrize("y", [2, 3])
def test_foo(x, y):
pass
这将按照装饰器的顺序运行测试,参数分别设置为 x=0/y=2
、x=1/y=2
、x=0/y=3
和 x=1/y=3
,以逐个排列参数。
基本的 pytest_generate_tests
示例
有时您可能想要实现自己的参数化方案或确定 fixture 的参数或范围的动态性。为此,您可以使用 pytest_generate_tests
hook,在收集测试函数时调用。通过传递的 metafunc
对象,您可以检查请求测试上下文,最重要的是,您可以调用 metafunc.parametrize()
来进行参数化。
例如,假设我们希望运行一个接受字符串输入的测试,我们希望通过一个新的 pytest
命令行选项来设置它。首先,我们编写一个简单的测试,接收 stringinput
fixture 函数参数:
# content of test_strings.py
def test_valid_string(stringinput):
assert stringinput.isalpha()
现在我们添加一个包含命令行选项添加和测试函数参数化的 conftest.py
文件:
# content of conftest.py
def pytest_addoption(parser):
parser.addoption(
"--stringinput",
action="append",
default=[],
help="list of stringinputs to pass to test functions",
)
def pytest_generate_tests(metafunc):
if "stringinput" in metafunc.fixturenames:
metafunc.parametrize("stringinput", metafunc.config.getoption("stringinput"))
如果我们现在传递两个 stringinput
值,我们的测试将运行两次:
$ pytest -q --stringinput="hello" --stringinput="world" test_strings.py
.. [100%]
2 passed in 0.12s
让我们还运行一个会导致测试失败的 stringinput
:
$ pytest -q --stringinput="!" test_strings.py
F [100%]
================================= FAILURES =================================
___________________________ test_valid_string[!] ___________________________
stringinput = '!'
def test_valid_string(stringinput):
> assert stringinput.isalpha()
E AssertionError: assert False
E + where False = <built-in method isalpha of str object at 0xdeadbeef0001>()
E + where <built-in method isalpha of str object at 0xdeadbeef0001> = '!'.isalpha
test_strings.py:4: AssertionError
========================= short test summary info ==========================
FAILED test_strings.py::test_valid_string[!] - AssertionError: assert False
1 failed in 0.12s
正如预期的那样,我们的测试函数失败了。
如果您没有指定 stringinput
,它将被跳过,因为 metafunc.parametrize()
将使用一个空参数列表调用它:
$ pytest -q -rs test_strings.py
s [100%]
========================= short test summary info ==========================
SKIPPED [1] test_strings.py: got empty parameter set ['stringinput'], function test_valid_string at /home/sweet/project/test_strings.py:2
1 skipped in 0.12s
请注意,当多次使用不同的参数集调用 metafunc.parametrize
时,所有这些集合中的参数名称不能重复,否则将引发错误。
更多示例
如果需要更多示例,您可以查看更多参数化示例。