Installation

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

$ pip install pytest-reporter

Usage

Specify the template you want to use and the output path of the report:

$ pytest --template-dir=templates --template=report.html --report=report.html

Writing templates

This plugin does not come with built-in support for any template engines, it is up to each template to implement the rendering (or use another template plugin as base). A minimal template may just implement the pytest_reporter_render hook.

This is a very basic Jinja2 template implementation:

from jinja2 import Environment, FileSystemLoader, TemplateNotFound

def pytest_reporter_render(template_name, dirs, context):
    env = Environment(loader=FileSystemLoader(dirs))
    try:
        template = env.get_template(template_name)
    except TemplateNotFound:
        # Don't know about this name, may be provided by some other template
        return
    return template.render(context)

See pytest-reporter-html1 for a full reference implementation.

The template context

The standard context available for all templates include the following:

• config: Config

• session: Session

• started: Unix timestamp when session started

• ended: Unix timestamp when session was finished

• warnings[]: List of warnings.WarningMessage

• items: Dictionary of collected items with nodeid as keys

• tests[]: List of each test run as dictionaries with the following keys:

  • item: Item

  • phases[]: List of each test phase (setup, call, teardown) as dictionaries with the following keys:

    • call (optional): CallInfo if available.

    • report: TestReport

    • sections: Same as report.sections but only the sections captured for this phase

    • log_records[]: List of logging.LogRecord recorded during the test phase

    • status: Status of this phase. Dictionary with the following keys:

      • category: Category of the status (e.g. "passed") or empty string

      • letter: Single letter version of status (e.g. "P") or empty string

      • word: Uppercase word version of status (e.g. "PASSED") or empty string

      • style: Dictionary with e.g. {"yellow": True} or empty dictionary

  • status: Status of whole test. Dictionary with the following keys:

    • category: Category of the test status (e.g. "passed")

    • letter: Single letter version of test status (e.g. "P")

    • word: Uppercase word version of test status (e.g. "PASSED")

    • style: Dictionary with e.g. {"yellow": True} or empty dictionary

The context may be extended or modified using the following methods:

• config.template_context

• The template_context fixture

• The pytest_reporter_context() hook

Hooks

See hooks.py for a complete list of hooks available.

License

Distributed under the terms of the MIT license, “pytest-reporter” is free and open source software

Issues

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