Go

A guide for generating Trunk-compatible test reports for Go tests

You can automatically detect and manage flaky tests in your Go projects by integrating with Trunk. This document explains how to configure Go 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

Before integrating with Trunk, you need to generate a Trunk-compatible report. For Go, go test does not output JUnit XML by default, so you must use secondary tools to generate them.

go test + go-junit-report

Update your existing go test usage to generate json and use go-junit-report to convert your standard Go testing output into JUnit XML.

go install github.com/jstemmer/go-junit-report/v2@latest

Then pipe go test into the go-junit-report:

go test -json 2>&1 | go-junit-report -parser gojson -out junt_report.xml

gotestsum

Install gotestsum into your project: go install gotest.tools/gotestsum@latest Call gotestsum to both execute your tests and generate the junit.xml file

gotestsum [path-to-tests-to-run] --junitfile ./junit.xml

Report File Path

In the examples above, the JUnit report would be written to junit.xml. You'll need this path later when configuring automatic uploads to Trunk.

Disable Retries

If you have automatic retries enabled, disable them. Retries negatively impact the detection accuracy of flaky tests. If you're using a package like retry, disable it to get more accurate results from Trunk.

Try It Locally

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:

The Validate Command

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:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests validate --junit-paths "./junit.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:

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>

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:

Azure DevOps Pipelines

BitBucket Pipelines

BuildKite

CircleCI

Drone CI

GitHub Actions

Gitlab

Jenkins

Semaphore

TeamCity

Travis CI

Other CI Providers