pytest-json

pytest-json is a plugin for py.test that generates JSON reports for test results

This Pytest plugin was generated with Cookiecutter along with @hackebrot's Cookiecutter-pytest-plugin template.

Requirements

Python 2.7, 3.3, 3.4, 3.5
py.test 2.7 or newer

Installation

You can install "pytest-json" via pip from PyPI:

$ pip install pytest-json

Usage

$ py.test --json=report.json

or you can set the report path in an ini file:

[pytest]
json_report = report.json

The command-line option will override the ini file

There is an optional flag to normalize the generated report to jsonapi. This is intended for (easier) consumption by ember-data and others:

$ py.test --json=report.json --jsonapi

or you can set the jsonapi flag in an ini file:

[pytest]
jsonapi = anything

Note that the value of the ini var can be anything. Presence alone will cause it to be true.

Adding to environment

You can modify request.config._json_environment in a fixture

@pytest.fixture(scope='session', autouse=True):
def extra_json_environment(request):
    request.config._json_environment.append(('herp', 'derp'))

Adding metadata per test stage

Metadata added via stage_metadata shows up in metadata field of the stage in the resulting JSON object

# conftest.py
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    if report.when == 'call':
        report.stage_metadata = {
            'foo': 'bar'
        }
    elif report.when == 'setup':
        report.stage_metadata = {
            'hoof': 'doof'
        }
    elif report.when == 'teardown':
        report.stage_metadata = {
            'herp': 'derp'
        }

Adding metadata per test

Metadata added on the tests themselves are represented by an array. To avoid collisions, etc. Any stage (setup, teardown, call) that sets test_metadata on a report will have its metadata appended to the array. Metadata added via test_metadata ends up in the metadata field of the test in the resulting JSON object

# conftest.py
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    report = outcome.get_result()
    # only add this during call instead of during any stage
    if report.when == 'call':
        report.test_metadata = 'whatever'

Compatibility with pytest-html

To avoid issues with pytest-html, pytest-json uses request.config._json_environment instead of request.config._environment

Additionally, pytest-json ignores the extra field on reports.

Example json

A formatted example of the output can be found in example.json

The actual output is not formatted, but this was passed through jq for readability.

A formatted example of the jsonapi output can be found in example_jsonapi.json

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the MIT license, "pytest-json" is free and open source software

Issues

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

vbuxbaum/pytest-json