Как я могу использовать параметры 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)

Опять же, данные «справки» используются для построения строки документации для созданных приборов и их документирования. Таким образом, вызов 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 для перебора списка и создания параметров. Во время выполнения функции декораторы должны были выполнить свою работу.