README.md

allure-mocha

Allure framewok integration for Mocha framework

• 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

---

Allure API doesn't work in parallel mode! If you want to use the functionality, please switch back to single thread mode!

Installation

npm i allure-mocha mocha --save-dev

or via yarn:

yarn add allure-mocha mocha --dev

Note that it's recommended to add the following dependencies as well for better user experience:

• typescript
• mocha-typescript
• source-map-support

Usage

Either add allure-mocha into mocha.opts:

--reporter allure-mocha

Or pass the same value via commandline / scripts:

mocha -R allure-mocha

If you want to provide extra information, such as steps and attachments, import the allure object into your code:

const { allure } = require("allure-mocha/runtime");

it("is a test", () => {
  allure.epic("Some info");
});

Parameters usage

const { allure } = require("allure-mocha/runtime");

it("is a test", () => {
  allure.parameter("parameterName", "parameterValue");
});

Also parameter method takes an third optional argument with the hidden and excluded options: mode: "hidden" | "masked" - masked hide parameter value to secure sensitive data, and hidden entirely hide parameter from report

excluded: true - excludes parameter from the history

import { allure } from "allure-mocha/runtime";

it("is a test", () => {
  allure.parameter("parameterName", "parameterValue", {
    mode: "hidden",
    excluded: true,
  });
});

Decorators Support

To make tests more readable and avoid explicit API calls, you can use a special extension - ts-test-decorators.

Examples

mocha-allure-example - minimal setup for using mocha with allure