JUnit XML reporting for CI in PyTest - Test Execution Trace

Test Overview

This test runs a simple pytest test case and generates a JUnit XML report. It verifies that the test passes and the XML report file is created for CI integration.

Test Code - pytest

PyTest

import pytest
import os
import sys

def test_addition():
    assert 2 + 3 == 5

if __name__ == '__main__':
    # Run pytest with JUnit XML report output
    retcode = pytest.main(['-v', '--junitxml=report.xml'])
    # Check if report.xml file is created
    assert os.path.exists('report.xml')
    # Exit with pytest return code
    sys.exit(retcode)

Execution Trace - 5 Steps

Step	Action	System State	Assertion	Result
1	Test starts by running pytest with the --junitxml option to generate XML report	Terminal shows pytest starting, test_addition discovered	—	PASS
2	Pytest runs test_addition function	Test executes assertion 2 + 3 == 5	Assert 2 + 3 == 5 is true	PASS
3	Pytest finishes test run and writes report.xml file	report.xml file is created in current directory	Check that report.xml file exists	PASS
4	Test script asserts report.xml file presence	File system contains report.xml	os.path.exists('report.xml') returns True	PASS
5	Test script exits with pytest return code 0 indicating success	Process ends with exit code 0	—	PASS

Failure Scenario

Failing Condition: The test_addition assertion fails or report.xml file is not created

Execution Trace Quiz - 3 Questions

What does the --junitxml option do in pytest?

A Generates a JUnit XML report file

B Runs tests in parallel

C Skips tests marked as slow

D Enables verbose output

Key Result

Always verify that your CI test runs generate the expected JUnit XML report file to integrate test results with CI dashboards.

Practice

1. What is the main purpose of generating a JUnit XML report in pytest for CI pipelines?

easy

A. To provide a standard format for test results that CI tools can read

B. To speed up test execution time

C. To automatically fix failing tests

D. To generate HTML reports for manual review

Solution

1. Step 1: Understand JUnit XML report role

   JUnit XML reports provide a standard format for test results that many CI tools can parse and display.

2. Step 2: Compare options with purpose

   Speeding tests, fixing tests, or generating HTML are not the main goals of JUnit XML reporting.

3. Final Answer:

   To provide a standard format for test results that CI tools can read -> Option A

4. Quick Check:

   JUnit XML = standard test result format [OK]

Hint: JUnit XML = standard test results for CI tools [OK]

Common Mistakes:

• Thinking JUnit XML speeds up tests
• Confusing XML report with HTML report
• Assuming it fixes tests automatically

2. Which pytest command correctly generates a JUnit XML report named results.xml?

easy

A. pytest --xml=results.xml

B. pytest --output=results.xml

C. pytest --report=results.xml

D. pytest --junitxml=results.xml

Solution

1. Step 1: Recall pytest option for JUnit XML

   The correct option to generate JUnit XML report is --junitxml=filename.

2. Step 2: Match option with command

   Only pytest --junitxml=results.xml uses --junitxml=results.xml, which is correct syntax.

3. Final Answer:

   pytest --junitxml=results.xml -> Option D

4. Quick Check:

   --junitxml option = correct flag [OK]

Hint: Use --junitxml=filename.xml to generate report [OK]

Common Mistakes:

• Using --xml instead of --junitxml
• Using --report or --output which are invalid
• Missing the equals sign '='

3. Given this pytest command:
pytest tests/ --junitxml=report.xml
What will happen after running it?

medium

A. Tests run but no report file is created

B. Tests run and a file named report.xml is created with test results in JUnit XML format

C. Tests do not run; only the report.xml file is created

D. Tests run and results are printed only to console, no file created

Solution

1. Step 1: Understand pytest command behavior

   The command runs tests in the tests/ folder and generates a JUnit XML report file named report.xml.

2. Step 2: Check output expectations

   Since --junitxml=report.xml is specified, the file will be created with test results in XML format.

3. Final Answer:

   Tests run and a file named report.xml is created with test results in JUnit XML format -> Option B

4. Quick Check:

   --junitxml creates XML report file [OK]

Hint: --junitxml creates XML report file after tests run [OK]

Common Mistakes:

• Thinking tests don't run when report option is used
• Expecting report file without running tests
• Assuming output only prints to console

4. You ran pytest --junitxml=results.xml but the file results.xml is empty. What is the most likely cause?

medium

A. No tests were collected or run

B. The --junitxml option is misspelled

C. The file path is invalid and pytest failed silently

D. JUnit XML reporting is not supported by pytest

Solution

1. Step 1: Analyze empty report cause

   An empty JUnit XML file usually means no tests were found or executed.

2. Step 2: Check other options

   The option --junitxml is correct, pytest supports it, and invalid paths usually cause errors, not silent empty files.

3. Final Answer:

   No tests were collected or run -> Option A

4. Quick Check:

   Empty XML = no tests run [OK]

Hint: Empty XML means no tests ran or were found [OK]

Common Mistakes:

• Assuming option is misspelled without checking
• Ignoring that no tests might be collected
• Thinking pytest doesn't support JUnit XML

5. You want your CI system to fail the build on the first pytest test failure using --failfast and --maxfail=1 and also save a JUnit XML report named ci-report.xml. Which command should you use?

hard

A. pytest --junitxml=ci-report.xml --maxfail=1 --exitfirst

B. pytest --junitxml=ci-report.xml --exitfirst --maxfail=0

C. pytest --junitxml=ci-report.xml --failfast --maxfail=1

D. pytest --junitxml=ci-report.xml --failfast --maxfail=0

Solution

1. Step 1: Understand options for failing fast

   To stop on first failure and fail the build, use --failfast and limit failures with --maxfail=1.

2. Step 2: Confirm JUnit XML report option

   --junitxml=ci-report.xml saves the report file as required.

3. Step 3: Evaluate options

   pytest --junitxml=ci-report.xml --failfast --maxfail=1 correctly combines --junitxml=ci-report.xml, --failfast, and --maxfail=1. Others have wrong or conflicting flags.

4. Final Answer:

   pytest --junitxml=ci-report.xml --failfast --maxfail=1 -> Option C

5. Quick Check:

   Fail fast + maxfail=1 + junitxml = pytest --junitxml=ci-report.xml --failfast --maxfail=1 [OK]

Hint: Use --failfast and --maxfail=1 with --junitxml for CI fail [OK]

Common Mistakes:

• Confusing --exitfirst with --failfast
• Setting maxfail=0 disables failure limit
• Omitting --failfast causes tests to run fully