Pytest
A guide for generating Trunk-compatible test reports for Pytest
Last updated
A guide for generating Trunk-compatible test reports for Pytest
Last updated
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.
By the end of this guide, you should achieve the following before proceeding to the next steps to configure your CI provider.
After correctly generating reports following the above steps, you'll be ready to move on to the next steps to configure uploads in CI.
Trunk detects flaky tests by analyzing test reports 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:
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.
The --junit-xml argument specifies the path of the JUnit report. You'll need this path later when configuring automatic uploads to Trunk.
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.
You can validate your test reports using the Trunk CLI. If you don't have it installed already, you can install and run the validate command like this:
This will not upload anything to Trunk. To improve detection accuracy, you should address all errors and warnings before proceeding to the next steps.
Before modifying your CI jobs to automatically upload test results to Trunk, try uploading a single test run manually.
You make a upload to Trunk using the following command:
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.
Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:
You can validate your test reports using the Trunk CLI. If you don't have it installed already, you can install and run the validate command like this:
This will not upload anything to Trunk. To improve detection accuracy, you should address all errors and warnings before proceeding to the next steps.
