GoogleTest

A guide for generating Trunk-compatible test reports for GoogleTest

You can automatically detect and manage flaky tests in your GoogleTest projects by integrating with Trunk. This document explains how to configure GoogleTest 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 you can integrate with Trunk, you need to generate a Trunk-compatible report. For GoogleTest, the built in XML reporter will work. You can use the --gtest_output=xml argument when you run your built test project:

./build/run_test --gtest_output=xml

Report File Path

By default, the JUnit report will be written to a test_detail.xml file.

You can specify a custom directory and filename with:

--gtest_output=xml:<path/to/file.xml>

For example, the following argument writes a JUnit report to ./junit.xml:

--gtest_output=xml:junit.xml

Disable Retries

You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests.

Omit the --gtest_repeat argument if you've previously configured your CI with these options to disable retries.

Try It Locally

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>

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