> ## 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.
# Cypress
> A guide for generating Trunk-compatible test reports for Cypress tests
You can automatically [detect and manage flaky tests](../../detection/) in your Cypress projects by integrating with Trunk. This document explains how to configure Cypress 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/).
Generate a compatible test report} />
Configure the report file path or glob} />
Disable retries for better detection accuracy} />
Test uploads locally} />
## Generating Reports
Cypress has a built-in Mocha JUnit reporter which outputs XML test reports. However, the built-in reporter does not include file paths in test case elements, which means Trunk cannot match tests to code owners or enable file-based filtering in the dashboard.
### Recommended: Use cypress-junit-plugin for file paths
For full functionality including code owner detection and file-based search, use the [`cypress-junit-plugin`](https://github.com/saucelabs/cypress-junit-plugin) reporter. It outputs test cases with the correct nested structure and file path attributes that Trunk expects.
Install the plugin:
```bash theme={null}
npm install --save-dev @saucelabs/cypress-junit-plugin
```
Update your Cypress config:
```javascript title="cypress.config.js" theme={null}
const { defineConfig } = require('cypress')
const { setupJUnitPlugin } = require('@saucelabs/cypress-junit-plugin')
module.exports = defineConfig({
e2e: {
setupNodeEvents(on, config) {
setupJUnitPlugin(on, config, { filename: './junit.xml' })
return config
},
},
})
```
### Alternative: Built-in Mocha reporter
If you don't need file path matching or code owner detection, you can use the built-in reporter. Uploads will still work, but you will see warnings about missing file paths and won't be able to search by file in the dashboard.
```javascript title="cypress.config.js" theme={null}
const { defineConfig } = require('cypress')
module.exports = defineConfig({
reporter: 'junit',
reporterOptions: {
mochaFile: './junit.xml',
toConsole: true,
},
})
```
The built-in Mocha JUnit reporter places the `file` attribute on `` elements but not on individual `` elements. Trunk requires file paths on test cases for code owner matching. If you see warnings like "report has test cases with missing file or filepath", switch to the `cypress-junit-plugin` above.
### Report File Path
The JUnit report location is specified by the `filename` option passed to `setupJUnitPlugin` (or the `mochaFile` property when using the built-in reporter). In the above examples, the file will 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 retries by setting `retries: 0` in your Cypress config file.
```javascript title="cypress.config.js" theme={null}
module.exports = defineConfig({
retries: 0,
})
```
## Try It Locally
### The Validate Command
```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"
```
### 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 \
--test-collection-id \
--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.
## Next Step
Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below: