Cypress

A guide for generating Trunk-compatible test reports for Cypress tests

You can automatically detect and manage flaky tests 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.

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

Cypress has a built-in XML reporter which you can use to output a Trunk-compatible report.

Update your Cypress config, such as you cypress.config.js or cypress.config.ts file to output XML reports:

cypress.config.js

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  reporter: 'junit',
  reporterOptions: {
    mochaFile: './junit.xml',
    toConsole: true,
  },
})

Report File Path

The JUnit report location is specified by the mochaFile property in your Cypress config. In the above example, 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.

cypress.config.js

module.exports = defineConfig({
  retries: 0,
})

Try It Locally

The Validate Command

You can validate your test reports using the Trunk CLI. If you don't have it installed already, you can install and run the validate command like this:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests validate --junit-paths "./junit.xml"

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 a upload to Trunk using the following command:

curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests upload --junit-paths "./junit.xml" \
    --org-url-slug <TRUNK_ORG_SLUG> \
    --token <TRUNK_ORG_TOKEN>

Next Step

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

Azure DevOps Pipelines

BitBucket Pipelines

BuildKite

CircleCI

Drone CI

GitHub Actions

Gitlab

Jenkins

Semaphore

TeamCity

Travis CI

Other CI Providers