Как добавить пользовательские разделы в отчет терминала в pytest
В питест, когда тестовый пример не пройден, у вас есть в отчете следующие категории:
- Сведения об отказе
- Захваченный стандартный вызов
- Захваченный вызов stderr
- Захваченный журнал вызовов
Я хотел бы добавить некоторые дополнительные пользовательские разделы (у меня есть сервер, который работает параллельно, и я хотел бы отображать информацию, зарегистрированную этим сервером, в выделенном разделе).
Как я мог это сделать (если вообще возможно)?
Спасибо
ПРИМЕЧАНИЕ:
В настоящее время я нашел следующее в исходном коде, но не знаю, будет ли это правильным подходом.
узлы.py
class Item(Node):
...
def add_report_section(self, when, key, content):
"""
Adds a new report section, similar to what's done internally
to add stdout and stderr captured output::
...
"""
отчеты.py
class BaseReport:
...
@property
def caplog(self):
"""Return captured log lines, if log capturing is enabled
.. versionadded:: 3.5
"""
return "\n".join(
content for (prefix, content) in self.get_sections("Captured log")
)
Ответы 2
Чтобы добавить пользовательские разделы в вывод терминала, вам нужно добавить их в список report.sections. Это можно сделать напрямую в хуке pytest_report_teststatus или косвенно в других хуках (через обёртку); фактическая реализация сильно зависит от вашего конкретного варианта использования. Пример:
# conftest.py
import os
import random
import pytest
def pytest_report_teststatus(report, config):
messages = (
'Egg and bacon',
'Egg, sausage and bacon',
'Egg and Spam',
'Egg, bacon and Spam'
)
if report.when == 'teardown':
line = f'{report.nodeid} says:\t"{random.choice(messages)}"'
report.sections.append(('My custom section', line))
def pytest_terminal_summary(terminalreporter, exitstatus, config):
reports = terminalreporter.getreports('')
content = os.linesep.join(text for report in reports for secname, text in report.sections)
if content:
terminalreporter.ensure_newline()
terminalreporter.section('My custom section', sep='-', blue=True, bold=True)
terminalreporter.line(content)
Примеры тестов:
def test_spam():
assert True
def test_eggs():
assert True
def test_bacon():
assert False
При запуске тестов вы должны увидеть заголовок My custom section внизу, окрашенный в синий цвет и содержащий сообщение для каждого теста:
collected 3 items
test_spam.py::test_spam PASSED
test_spam.py::test_eggs PASSED
test_spam.py::test_bacon FAILED
============================================= FAILURES =============================================
____________________________________________ test_bacon ____________________________________________
def test_bacon():
> assert False
E assert False
test_spam.py:9: AssertionError
---------------------------------------- My custom section -----------------------------------------
test_spam.py::test_spam says: "Egg, bacon and Spam"
test_spam.py::test_eggs says: "Egg and Spam"
test_spam.py::test_bacon says: "Egg, sausage and bacon"
================================ 1 failed, 2 passed in 0.07 seconds ================================
Ваше решение добавляет раздел для всей тестовой сессии: возможно ли иметь один раздел для каждого тестового случая?
У вас может быть один раздел для каждого теста, просто не присоединяйте строки к тексту одного раздела (content = os.linesep.join(text for report in reports for secname, text in report.sections)). Создайте свой собственный цикл for, в нем проверьте, какой у вас текущий тестовый пример (по report.nodeid), и распечатайте содержимое нескольких отчетов по отдельности.
В другом ответе показано, как добавить настраиваемый раздел в отчет терминала резюме, но это не лучший способ добавления настраиваемого раздела для каждого теста.
Для этой цели вы можете (и должны) использовать высокоуровневый API add_report_section узла Item (документы). Минималистский пример показан ниже, измените его в соответствии с вашими потребностями. При необходимости вы можете передать состояние из экземпляра теста через узел элемента.
В test_something.py вот один пройденный тест и два не пройденных:
def test_good():
assert 2 + 2 == 4
def test_bad():
assert 2 + 2 == 5
def test_ugly():
errorerror
В conftest.py настройте обёртку хука:
import pytest
content = iter(["first", "second", "third"])
@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_call(item):
outcome = yield
item.add_report_section("call", "custom", next(content))
В отчете теперь будут отображаться пользовательские разделы за тест:
$ pytest
============================== test session starts ===============================
platform linux -- Python 3.9.0, pytest-6.2.2, py-1.10.0, pluggy-0.13.1
rootdir: /tmp/example
collected 3 items
test_something.py .FF [100%]
==================================== FAILURES ====================================
____________________________________ test_bad ____________________________________
def test_bad():
> assert 2 + 2 == 5
E assert (2 + 2) == 5
test_something.py:5: AssertionError
------------------------------ Captured custom call ------------------------------
second
___________________________________ test_ugly ____________________________________
def test_ugly():
> errorerror
E NameError: name 'errorerror' is not defined
test_something.py:8: NameError
------------------------------ Captured custom call ------------------------------
third
============================ short test summary info =============================
FAILED test_something.py::test_bad - assert (2 + 2) == 5
FAILED test_something.py::test_ugly - NameError: name 'errorerror' is not defined
========================== 2 failed, 1 passed in 0.02s ===========================
Спасибо за этот новый ответ! Я проверю это в ближайшее время.
Звучит безподобно! Я попробую в ближайшее время.