testplan.md

description	A guide for generating Trunk-compatible test reports for Testplan

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.

Checklist

By the end of this guide, you should achieve the following before proceeding to the next steps to configure your CI provider.

• Generate a compatible test report
• Configure the report file path or glob
• Disable retries for better detection accuracy
• Test uploads locally

After correctly generating reports following the above steps, you'll be ready to move on to the next steps to configure uploads in CI.

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.

{% tabs %} {% tab title="Python" %}

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

{% endtab %} {% endtabs %}

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:

{% tabs %} {% tab title="Linux (x64)" %}

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"

{% endtab %}

{% tab title="Linux (arm64)" %}

SKU="trunk-analytics-cli-aarch64-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"

{% endtab %}

{% tab title="macOS (arm64)" %}

SKU="trunk-analytics-cli-aarch64-apple-darwin.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"

{% endtab %}

{% tab title="macOS (x64)" %}

SKU="trunk-analytics-cli-x86_64-apple-darwin.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"

{% endtab %} {% endtabs %}

{% hint style="info" %} This will not upload anything to Trunk. To improve detection accuracy, you should address all errors and warnings before proceeding to the next steps. {% endhint %}

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>

{% hint style="info" %} 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. {% endhint %}

Next Steps

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

Azure DevOps Pipelines		azure-devops-pipelines.md	azure.png
BitBucket Pipelines		bitbucket-pipelines.md	bitbucket.png
BuildKite		buildkite.md	buildkite.png
CircleCI		circleci.md	circle-ci.png
Drone CI		droneci.md	drone.png
GitHub Actions		github-actions.md	github.png
GitLab		gitlab.md	gitlab.png
Jenkins		jenkins.md	jenkins.png
Semaphore		semaphoreci.md	semaphore.png
TeamCity		broken-reference	teamcity.png
Travis CI		travisci.md	travis.png
Other CI Providers		otherci.md	other.png