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

# Getting started with Allure CodeceptJS

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

Generate beautiful HTML reports using [Allure Report](https://allurereport.org/docs/) and your [CodeceptJS](https://codecept.io/) tests.

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%3Acodeceptjs) to see Allure CodeceptJS in action.

## Setting up

### 1. Prepare your project

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

   Allure CodeceptJS 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 CodeceptJS integration.

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

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

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

1. In your [`codecept.conf.js`](https://codecept.io/configuration/) file, enable the `allure` plugin.

   ```js
   exports.config = {
     tests: "tests/**.test.js",
     plugins: {
       allure: {
         enabled: true,
         require: "allure-codeceptjs",
       },
     },
   };
   ```

### 2. Run tests

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

**npm:**
```bash
npx codeceptjs run
```

**yarn:**
```bash
yarn run codeceptjs run
```

**pnpm:**
```bash
pnpx codeceptjs run
```

This will save necessary data into `allure-results` or other directory, according to the [configuration](/docs/codeceptjs-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 CodeceptJS integration extends the standard reporting features of CodeceptJS 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.
- **Environment Details**: Include comprehensive [environment information](#environment-information) to accompany the test report.

In most cases, Allure CodeceptJS provides two different ways to use a feature: the Runtime API and the Tags 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.

- **Tags API**: use the [`tag()`](https://codecept.io/advanced/#tags) method to assign various data to a particular scenario.

  Most of the tags require values. You can use either a colon or an equal sign to separate the value from the name, e.g., `@allure.label.epic:WebInterface` is identical to `@allure.label.epic=WebInterface`.

  When using this approach, the data is guaranteed to be added to the test result 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/codeceptjs-reference/#metadata) for an exhaustive list of what can be added.

**Runtime API:**
```js
const allure = require("allure-js-commons");

Feature("Test My Website");

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

**Tags API:**
```js
Feature("Test My Website");

Scenario("Test Authentication", async () => {
  // ...
})
  .tag("@allure.label.owner:JohnDoe")
  .tag("@allure.label.severity:critical");
  .tag("Web interface")
  .tag("Authentication")
```

### 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
const allure = require("allure-js-commons");

Feature("Test My Website");

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

**Tags API:**
```js
Feature("Test My Website");

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

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

**Runtime API:**
```js
const allure = require("allure-js-commons");

Feature("Test My Website");

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

**Tags API:**
```js
Feature("Test My Website");

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

### Divide a test into steps

To [create steps and sub-steps](/docs/steps/), you can use the `step()` function, see the [reference](/docs/codeceptjs-reference/#test-steps).

```js
const allure = require("allure-js-commons");
const { Status } = require("allure-js-commons");

Feature("Test My Website");

Scenario("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

If you use the [parametrized tests](/docs/v2/readability/#parametrized-tests) pattern, call the `allure.parameter()` function to add the parameters to the test report, see the [reference](/docs/codeceptjs-reference/#parametrized-tests).

```js
const allure = require("allure-js-commons");

Feature("Test My Website");

let accounts = new DataTable(["login", "password"]);
accounts.add(["johndoe", "qwerty"]);
accounts.add(["admin", "qwerty"]);

Data(accounts).Scenario("Test Authentication", async ({ current }) => {
  await allure.parameter("Login", current.login);
  await allure.parameter("Password", current.password);
  // ...
});
```

### Set labels globally

Any [labels](/docs/codeceptjs-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
npx codeceptjs run
```

**Windows:**
```powershell
$Env:ALLURE_LABEL_epic = "WebInterface"
npx codeceptjs run
```

### 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 CodeceptJS reference](/docs/codeceptjs-reference/#attachments).

```js
const allure = require("allure-js-commons");
const { ContentType } = require("allure-js-commons");

Feature("Test My Website");

Scenario("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

Danger:
Test plan is currently not supported by the Allure CodeceptJS integration.

### 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/codeceptjs-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
const { setCommonPlugins } = require("@codeceptjs/configure");
const os = require("node:os");

setCommonPlugins();

/** @type {CodeceptJS.MainConfig} */
exports.config = {
  tests: "tests/**/*.js",
  plugins: {
    allure: {
      enabled: true,
      require: "allure-codeceptjs",
      environmentInfo: {
        os_platform: os.platform(),
        os_release: os.release(),
        os_version: os.version(),
        node_version: process.version,
      },
    },
  },
};
```

Note that if your launch includes multiple CodeceptJS runs (see [How it works](/docs/how-it-works/)), Allure CodeceptJS will only save the environment information from the latest run.