如何使用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添加一个选项和相应的夹具来实现DRY / SPOT代码？

Answer 1

经过一些测试，我找到了一些工作。它可能不是最好的方法，但我认为这是非常令人满意的。除了两个测试之外，下面的所有代码都已添加到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'数据用于为创建的fixture创建一个docstring并记录它们。因此，调用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

（非常有趣的问题，我希望看到更像这个）

Answer 2

而不是更改pytest装饰器，创建自己的一个：

parse_options = []

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

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

下一步是修改pytest_addoption以迭代列表并创建选项。在执行函数时，装饰者应该完成他们的工作。