README.md

allure-jest

Allure framework integration for Jest

• Learn more about Allure Report at https://allurereport.org
• 📚 Documentation – discover official documentation for Allure Report
• ❓ Questions and Support – get help from the team and community
• 📢 Official annoucements – be in touch with the latest updates
• 💬 General Discussion – engage in casual conversations, share insights and ideas with the community

---

Warning This package only works with the jest-circus test runner for Jest. It's the default runner for Jest starting from 27.0.0. If you use jest@<27.0.0, you should install jest-circus manually and set the testRunner Jest option to "jest-circus/runner". If you're a jest-jasmine2 user, consider switching to jest-circus. If that's not an option for you, please use allure-jasmine instead.

The documentation and examples

The docs for Allure Jest are available at https://allurereport.org/docs/jest/.

Also, check out the examples at github.com/allure-examples.

Installation

Install allure-jest using a package manager of your choice. For example:

npm install -D allure-jest

If you're a Yarn PnP user, you must also explicitly install the Jest environment package and allure-js-commons. For example:

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

Keep in mind, that allure-js-commons and allure-jest must have the same version. The same goes for all Jest packages (jest, jest-circus, jest-environment-node, etc). Use yarn info to check the versions.

Usage

Set the testEnvironment Jest option according to your needs:

• If you need access to DOM, set it to "allure-jest/jsdom" (make sure jest-environment-jsdom is installed).
• If you don't need access to DOM, set it to "allure-jest/node".

Example:

const config = {
  testEnvironment: "allure-jest/jsdom",
};

export default config;

When the test run completes, the result files will be generated in the ./allure-results directory.

You may select another location, or further customize the behavior of Allure Jest with the configuration options.

View the report

You need Allure Report to be installed on your machine to generate and open the report from the result files. See the installation instructions on how to get it.

Generate Allure Report after the tests are executed:

allure generate ./allure-results -o ./allure-report

Open the generated report:

allure open ./allure-report

Allure API

Enhance the report by utilizing the runtime API:

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

describe("signing in with a password", () => {
  it("should sign in with a valid password", async () => {
    await allure.description("The test checks if an active user with a valid password can sign in to the app.");
    await allure.epic("Signing in");
    await allure.feature("Sign in with a password");
    await allure.story("As an active user, I want to successfully sign in using a valid password");
    await allure.tags("signin", "ui", "positive");
    await allure.issue("https://github.com/allure-framework/allure-js/issues/4", "ISSUE-4");
    await allure.owner("eroshenkoam");
    await allure.parameter("browser", "chrome");

    const user = await allure.step("Prepare the user", async () => {
      return await createAnActiveUserInDb();
    });

    await allure.step("Make a sign-in attempt", async () => {
      await allure.step("Navigate to the sign in page", async () => {
        // ...
      });

      await allure.step("Fill the sign-in form", async (stepContext) => {
        await stepContext.parameter("login", user.login);
        await stepContext.parameter("password", user.password, "masked");

        // ...
      });

      await allure.step("Submit the form", async () => {
        // ...
        // const responseData = ...

        await allure.attachment("response", JSON.stringify(responseData), { contentType: "application/json" });
      });
    });

    await allure.step("Assert the signed-in state", async () => {
        // ...
    });
  });
});

More details about the API are available at https://allurereport.org/docs/jest-reference/.