Gradle

A guide for generating Trunk-compatible test reports for Gradle

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

Tests run with Gradle will generate JUnit XML reports by default and are compatible with Trunk. You can further configure reporting behavior in your build.gradle.kts or build.gradle.

Report File Path

By default, Android projects will produce a directory with JUnit XML reports under ./app/build/test-results/test. You can locate these files with the glob "./app/build/test-results/test/*.xml".

If you wish to override the default test result path, you can do so in the build.gradle.kts or build.gradle files:

build.gradle

java.testResultsDir = layout.buildDirectory.dir("junit-reports")

build.gradle.kts

java.testResultsDir = layout.buildDirectory.dir("junit-reports")

This example will write report files to "./app/build/junit-reports/test/*.xml"

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.

If you've enabled retries using a plugin like the test-retry-gradle-plugin, disable it when running tests for Trunk flaky tests.

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 "./app/build/junit-reports/test/*.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 "./app/build/junit-reports/test/" \
    --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.