pytest-nunit

1.0.7 · active · verified Mon Apr 13

pytest-nunit is a pytest plugin for generating NUnit3 test result XML output. It integrates seamlessly with `pytest` to produce reports compatible with NUnit test runners. The project is actively maintained with frequent updates, including recent support for `pytest` 8 and ongoing compatibility improvements.

Warnings

breaking Older versions of `pytest-nunit` (prior to 1.0.7) may not be fully compatible with `pytest` 8.0.0 and newer due to significant internal breaking changes introduced in `pytest`'s collection phase.
Fix: Upgrade to `pytest-nunit` version 1.0.7 or later to ensure compatibility with `pytest` 8.x series.
deprecated The `datetime.utcnow()` function, used internally by `pytest-nunit`, was replaced in version 1.0.6 due to deprecation in Python. Running older `pytest-nunit` versions on newer Python environments might surface deprecation warnings related to `datetime` usage.
Fix: Update `pytest-nunit` to version 1.0.6 or newer to use `datetime.now(timezone.utc)` and avoid `utcnow()` deprecation warnings.
gotcha The `xmlschema` package became a required dependency starting from `pytest-nunit` version 1.0.2. Environments that do not automatically resolve transitive dependencies might fail if `xmlschema` is not explicitly installed.
Fix: Ensure `xmlschema` is installed alongside `pytest-nunit`. Typically `pip install pytest-nunit` handles this, but manual installation (`pip install xmlschema`) might be needed in isolated environments.
gotcha The primary method to generate an NUnit XML report is by using the `--nunit-xml=<path>` command-line option. Forgetting this option will result in `pytest` running tests but not producing the desired XML output.
Fix: Always include `--nunit-xml=your_report_file.xml` when invoking `pytest` to ensure the report is generated.
deprecated The `nunit_suite_name` INI option is deprecated and its value is ignored by `pytest-nunit`.
Fix: Avoid using the `nunit_suite_name` INI option as it has no effect.
gotcha When using `pytest-xdist` with the `-f` (looponfail) option, it's recommended to add `looponfailroots = testdir` to your `pytest.ini` or `setup.cfg`. This prevents the generated XML report files from being continuously watched for changes, which can lead to unexpected behavior or performance issues.
Fix: Add `looponfailroots = testdir` to your `pytest` configuration file (e.g., `pytest.ini`) to exclude XML report files from being watched by `pytest-xdist`'s looponfail feature.

Install

pip install pytest-nunit Install latest version

Quickstart

To use `pytest-nunit`, simply install the package. It integrates automatically with `pytest`. You can then generate an NUnit XML report by running `pytest` with the `--nunit-xml` option, specifying the desired output file path. This example demonstrates running tests and generating an XML report named `test-results.xml`.

import pytest

# Create a dummy test file, e.g., test_example.py
with open('test_example.py', 'w') as f:
    f.write('def test_success():\n    assert True\n\ndef test_failure():\n    assert False\n')

# Run pytest with nunitxml output
# This will generate a 'test-results.xml' file in the current directory
pytest.main(['test_example.py', '--nunit-xml=test-results.xml'])

# Clean up (optional)
import os
os.remove('test_example.py')
os.remove('test-results.xml')

view raw JSON →