Getting started with Allure Jest

Generate beautiful HTML reports with Allure Report and your Jest tests. Both the Node.js and jsdom environments are supported.

The integration works with Jest 24.8 or higher. However, it relies on the Circus runner (which is the default in Jest 27 or higher). If your project uses the Jasmine runner, and you can't switch to Circus, please use the Allure Jasmine integration instead.

INFO

Check out the example projects at github.com/allure-examples to see Allure Jest in action.

Setting up

1. Prepare your project

Make sure Node.js is installed.
Allure Jest is tested against Node.js 18 and higher. Older versions may work, but we can't guarantee that.
Open a terminal and go to the project directory. For example:
bash
```
cd /home/user/myproject
```
Make sure Allure Report is installed. If it's not, follow the installation instructions. Note that Allure Report requires Java.

Install the Allure Jest integration.

npmyarnpnpm

bash

npm install --save-dev allure-jest

bash

yarn add --dev allure-jest allure-js-commons

bash

pnpm add -D allure-jest

Allure Jest supports two Jest environments: jest-environment-node and jest-environment-jsdom. Make sure to install the one you plan to use. For example:
npmyarnpnpm
bash
```
npm install --save-dev jest-environment-node
```
bash
```
yarn add --dev jest-environment-node
```
bash
```
pnpm add -D jest-environment-node
```
WARNING
The version of the jest-environment-node or jest-environment-jsdom package must match the version of the jest package, otherwise the integration may not work.
If you're a Yarn PnP user, don't skip this step even if you use jest-environment-node (which is installed automatically with Jest). Otherwise, you will observe the following error:
allure-jest tried to access jest-environment-node (a peer dependency) but it isn't provided by your application; this makes the require call ambiguous and unsound.
If the Jest version is lower than 27, install Circus and configure Jest to use it as the test runner.
npmyarnpnpm
bash
```
npm install --save-dev jest-circus
```
bash
```
yarn add --dev jest-circus
```
bash
```
pnpm add -D jest-circus
```
js
```
const config = {
  testRunner: "jest-circus/runner",
};
```
WARNING
The version of the jest-circus package must match the version of the jest package, otherwise the integration may not work.
In the Jest configuration file, e.g., jest.config.js, set the appropriate test environment.
For client-side testsFor server-side tests
js
```
const config = {
  testEnvironment: "allure-jest/jsdom",
};
```
js
```
const config = {
  testEnvironment: "allure-jest/node",
};
```

2. Run tests

Run your Jest tests the same way as you would run them usually. For example:

npmyarnpnpm

bash

npm test

bash

yarn test

bash

pnpm test

This will save necessary data into allure-results or other directory, according to the configuration. If the directory already exists, the new files will be added to the existing ones, so that a future report will be based on them all.

3. Generate a report

Finally, convert the test results into an HTML report. This can be done by one of two commands:

allure generate processes the test results and saves an HTML report into the allure-report directory. To view the report, use the allure open command.
allure serve creates the same report as allure generate, then automatically opens the main page of the report in a web browser.

Writing tests

The Allure Jest integration extends the standard reporting features of Jest by providing additional capabilities for crafting more informative and structured tests. This section highlights key enhancements that can be utilized:

Metadata Annotation: Enhance test reports with descriptions, links, and other metadata.
Test Organization: Structure your tests into clear hierarchies for better readability and organization organize tests.
Step Division: Break down tests into smaller test steps for easier understanding and maintenance.
Parametrized Tests: Clearly describe the parameters for parametrized tests to specify different scenarios.
Set labels globally: Use environment variables to set metadata and other labels.
Attachments: Automatically capture screenshots and other files during test execution.
Test Selection: Use a test plan file to select which tests to run, allowing for flexible test execution.
Environment Details: Include comprehensive environment information to accompany the test report.

In most cases, Allure Jest provides two different ways to use a feature: the Runtime API and the Metadata API.

Runtime API: use Allure's functions to add certain data to the test result during its execution. This approach allows for constructing the data dynamically.
Note that it is recommended to call the Allure's functions as close to the beginning of the test as possible. This way, the data will be added even if the test fails early.
Metadata API: add a metadata tag (beginning with @) into the test name. Allure Jest will extract it and update the test result's data accordingly. When using this approach, the data is guaranteed to be added regardless of how the test itself runs.

Add Metadata

Allure allows you to enrich your reports with a variety of metadata. This additional information provides context and details for each test, enhancing the report's usefulness. Refer to the metadata reference section for an exhaustive list of what can be added.

Runtime APIMetadata API

import * as allure from "allure-js-commons";

it("Test Authentication", async () => {
  await allure.owner("John Doe");
  await allure.tags("Web interface", "Authentication");
  await allure.severity("critical");
  // ...
});

it(
  "Test Authentication" +
    " @allure.label.owner:JohnDoe" +
    " @allure.label.tag:WebInterface" +
    " @allure.label.tag:Authentication" +
    " @allure.label.severity:critical",
  async () => {
    // ...
  },
);

Organize tests

As described in Improving navigation in your test report, Allure supports multiple ways to organize tests into hierarchical structures.

To specify a test's location in the behavior-based hierarchy:

Runtime APIMetadata API

import * as allure from "allure-js-commons";

it("Test Authentication", async () => {
  await allure.epic("Web interface");
  await allure.feature("Essential features");
  await allure.story("Authentication");
  // ...
});

it(
  "Test Authentication" +
    " @allure.label.epic:WebInterface" +
    " @allure.label.feature:EssentialFeatures" +
    " @allure.label.story:Authentication",
  async () => {
    // ...
  },
);

To specify a test's location in the suite-based hierarchy:

Runtime APIMetadata API

import * as allure from "allure-js-commons";

it("Test Authentication", async () => {
  await allure.parentSuite("Tests for web interface");
  await allure.suite("Tests for essential features");
  await allure.subSuite("Tests for authentication");
  // ...
});

it(
  "Test Authentication" +
    " @allure.label.parentSuite:TestsForWebInterface" +
    " @allure.label.suite:TestsForEssentialFeatures" +
    " @allure.label.subSuite:TestsForAuthentication",
  async () => {
    // ...
  },
);

Divide a test into steps

To create steps and sub-steps, you can use the step() function, see the reference.

import * as allure from "allure-js-commons";
import { Status } from "allure-js-commons";

it("Test Authentication", async () => {
  await allure.step("Step 1", async () => {
    await allure.step("Sub-step 1", async (ctx) => {
      await ctx.parameter("foo", "1");
      // ...
    });
    await allure.step("Sub-step 2", async (ctx) => {
      await ctx.parameter("foo", "2");
      // ...
    });
  });
  await allure.logStep("Step 2", Status.SKIPPED);
});

Describe parametrized tests

A typical way to implement the parametrized tests pattern in Jest is via the test.each() function.

To display a parameter value in the test report, pass it to the parameter() function.

import * as allure from "allure-js-commons";

test.each([["johndoe"], ["[email protected]"]])("Test Authentication as %s", async (login) => {
  await allure.parameter("login", login);
  await allure.parameter("time", new Date().toUTCString(), { excluded: true });
  // ...
});

Set labels globally

Any labels, including custom ones, can be set via the environment variables in your operating system. Here's an example (assuming you use the npm package manager):

MacOS/LinuxWindows

bash

export ALLURE_LABEL_epic=WebInterface
npm test

powershell

$Env:ALLURE_LABEL_epic = "WebInterface"
npm test

Attach screenshots and other files

In Allure reports, you have the ability to attach various types of files, which can greatly enhance the comprehensibility of the report. A common practice is to attach screenshots that capture the state of the user interface at specific moments during test execution.

For detailed instructions on how to implement attachments, refer to the attachments section in the Allure Jest reference.

import * as allure from "allure-js-commons";
import { ContentType } from "allure-js-commons";

it("Test Authentication", async () => {
  // ...

  await allure.attachment("Text file", "This is the file content.", ContentType.TEXT);

  await allure.attachmentPath("Screenshot", "/path/to/image.png", {
    contentType: ContentType.PNG,
    fileExtension: "png",
  });
});

Select tests via a test plan file

If the ALLURE_TESTPLAN_PATH environment variable is defined and points to an existing file, Jest will only run tests listed in this file.

Here's an example of running tests according to a file named testplan.json (assuming you use the npm package manager):

MacOS/LinuxWindows

bash

export ALLURE_TESTPLAN_PATH=testplan.json
npm test

powershell

$Env:ALLURE_TESTPLAN_PATH = "testplan.json"
npm test

Environment information

For the main page of the report, you can collect various information about the environment in which the tests were executed. To do so, edit the environmentInfo object in the configuration.

For example, it is a good idea to use this to remember the OS version and Node.js version retrieved from the os and process objects. This may help the future reader investigate bugs that are reproducible only in some environments.

import { Status } from "allure-js-commons";
import os from "node:os";

export default {
  testEnvironment: "allure-jest/node",
  testEnvironmentOptions: {
    environmentInfo: {
      os_platform: os.platform(),
      os_release: os.release(),
      os_version: os.version(),
      node_version: process.version,
    },
  },
};

Note that if your launch includes multiple Jest runs (see How it works), Allure Jest will only save the environment information from the latest run.

Install & Upgrade

Install & Upgrade

Getting started with Allure Jest

Setting up

1. Prepare your project

2. Run tests

3. Generate a report

Writing tests

Add Metadata

Organize tests

Divide a test into steps

Describe parametrized tests

Set labels globally

Attach screenshots and other files

Select tests via a test plan file

Environment information

Powered by

Subscribe to our newsletter

Allure TestOps

Company

Getting started with Allure Jest ​

Setting up ​

1. Prepare your project ​

2. Run tests ​

3. Generate a report ​

Writing tests ​

Add Metadata ​

Organize tests ​

Divide a test into steps ​

Describe parametrized tests ​

Set labels globally ​

Attach screenshots and other files ​

Select tests via a test plan file ​

Environment information ​

Powered by

Subscribe to our newsletter

Allure TestOps

Company

Getting started with Allure Jest

Setting up

1. Prepare your project

2. Run tests

3. Generate a report

Writing tests

Add Metadata

Organize tests

Divide a test into steps

Describe parametrized tests

Set labels globally

Attach screenshots and other files

Select tests via a test plan file

Environment information