Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A pytest plugin for generating NUnit3 test result XML output

Project description

Build status PyPI version Python versions PyPI download month

A pytest plugin for generating NUnit3 test result XML output

This plugin is in beta.

Command-line options

--nunit-xml

A string value to set the file name of the generated XML file.

Argument takes a path to the output file, either relative, or absolute.

--nunit-prefix

A string value to prefix all test case names the string provided.

Defaults to an empty string.

INI Options

nunit_show_username

Boolean value to include the system username in the test run properties.

Defaults to false

nunit_show_user_domain

Boolean value to include the system user domain in the test run properties.

Defaults to false

nunit_suite_name

(Deprecated, value ignored)

String value to set the test suite name.

Defaults to 'pytest'

nunit_attach_on

Enumeration to control whether the attachments property is set on all test cases when the add_nunit_attachment is used.

Can be one of:

  • any - Include test attachments for all outcomes (Default)
  • pass - Include test attachments for only passed test cases
  • fail - Include test attachments for only failed test cases

Fixtures

The following fixtures are made available by this plugin.

record_nunit_property

Calling record_nunit_property(key: str, value: str) will result in Property tags being added to the test-case for the related node.

def test_basic(record_nunit_property):
    record_nunit_property("test", "value")
    assert 1 == 1

add_nunit_attachment

Add an attachment to a node test-case by calling the add_nunit_attachment(path: str, description: str) function with the filepath and a description.

def test_attachment(add_nunit_attachment):
    pth = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'fixture.gif')
    add_nunit_attachment(path, "peanut butter jelly time")
    assert 1 == 1

Usage with Azure Pipelines

Add the following steps to your build job to publish the results to Azure Pipelines:

- script: "pip install pytest-nunit"

- script: |
    python -m pytest tests -v --nunit-xml=test-results.xml
  continueOnError: true

- task: PublishTestResults@2
  inputs:
    testResultsFormat: NUnit
    testResultsFiles: '**/test-results.xml'

Skipped Tests

Skipped tests will have the reason attribute (if provided) included in the results.

https://github.com/pytest-dev/pytest-nunit/raw/master/docs/source/_static/screen_skips.png

Attachments

Using the add_nunit_attachment fixture will render any attachments in the “attachments” tab inside the Tests console:

https://github.com/pytest-dev/pytest-nunit/raw/master/docs/source/_static/screen_attachments.png

Failures and xfails

Any failed tests, whether as xpass or xfail, will have the error output and comparison, as well as the failing line in the stack trace.

https://github.com/pytest-dev/pytest-nunit/raw/master/docs/source/_static/screen_fails.png

Compatibility with other plugins

x-dist

When running with -f, make sure to add in your pytest config file (setup.cfg etc) looponfailroots = testdir to exclude xml report files from being watched for changes.

Check looponfails

History

0.5.2 (30th August 2019)

  • Bugfix - Escape tabbed unicode characters from stdout feed from being in CDATA output

0.5.1 (30th August 2019)

  • Bugfix - Fixed cause of crash for tests that could be discovered but never executed

0.5.0 (30th August 2019)

  • Docstrings of nodes (functions) are set as the label for TestCase elements (contribution by @mikeattara)
  • Pytest -k keyword filters are added to the test run filter element under name.
  • Pytest -m marker filters are added to the test run filter element under namespace.
  • Any path filters are added to the test run filter element under test.
  • Each Python module containing tests is now a separate test-suite element, instead of having one large suite
  • Docstrings of modules are set as the label for TestSuite elements

0.4.0 (28th August 2019)

  • Added user domain (contribution by @williano)
  • Added tests and help for xdist execution (contribution by @mei-li)
  • Dynamically use the keyword list when generating schema to avoid reserved word collision (contribution by @gerhardtdatsomor)
  • Add method names, classnames and module names to output (contribution by @adekanyetomie)
  • Added locale and uiculture properties to runtime output (contribution by @terrameijar)
  • Added nunit_attach_on INI option to control when attachments are included in test cases.

0.3.0 (15th July 2019)

  • Added --nunit-prefix option.

0.2.1 (15th July 2019)

  • First stable release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-nunit, version 0.5.2
Filename, size File type Python version Upload date Hashes
Filename, size pytest_nunit-0.5.2-py3-none-any.whl (13.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pytest-nunit-0.5.2.tar.gz (15.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page