Skip to content
This repository

Java jenkins plugin for cucumber-jvm reporting

README.md

Publish pretty cucumber-jvm reports on Jenkins

This is a Java Jenkins plugin which publishes pretty html reports showing the results of cucumber-jvm runs. It also works for the ruby versions of cucumber - not just the cucumber-jvm. To use with regular cucumber just make sure to run cucumber like this: cucumber --format json -o cucumber.json

Put up a Bounty

If you would like something fixed or an enhancement added feel free to create a bounty for it and I will be immediately more motivated to fix or create the item

https://www.bountysource.com/trackers/17809-masterthought-jenkins-cucumber-jvm-reports-plugin-java

Background

Cucumber-JVM 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 plugin allows Jenkins to publish the results as pretty html reports hosted by the Jenkins build server. In order for this plugin to work you must be using the JUnit runner and generating a json report. The plugin converts the json report into an overview html linking to separate feature file htmls with stats and results.

Install

  1. Get Jenkins.

  2. Install the cucumber-jvm-reports-java plugin.

  3. Restart Jenkins.

Read this if you need further detailed install and configuration instructions

Release Notes

Release notes are here

Use

You must use a Freestyle project type in jenkins.

With the cucumber-jvm-reports plugin installed in Jenkins, you simply check the "Publish cucumber results as a report" box in the publish section of the build config:

check the publish cucumber-jvm-reports box

If you need more control over the plugin you can click the Advanced button for more options:

check the publish cucumber-jvm-reports box

  1. Leave empty for the plugin to automagically find your json files or enter the path to the json reports relative to the workspace if for some reason the automagic doesn't work for you
  2. Leave empty unless your jenkins is installed on a different url to the default hostname:port - see the wiki for further info on this option
  3. Tick if you want Skipped steps to cause the build to fail - see further down for more info on this
  4. Tick if you want Not Implemented/Pending steps to cause the build to fail - see further down for more info on this
  5. Tick if you don't want the reports to be displayed in flash. Javascript will be used instead - see further down for more info on this
  6. Tick if you want failed test not to fail the entire build but make it unstable

When a build runs that publishes cucumber-jvm results it will put a link in the sidepanel to the cucumber reports. There is a feature overview page:

feature overview page

And there are also feature specific results pages:

feature specific page passing

And useful information for failures:

feature specific page passing

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

Tag overview

And you can drill down into tag specific reports:

Tag report

Advanced Configuration Options

There are 4 advanced configuration options that can affect the outcome of the build status. Click on the Advanced tab in the configuration screen:

Advanced Configuration

The first setting is Skipped steps fail the build - so if you tick this any steps that are skipped during executions will be marked as failed and will cause the build to fail:

Skipped Fails

The second setting is Not Implemented steps fail the build - so if you tick this any steps that are not implemented will be marked as failed and will cause the build to fail:

Not Implemented Fails

If you check both skipped and not implemented fails the build then your report will look something like this:

Not Implemented and Skipped Fails

Finally if you don't check either of these options then skipped or not implemented steps will not fail the build and the report will look something like this:

Build Passes on Skipped and Not Implemented

The third setting is to turn off the default flash charts - if you check this then you will get javascript charts using graphael javascript charting library.

Javascript Charts on Feature Overview:

JS Feature Overview

Javascript Charts on Tag Overview:

JS Feature Overview

Unstable builds:

The fourth setting is Ignore failed tests - so if you tick this and one of the tests fail, the build becomes unstable instead of failed.

Make sure you have configured cucumber-jvm to run with the JUnit runner and to generate a json report: (note - you can add other formatters in if you like e.g. pretty - but only the json formatter is required for the reports to work)

package net.masterthought.example;

import cucumber.junit.Cucumber;
import org.junit.runner.RunWith;

@RunWith(Cucumber.class)
@Cucumber.Options(format = {"json:target/cucumber.json"})
public class ATMTest {
}

Develop

Interested in contributing to the Jenkins cucumber-jvm-reports plugin? Great! Start here.

Something went wrong with that request. Please try again.