Sortez la docstring de la fonction de test dans le rapport avec pytest-html

Voici un résumé de la façon de générer une docstring dans un rapport pytest-html en tant qu'informations détaillées sur la fonction de test.

1. Modifiez conftest.py

Ajoutez les paramètres suivants à conftest.py (créé s'il n'existe pas) directement sous le répertoire de tests. Le titre est inséré dans la troisième colonne de l'en-tête du tableau et les informations de la fonction de test docstring sont insérées dans la troisième colonne du corps du tableau.

conftest.py

import pytest
from py.xml import html


def pytest_html_results_table_header(cells):
    cells.insert(2, html.th('Description'))

def pytest_html_results_table_row(report, cells):
    cells.insert(2, html.td(report.description))

@pytest.hookimpl(hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    report.description = str(item.function.__doc__)

2. Écrivez une docstring dans votre code de test

def test_one(self):
    """
C'est le test 1
    """
    assert True

def test_two(self):
    """
C'est le test 2
    """
    assert False

3. Exécution des tests

$ pytest --html=report.html

4. Résultat

La docstring de chaque fonction de test est affichée dans la troisième colonne du tableau.

référence

• https://github.com/pytest-dev/pytest-html