Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/damianszczepanik/cucumber-reporting
HTML reports for Cucumber
https://github.com/damianszczepanik/cucumber-reporting
cucumber-reports html-report java jenkins json-report
Last synced: 27 days ago
JSON representation
HTML reports for Cucumber
- Host: GitHub
- URL: https://github.com/damianszczepanik/cucumber-reporting
- Owner: damianszczepanik
- License: lgpl-2.1
- Created: 2012-07-05T23:20:43.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T10:09:04.000Z (2 months ago)
- Last Synced: 2024-09-30T18:01:16.768Z (about 1 month ago)
- Topics: cucumber-reports, html-report, java, jenkins, json-report
- Language: Java
- Homepage:
- Size: 22.5 MB
- Stars: 546
- Watchers: 64
- Forks: 402
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-bdd - HTML reports for Cucumber - This is a Java report publisher primarily created to publish cucumber reports on the Jenkins build server. It publishes pretty html reports with charts showing the results of cucumber runs. (Tools / Java)
README
[](https://github.com/damianszczepanik/cucumber-reporting/actions/workflows/build.yml)
[](https://ci.appveyor.com/project/damianszczepanik/cucumber-reporting/history)
[](https://damianszczepanik.github.io/cucumber-html-reports/overview-features.html)
[](https://codecov.io/github/damianszczepanik/cucumber-reporting)
[](https://sonarcloud.io/dashboard?id=damianszczepanik_cucumber-reporting)
[](https://app.codacy.com/gh/damianszczepanik/cucumber-reporting/)
[](https://codebeat.co/projects/github-com-damianszczepanik-cucumber-reporting)
[](https://snyk.io/org/damianszczepanik/project/6a2fe301-d56c-49e7-8c78-cd3ff09c3828)
[](http://search.maven.org/#search|gav|1|g%3A%22net.masterthought%22%20AND%20a%3A%22cucumber-reporting%22)
[](https://raw.githubusercontent.com/damianszczepanik/cucumber-reporting/master/LICENCE)
[](https://github.com/damianszczepanik/cucumber-reporting/graphs/contributors)
# Publish pretty [cucumber](https://cucumber.io/) reports
This is a Java report publisher primarily created to publish cucumber reports on the Jenkins build server.
It publishes pretty html reports with charts 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. Generated report has no dependency so can be viewed offline.
## 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 files with stats and results.
## Install
Add a maven dependency to your pom
```xml
net.masterthought
cucumber-reporting
(check version above)
```
Read this if you need further [detailed configuration](https://github.com/jenkinsci/cucumber-reports-plugin/wiki/Detailed-Configuration) instructions for using the Jenkins version of this project
## Usage
```Java
File reportOutputDirectory = new File("target");
List jsonFiles = new ArrayList<>();
jsonFiles.add("cucumber-report-1.json");
jsonFiles.add("cucumber-report-2.json");
String buildNumber = "1";
String projectName = "cucumberProject";
Configuration configuration = new Configuration(reportOutputDirectory, projectName);
// optional configuration - check javadoc for details
configuration.addPresentationModes(PresentationMode.RUN_WITH_JENKINS);
// do not make scenario failed when step has status SKIPPED
configuration.setNotFailingStatuses(Collections.singleton(Status.SKIPPED));
configuration.setBuildNumber(buildNumber);
// addidtional metadata presented on main page
configuration.addClassifications("Platform", "Windows");
configuration.addClassifications("Browser", "Firefox");
configuration.addClassifications("Branch", "release/1.0");
// optionally add metadata presented on main page via properties file
List classificationFiles = new ArrayList<>();
classificationFiles.add("properties-1.properties");
classificationFiles.add("properties-2.properties");
configuration.addClassificationFiles(classificationFiles);
// optionally specify qualifiers for each of the report json files
configuration.addPresentationModes(PresentationMode.PARALLEL_TESTING);
configuration.setQualifier("cucumber-report-1","First report");
configuration.setQualifier("cucumber-report-2","Second report");
ReportBuilder reportBuilder=new ReportBuilder(jsonFiles,configuration);
Reportable result=reportBuilder.generateReports();
// and here validate 'result' to decide what to do if report has failed
```
There is a feature overview page:
And there are also feature specific results pages:
And useful information for failures:
If you have tags in your cucumber features you can see a tag overview:
And you can drill down into tag specific reports:
## Continuous delivery and live demo
You can play with the [live demo](http://damianszczepanik.github.io/cucumber-html-reports/overview-features.html) report before you decide if this is worth to use. Report is generated every time new change is merged into the main development branch so it always refers to the most recent version of this project. Sample configuration is provided by [sample code](./src/test/java/LiveDemoTest.java).
## Code quality
Once you developed your new feature or improvement you should test it by providing several unit or integration tests.
## Contribution
Interested in contributing to the cucumber-reporting? Great! Start [here](https://github.com/damianszczepanik/cucumber-reporting).