allure-js-commons

What is allure-js-commons?

The allure-js-commons package is a JavaScript library that provides a common set of utilities for generating Allure reports. Allure is a flexible, lightweight multi-language test report tool that not only shows a very concise representation of what has been tested in a neat web report form but also allows everyone participating in the development process to extract maximum of useful information from everyday execution of tests.

What are allure-js-commons's main functionalities?

Creating Test Suites

This feature allows you to create and manage test suites. The code sample demonstrates how to start and end a test suite using the AllureRuntime and InMemoryAllureWriter.

const { AllureRuntime, InMemoryAllureWriter } = require('allure-js-commons');
const runtime = new AllureRuntime({ writer: new InMemoryAllureWriter() });
const suite = runtime.startGroup('My Test Suite');
suite.endGroup();

Logging Test Steps

This feature allows you to log individual test steps within a test case. The code sample demonstrates how to start and end a test step within a test case.

const { AllureRuntime, InMemoryAllureWriter } = require('allure-js-commons');
const runtime = new AllureRuntime({ writer: new InMemoryAllureWriter() });
const test = runtime.startTest('My Test');
const step = test.startStep('My Step');
step.endStep();
test.endTest();

Attaching Files

This feature allows you to attach files to your test cases. The code sample demonstrates how to attach a screenshot to a test case.

const { AllureRuntime, InMemoryAllureWriter } = require('allure-js-commons');
const runtime = new AllureRuntime({ writer: new InMemoryAllureWriter() });
const test = runtime.startTest('My Test');
test.addAttachment('Screenshot', 'image/png', Buffer.from('...'));
test.endTest();

Other packages similar to allure-js-commons

mochawesome

Mochawesome is a custom reporter for use with the JavaScript testing framework, Mocha. It generates a standalone HTML/CSS report to help visualize your test results. Compared to allure-js-commons, mochawesome is more tightly integrated with Mocha and provides a more visually appealing report out of the box.

jest-html-reporter

jest-html-reporter is a Jest test results processor that creates a simple HTML report. It is specifically designed for use with Jest, whereas allure-js-commons is more flexible and can be used with multiple testing frameworks.

cucumber-html-reporter

cucumber-html-reporter is a Cucumber.js reporter that generates a HTML report. It is specifically designed for use with Cucumber.js, while allure-js-commons supports multiple testing frameworks and provides more detailed reporting capabilities.

README

allure-js-commons

Common utilities for Allure framework JavaScript integrations

• 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

---

Interface for Allure to be used from Javascript and TypeScript. There you can find primitives to create custom integrations for the javascript testing frameworks.

API Overview

Labels environment variables

Allure allows to use environment variables for setting test labels. Using ALLURE_LABEL_{{labelName}}={{labelValue}} syntax you can set common labels for all of your tests.

Examples

ALLURE_LABEL_epic="Story 1" npm test