allure

Allure reporter

Enables Allure reporter.

Usage

To start please install allure-commandline package (which requires Java 8)

npm install -g allure-commandline --save-dev

Add this plugin to config file:

"plugins": {
    "allure": {}
}

Run tests with allure plugin enabled:

codeceptjs run --plugins allure

By default, allure reports are saved to output directory. Launch Allure server and see the report like on a screenshot above:

allure serve output

Configuration

Parameters

retryFailedStep

Retries each failed step in a test.

Add this plugin to config file:

"plugins": {
    "runFailedStep": {
       "enabled": true
    }
}

Run tests with plugin enabled:

codeceptjs run --plugins retryFailedStep

Configuration:

This plugin is very basic so it's recommended to improve it to match your custom needs.

Parameters

screenshotOnFail

Creates screenshot on failure. Screenshot is saved into output directory.

Initially this functionality was part of corresponding helper but has been moved into plugin since 1.4

This plugin is enabled by default.

Configuration

Configuration can either be taken from a corresponding helper (deprecated) or a from plugin config (recommended).

"plugins": {
   "screenshotOnFail": {
     "enabled": true
   }
}

Possible config options:

Parameters

stepByStepReport

Generates step by step report for a test. After each step in a test a screenshot is created. After test executed screenshots are combined into slideshow. By default, reports are generated only for failed tests.

Run tests with plugin enabled:

codeceptjs run --plugins stepByStepReport

Configuration

"plugins": {
   "stepByStepReport": {
     "enabled": true
   }
}

Possible config options:

Allure Reports

If Allure plugin is enabled this plugin attaches each saved screenshot to allure report.

Parameters