Android

A guide for generating Trunk-compatible test reports for Android projects

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

Android tests run with Gradle, typically using ./gradlew test in CI. This will generate JUnit XML output by default, which you can further configure 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.

You can customize the report output location in your build.gradle.kts or build.gradle, for example, writing the reports to ./app/junit-reports.

Groovy

android {
    testOptions {
        unitTests {
            all {
                reports {
                    junitXml {
                        outputLocation = file("./junit-reports")
                    }
                }
            }
        }
    }
}

Kotlin

android {
    testOptions {
        unitTests {
            all {
                reports {
                    junitXml.outputLocation.set(file("./junit-reports"))
                }
            }
        }
    }
}

When you configure your CI provider to upload reports in later steps, you will be uploading the reports using a glob such as ./junit-reports/*.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:

Linux (x64)

SKU="trunk-analytics-cli-x86_64-unknown-linux.tar.gz"
curl -fL --retry 3 \
  "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
  | tar -xz

chmod +x trunk-analytics-cli
./trunk-analytics-cli validate --junit-paths "./apps/junit-reports/*.xml"

Linux (arm64)

SKU="trunk-analytics-cli-aarch64-unknown-linux.tar.gz"
curl -fL --retry 3 \
  "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
  | tar -xz

chmod +x trunk-analytics-cli
./trunk-analytics-cli validate --junit-paths "./apps/junit-reports/*.xml"

macOS (arm64)

SKU="trunk-analytics-cli-aarch64-apple-darwin.tar.gz"
curl -fL --retry 3 \
  "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
  | tar -xz

chmod +x trunk-analytics-cli
./trunk-analytics-cli validate --junit-paths "./apps/junit-reports/*.xml"

macOS (x64)

SKU="trunk-analytics-cli-x86_64-apple-darwin.tar.gz"
curl -fL --retry 3 \
  "https://github.com/trunk-io/analytics-cli/releases/latest/download/${SKU}" \
  | tar -xz

chmod +x trunk-analytics-cli
./trunk-analytics-cli validate --junit-paths "./apps/junit-reports/*.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:

./trunk-analytics-cli upload --junit-paths "./app/junit-reports/*.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		azure-devops-pipelines	azure.png
BitBucket Pipelines		bitbucket-pipelines	bitbucket.png
BuildKite		buildkite	buildkite.png
CircleCI		circleci	circle-ci.png
Drone CI		droneci	drone.png
GitHub Actions		github-actions	github.png
Gitlab		gitlab	gitlab.png
Jenkins		jenkins	jenkins.png
Semaphore		semaphoreci	semaphore.png
TeamCity		https://github.com/trunk-io/docs/blob/main/flaky-tests/get-started/frameworks/broken-reference/README.md	teamcity.png
Travis CI		travisci	travis.png
Other CI Providers		otherci	other.png