https://github.com/trivago/cluecumber

Clear and concise reporting for the Cucumber BDD JSON format.
https://github.com/trivago/cluecumber

automated-testing bdd cluecumber cucumber cucumber-bdd cucumber-java cucumber-json cucumber-jvm cucumber-reports cucumber-tests custom-css html human-readable json-files karate karate-framework karate-grpc maven-plugin reporting scenario

Last synced: about 1 month ago
JSON representation

Clear and concise reporting for the Cucumber BDD JSON format.

• Host: GitHub
• URL: https://github.com/trivago/cluecumber
• Owner: trivago
• License: apache-2.0
• Created: 2017-11-08T14:30:19.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T16:27:42.000Z (3 months ago)
• Last Synced: 2024-05-08T02:36:39.947Z (about 1 month ago)
• Topics: automated-testing, bdd, cluecumber, cucumber, cucumber-bdd, cucumber-java, cucumber-json, cucumber-jvm, cucumber-reports, cucumber-tests, custom-css, html, human-readable, json-files, karate, karate-framework, karate-grpc, maven-plugin, reporting, scenario
• Language: Java
• Homepage: https://www.softwaretester.blog
• Size: 21.5 MB
• Stars: 257
• Watchers: 22
• Forks: 88
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-bdd - Cluecumber Report Maven Plugin - This plugin creates aggregated test reports from Cucumber compatible JSON files that are generated by Cucumber BDD, Karate and other frameworks. (Tools / Java)

README

        
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

[![Maven Central](https://img.shields.io/maven-central/v/com.trivago.rta/cluecumber-parent.svg)](https://repo1.maven.org/maven2/com/trivago/rta/)

[![Example Report](https://img.shields.io/badge/Example-Report-blue.svg)](http://cluecumber.softwaretester.blog/)





# Cluecumber

_Clear and concise JVM and Maven reporting for the Cucumber BDD JSON format_

This project creates aggregated test reports from Cucumber compatible JSON files that are generated

by [Cucumber BDD](https://github.com/cucumber), [Karate](https://github.com/intuit/karate) and other frameworks.

Cluecumber comes in two flavors:

* [__Cluecumber Core__](core) -  generates reports from Java code

* [__Cluecumber Maven__](maven) - generates reports from Maven

![Cluecumber animation](documentation/img/cluecumber.gif)

A fully generated example report can be [viewed here](http://cluecumber.softwaretester.blog/)!

## Generated pages

Cluecumber generates the following report pages:

* __All Scenarios__: all scenarios grouped by their status `passed`, `failed` or `skipped`.

* __Scenario Sequence__: all scenarios in running order including their individual status information

* __Scenario Details__: all steps, hooks, stack traces and attachments of a single scenario

* __All Features__: an overview of all features

* __All Tags__: all used tags in scenarios, features and example tables including their individual status information

* __All Steps__: all steps in use including their individual status information

* __Scenarios by Tag__: all scenarios including a specific tag

* __Scenarios by Feature__: all scenarios belonging to a specific feature

* __Scenario by Step__: all scenarios that include a specific step

* __Tree View__: all features and scenarios in a tree for an easy overview of the test suite

## Changelog

All changes are documented in the [full changelog](CHANGELOG.md).

# Appendix

## Building

Cluecumber requires Java >= 11 and Maven >= 3.3.9.

It is available in [Maven central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.trivago.rta%22%20AND%20a%3A%22cluecumber-report-plugin%22).

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=trivago/cluecumber-report-plugin&type=Date)](https://star-history.com/#trivago/cluecumber-report-plugin&Date)

## License

Copyright 2018 - 2023 trivago N.V.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the

License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "

AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific

language governing permissions and limitations under the License.