What is jest-allure2-reporter?

This library connects Jest tests with Allure Framework to generate rich, interactive test reports that provide:

• Clear test execution flows with step-by-step breakdowns
• Attachments (screenshots, logs, data)
• Historical test data and trends
• Comprehensive context for easier debugging

Watch how jest-allure2-reporter turns test investigations into detective stories with every clue clearly laid out

As shown in the video, you can easily:

• Add metadata with docblock pragmas or the programmatic API
• Automatically track steps and attach artifacts using decorators
• Organize your tests with powerful configuration options

Quick Installation

1npm install --save-dev jest-allure2-reporter

Configure Jest (e.g., in jest.config.js):

1/** @type {import('@jest/types').Config.InitialOptions} */
2module.exports = {
3  // Add to your existing configuration
4  reporters: [
5    'default', // Keep for console output
6    'jest-allure2-reporter',
7  ],
8  testEnvironment: 'jest-allure2-reporter/environment-node',
9  // Or for browser testing: 'jest-allure2-reporter/environment-jsdom'
10};

Key Features

• Test Steps: Define and visualize test steps using the @Step decorator
• Rich Attachments: Add screenshots, logs, JSON data, etc. to your test reports
• Test Metadata: Enhance reports with descriptions, links, tags, and more
• TypeScript Support: Comprehensive type definitions for better development
• Visual Regression: Support for image snapshot comparisons and diff visualization

Basic Usage

1// my-page.ts
2import { allure, Step } from 'jest-allure2-reporter/api';
3
4export class MyPage {
5  @Step('Load user data for ID: {{userId}}')
6  async loadUserData(userId: string) {
7    // Fetch data logic...
8    const userData = { name: 'John Doe', id: userId };
9
10    // Add JSON attachment
11    allure.attachment('User Data', JSON.stringify(userData, null, 2), 'application/json');
12    return userData;
13  }
14}
15
16// my.test.ts
17import { allure } from 'jest-allure2-reporter/api';
18import { MyPage } from './my-page';
19
20describe('User Profile', () => {
21  const page = new MyPage();
22
23  it('should load user data correctly', async () => {
24    // Add metadata
25    allure.feature('Profile');
26    allure.severity('critical');
27
28    const userData = await page.loadUserData('user123');
29    expect(userData.name).toBe('John Doe');
30  });
31});

Generating Reports

After running your tests, generate the Allure report:

1# Install Allure command line if needed
2npm install -g allure-commandline
3
4# Generate and open report
5allure generate allure-results --clean
6allure open

For CI environments:

1ALLURE_NO_ANALYTICS=1 allure generate allure-results --clean

Core Features

Test Steps with @Step

1@Step('Add item "{{itemName}}" to cart')
2async addItemToCart(itemName: string, quantity: number) {
3  allure.parameter('Quantity', quantity);
4  // Implementation...
5}

Attachments

1// Direct attachment
2allure.attachment('Screenshot', screenshotBuffer, 'image/png');
3
4// Method decorator
5@Attachment('Order Details', 'application/json')
6getOrderDetails() {
7  return JSON.stringify(this.orderData);
8}
9
10// File attachment
11@FileAttachment('Invoice', 'application/pdf')
12getInvoicePath() {
13  return '/path/to/invoice.pdf';
14}

Test Metadata

1// Runtime API
2allure.epic('User Management');
3allure.feature('Registration');
4allure.tag('smoke', 'critical');
5allure.link('https://example.com/requirements/REQ-101', 'REQ-101');
6
7// Docblock annotations
8/**
9 * @epic Product Discovery
10 * @feature Product Details
11 * @severity blocker
12 */
13describe('Product Details', () => {
14  // Tests...
15});
16
17// BDD-style
18$Epic('E-commerce');
19$Feature('Shopping Cart');
20describe('Cart Functionality', () => {
21  // Tests...
22});

Configuration

For advanced configuration options including custom categories, environment details, and more, refer to our documentation.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

MIT License