Azure DevOps Pipelines

Introduction

Trunk Flaky Tests integrates with your CI by adding an Upload Test Results step in each of your Azure DevOps Pipelines to upload tests with the Trunk Uploader CLI.

Before you start on these steps, see the Test Frameworks docs for instructions on producing JUnit XML output for your test runner, supported by virtually all test frameworks, which is what Trunk ingests.

1. Store a TRUNK_TOKEN secret in your CI system

In app.trunk.io, navigate to:

Settings > Organization > Manage > Organization API Token > View Organization API Token > View

Store your API Token in your Azure DevOps Pipelines as a new variable named TRUNK_TOKEN. Make sure you are getting your organization token, not your project/repo token.

2. Grab your Organization Slug

To upload test results to Trunk, you'll need to pass a Trunk Organization Slug to the upload command. To get your organization slug, In app.trunk.io, navigate to:

Settings > Organization > Manage > Organization Name > Slug

Your Trunk Organization Slug can be pasted directly into your CI workflow; it's not a secret. In the example workflow in the next step, replace <TRUNK_ORG_SLUG> with your organization slug.

3. Modify workflows to upload test results

Add an Upload Test Results step after running tests in each of your CI jobs that run tests. This should be minimally all jobs that run on pull requests, as well as from jobs that run on your stable branches, for example, main, master, or develop.

You must upload tests from both PR and stable branchs, such as main, master, or develop in CI for Trunk to detect flaky tests. Trunk will not detect flaky tests without uploads from both PR and stable branches.

Learn more about detection

Add Uploader to Testing Pipelines

The following is an example of a workflow step to upload test results after your tests run. Note: you must either run trunk from the repo root when uploading test results or pass a --repo-root argument.

To find out how to produce the JUnit XML files the uploader needs, see the instructions for your test framework in the Test Frameworks docs.

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
# ... Omitted steps

- script: |
    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_TOKEN)
  condition: always() # this should always run
  displayName: Upload test results to Trunk.io

See the Uploader CLI Reference for all available command line arguments and usage.

Stale files

Ensure you report every test run in CI and clean up stale files produced by your test framework. If you're reusing test runners and using a glob like **/junit.xml to upload tests, stale files not cleaned up will be included in the current test run, throwing off detection of flakiness. You should clean up all your results files after every upload step.

Learn more about cleaning up artifacts in Azure DevOps Pipelines

Have questions?

Join us and 1500+ fellow engineers on Slack to get help with Trunk.