- Cluecumber Report Maven Plugin
- Prerequisites
- Maven POM settings
- Running the reporting goal directly via command line
- Example project
- Appendix
This plugin creates aggregated test reports from Cucumber compatible JSON files that are generated by Cucumber BDD, Karate and other frameworks.
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 allows to customize the report CSS to alter the looks of the generated report
Note: If you need to run Cucumber tests in parallel, please check out our Cucable project!
A fully generated example report can also be viewed online!
All changes are documented in the full changelog.
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.
<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>There are two mandatory parameters that have to be specified within the Maven POM configuration section or system properties:
Note: Typically, both properties point to directories inside the Maven target directory.
This specifies the source folder of the Cucumber JSON result files.
This points to the root directory of the generated Cluecumber HTML report.
The skip property is used to skip the report generation. The default value is false
<configuration>
<skip>true</skip>
...
</configuration>
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:
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: dimgray;
}
h3, h4 {
color: orange;
}To use this files, specify it like so in your pom file or as a system property:
<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:
Likewise, if you want to hide elements from the report, e.g. the total time on the start page, you can also add this to the custom css like so:
[data-cluecumber-item="total-scenario-duration"] {
display: none;
}These options can be set to true to expand or collapse before/after hooks, step hooks or docstrings respectively on scenario detail pages.
If they are not set, they default to false. This means that the report user has to use the buttons on a scenario detail page to expand those sections on demand.
<configuration>
<expandBeforeAfterHooks>true|false</expandBeforeAfterHooks>
<expandStepHooks>true|false</expandStepHooks>
<expandDocStrings>true|false</expandDocStrings>
</configuration>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.
Note: If you want this invocation to consider the configuration that is included in your POM file,
the configuration block must be outside of your executions block. Otherwise, it only applies to the
specified execution and is ignored when you run mvn cluecumber-report:reporting from the command line:
<executions>
<execution>
<id>report</id>
<phase>post-integration-test</phase>
<goals>
<goal>reporting</goal>
</goals>
<configuration>
<!-- This configuration block applies ONLY to this execution -->
</configuration>
</execution>
</executions>
<configuration>
<!-- This configuration block applies to all executions including command line invocation -->
</configuration>
You can also pass properties directly on the command line, e.g.
mvn cluecumber-report:reporting -DsourceJsonReportDirectory=path_to_json_files -D...
If you want to set a custom parameter, you can do it like this:
Set an empty property in your pom file's properties block:
<properties>
<someProperty/>
</properties>Also define it in the Cluecumber section in your POM:
<customParameters>
<My_Parameter_Name>${someProperty}</Base_Url>
</customParameters>When invoking the reporting, you can now pass this property via the -D option:
mvn cluecumber-report:reporting -DsomeProperty="this is cool" -D...
Note: If you don't pass this property, Cluecumber will ignore it and not show it in the report.
You can test the complete flow and POM configuration by checking out the Cluecumber example project.
Cluecumber requires Java >= 8 and Maven >= 3.3.9. It is available in Maven central.
This page shows an overview of all scenarios grouped by their status passed, failed or skipped:
This page shows an overview of all scenarios in running order including their individual status information:
This page shows all steps, hooks, stack traces and attachments of a single scenario:
This page shows an overview of all features:
This page shows an overview of all used tags in scenarios, features and example tables including their individual status information:
This page shows an overview of all steps in use including their individual status information:
This page shows all scenarios including a specific tag:
This page shows all scenarios belonging to a specific feature:
This page shows all scenarios that include a specific step:
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.