Package Exports

cucumber-html-reporter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cucumber-html-reporter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cucumber-html-reporter

Generate Cucumber HTML reports with pie charts

Available HTML themes: ['bootstrap', 'foundation', 'simple']

Preview of HTML Reports

Snapshot of Bootstrap Report

Alt text

Install

npm install cucumber-html-reporter --save-dev

Usage

Provide Cucumber JSON report file created from your framework and this module will create pretty HTML reports. Choose your best suitable HTML theme and dashboard on your CI with available HTML reporter plugins.

Example of bootstrap theme:

var reporter = require('cucumber-html-reporter');

var options = {
        theme: 'bootstrap',
        jsonFile: 'test/report/cucumber_report.json',
        output: 'test/report/cucumber_report.html',
        reportSuiteAsScenarios: true
    };

    reporter.generate(options);

Plugin the above code to the cucumber's AfterFeatures hook as shown in test/features/step_definitions/hooks and pick the theme you are interested in.

This module converts Cucumber's JSON format to HTML reports. In order to generate JSON formats, run the Cucumber to create the JSON format and pass the file name to the formatter as shown below,

$ cucumberjs test/features/ -f json:test/report/cucumber_report.json

Multiple formatter are also supported,

$ cucumberjs test/features/ -f pretty -f json:test/report/cucumber_report.json

Are you using cucumber with other frameworks or running cucumber-parallel? Pass relative path of JSON file to the options as shown here

Options

`theme`

Available: ['bootstrap', 'foundation', 'simple'] Type: String

Select the Theme for HTML report.

`jsonFile`

Type: String

Provide path of the Cucumber JSON format file

`output`

Type: String

Provide HTML output file path and name

`reportSuiteAsScenarios`

Type: Boolean Supported in the Bootstrap theme.

true: Reports total number of passed/failed scenarios as HEADER.

false: Reports total number of passed/failed features as HEADER.

Tips

Attach Screenshots to HTML report

Capture and Attach screenshots to the Cucumber Scenario and HTML report will render the screenshot image

  
  driver.takeScreenshot().then(function (buffer) {
    return scenario.attach(new Buffer(buffer, 'base64'), 'image/png');
  }

Attach Plain Text to HTML report

Attach plain-texts/data to HTML report to help debug/review the results

 
  scenario.attach('test data goes here');

Attach pretty JSON to HTML report

Attach JSON to HTML report

 
  scenario.attach(JSON.stringity(myJsonObject, undefined, 4));

Credits

Credit to the developers of grunt-cucumberjs for developing pretty HTML reporting. HTML reporting is extracted from the grunt task. Thanks to all the contributors for making HTML Reporting available to the wider audiences of cucumber-js community.