Skip to content

jenkinsci/cucumber-jvm-reports-plugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Publish pretty cucumber-jvm reports on Jenkins

This is a pure Ruby Jenkins plugin which publishes pretty html reports showing the results of cucumber-jvm runs.

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 ruby-runtime plugin and the [cucumber-jvm-reports] (https://wiki.jenkins-ci.org/display/JENKINS) plugin.

  3. Restart Jenkins.

Use

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 and enter the path to the json reports relative to the workspace:

![check the publish cucumber-jvm-reports box] (https://github.com/masterthought/jenkins-cucumber-jvm-reports-plugin/raw/master/.README/publish-box.png)

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] (https://github.com/masterthought/jenkins-cucumber-jvm-reports-plugin/raw/master/.README/feature-overview.png)

And there are also feature specific results pages:

![feature specific page passing] (https://github.com/masterthought/jenkins-cucumber-jvm-reports-plugin/raw/master/.README/feature-passed.png)

And useful information for failures:

![feature specific page passing] (https://github.com/masterthought/jenkins-cucumber-jvm-reports-plugin/raw/master/.README/feature-failed.png)

Make sure you have configured cucumber-jvm to run with the JUnit runner and to generate a json report:

package net.masterthought.example;

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

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

Develop

Interested in contributing to the Jenkins cucumber-jvm-reports plugin? Great! Start [here] (https://github.com/jenkinsci/jenkins.rb/wiki/Getting-Started-With-Ruby-Plugins).

About

Publishes Cucumber-JVM reports on Jenkins

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 50.4%
  • Ruby 37.3%
  • JavaScript 12.3%