我怎样才能使用 pytest 选项作为固定装置而不是重复自己？

Question

我有一个测试套件，其中 conftest.py 定义了一些选项和一些用于检索它们的装置：

def pytest_addoption(parser):
  parser.addoption("--ip", action="store")
  parser.addoption("--port", action="store")

@pytest.fixture
def ip(request):
  return request.config.getoption("ip")

@pytest.fixture
def port(request):
  return request.config.getoption("ip")

（我在复制粘贴错误中漏掉了一个观点）

我的测试可以非常雄辩地表达他们需要的选项：

def test_can_ping(ip):
  ...

def test_can_net_cat(ip, port):
  ...

但是...

我尽量避免在这里重复自己：我必须在三个地方指定配置参数的名称才能使其正常工作。

如果我有这样的东西，我本可以避免复制粘贴错误：

# does not exist:
@pytest.option_fixture
def ip(request, parser):
  return request.config.getoption(this_function_name)

或这个

def pytest_addoption(parser):
  # does not exist: an as_fixture parameter
  parser.addoption("--ip", action="store", as_fixture=True)
  parser.addoption("--port", action="store", as_fixture=True)

有没有办法告诉pytest添加一个选项和相应的 fixture实现DRY/SPOT代码?

Answer 1

与其更改 pytest 装饰器，不如创建一个您自己的装饰器：

parse_options = []

@addOption(parse_options)
@pytest
def ip(...): ...

装饰器没有修改传入的函数。所以在这种情况下，查看方法对象，使用f.__name__得到名称并在列表中添加一个条目 parse_options。

下一步是修改 pytest_addoption 以遍历列表并创建选项。在函数执行的时候，装饰器应该已经完成了他们的工作。

Answer 2

经过一些测试，我找到了一些有用的东西。这可能不是最好的方法，但我认为它非常令人满意。 下面的所有代码都已添加到 conftest.py 模块中，除了两个测试。

首先定义一个包含选项数据的字典：

options = {
    'port': {'action': 'store', 'help': 'TCP port', 'type': int},
    'ip': {'action': 'store', 'help': 'IP address', 'type': str},
}

我们可以不用help和type，但以后会有一定的用处。

然后你可以使用这个 options 创建 pytest 选项：

def pytest_addoption(parser):
    for option, config in options.items():
        parser.addoption(f'--{option}', **config)

在这一点上，pytest --help 给出了这个（注意 help 提供方便文档的数据使用）：

usage: pytest [options] [file_or_dir] [file_or_dir] [...]
...
custom options:
  --port=PORT           TCP port
  --ip=IP               IP address

最后我们必须定义灯具。我通过提供一个 make_fixture 函数来做到这一点，该函数在 conftest.py 读取的循环中使用，以动态创建固定装置并将它们添加到模块的全局范围：

def make_fixture(option, config):
    func = lambda request: request.config.getoption(option)
    func.__doc__ = config['help']
    globals()[option] = pytest.fixture()(func)


for option, config in options.items():
    make_fixture(option, config)

同样，'help' 数据用于为创建的固定装置构建文档字符串并记录它们。因此，调用 pytest --fixtures 会打印出：

...
---- fixtures defined from conftest ----
ip
    IP address
port
    TCP port

调用 pytest --port 80 --ip 127.0.0.1，通过以下两个非常简单的测试，似乎验证了这个技巧（这里的 type 数据显示了它的实用性，它使 pytest 将端口转换为 int, 而不是字符串):

def test_ip(ip):
    assert ip == '127.0.0.1'


def test_ip_port(ip, port):
    assert ip == '127.0.0.1'
    assert port == 80

（非常有趣的问题，我希望看到更多类似的问题）

我怎样才能使用 pytest 选项作为固定装置而不是重复自己？

How can I use pytest options as fixture and not repeat myself?

python

dry

fixtures

pytest