> ## Documentation Index
> Fetch the complete documentation index at: https://trunk-4cab4936-sam-gutentag-api-conventions.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Robot Framework

> A guide for generating Trunk-compatible test reports for Robot Framework

You can automatically [detect and manage flaky tests](../../detection/) in your projects running tests with Robot by integrating with Trunk. This document explains how to configure Robot to output JUnit XML reports that can be uploaded to Trunk for analysis.

## Setup steps

Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/).

<Steps>
  <Step title={<a href="#generating-reports">Generate a compatible test report</a>} />

  <Step title={<a href="#report-file-path">Configure the report file path or glob</a>} />

  <Step title={<a href="#disable-retries">Disable retries for better detection accuracy</a>} />

  <Step title={<a href="#try-it-locally">Test uploads locally</a>} />
</Steps>

## Generating Reports

Trunk detects flaky tests by analyzing test results automatically uploaded from your CI jobs. You can do this by generating Trunk-compatible XML reports from your test runs.

To output compatible reports, add the `--xunit` argument to your `robot` command:

```shell theme={null}
robot --xunit=junit.xml TestSuite.robot
```

### Report File Path

The JUnit report will be written to the location specified by the `--xunit` argument. In the example above, it would be at `./junit.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 them and prefer using the [Quarantine](../../quarantining/) feature to mitigate the negative impact of Flaky Tests.

Omit the [`--rerunfailed`](https://docs.robotframework.org/docs/flaky_tests#re-execute-failed-tests-and-merge-results) flag and remove any [RetryFailed Listeners](https://docs.robotframework.org/docs/flaky_tests#retryfailed-listener) previously configured to run as part of your CI pipeline to disable retries.

## Try It Locally

### The Validate Command

You can validate your test reports using the [Trunk Analytics CLI](../../reference/cli-reference). If you don't have it installed already, you can install and run the `validate` command like this:

<CodeGroup>
  ```bash Linux (x64) theme={null}
  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 "./junit.xml"
  ```

  ```bash Linux (arm64) theme={null}
  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 "./junit.xml"
  ```

  ```bash macOS (arm64) theme={null}
  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 "./junit.xml"
  ```

  ```bash macOS (x64) theme={null}
  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 "./junit.xml"
  ```
</CodeGroup>

**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:

```sh theme={null}
./trunk-analytics-cli upload --junit-paths "./junit.xml" \
    --org-url-slug <TRUNK_ORG_URL_SLUG> \
    --token <TRUNK_ORG_TOKEN>
```

You can find your Trunk organization slug and token in the settings or by following these [instructions](/flaky-tests/get-started/ci-providers/otherci#id-1.-store-a-trunk_token-secret-in-your-ci-system). 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.

<Frame>
  <img className="block dark:hidden" src="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/SWcmEIlfMVD9BUFI/assets/data-uploads-light.png?fit=max&auto=format&n=SWcmEIlfMVD9BUFI&q=85&s=6f03edb5de40f783f2cd2ed75639cc75" alt="" width="2560" height="1800" data-path="assets/data-uploads-light.png" />

  <img className="hidden dark:block" src="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/SWcmEIlfMVD9BUFI/assets/data-uploads-dark.png?fit=max&auto=format&n=SWcmEIlfMVD9BUFI&q=85&s=ecb030e0a9dc01757d9f0bc740d3098e" alt="" width="2560" height="1800" data-path="assets/data-uploads-dark.png" />
</Frame>

## Next Steps

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

<Columns cols={3}>
  <Card title="Atlassian Bamboo" href="/flaky-tests/get-started/ci-providers/atlassian-bamboo" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/atlassian-bamboo.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=7c2e073d8a482cd6a7356ee688e8f089" width="1600" height="1000" data-path="assets/atlassian-bamboo.png" />

  <Card title="Azure DevOps Pipelines" href="/flaky-tests/get-started/ci-providers/azure-devops-pipelines" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/azure.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=a39579188faffced39b8dc77bdfd6bca" width="1600" height="1000" data-path="assets/azure.png" />

  <Card title="BitBucket Pipelines" href="/flaky-tests/get-started/ci-providers/bitbucket-pipelines" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/bitbucket.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=03a7fab310505fe2a0224bfcec42fb14" width="1600" height="1000" data-path="assets/bitbucket.png" />

  <Card title="BuildKite" href="/flaky-tests/get-started/ci-providers/buildkite" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/buildkite.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=72ec38bf82f5c90372f2ec160a968bfd" width="1600" height="1000" data-path="assets/buildkite.png" />

  <Card title="CircleCI" href="/flaky-tests/get-started/ci-providers/circleci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/circle-ci.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=60d9700c281d5bc07eab3c619f9b28f9" width="1600" height="1000" data-path="assets/circle-ci.png" />

  <Card title="Drone CI" href="/flaky-tests/get-started/ci-providers/droneci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/Jp89JT8l5x9D9wH9/assets/drone.png?fit=max&auto=format&n=Jp89JT8l5x9D9wH9&q=85&s=3b7f8bdddf4ef90ff3255320e231f502" width="1600" height="1000" data-path="assets/drone.png" />

  <Card title="GitHub Actions" href="/flaky-tests/get-started/ci-providers/github-actions" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/Jp89JT8l5x9D9wH9/assets/github.png?fit=max&auto=format&n=Jp89JT8l5x9D9wH9&q=85&s=a337f701a50a3701ed721802eec22f50" width="1600" height="1000" data-path="assets/github.png" />

  <Card title="GitLab" href="/flaky-tests/get-started/ci-providers/gitlab" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/Jp89JT8l5x9D9wH9/assets/gitlab.png?fit=max&auto=format&n=Jp89JT8l5x9D9wH9&q=85&s=aa3b7b6c434a561525db2babdfa6494e" width="1600" height="1000" data-path="assets/gitlab.png" />

  <Card title="Jenkins" href="/flaky-tests/get-started/ci-providers/jenkins" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/_tZbo39T-AVwvieD/assets/jenkins.png?fit=max&auto=format&n=_tZbo39T-AVwvieD&q=85&s=a7ff501092de3489d3c8c824236a0bbc" width="1600" height="1000" data-path="assets/jenkins.png" />

  <Card title="Semaphore" href="/flaky-tests/get-started/ci-providers/semaphoreci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/6EPZ5IXH1__vFgXF/assets/semaphore.png?fit=max&auto=format&n=6EPZ5IXH1__vFgXF&q=85&s=15ae9dcf3069cf1fb1cd4987d2670bf8" width="1600" height="1000" data-path="assets/semaphore.png" />

  <Card title="TeamCity" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/6EPZ5IXH1__vFgXF/assets/teamcity.png?fit=max&auto=format&n=6EPZ5IXH1__vFgXF&q=85&s=0fc0357e6794a526e6299175baf3d539" width="1600" height="1000" data-path="assets/teamcity.png" />

  <Card title="Travis CI" href="/flaky-tests/get-started/ci-providers/travisci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/FjXJyQtUuAxL45aC/assets/travis.png?fit=max&auto=format&n=FjXJyQtUuAxL45aC&q=85&s=3d1249250b29bb351eec3f66f3405841" width="1600" height="1000" data-path="assets/travis.png" />

  <Card title="Other CI Providers" href="/flaky-tests/get-started/ci-providers/otherci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/6EPZ5IXH1__vFgXF/assets/other.png?fit=max&auto=format&n=6EPZ5IXH1__vFgXF&q=85&s=20cc970bad6132744e02a7bafedd4de4" width="1600" height="1000" data-path="assets/other.png" />
</Columns>

<Columns cols={3}>
  <Card title="Azure DevOps Pipelines" href="../ci-providers/azure-devops-pipelines" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/azure.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=a39579188faffced39b8dc77bdfd6bca" width="1600" height="1000" data-path="assets/azure.png" />

  <Card title="BitBucket Pipelines" href="../ci-providers/bitbucket-pipelines" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/bitbucket.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=03a7fab310505fe2a0224bfcec42fb14" width="1600" height="1000" data-path="assets/bitbucket.png" />

  <Card title="BuildKite" href="../ci-providers/buildkite" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/buildkite.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=72ec38bf82f5c90372f2ec160a968bfd" width="1600" height="1000" data-path="assets/buildkite.png" />

  <Card title="CircleCI" href="../ci-providers/circleci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/RMA2tHeMVebmkls4/assets/circle-ci.png?fit=max&auto=format&n=RMA2tHeMVebmkls4&q=85&s=60d9700c281d5bc07eab3c619f9b28f9" width="1600" height="1000" data-path="assets/circle-ci.png" />

  <Card title="Drone CI" href="../ci-providers/droneci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/Jp89JT8l5x9D9wH9/assets/drone.png?fit=max&auto=format&n=Jp89JT8l5x9D9wH9&q=85&s=3b7f8bdddf4ef90ff3255320e231f502" width="1600" height="1000" data-path="assets/drone.png" />

  <Card title="GitHub Actions" href="../ci-providers/github-actions" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/Jp89JT8l5x9D9wH9/assets/github.png?fit=max&auto=format&n=Jp89JT8l5x9D9wH9&q=85&s=a337f701a50a3701ed721802eec22f50" width="1600" height="1000" data-path="assets/github.png" />

  <Card title="GitLab" href="../ci-providers/gitlab" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/Jp89JT8l5x9D9wH9/assets/gitlab.png?fit=max&auto=format&n=Jp89JT8l5x9D9wH9&q=85&s=aa3b7b6c434a561525db2babdfa6494e" width="1600" height="1000" data-path="assets/gitlab.png" />

  <Card title="Jenkins" href="../ci-providers/jenkins" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/_tZbo39T-AVwvieD/assets/jenkins.png?fit=max&auto=format&n=_tZbo39T-AVwvieD&q=85&s=a7ff501092de3489d3c8c824236a0bbc" width="1600" height="1000" data-path="assets/jenkins.png" />

  <Card title="Semaphore" href="../ci-providers/semaphoreci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/6EPZ5IXH1__vFgXF/assets/semaphore.png?fit=max&auto=format&n=6EPZ5IXH1__vFgXF&q=85&s=15ae9dcf3069cf1fb1cd4987d2670bf8" width="1600" height="1000" data-path="assets/semaphore.png" />

  <Card title="TeamCity" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/6EPZ5IXH1__vFgXF/assets/teamcity.png?fit=max&auto=format&n=6EPZ5IXH1__vFgXF&q=85&s=0fc0357e6794a526e6299175baf3d539" width="1600" height="1000" data-path="assets/teamcity.png" />

  <Card title="Travis CI" href="../ci-providers/travisci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/FjXJyQtUuAxL45aC/assets/travis.png?fit=max&auto=format&n=FjXJyQtUuAxL45aC&q=85&s=3d1249250b29bb351eec3f66f3405841" width="1600" height="1000" data-path="assets/travis.png" />

  <Card title="Other CI Providers" href="../ci-providers/otherci" img="https://mintcdn.com/trunk-4cab4936-sam-gutentag-api-conventions/6EPZ5IXH1__vFgXF/assets/other.png?fit=max&auto=format&n=6EPZ5IXH1__vFgXF&q=85&s=20cc970bad6132744e02a7bafedd4de4" width="1600" height="1000" data-path="assets/other.png" />
</Columns>
