Testplan

You can automatically detect and manage flaky tests in your projects running Testplan by integrating with Trunk. This document explains how to configure Testplan 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. Testplan can output JUnit XML reports which are compatible with Trunk. You can do so with the --xml option:

./test_plan.py --xml

Report file path

You can specify the file path for the reports with the --xml option.

./test_plan.py --xml ./junit-reports

Testplan outputs multiple XML reports under the JUnit directory. You can locate these when uploading the reports in CI with the "./junit-reports/*.xml" glob.

@test_plan(name='SamplePlan', xml_dir='junit-reports')
def main(plan):
    ...

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.

Task-level Retries

If you’re using execution pools (ThreadPool, ProcessPool) and have configured tasks with the rerun parameter, you should remove this configuration:

# Remove or set rerun=0
task = Task(target='make_multitest', module='tasks', rerun=2) 
plan.schedule(task, resource='MyPool')

# Instead, use:
task = Task(target='make_multitest', module='tasks')
plan.schedule(task, resource='MyPool')

Thread Pool Retries

If you’re using ThreadPools, tasks retries can be disabled at the pool level, you should remove this configuration:

# Set allow_task_rerun=FALSE
pool = ThreadPool(name="MyPool", allow_task_rerun=True) 

# Instead, use:
pool = ThreadPool(name="MyPool", allow_task_rerun=False)

Try It Locally

The Validate Command

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-reports/*.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-reports/*.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.

Next Steps

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

Flaky Tests

Setup steps

Generating reports

Report file path

Disable Retries

Task-level Retries

Thread Pool Retries

Try It Locally

The Validate Command

Test Upload

Next Steps

Azure DevOps Pipelines

BitBucket Pipelines

BuildKite

CircleCI

Drone CI

GitHub Actions

GitLab

Jenkins

Semaphore

TeamCity

Travis CI

Other CI Providers

Flaky Tests

Documentation Index

​Setup steps

​Generating reports

​Report file path

​Disable Retries

​Task-level Retries

​Thread Pool Retries

​Try It Locally

​The Validate Command

​Test Upload

​Next Steps

Azure DevOps Pipelines

BitBucket Pipelines

BuildKite

CircleCI

Drone CI

GitHub Actions

GitLab

Jenkins

Semaphore

TeamCity

Travis CI

Other CI Providers

Setup steps

Generating reports

Report file path

Disable Retries

Task-level Retries

Thread Pool Retries

Try It Locally

The Validate Command

Test Upload

Next Steps