Как я могу использовать параметры pytest в качестве приспособления и не повторяться?

#python #pytest #dry #fixtures

#python #pytest #dry #приспособления

Вопрос:

У меня есть набор тестов с 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 добавить опцию и соответствующий
приспособление для получения СУХОГО / точечного кода?

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

(Очень интересный вопрос, я хотел бы видеть больше подобных этому)

Комментарии:

1. Мне интересно о рекурсии в make_fixture : почему это не создает бесконечный цикл?

2. @AaronDigulla: упс, это ошибка редактирования, она исправлена

3. Теперь есть СУХОЕ решение! Спасибо!

Ответ №2:

Вместо того, чтобы менять pytest декораторы, создайте свой собственный:

 parse_options = []

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

Декоратору не нужно изменять переданную функцию. Итак, в этом случае посмотрите на объект метода, используйте f.__name__ для получения имени и добавьте для него запись в список parse_options .

Следующий шаг — изменить pytest_addoption , чтобы выполнить итерацию по списку и создать параметры. Во время выполнения функции декораторы должны были выполнить свою работу.

Комментарии:

1. Довольно хороший намек! Я мог бы даже оставить ip функцию пустой и создать полностью новую функцию, которая возвращает параметр на основе имени функции.