Pytest

You can automatically detect and manage flaky tests in your Pytest projects by integrating with Trunk. This document explains how to configure Pytest to output JUnit XML reports that can be uploaded to Trunk for analysis.

Setup steps

Work through the steps below in order. Once you’ve finished the last one, you’ll be ready to move on to configure uploads in CI.

Generate a compatible test report

Configure the report file path or glob

Disable retries for better detection accuracy

Test uploads locally

Generating Reports

Trunk detects flaky tests by analyzing test results automatically uploaded from your CI jobs. You can do this by generating JUnit XML reports from your test runs. In your CI job, update your pytest command to include the --junit-xml and junit_family=xunit1 arguments to generate XML reports:

pytest --junit-xml=junit.xml -o junit_family=xunit1

The junit_family=xunit1 is necessary so that the generated XML report includes file paths for each test case. File paths for test cases are used for features that use code owners like the Jira integration and webhooks.

Report File Path

The --junit-xml argument specifies the path of the JUnit report. You’ll need this path later when configuring automatic uploads to Trunk.

Disable Retries

You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests. You should disable retries for accurate detection and use the Quarantining feature to stop flaky tests from failing your CI jobs. Omit the --lf or --ff options if you’ve previously configured your CI with these options to disable retries.

Try It Locally

You can validate your test reports using the Trunk Analytics CLI. If you don’t have it installed already, you can install and run the validate command like this:

SKU="trunk-analytics-cli-x86_64-unknown-linux.tar.gz"
curl -fL --retry 3 \
  "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
  | tar -xz

chmod +x trunk-analytics-cli
./trunk-analytics-cli validate --junit-paths "./junit.xml"

This will not upload anything to Trunk. To improve detection accuracy, you should address all errors and warnings before proceeding to the next steps.

Test Upload

Before modifying your CI jobs to automatically upload test results to Trunk, try uploading a single test run manually. You make an upload to Trunk using the following command:

./trunk-analytics-cli upload --junit-paths "./junit.xml" \
    --org-url-slug <TRUNK_ORG_SLUG> \
    --token <TRUNK_ORG_TOKEN>

You can find your Trunk organization slug and token in the settings or by following these instructions. After your upload, you can verify that Trunk has received and processed it successfully in the Uploads tab. Warnings will be displayed if the report has issues.