how to customize html report file generated using py.test?

Question

I am trying to customize html report using pytest. For example, if I've got a directory structure like:

tests
    temp1
         test_temp1.py
    conftest.py

A conftest.py file is also in the tests directory, and it should be common to all the sub-directories in the tests directory. What fixtures and hookwrappers can I use in the conftest.py to change the contents of the html file generated using the following command:

py.test tests/temp1/test_temp1.py --html=report.html

Answer 1

UPDATE: In latest version, if you wanna modify the Environment table in html report, add to your conftest.py next code:

@pytest.fixture(scope='session', autouse=True)
def configure_html_report_env(request)
    request.config._metadata.update(
        {'foo': 'bar'}
    )

Answer 2

Looks like you are using some plugin like pytest-html. If that is the case check documentation for that plugin for what all hooks are provided.

for pytest-html following hooks are provided You can add change the Environment section of the report by modifying request.config._html.environment from a fixture:

@pytest.fixture(autouse=True)
def _environment(request):
    request.config._environment.append(('foo', 'bar'))

You can add details to the HTML reports by creating an ‘extra’ list on the report object. The following example adds the various types of extras using a pytest_runtest_makereport hook, which can be implemented in a plugin or conftest.py file:

import pytest
@pytest.mark.hookwrapper
def pytest_runtest_makereport(item, call):
    pytest_html = item.config.pluginmanager.getplugin('html')
    outcome = yield
    report = outcome.get_result()
    extra = getattr(report, 'extra', [])
    if report.when == 'call':
        # always add url to report
        extra.append(pytest_html.extras.url('http://www.example.com/'))
        xfail = hasattr(report, 'wasxfail')
        if (report.skipped and xfail) or (report.failed and not xfail):
            # only add additional html on failure
            extra.append(pytest_html.extras.html('<div>Additional HTML</div>'))
        report.extra = extra