Requirements

You will need the following prerequisites in order to use pytest-html:

• Python 3.10

Installation

You can install “pytest-jinja” via pip from PyPI:

$ pip install pytest-jinja

Usage

• if no template is specified a default template is used. The default template looks almost identical to pytest-html:

  $ pytest testcase --report=test_report.html

• or you can pass your own template, pytest-jinja will render your template passing in the report data as jinja variables:

  $ pytest testcase --report=test_report.html --template=my_template.html

Creating a custom template

You can create your own template by simply creating any template. The report data is “passed” to the page as a single object called report. The attributes of this object contain all the necessary report data.

Template Example

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Test Report - {{ report.time_report_generation }}</title>
</head>
<body>
<h1>Test Report - {{ report.time_report_generation }} </h1>

<h2>Environment</h2>
<table id="environment">
    {% for name,value in report.environment.items() %}
    <tr>
        <td>{{ name }}</td>
        <td>{{ value }}</td>
    </tr>
    {% endfor %}
</table>

<h2>Summary</h2>
<p>{{ report.tests_count }} tests ran in {{ report.duration | round(2)}} seconds. </p>

<h2>Results</h2>
<table>
    {% for r in report.results %}
    <tr>
        <td>{{ r.test_id }}</td>
        <td>{{ r.outcome }}</td>
        <td><strong>{{ r.time|round(5) }}s</strong></td>
    </tr>
    {% endfor %}
</table>

</body>
</html>

Another Template Example

{{ report | json }}

Available Report Data

report.tests_count : the total number of tests executed (int)

report.errors : the number of errors (int)

report.failed : the number of failed tests (int)

report.passed : the number of passed tests (int)

report.skipped : the number of skipped tests (int)

report.xfailed : the number of expected failures (int)

report.xpassed: the number of unexpected passes (int)

report.rerun: the number of reruns (int)

report.duration : the test session duration in seconds (float)

report.time_report_generation : date and time of report generation (str)

report.environment: metadata on tests execution (dict)

report.results: the test results data (Object with attributes test_id, time, outcome, stacktrace, config)

report.report_path: report path passed via command line (pathlib.Path)

report.template_path: template path passed via command line (pathlib.Path)

Contributing

Contributions are very welcome. Tests can be run with tox.

License

Distributed under Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. “pytest-jinja” is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

This pytest plugin was generated with Cookiecutter along with @hackebrot’s cookiecutter-pytest-plugin template.