Jasmine

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

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

Before integrating with Trunk, you need to generate Trunk-compatible reports. For Jasmine, the easiest approach is to generate XML reports.

First, install the jasmine-reporters package:

npm install --save-dev jasmine-reporters

In-Browser tests

When used for in-browser tests, the reporters are registered on a jasmineReporters object in the global scope (i.e. window.jasmineReporters). You can register it like this in your Jasmine config under /spec/support/jasmine.mjs:

import jasmineReporters from 'jasmine-reporters';

var junitReporter = new jasmineReporters.JUnitXmlReporter({
    savePath: "test-reports",
    consolidateAll: false
});
jasmine.getEnv().addReporter(junitReporter);

NodeJS

In Node.js, jasmine-reporters exports an object with all the reporters. You can register it like this in your Jasmine config under /spec/support/jasmine.mjs:

var reporters = require('jasmine-reporters');
var junitReporter = new reporters.JUnitXmlReporter({
    savePath: "test-reports",
    consolidateAll: false
});
jasmine.getEnv().addReporter(junitReporter)

Report File Path

Jasmine will generate an XML report at the location specified by the savePath property. In the examples above, the XML report can be located 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.

If you’re using a package like protractor-flake, disable it to get more accurate results from Trunk. Instead, you can mitigate flaky tests using the Quarantining feature in Trunk.

Try It Locally

The Validate Command

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:

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-reports/*.xml"

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-reports/*.xml"

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-reports/*.xml"

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-reports/*.xml"

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:

./trunk-analytics-cli flakytests upload --junit-paths "./junit-reports/*.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:

Azure DevOps Pipelines		azure-devops-pipelines	azure.png
BitBucket Pipelines		bitbucket-pipelines	bitbucket.png
BuildKite		buildkite	buildkite.png
CircleCI		circleci	circle-ci.png
Drone CI		droneci	drone.png
GitHub Actions		github-actions	github.png
Gitlab		gitlab	gitlab.png
Jenkins		jenkins	jenkins.png
Semaphore		semaphoreci	semaphore.png
TeamCity		https://github.com/trunk-io/docs/blob/main/flaky-tests/get-started/frameworks/broken-reference/README.md	teamcity.png
Travis CI		travisci	travis.png
Other CI Providers		otherci	other.png