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

Question

В pytest , если тестовый случай не пройден, в отчете есть следующие категории:

• Сведения об ошибке
• Захваченный стандартный вызов
• Захваченный вызов stderr
• Захваченный вызов журнала

Я хотел бы добавить несколько дополнительных пользовательских разделов (У меня есть сервер, который вращается параллельно и хотел бы отобразить информацию, записанную этим сервером в отдельном разделе).

Как я могу это сделать (если возможно)?

Спасибо

---

ПРИМЕЧАНИЕ :

В настоящее время я нашел следующее в исходном коде, но не знаю, будет ли это правильным подходом

node.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:: 
        ...
        """

reports.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")
        )

Answer 1

Чтобы добавить пользовательские разделы к выводу терминала, вам нужно добавить в список 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 ================================