Uploader CLI Reference

Trunk detects and tracks flaky tests in your repos by receiving uploads from your test runs in CI, uploaded from the Uploader CLI. These uploads happen in the CI jobs used to run tests in your nightly CI, post-commit jobs, and PR checks.

Guides

If you're setting up Trunk Flaky Tests for the first time, you can follow the guides for your CI provider and test framework.

Guides by Test Frameworks

Guides by CI Provider

Installing the CLI

The CLI should be downloaded as part of your test workflow in your CI system. The launcher is platform agnostic and will download the latest version of the uploader for your platform.

You should always use the latest version of the uploader CLI by downloading it fresh in your CI jobs for the best detection results.

You can download the uploader CLI and mark it executable with the following command:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk

And you can verify that it's been downloaded properly by running:

./trunk flakytests -V

Under-the-hood, this downloads the Trunk CLI Launcher which will download the appropriate binaries for your environment.

Organization Slug and Token

The CLI requires your Trunk organization slug and token passed through --org-url-slug and --token to upload results to the correct organzation.

You can find your organization slug and token by going to Settings > Manage > Organization.

Uploading Using the CLI

The uploaded tests are processed by Trunk periodically, not in real-time. Wait for at least an hour after the initial upload before they’re displayed in the Uploads tab. Multiple uploads are required before a test can be accurately detected as broken or flaky.

Trunk accepts uploads in three main report formats, XML, Bazel Event Protocol JSONs, and XCode XCResult paths. You can upload each of these test report formats using the ./trunk flakytest upload command like this:

Trunk can accept JUnit XMLs through the --junit-paths argument:

./trunk flakytests upload --junit-paths "test_output.xml" \
   --org-url-slug <TRUNK_ORG_SLUG> \
   --token $TRUNK_API_TOKEN

Trunk can accept Bazel through the --bazel-bep-path argument:

./trunk flakytests upload --bazel-bep-path <BEP_JSON_PATH> \
   --org-url-slug <TRUNK_ORG_SLUG> \
   --token $TRUNK_API_TOKEN

Trunk can accept XCode through the --xcresult-path argument:

./trunk flakytests upload --xcresult-path <XCRESULT_PATH> \
   --org-url-slug <TRUNK_ORG_SLUG> \
   --token $TRUNK_API_TOKEN

Testing Using the CLI

You can also execute tests and upload results to Trunk in a single step using the ./trunk flakytest test command to wrap your test command.

This is especially useful for Quarantining, where the Trunk CLI will override the exit code of the test command if all failures can be quarantined, preventing flaky tests from failing your builds in CI.

Trunk can accept JUnit XMLs through the --junit-paths argument:

./trunk flakytests test --junit-paths "test_output.xml" \
   --org-url-slug <TRUNK_ORG_SLUG> \
   --token $TRUNK_API_TOKEN \
   <YOUR_TEST_COMMAND>

Trunk can accept Bazel through the --bazel-bep-path argument:

./trunk flakytests test --bazel-bep-path <BEP_JSON_PATH> \
   --org-url-slug <TRUNK_ORG_SLUG> \
   --token $TRUNK_API_TOKEN \
   <YOUR_TEST_COMMAND>

Trunk can accept XCode through the --xcresult-path argument:

./trunk flakytests test --xcresult-path <XCRESULT_PATH> \
   --org-url-slug <TRUNK_ORG_SLUG> \
   --token $TRUNK_API_TOKEN \
   <YOUR_TEST_COMMAND>

Upload failure vs test failure

We use the SOFTWARE exit code (70) if the upload fails.

If you use the test command and tests fail without the failures being quarantined, we return the provided exit code from the wrapped execution.

If you use the upload command, we return exit code FAILURE or the exit code provided with the --test_process_exit_code argument.

Validating Reports Locally

You can validate the test reports produced by your test frameworks before you set up Trunk in your CI jobs. This is currently only available for XML reports.

You can run the validate command like this:

./trunk flakytests validate --junit-paths "test_output.xml"

The ./trunk flakytests validate command will output any problems with your reports so you can address them before setting up Trunk in CI.

Validating the following 1 files:
  File set matching junit.xml:
    junit.xml

junit.xml - 1 test suites, 0 test cases, 0 validation errors

All 1 files are valid! ✅
Navigate to https://app.trunk.io/onboarding?intent=flaky+tests to continue using Trunk Flaky Tests! 🚀🧪

Upgrade

If you installed the CLI in your CI jobs following the instructions in the Installing the CLI step, the CI job will automatically install the latest version of the CLI. You should always download a fresh copy of the latest CLI in CI.

If you're using the flakytests CLI subcommand with the Trunk CLI locally, you can upgrade with this command:

./trunk flakytests --upgrade

Full Command Reference

The trunk command-line tool can upload and analyze test results. The trunk flakytests command accepts the following subcommands:

Command

Description

trunk flakytests upload

Upload data to Trunk Flaky Tests.

trunk flakytests validate

Validates if the provided JUnit XML files and prints any errors.

trunk flakytests test <COMMAND>

Runs tests using the provided command, uploads results, checks whether the failures are quarantined tests, and correct the exit code based on that.

The upload and test commands accept the following options:

Argument

Description

--junit-paths <JUNIT_PATHS>

Path to the test output files. File globs are supported. Remember to wrap globs in "" quotes

--bazel-bep-path <BEP_JSON_PATH>

Path to a JSON serialized Bazel Build Event Protocol. Trunk will use the BEP file to locate test reports. Your test frameworks must still output compatible report formats.

--xcresult-path <XCRESULT_PATH>

Path to a .xcresult directory, which contains test reports from xcodebuild.

--org-url-slug <ORG_URL_SLUG>

Trunk Organization slug, from the Settings page.

--token <TOKEN>

Trunk Organization (not repo) token, from the Settings page. Defaults to the TRUNK_API_TOKEN variable.

-h, --help

Additional detailed description of the upload command.

--repo-root

Path to the repository root. Defaults to the current directory.

--repo-url <REPO_URL>

Value to override URL of repository. Optional.

--repo-head-sha <REPO_HEAD_SHA>

Value to override SHA of repository head. Optional.

--repo-head-branch <REPO_HEAD_BRANCH>

Value to override branch of repository head. Optional.

--repo-head-commit-epoch <REPO_HEAD_COMMIT_EPOCH>

Value to override commit epoch of repository head. Optional.

--codeowners-path <CODEOWNERS_PATH>

Value to override CODEOWNERS file or directory path. Optional.

--allow-empty-test-results

Don't fail commands if test results are empty or missing. Use it when you sometimes skip all tests for certain CI jobs. Defaults to true.

--variant <VARIANT_NAME>

Upload tests to a specific variant group. Optional.

--test-process-exit-code <EXIT_CODE>

Specify the exit code of the test previously run. This is used by the upload command to identify errors that happen outside of the context of the test execution (such as build errors).

Last updated 12 days ago