Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.53 KB

pytest.md

File metadata and controls

69 lines (45 loc) · 2.53 KB
title description layout
Configuring pytest
A guide for generating Trunk-compatible test reports for Pytest
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
true
visible
true

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.

{% include "../../../.gitbook/includes/checklist.md" %}

Generating Reports

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:

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

The Validate Command

{% include "../../../.gitbook/includes/you-can-validate-your-test-....md" %}

Test Upload

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:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests upload --junit-paths "./junit.xml" \
    --org-url-slug <TRUNK_ORG_SLUG> \
    --token <TRUNK_ORG_TOKEN>

Next Steps

Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:

{% include "../../../.gitbook/includes/ci-providers.md" %}