README.md

allure-codeceptjs

Allure framework integration for CodeceptJS

• 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

---

The documentation and examples

The docs for Allure CodeceptJS are available at https://allurereport.org/docs/codeceptjs/.

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

Installation

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

npm install -D allure-codeceptjs

Usage

Enable the allure plugin in the CodeceptJS configuration file:

module.exports.config = {
  plugins: {
    allure: {
      enabled: true,
      require: "allure-codeceptjs",
    },

    // Other plugins...
  },

  // Other CodeceptJS options...
};

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 plugin's behavior 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 Allure API:

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

Feature("Signing in with a password");
Scenario("Signing in with a correct 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.tags("signin", "ui", "positive");
    await allure.issue("https://github.com/allure-framework/allure-js/issues/673", "ISSUE-673");
    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/codeceptjs-reference/.