cucumber-html-reporter-cli

Generate Cucumber HTML reports with pie charts

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

Preview of HTML Reports

Snapshot of Bootstrap Report

Install

git clone <*repo*>
cd cucumber-html-reporter
npm install . -g

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:

cucumber-html-reporter-cli -j 'functionals.json' -o 'report.html' -t 'bootstrap'

    //to generate consodilated report from multi-cucumber JSON files, please use `jsonDir` option instead of `jsonFile`. More info is available in `options` section below.

Please look at the options section below for more 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

`jsonDir`

Type: String

If you have more than one cucumber JSON files, provide the path of JSON directory. This module will create consolidated report of all Cucumber JSON files.

e.g. jsonDir: 'test/reports' //where reports directory contains valid *.json files

N.B.: jsonFile takes precedence over jsonDir. We recommend to use either jsonFile or jsonDir option.

`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.

`launchReport`

Type: Boolean

Automatically launch HTML report at the end of test suite

true: Launch HTML report in the default browser

false: Do not launch HTML report at the end of test suite

`ignoreBadJsonFile`

Type: Boolean

Report any bad json files found during merging json files from directory option.

true: ignore any bad json files found and continue with remaining files to merge.

false: Default option. Fail report generation if any bad files found during merge.

`name`

Type: String (optional)

Custom project name. If not passed, module reads the name from projects package.json which is preferable.

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.stringify(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.

License

billwang1990/cucumber-html-reporter

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages