如何使用pytest选项作为固定装置,而不重复自己?

时间:2019-03-25 13:56:38

标签: python pytest dry fixtures

我有一个带有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):
  ...

但是...

我试图避免在这里重复自己:我必须在三个位置指定config参数的名称,以使其起作用。

如果我看起来像这样,我可以避免复制粘贴错误:

# 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代码?

2 个答案:

答案 0 :(得分:1)

创建您自己的装饰器,而不是更改pytest装饰器:

parse_options = []

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

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

下一步是修改pytest_addoption以遍历列表并创建选项。在执行该功能时,装饰器应已完成工作。

答案 1 :(得分:1)

经过一些测试,我发现有些工作。这可能不是最好的方法,但我认为这很令人满意。 下面的所有代码都已添加到conftest.py模块中,这两个测试除外。

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

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

我们可以不用helptype,但是以后会具有一定的实用性。

然后,您可以使用此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)

同样,“帮助”数据用于为创建的灯具建立文档字符串并对其进行记录。因此,调用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

(一个非常有趣的问题,我想看到更多类似的问题)