| title | description | layout | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Configuring gotestsum |
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.
{% include "../../../.gitbook/includes/checklist.md" %}
To generate compatible test reports, we will use gotestsum. Download gotestsum from releases, or build from source with go install gotest.tools/gotestsum@latest.
You can now run your tests using the gotestsum, which runs the test with go test under-the-hood before formatting the test results into a test report.
gotestsum --junitfile ./junit.xmlgotestsum will write a JUnit test report to the file specified by the --junitfile argument. In the example above, the JUnit report would be written to junit.xml. You'll need this path later when configuring automatic uploads to Trunk.
You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests.
If you're using a package like retry, disable it to get more accurate results from Trunk.
{% include "../../../.gitbook/includes/you-can-validate-your-test-....md" %}
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>{% include "../../../.gitbook/includes/you-can-find-your-trunk-org....md" %}
Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:
{% include "../../../.gitbook/includes/ci-providers.md" %}