Jest

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

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

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

To generate a Trunk-compatible XML report, install the jest-junit package:

npm install --save-dev jest-junit

Update your Jest config to add jest-junit as a reporter:

jest.config.json

{
  "reporters": [
    [
      "jest-junit",
      {
        "outputDirectory": "./",
        "outputName": "junit.xml",
        "addFileAttribute": "true"
      }
    ]
  ]
}

Report File Path

The outputDirectory and outputName options specify the path of the XML report. You'll need this path later when configuring automatic uploads to Trunk.

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 have retries configured using the jest.retryTimes method, disable them for more accurate results.

Try It Locally

The Validate Command

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:

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>

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 Steps

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

Last updated 2 months ago