This page outlines how the Launchable CLI interfaces with Jest.
This is a reference page. See Getting started, Sending data to Launchable, and Subsetting your test runs for more comprehensive usage guidelines.

Recording test results

After running tests, point the CLI to your test report files to collect test results and train a model:
# install jest-junit reporter
npm install jest-junit --save-dev
# or
yarn add --dev jest-junit
# configure jest-junit to include file paths in test reports
export JEST_JUNIT_SUITE_NAME="{filepath}"
# run tests with jest-junit
jest --ci --reporters=default --reporters=jest-junit
# send test results to Launchable
launchable record tests --build <BUILD NAME> jest your-junit.xml
  • By default, jest-junit's report file is saved to ./junit.xml, but that might be different depending on how your Jest project is configured.
  • You can specify multiple directories if you do multi-project build.

Configure environment valiables

You need to configure jest-junit to include file paths in reports. To specify it, set the JEST_JUNIT_SUITE_NAME environment variable like bellow.
Recommended config:
export JEST_JUNIT_CLASSNAME="{classname}"
export JEST_JUNIT_TITLE="{title}"
export JEST_JUNIT_SUITE_NAME="{filepath}"
Minimum config:
export JEST_JUNIT_SUITE_NAME="{filepath}"

Configure package.json

Or add the below lines to your package.json. The detail is the jest-junit section.
Recommended config:
// package.json
"jest-junit": {
"suiteNameTemplate": "{filepath}",
"classNameTemplate": "{classname}",
"titleTemplate": "{title}"
Minimum config:
// package.json
"jest-junit": {
"suiteNameTemplate": "{filepath}"
You might need to take extra steps to make sure that launchable record tests always runs even if the build fails. See Always record tests.

Subsetting your test runs

The high level flow for subsetting is:
  1. 1.
    Get the full list of tests/test paths and pass that to launchable subset with an optimization target for the subset
  2. 2.
    launchable subset will get a subset from the Launchable platform and output that list to a text file
  3. 3.
    Pass the text file into your test runner to run only those tests
To retrieve a subset of tests, first use jest --listTests to list all the tests you would normally run and pass that to launchable subset:
jest --listTests | launchable subset \
--build <BUILD NAME> \
--confidence <TARGET> \
--base $(pwd)
jest > launchable-subset.txt
  • The --build should use the same <BUILD NAME> value that you used before in launchable record build.
  • The --confidence option should be a percentage; we suggest 90% to start. You can also use --time or --target; see Subsetting your test runs for more info.
This creates a file called launchable-subset.txt that you can pass into your command to run tests:
jest $(< launchable-subset.txt)
Last modified 10d ago