Maven plugin for clear and concise Cucumber BDD test reporting.
Clone or download
Latest commit 50a12a2 Oct 9, 2018

README.md

cluecumber logo

Clear and Concise Cucumber Reporting

Apache V2 License Maven Central Build Status codecov Twitter URL

Cucumber animation

Cucumber compatible

Cluecumber Report Maven Plugin

This plugin creates aggregated test reports from Cucumber JSON files.

This project was created because

  • some other projects are using legacy technology and/or were not maintained at all
  • some other projects generate partial or even full HTML code in Java making it hard to maintain
  • the reporting generated from other plugins showed too much unneeded or even wrong information
  • some other projects consume a large amount of memory when generating reports from large JSON files
  • it will allow to completely customize the report appearance and information

Note: If you need to run Cucumber tests in parallel, please check out our Cucable project!

Example report

A fully generated example report can also be viewed online!

Changelog

All changes are documented in the full changelog.

Prerequisites

In order to have the JSON files as a source for the Cluecumber Report generation, you need to specify this option in your Cucumber runner configuration:

Cucumber 1.x:

@CucumberOptions(
    format = {"json:target/cucumber-report/cucumber.json"}
)

Cucumber 2.x:

@CucumberOptions(
    plugin = {"json:target/cucumber-report/cucumber.json"}
)

This will generate JSON results for all Cucumber tests.

Maven POM settings

<plugin>
    <groupId>com.trivago.rta</groupId>
    <artifactId>cluecumber-report-plugin</artifactId>
    <version>Check the version number above</version>
    <executions>
        <execution>
            <id>report</id>
            <phase>post-integration-test</phase>
            <goals>
                <goal>reporting</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <sourceJsonReportDirectory>${project.build.directory}/cucumber-report</sourceJsonReportDirectory>
        <generatedHtmlReportDirectory>${project.build.directory}/generated-report</generatedHtmlReportDirectory>
    </configuration>    
</plugin>

Running the reporting goal directly through the command line

In some cases it may be desirable to run the reporting as a completely separate step, e.g. in CI pipelines. This can be done by running

mvn cluecumber-report:reporting

directly from the command line.

Mandatory Configuration Parameters

There are two mandatory parameters that have to be specified within the Maven POM configuration section:

Note: Typically, both properties point to directories inside the Maven target directory.

sourceJsonReportDirectory

This specifies the source folder of the Cucumber JSON result files.

generatedHtmlReportDirectory

This points to the root directory of the generated Cluecumber HTML report.

Optional Configuration Parameters

skip

The skip property is used to skip the report generation. The default value is false

<configuration>
    ...
    <skip>true</skip>
    ...
</configuration>

customParameters

The customParameters block can be used to define custom information that should be displayed on the report start page.

Note: Underscores in the parameter names are automatically turned into spaces in the report. Valid URLs that start with a protocol (http, https, ftp) are automatically recognized and turned into clickable links.

<customParameters>
    <Custom_Parameter>This is a test</Custom_Parameter>
    <Custom_URL>http://www.google.com</Custom_URL>
</customParameters>

The property definitions above are shown in the report like this:

custom parameters

customCSS

The customCSS property can be used to define a custom CSS file that will be automatically loaded on top of Cluecumber's default styles.

If you have a custom CSS file called custom/custom.css in your project, you could use it to change the report's background and header colors:

body {
    background-color: black;
}

h3, h4 {
    color: white;
}

To use this files, specify it like so:

<customCss>custom/custom.css</customCss>

When generating the report, this file is automatically included as cluecumber_custom.css and applied on top of all other styles:

Custom CSS

Example project

You can test the complete flow and POM configuration by checking out the Cluecumber example project.

Appendix

Building

Cluecumber requires Java >= 8 and Maven >= 3.3.9. It is available in Maven central.

Generated pages

All Scenarios

Scenario Details

All Features

All Tags

Scenarios by tag

report_detail

License

Copyright 2018 trivago NV

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.