jest-circus-allure-environment

Jest Circus Allure Environment

A Jest Circus environment for Allure reporting.

Requirements

Resource	Description
Jest	A delightful JavaScript testing framework.
Allure 2 CLI	"A Java jar command line tool that turns Allure result files into beautiful Allure reports."

:rocket: Quick start

1. Add this package

yarn add --dev jest-circus-allure-environment

1. Update jest.config.js

See the testEnvironment docs for configuration details.

{
  "testEnvironment": ["jest-circus-allure-environment"],
  "testRunner": "jest-circus/runner"
}

1. Run tests

yarn test

1. Open the Allure report

allure serve ./allure-results

Allure reporting in your tests

To provide more information in your reports you can call allure from your tests. For types support you'll need some additional configuration.

// simple.test.js

test('2 + 3 is 5', () => {
  allure.epic('Implement addition functionality')
  allure.tag('Accounting')

  expect(2 + 3).toBe(5)
})

Typescript & Intellisense setup

1. Support Typescript & intellisense by loading the module into your jest.setup.js file

// jest.setup.js

import 'jest-circus-allure-environment' // Typescript or ESM
require('jest-circus-allure-environment') // CommonJS

1. Make sure your jest.setup.js file is properly configured.

See the setupFilesAfterEnv docs for configuration details.

// jest.config.js

{
  "setupFilesAfterEnv": ["./jest.setup.js"]
}