Karma
A guide for generating Trunk-compatible test reports for Karma tests
Last updated
A guide for generating Trunk-compatible test reports for Karma tests
Last updated
You can automatically detect and manage flaky tests 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.
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 karma-junit-reporter
package:
Add the junit
reporter to your karma config file:
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
.
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.
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:
This will not upload anything to Trunk. To improve detection accuracy, you should address all errors and warnings before proceeding to the next steps.
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:
Configure your CI to upload test runs to Trunk. Find the guides for your CI framework below:
By the end of this guide, you should achieve the following before proceeding to the next steps to configure your CI provider.
After correctly generating reports following the above steps, you'll be ready to move on to the next steps to configure uploads in CI.