pytest-json-report

1.5.0 · active · verified Thu Apr 09

pytest-json-report is a pytest plugin that generates a comprehensive JSON report of your test results. It provides detailed information on test outcomes, collected items, and environment details, useful for integration with CI/CD systems or custom reporting tools. The current version is 1.5.0, with minor releases occurring every few months to address bugs and add features.

Warnings

breaking Python 2.x support was dropped in v1.2.4. Python 3.7+ is now required. As of v1.5.0, supported Python versions are 3.7 - 3.10, and pytest versions 3.7 - 7.0.
Fix: Ensure your project uses Python 3.7-3.10 and pytest 3.7-7.0 to use pytest-json-report v1.5.0 and newer.
gotcha The plugin does not activate automatically. You must explicitly enable it via the command line with `--json-report` or by adding `addopts = --json-report` to your `pytest.ini` configuration file.
Fix: Always include `--json-report` when running pytest or configure it in `pytest.ini`.
gotcha The structure and content of the JSON report, particularly the `summary` and `collected` counts, have evolved. Specifically, the `collected` count was fixed in v1.5.0 to accurately reflect all items, and the `deselected` count was added to the summary in v1.5.0 (and to collector result in v1.2.0).
Fix: If parsing reports from older versions, be aware that `collected` and `deselected` counts might be missing or inaccurate. Update to v1.5.0 or newer for the most accurate and complete summary data.
gotcha By default, the report is saved as `report.json` in the current working directory. To customize the output file path or control terminal verbosity, use specific command-line options.
Fix: Use `--json-report-file=/path/to/your/report.json` to specify the output path. Use `--json-report-verbosity=0|1|2` (since v1.4.0) to control terminal output verbosity (0=silent, 1=summary only, 2=verbose).

Install

pip install pytest-json-report Install stable version

Quickstart

Create a `test_example.py` file with some tests, then run `pytest --json-report` from your terminal. This command will execute your tests and generate a `report.json` file in your current working directory containing the test results and a summary.

import pytest
import json
import os

def test_success():
    assert True

def test_failure():
    assert False

@pytest.mark.skip(reason="demonstrating skip")
def test_skipped():
    pass

def test_record_property(record_property):
    record_property("my_custom_key", "my_custom_value")
    assert True

# Run pytest and generate report.json
# os.system('pytest --json-report') would run it, but for a quickstart example, we'll demonstrate the command.
print("To run this example, save it as `test_example.py` and run:")
print("pytest --json-report")
print("Then inspect the generated `report.json` file.")

# Example of reading the report (would typically be in a separate script or CI/CD)
# if os.path.exists('report.json'):
#     with open('report.json', 'r') as f:
#         report_data = json.load(f)
#     print(json.dumps(report_data['summary'], indent=2))

view raw JSON →