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: about 1 month 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 (almost 12 years ago)
Default Branch: master
Last Pushed: 2024-05-03T09:58:06.000Z (about 1 month ago)
Last Synced: 2024-05-03T16:15:19.359Z (about 1 month ago)
Topics: cucumber-reports, html-report, java, jenkins, json-report
Language: Java
Homepage:
Size: 22.5 MB
Stars: 535
Watchers: 62
Forks: 400
Open Issues: 55
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Lists

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)
awesome-tester - cucumber-reporting
awesome-testing - cucumber-reporting
Awesome-Cucumber - 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, Libraries & Frameworks)

README

        [![Github build](https://github.com/damianszczepanik/cucumber-reporting/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/damianszczepanik/cucumber-reporting/actions/workflows/build.yml)

[![AppVeyor Status](https://img.shields.io/appveyor/ci/damianszczepanik/cucumber-reporting/master.svg?label=AppVeyor%20build)](https://ci.appveyor.com/project/damianszczepanik/cucumber-reporting/history)

[![Live Demo](https://img.shields.io/badge/Online%20demo-published-blue.svg)](https://damianszczepanik.github.io/cucumber-html-reports/overview-features.html)

[![Coverage Status](https://codecov.io/gh/damianszczepanik/cucumber-reporting/branch/master/graph/badge.svg)](https://codecov.io/github/damianszczepanik/cucumber-reporting)

[![Sonarqube Status](https://sonarcloud.io/api/project_badges/measure?project=damianszczepanik_cucumber-reporting&metric=alert_status)](https://sonarcloud.io/dashboard?id=damianszczepanik_cucumber-reporting)

[![Codacy](https://api.codacy.com/project/badge/grade/7f206992ed364f0896490057fdbdaa2e)](https://app.codacy.com/gh/damianszczepanik/cucumber-reporting/)

[![Codebeat](https://codebeat.co/badges/cb097d5a-280a-4867-8120-d6f03a874861)](https://codebeat.co/projects/github-com-damianszczepanik-cucumber-reporting)

[![Vulnerabilities](https://snyk.io/test/github/damianszczepanik/cucumber-reporting/badge.svg)](https://snyk.io/org/damianszczepanik/project/6a2fe301-d56c-49e7-8c78-cd3ff09c3828)

[![Maven Central](https://img.shields.io/maven-central/v/net.masterthought/cucumber-reporting.svg)](http://search.maven.org/#search|gav|1|g%3A%22net.masterthought%22%20AND%20a%3A%22cucumber-reporting%22)

[![License](https://img.shields.io/badge/license-GNU%20LGPL%20v2.1-blue.svg)](https://raw.githubusercontent.com/damianszczepanik/cucumber-reporting/master/LICENCE)

[![Contributors](https://img.shields.io/github/contributors/damianszczepanik/cucumber-reporting.svg)](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:

![feature overview page](./.README/feature-overview.png)

And there are also feature specific results pages:

![feature specific page passing](./.README/feature-passed.png)

And useful information for failures:

![feature specific page passing](./.README/feature-failed.png)

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

![Tag overview](./.README/tag-overview.png)

And you can drill down into tag specific reports:

![Tag report](./.README/tag-report.png)

![Trends report](./.README/trends.png)

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

![codecov.io](https://codecov.io/gh/damianszczepanik/cucumber-reporting/branch/master/graphs/tree.svg)

## Contribution

Interested in contributing to the cucumber-reporting?  Great!  Start [here](https://github.com/damianszczepanik/cucumber-reporting).