unittest-xml-reporting

Warnings

• breaking Version 4.0.0 of `unittest-xml-reporting` requires Python 3.10 or newer. If you are using an older Python version (e.g., 3.7-3.9), you must use an earlier version of the library (e.g., 3.2.0).
  Fix: Upgrade Python to 3.10+ or downgrade `unittest-xml-reporting` to a compatible version (e.g., `pip install unittest-xml-reporting==3.2.0` for Python 3.7-3.9).
• gotcha The `unittest.TestCase.subTest` feature has limited support. Sub-test granularity may be lost in the generated XML reports as it does not map directly to the xUnit schema, and successful sub-tests might not be explicitly reported.
  Fix: Be aware that reports for tests using `subTest` might lack fine-grained detail. Consider restructuring complex sub-tests into individual test methods if detailed reporting is critical for each variation.
• gotcha Malformed JUnit XML reports are a common issue, leading to parsing errors in CI/CD systems like GitLab or Jenkins. This can be caused by invalid XML, encoding problems, or missing test data.
  Fix: Ensure your XML files strictly adhere to the JUnit XML format. Validate reports as part of your CI pipeline, ensure correct output paths, and check for unique test names and classes.
• gotcha When consuming reports in Jenkins, different versions of the Jenkins xUnit plugin may have varying levels of XSD validation strictness. This can cause valid reports for one plugin version to be rejected by another.
  Fix: Refer to the documentation of your specific Jenkins xUnit plugin version. If issues arise, consider configuring the plugin to use a more lenient XSD or adjusting the report generation to match its expected schema.

Install

• pip install unittest-xml-reporting Install latest version

Imports

• XMLTestRunner

  import xmlrunner
  # ...
  xmlrunner.XMLTestRunner(...)

  The primary runner class is accessed via the 'xmlrunner' module.

Quickstart

This quickstart demonstrates how to set up a basic unittest suite and run it using `xmlrunner.XMLTestRunner` to generate xUnit-compatible XML reports in a specified output directory.

import unittest
import xmlrunner
import os

class MyTests(unittest.TestCase):
    def test_success(self):
        self.assertTrue(True)

    def test_failure(self):
        self.assertEqual(1, 2, "1 is not equal to 2")

    @unittest.skip("demonstrating skipping")
    def test_skipped(self):
        self.fail("shouldn't run this")

if __name__ == '__main__':
    output_dir = os.environ.get('TEST_OUTPUT_DIR', 'test-reports')
    os.makedirs(output_dir, exist_ok=True)
    
    # Run tests and generate XML report in the specified directory
    unittest.main(
        testRunner=xmlrunner.XMLTestRunner(output=output_dir),
        # Using exit=False allows the script to continue after tests,
        # which can be useful in some CI/CD setups or when integrating.
        exit=False
    )

    print(f"Test reports generated in: {os.path.abspath(output_dir)}")