Skip to main content

A basic HTML report for pytest using Jinja2 template engine.

Project description

This is a fork of the great template pytest-reporter-html1 with one detail changed: Instead of grouping the tests and showing only a number how many tests have failed and how many have passed, this template tries to mimic the standard pytest output with one dot for every test. This has the advantages that (1) even without expanding a file it’s visible which tests have failed and whether they are the same like in the last run and (2) it gives a better visualization how many tests have failed in a specific file. Hovering over a badge shows the name of the test and it’s status (e.g. passed/failed/skipped).

A basic HTML report for pytest using Jinja2 template engine. Based on pytest-reporter which provides the data to the template.

Features

  • Overview of files, tests, and phases with expandable sections

  • Includes information about tests such as documentation, markers, and fixtures

  • Fairly mobile friendly

  • Complies with Jenkins default CSP policy (with --split-report)

  • Support for pytest-metadata and pytest-rerunfailures

  • May be used as a base template for customization

Screenshot

Installation

You can install “pytest-reporter-html-dots” via pip from PyPI:

$ pip install pytest-reporter-html-dots

Usage

Specify the html-dots template and the output path of the report:

$ pytest --template=html-dots/index.html --report=report.html

By default the report is self-contained, but you can separate CSS, images, and JavaScript by specifying the --split-report option.

Customization

You can customize this template using template inheritance.

If you want to add more information to the meta data table, extend the session_metadata block. Create the following file called report-template.html next to your tox.ini:

{% extends "html-dots/index.html" %}
{% block session_metadata %}
    {{ super() }}
    <tr>
        <th>System under test version</th>
        <td>{{ version }}</td>
    </tr>
{% endblock %}

Add version to the context in the pytest_reporter_context hook in conftest.py:

import pytest

@pytest.hookimpl  # type: ignore [misc]  # Untyped decorator makes function "pytest_reporter_context" untyped
def pytest_reporter_context(context: 'dict[str, object]', config: 'pytest.Config') -> None:
    context['version'] = '0.1.2'

Add --template-dir and change --template in tox.ini (I am using bash to insert a timestamp into the report name via command substitution with date):

[tox]
envlist = py3
isolated_build = True

[testenv]
allowlist_externals = bash
deps =
    mypy
    pytest
    pytest-reporter-html-dots
commands =
    mypy src
    bash -c "pytest --template-dir={toxinidir} --template=report-template.html --report={toxinidir}{/}log{/}pytest-`date +%Y-%m-%d_%H-%M`.html {posargs}"

Some additional filters are available for templates to use:

asset(path_or_content, extension)

Takes a path to a local file or a raw bytes object and either returns a base64 encoded URL or a new relative URL to a copy depending on if the report is self-contained or not.

<img src="{{ 'path/to/image.png'|asset }}">
<img src="{{ raw_byte_data|asset('png') }}">
ansi(s)

Convert ANSI color codes to HTML.

strftime(value, format)

Format a Unix timestamp using datetime.strftime.

Started: {{ started|strftime('%Y-%m-%d %H:%M:%S') }}
timedelta(value)

Convert a time in seconds to a timedelta object.

rst(s)

Convert reStructuredText to HTML.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-reporter-html-dots-0.10.0.tar.gz (140.6 kB view details)

Uploaded Source

Built Distribution

pytest_reporter_html_dots-0.10.0-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file pytest-reporter-html-dots-0.10.0.tar.gz.

File metadata

File hashes

Hashes for pytest-reporter-html-dots-0.10.0.tar.gz
Algorithm Hash digest
SHA256 9d5e529a9efce88e6a71d560b39857d73690a509c51927585129d50b557dd274
MD5 c7fc99c4a1e79c8527def219c79530b3
BLAKE2b-256 f52169abe7330ff8691bae00852573bf5099a927e583b92733ce87b49d4bd0ed

See more details on using hashes here.

File details

Details for the file pytest_reporter_html_dots-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_reporter_html_dots-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae61d14dacb9e7822f79454ec2a9b0f53cfa123c5137505391a27c03a002fa5a
MD5 c607b50e5d4dce9bbddc06d50dbef82c
BLAKE2b-256 d19c5b68e85e1304df728c7b3a783245308f420b39dc1378b825934e3ea4e483

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page