Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
standalone cucumber-reporting
Java

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.README
src
.gitignore
.travis.yml
README.md
cucumber-reporting.iml
pom.xml

README.md

Publish pretty cucumber reports

This is a Java report publisher primarily created to publish cucumber reports on the Jenkins build server.It publishes pretty html reports showing the results of cucumber runs. It has been split out into a standalone package so it can be used for Jenkins and maven command line as well as any other packaging that might be useful.

Build Status

Background

Cucumber is a test automation tool following the principles of Behavioural Driven Design and living documentation. Specifications are written in a concise human readable form and executed in continuous integration.

This project allows you to publish the results of a cucumber run as pretty html reports. In order for this to work you must generate a cucumber json report. The project converts the json report into an overview html linking to separate feature file htmls with stats and results.

Install

  1. Add a maven dependency to your pom

  2. Or grab the jar file from the downloads page

Read this if you need further detailed install and configuration instructions for using the Jenkins version of this project

Release Notes

Release notes are here

Use

File reportOutputDirectory = new File("/path/to/report/output/directory/e.g./cucumber-html-reports");
List<String> jsonReportFiles = new ArrayList<String>();
list.add("/path/to/a/cucumber/json/report/e.g./cucumber_1.json");
list.add("/path/to/another/cucumber/json/report/e.g./cucumber_2.json");

String buildNumber = "1";
String buildProjectName = "super_project";
Boolean skippedFails = false;
Boolean undefinedFails = false;
Boolean flashCharts = true;
Boolean runWithJenkins = true;
ReportBuilder reportBuilder = new ReportBuilder(jsonReportFiles,reportOutputDirectory,pluginUrl,buildNumber,buildProjectName,skippedFails,undefinedFails,flashCharts,runWithJenkins);
reportBuilder.generateReports();

skippedFails means the build will be failed if any steps are in skipped status and undefinedFails means the build will be failed if any steps are in undefined status. This only applies when running with Jenkins. flashCharts means either use the default flashcharts or use the D3 javascript charts. runWithJenkins means put in the links back to jenkins in the report.

There is a feature overview page:

feature overview page

And there are also feature specific results pages:

feature specific page passing

And useful information for failures:

feature specific page passing

If you have tags in your cucumber features you can see a tag overview:

Tag overview

And you can drill down into tag specific reports:

Tag report

Develop

Interested in contributing to the cucumber-reporting? Great! Start here.

Something went wrong with that request. Please try again.