jest.md

title	Configuring jest
description	A guide for generating Trunk-compatible test reports for Jest tests

Jest

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

{% code title="jest.config.json" %}

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

{% endcode %}

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.

Using filePathPrefix

In a monorepo with pnpm workspaces (or similar), Jest runs from within the package directory, so the file paths it records in the XML report are relative to that package — not to the repository root. For example, a test at packages/my-package/src/__tests__/foo.test.js would be recorded as src/__tests__/foo.test.js.

This causes codeowners matching to fail because Trunk compares test file paths against the codeowners file at the repo root, which uses full repo-relative paths.

To fix this, set the filePathPrefix option to the path of the package within the repo:

{% code title="jest.config.json" %}

{
  "reporters": [
    [
      "jest-junit",
      {
        "outputDirectory": "./",
        "outputName": "junit.xml",
        "addFileAttribute": "true",
        "reportTestSuiteErrors": "true",
        "filePathPrefix": "packages/my-package"
      }
    ]
  ]
}

{% endcode %}

With filePathPrefix set, jest-junit will prepend the given path to every file path in the XML output, producing repo-root-relative paths that Trunk can correctly match against your codeowners file.

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

{% tabs %} {% tab title="Linux (x64)" %}

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"

{% endtab %}

{% tab title="Linux (arm64)" %}

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"

{% endtab %}

{% tab title="macOS (arm64)" %}

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"

{% endtab %}

{% tab title="macOS (x64)" %}

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"

{% endtab %} {% endtabs %}

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:

./trunk-analytics-cli 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:

{% include "../../../.gitbook/includes/ci-providers.md" %}

Azure DevOps Pipelines		azure-devops-pipelines.md	azure.png
BitBucket Pipelines		bitbucket-pipelines.md	bitbucket.png
BuildKite		buildkite.md	buildkite.png
CircleCI		circleci.md	circle-ci.png
Drone CI		droneci.md	drone.png
GitHub Actions		github-actions.md	github.png
GitLab		gitlab.md	gitlab.png
Jenkins		jenkins.md	jenkins.png
Semaphore		semaphoreci.md	semaphore.png
TeamCity		broken-reference	teamcity.png
Travis CI		travisci.md	travis.png
Other CI Providers		otherci.md	other.png