# Karma You can automatically [detect and manage flaky tests](https://docs.trunk.io/flaky-tests/detection) in your Karma projects by integrating with Trunk. This document explains how to configure Karma 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 XML reports from your test runs. To generate a Trunk-compatible XML report, install the `karma-junit-reporter` package: ```shell npm install --save-dev karma-junit-reporter ``` Add the `junit` reporter to your karma config file: {% code title="karma.conf.js" %} ```javascript module.exports = function(config) { config.set( { reporters: ['junit'], junitReporter: { outputDir: 'test-reports', } } ) } ``` {% endcode %} #### Report File Path The `outputDir` and `outputFile` specify the location of the JUnit test report. In the example above, the JUnit would be at `./test-reports/{$browserName}.xml`. You can locate the reports during uploads with the glob `./test-reports/*.xml`. #### Disable Retries You need to disable automatic retries if you previously enabled them. Retries compromise the accurate detection of flaky tests. Karma doesn't support retries out of the box, but if you implemented retries, remember to disable them. ### Try It Locally #### The Validate Command 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: {% 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-reports/*.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-reports/*.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-reports/*.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-reports/*.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 ./trunk-analytics-cli upload --junit-paths "./junit-reports/*.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 Steps Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:
Atlassian Bambooatlassian-bamboo
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/.gitbook/includes/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/karma.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.