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

# Mocha

> A guide for generating Trunk-compatible test reports for Mocha

You can automatically [detect and manage flaky tests](../../detection/) in your Mocha projects by integrating with Trunk. This document explains how to configure Mocha 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

Before integrating with Trunk, you need to generate Trunk-compatible reports. For Mocha, the easiest approach is to generate XML reports.

First, install the `mocha-junit-reporter` package:

```shell theme={null}
npm install --save-dev mocha-junit-reporter
```

You can then generate reports when you run your tests by providing the `--reporter` and `--reporter-options` options when you run your tests:

```sh theme={null}
mocha --reporter mocha-junit-reporter --reporter-options mochaFile=./junit.xml
```

You can configure your Mocha runner to use the reporter programmatically as well:

```javascript theme={null}
var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        mochaFile: './junit.xml'
    }
});
```

### Report File Path

The resulting JUnit XML file will be written to the location specified by the `mochaFile` property in `reporterOptions`. In the examples above, the results 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 can disable retry by omitting the `--retries` CLI option and [removing retries for individual tests](https://mochajs.org/#retry-tests).

## 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> \
    --test-collection-id <TRUNK_TEST_COLLECTION_ID> \
    --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). The collection ID identifies the [test collection](/flaky-tests/get-started/test-collections) the results belong to, and you copy it from that collection in the Trunk app. 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://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/data-uploads-light.png" alt="" />

  <img className="hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/data-uploads-dark.png" alt="" />
</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="Azure DevOps Pipelines" href="../ci-providers/azure-devops-pipelines" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/azure.png" />

  <Card title="BitBucket Pipelines" href="../ci-providers/bitbucket-pipelines" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/bitbucket.png" />

  <Card title="BuildKite" href="../ci-providers/buildkite" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/buildkite.png" />

  <Card title="CircleCI" href="../ci-providers/circleci" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/circle-ci.png" />

  <Card title="Drone CI" href="../ci-providers/droneci" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/drone.png" />

  <Card title="GitHub Actions" href="../ci-providers/github-actions" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/github.png" />

  <Card title="GitLab" href="../ci-providers/gitlab" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/gitlab.png" />

  <Card title="Jenkins" href="../ci-providers/jenkins" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/jenkins.png" />

  <Card title="Semaphore" href="../ci-providers/semaphoreci" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/semaphore.png" />

  <Card title="TeamCity" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/teamcity.png" />

  <Card title="Travis CI" href="../ci-providers/travisci" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/travis.png" />

  <Card title="Other CI Providers" href="../ci-providers/otherci" img="https://mintlify.s3.us-west-1.amazonaws.com/trunk-4cab4936-test-collections-setup-instructions/assets/_shared/other.png" />
</Columns>
