---
title: Jest
description: Learn how to integrate Allure with Jest to generate rich, interactive test reports. Follow step-by-step setup, test execution, and report generation guidance.
---

# Getting started with Allure Jest

[![Allure Jest npm latest version](https://img.shields.io/npm/v/allure-jest?style=flat "Allure Jest npm latest version")](https://www.npmjs.com/package/allure-jest)

Generate beautiful HTML reports with [Allure Report](https://allurereport.org/docs/) and your [Jest](https://jestjs.io/) 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](https://www.npmjs.com/package/jest-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](/docs/jasmine/) integration instead.

Info:
Check out the example projects at [github.com/allure-examples](https://github.com/orgs/allure-examples/repositories?q=visibility%3Apublic+archived%3Afalse+topic%3Aexample+topic%3Ajest) to see Allure Jest in action.

## Setting up

### 1. Prepare your project

1. Make sure [Node.js](https://nodejs.org/) is installed.

   Allure Jest is tested against Node.js 18 and higher. Older versions may work, but we can't guarantee that.

1. Open a terminal and go to the project directory. For example:

   ```bash
   cd /home/user/myproject
   ```

1. Make sure Allure Report is installed. If it's not, follow the [installation instructions](/docs/v2/install/). Note that Allure Report requires Java.

1. Install the Allure Jest integration.

   **npm:**
   ```bash
   npm install --save-dev allure-jest
   ```

   **yarn:**
   ```bash
   yarn add --dev allure-jest allure-js-commons
   ```

   **pnpm:**
   ```bash
   pnpm install --dev allure-jest
   ```

1. 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:

   **npm:**
   ```bash
   npm install --save-dev jest-environment-node
   ```

   **yarn:**
   ```bash
   yarn add --dev jest-environment-node
   ```

   **pnpm:**
   ```bash
   pnpm install --dev 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.

1. If the Jest version is lower than 27, install Circus and configure Jest to use it as the test runner.

   **npm:**
   ```bash
   npm install --save-dev jest-circus
   ```

   **yarn:**
   ```bash
   yarn add --dev jest-circus
   ```

   **pnpm:**
   ```bash
   pnpm install --dev 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.

1. In the [Jest configuration file](https://jestjs.io/docs/configuration), e.g., `jest.config.js`, set the appropriate test environment.

   **For client-side tests:**
   ```js
   const config = {
     testEnvironment: "allure-jest/jsdom",
   };
   ```

   **For server-side tests:**
   ```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:

**npm:**
```bash
npm test
```

**yarn:**
```bash
yarn test
```

**pnpm:**
```bash
pnpm test
```

This will save necessary data into `allure-results` or other directory, according to the [configuration](/docs/jest-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](#add-metadata).
- **Test Organization**: Structure your tests into clear hierarchies for better readability and organization [organize tests](#organize-tests).
- **Step Division**: Break down tests into smaller [test steps](#divide-a-test-into-steps) for easier understanding and maintenance.
- **Parametrized Tests**: Clearly describe the parameters for [parametrized tests](#describe-parametrized-tests) to specify different scenarios.
- **Set labels globally**: Use [environment variables](#set-labels-globally) to set metadata and other labels.
- **Attachments**: Automatically capture [screenshots and other files](#attach-screenshots-and-other-files) during test execution.
- **Test Selection**: Use a test plan file to [select which tests to run](#select-tests-via-a-test-plan-file), allowing for flexible test execution.
- **Environment Details**: Include comprehensive [environment information](#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](/docs/v2/readability/#description-links-and-other-metadata). This additional information provides context and details for each test, enhancing the report's usefulness. Refer to the [metadata reference section](/docs/jest-reference/#metadata) for an exhaustive list of what can be added.

**Runtime API:**
```js
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");
  // ...
});
```

**Metadata API:**
```js
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](/docs/v2/navigation/), Allure supports multiple ways to organize tests into hierarchical structures.

To specify a test's location in the [behavior-based hierarchy](/docs/v2/navigation/#behavior-based-hierarchy):

**Runtime API:**
```js
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");
  // ...
});
```

**Metadata API:**
```js
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](/docs/v2/navigation/#suite-based-hierarchy):

**Runtime API:**
```js
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");
  // ...
});
```

**Metadata API:**
```js
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](/docs/steps/), you can use the `step()` function, see the [reference](/docs/jest-reference/#test-steps).

```js
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](/docs/v2/readability/#parametrized-tests) pattern in Jest is via the [`test.each()`](https://jestjs.io/docs/api#testeachtablename-fn-timeout) function.

To display a parameter value in the test report, pass it to the [`parameter()`](/docs/jest-reference/#parametrized-tests) function.

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

test.each([["johndoe"], ["johndoe@example.com"]])("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](/docs/jest-reference/#label), 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/Linux:**
```bash
export ALLURE_LABEL_epic=WebInterface
npm test
```

**Windows:**
```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](/docs/attachments/), 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](/docs/jest-reference/#attachments).

```js
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/Linux:**
```bash
export ALLURE_TESTPLAN_PATH=testplan.json
npm test
```

**Windows:**
```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`](/docs/vitest-configuration/#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`](https://nodejs.org/api/os.html) and [`process`](https://nodejs.org/api/process.html) objects. This may help the future reader investigate bugs that are reproducible only in some environments.

Images: /images/js/environment-allure3.png, /images/js/environment-allure2.png

```js
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](/docs/how-it-works/)), Allure Jest will only save the environment information from the latest run.