Pytest JSON CTRF Reporter

0.3.6 · active · verified Sun Mar 29

pytest-json-ctrf is a pytest plugin that generates test reports in the Common Test Report Format (CTRF) as a JSON file. This standard format allows for consistent reporting across various testing tools and frameworks, facilitating better analysis and integration with external systems like GitHub Actions for prettifying reports. The current version is 0.3.6, with releases tied to pytest compatibility and feature enhancements.

Warnings

gotcha The `--ctrf` command-line option requires a file path argument. If not provided, pytest will not generate the CTRF report, or may raise an error depending on the pytest version. Ensure a valid file path is always specified.
Fix: Always use `pytest --ctrf <your_report_file_name.json>`.
gotcha As a pytest plugin, `pytest-json-ctrf` is activated via a command-line option (`--ctrf`) rather than direct Python imports within your test code. Attempting to import symbols directly from `pytest_json_ctrf` in your tests is generally unnecessary and will likely result in an `ImportError` or other unexpected behavior.
Fix: Ensure the plugin is installed (`pip install pytest-json-ctrf`) and activate it using the `--ctrf` command-line flag when running pytest. No explicit Python imports are typically needed in your test files for this plugin.
gotcha To ensure your tests are discovered and reported correctly by pytest (and subsequently by `pytest-json-ctrf`), adhere to pytest's standard test discovery rules: test files should start with `test_` or end with `_test.py`, and test functions/methods should start with `test_`.
Fix: Rename test files and functions to follow pytest conventions (e.g., `test_my_feature.py`, `def test_functionality()`).

Install

pip install pytest-json-ctrf Install plugin

Quickstart

First, create a simple test file (e.g., `test_example.py`). Then, run pytest from your terminal, specifying the `--ctrf` flag followed by the desired output filename. This will generate a JSON report in the Common Test Report Format in the specified file.

import pytest

# tests/test_example.py
def test_passing_example():
    assert True

def test_failing_example():
    assert False

# To run and generate report:
# pytest --ctrf report.json
# cat report.json

view raw JSON →