# Vitest You can automatically [detect and manage flaky tests](https://docs.trunk.io/flaky-tests/detection) in your Vitest projects by integrating with Trunk. This document explains how to configure Vitest 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](#next-step) 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](https://docs.trunk.io/flaky-tests/get-started/ci-providers). ### Generating Reports Trunk detects flaky tests by analyzing test results automatically uploaded from your CI jobs. You can do this by generating Trunk-compatible XML reports from your test runs. You can configure Vitest to produce a Trunk-compatible JUnitXML report by updating your `vitest.config.ts`. {% code title="vitest.config.ts" %} ```javascript import { defineConfig } from 'vitest/config'; export default defineConfig({ test: { reporters: [ ['junit', { outputFile: './junit.xml', addFileAttribute: true }], ], }, }); ``` {% endcode %} {% hint style="warning" %} **Important**: The `addFileAttribute: true` option is required for the JUnit report to pass `trunk-analytics-cli` validation. This option adds file path information to each test case in the XML output, which Trunk uses to associate test results with source files. {% endhint %} #### Report File Path The `outputFile: './junit.xml'` option specifies the path of the JUnit 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](https://docs.trunk.io/flaky-tests/quarantining) feature to stop flaky tests from failing your CI jobs. If you've enabled retries, you can disable them following the [Vitest docs](https://vitest.dev/api/) for more accurate results. {% hint style="info" %} **Note**: Configuration errors can sometimes mask themselves as consistent test failures. If you're seeing file-level test entries instead of individual test cases, resolve configuration issues first before adjusting retry settings. A properly configured test suite should show individual test case names in the JUnit output, not file names. {% endhint %} ### Troubleshooting **Configuration Errors and File-Level Test Failures** **Issue**: You might see Trunk identifying flaky tests with names that match your test file names (e.g., `auth.test.ts` instead of `should login successfully`) rather than individual test case names. **Root Cause**: This typically occurs when Vitest encounters configuration errors that prevent it from properly parsing or running the tests in a file. Common scenarios include: * TypeScript configuration errors in `tsconfig.json` * Missing dependencies or import resolution failures * Syntax errors in test setup files * Invalid Vitest configuration options **What Happens**: When Vitest cannot execute the individual tests within a file due to configuration issues, it generates a single JUnit test case entry named after the file itself, regardless of how many actual test cases exist in that file. **How to Diagnose**: 1. Run your tests locally with verbose output: `vitest --reporter=verbose` 2. Check for configuration warnings or errors in the test output 3. Look for test files that show as single entries in your JUnit report when they should contain multiple test cases **How to Fix**: 1. **Check TypeScript Configuration**: Ensure your `tsconfig.json` is valid and includes all necessary paths 2. **Verify Dependencies**: Make sure all imported modules are properly installed and accessible 3. **Review Setup Files**: Check any test setup files referenced in your Vitest config for errors 4. **Validate Vitest Config**: Make sure your `vitest.config.ts` doesn't contain invalid options ### Try It Locally #### Validate Test Execution First Before validating your JUnit reports with Trunk, make sure Vitest can properly execute your tests: ```bash # Run tests with detailed output to catch configuration issues vitest run --reporter=verbose # Check that individual test cases appear in output, not just file names vitest run --reporter=json | jq '.testResults[].assertionResults' ``` If you see test files listed as single entries rather than individual test cases, you likely have configuration issues that need to be resolved before proceeding. You can validate your test reports using the [Trunk Analytics CLI](https://docs.trunk.io/flaky-tests/uploader). If you don't have it installed already, you can install and run the `validate` command like this: #### **The Validate Command** {% tabs %} {% tab title="Linux (x64)" %} ```bash 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)" %} ```bash 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)" %} ```bash 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)" %} ```bash 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 %} **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 curl -fL --retry 3 "https://github.com/trunk-io/analytics-cli/releases/latest/download/trunk-analytics-cli-x86_64-unknown-linux.tar.gz" | tar -xz && chmod +x trunk-analytics-cli ./trunk-analytics-cli upload --junit-paths "./junit.xml" \ --org-url-slug \ --token ``` You can find your Trunk organization slug and token in the settings or by following these [instructions](https://docs.trunk.io/flaky-tests/get-started/ci-providers/otherci#id-1.-store-a-trunk_token-secret-in-your-ci-system). 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:
Azure DevOps Pipelinesazure-devops-pipelinesazure.png
BitBucket Pipelinesbitbucket-pipelinesbitbucket.png
BuildKitebuildkitebuildkite.png
CircleCIcirclecicircle-ci.png
Drone CIdronecidrone.png
GitHub Actionsgithub-actionsgithub.png
GitLabgitlabgitlab.png
Jenkinsjenkinsjenkins.png
Semaphoresemaphorecisemaphore.png
TeamCityhttps://github.com/trunk-io/docs/blob/main/flaky-tests/get-started/frameworks/broken-reference/README.mdteamcity.png
Travis CItraviscitravis.png
Other CI Providersotherciother.png
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.trunk.io/flaky-tests/get-started/frameworks/vitest.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.