XCTest

A guide for generating Trunk-compatible test reports for XCode and xcodebuild

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

Running XCTests from xcodebuild produces a .xcresult in an obscure directory by default. You can specify a -resultBundlePath option to generate the results locally:

xcodebuild test -scheme <YOUR_SCHEME> \
  -resultBundlePath ./test-results.xcresult

You can upload .xcresult directories directly to Trunk Flaky Tests.

Report File Path

The test reports will be written to the ./test-results.xcresult directory when running tests with the -resultBundlePath ./test-results.xcresultoption. You will need this path when uploading results to Trunk in CI.

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 run tests in CI with the -retry-tests-on-failure option, disable it for more accurate results.

Try It Locally

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 --xcresults-path "./test-results.xcresult" \
    --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.

Next Step

Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:

Last updated 3 days ago

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk ./trunk flakytests upload --xcresults-path "./test-results.xcresult" \ --org-url-slug <TRUNK_ORG_SLUG> \ --token <TRUNK_ORG_TOKEN>