How to Cucumber : Test Report Plugin 2 with Maven and Java

2016-05-092019-05-04 Damien FREMONT IT Tutorialsbdd, cucumber, java, junit, maven, reporting, test

It is often useful to show the results of our tests to others people who are not developers, like managers or executive. This tutorial shows how to integrate a Cucumber reporting a Java plugin in Maven project. The result is a simple web page, which does not require a special tool to be read.

This tutorial will cover 3 reports plugins : JSON, HTML Pretty and Cucumber Report 2.

Native JSON Result

How to:

pom.xml



  4.0.0
  com.damienfremont.blog
  20160509-test-cucumber_plugin_reporting_2
  0.0.1-SNAPSHOT
  jar
  
    1.2.5
    8
  
  
    
      info.cukes
      cucumber-junit
      ${cucumber.version}
      test
    
    
      info.cukes
      cucumber-java8
      ${cucumber.version}
      test
    
  
  
    
      
        org.apache.maven.plugins
        maven-compiler-plugin
        3.3
        
          1.${java.version}
          1.${java.version}
        
      
      
        org.apache.maven.plugins
        maven-surefire-plugin
        2.18.1
        
          true
          
            **/*BDDTest.java

RunBDDTest.java

package com.damienfremont.blog;

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

@RunWith(Cucumber.class)
@CucumberOptions(strict = false, features = "features", format = { "pretty",
    "json:target/cucumber.json" }, tags = { "~@ignore" })
public class RunBDDTest {

}

Demo:

Launch with JUnit or

mvn test

The result is at /target/cucumber.json

Native HTML Plugin

How to:

RunBDDTest.java

package com.damienfremont.blog;

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

@RunWith(Cucumber.class)
@CucumberOptions(strict = false, features = "features", format = { "pretty",
    "html:target/site/cucumber-pretty",
    "json:target/cucumber.json" }, tags = { "~@ignore" })
public class RunBDDTest {

}

Demo:

Launch with JUnit or

mvn test

The result is at /target/site/cucumber-pretty/index.html

Cucumber-Reports HTML Plugin

How to:

pom.xml



  4.0.0
  com.damienfremont.blog
  20160509-test-cucumber_plugin_reporting_2
  0.0.1-SNAPSHOT
  jar
  
    1.2.5
    8
  
  
    
      info.cukes
      cucumber-junit
      ${cucumber.version}
      test
    
    
      info.cukes
      cucumber-java8
      ${cucumber.version}
      test
    
  
  
    
      
        org.apache.maven.plugins
        maven-compiler-plugin
        3.3
        
          1.${java.version}
          1.${java.version}
        
      
      
        org.apache.maven.plugins
        maven-surefire-plugin
        2.18.1
        
          true
          
            **/*BDDTest.java
          
        
      
      
        net.masterthought
        maven-cucumber-reporting
        2.0.0
        
          
            execution
            verify
            
              generate
            
            
              cucumber-jvm-example
              ${project.build.directory}/site/cucumber-reports
              ${project.build.directory}/cucumber.json
              true
              false
              42

RunBDDTest.java

package com.damienfremont.blog;

import org.junit.runner.RunWith;

import cucumber.api.CucumberOptions;
import cucumber.api.junit.Cucumber;

@RunWith(Cucumber.class)
@CucumberOptions(strict = false, features = "features", format = { "pretty",
    "json:target/cucumber.json" }, tags = { "~@ignore" })
public class RunBDDTest {

}

Demo:

Launch with

mvn test verify

The result is at /target/site/cucumber-reports/feature-overview.html

Conclusion

JSON is OK for integration with other tools (jenkins plugin, reports, etc).

Pretty HTML is OK during development phase (like a JUnit or Surefire report for versionning).

Cucumber-Reports is good for reporting outside of the dev team (like managers).

Source

https://damienfremont.com/2016/05/09/how-to-cucumber-test-report-plugin-2-with-maven-and-java

https://github.com/DamienFremont/blog/tree/master/20160509-test-cucumber_plugin_reporting_2

References

https://cucumber.io/docs/reference/jvm

https://github.com/masterthought/cucumber-reporting

http://www.masterthought.net/section/cucumber-reporting

32 thoughts on “How to Cucumber : Test Report Plugin 2 with Maven and Java”

How to Cucumber : Test Reporting Plugin with Maven and Java | #DEV/FR Damien.FREMONT says:

2016-05-09 at 13:50

[…] EDIT: this post is deprecated. Please go to the new version here: How to Cucumber : Test Report Plugin 2 with Maven and Java […]

Reply
suresh says:

2016-08-09 at 11:51

Hi Damien,

Do we need to execute runner class or we have to run via feature file for those cucumber-jvm report with charts.

Thanks,
Suresh

Reply
suresh says:

2016-08-18 at 07:23

Hi Damien,

I need to generate report like the one Cucumber-reports HTML Plugin with features-overview.html file. Can u guide me on how to do that one.

Thanks,
Suresh

Reply
Mukund K says:

2016-09-13 at 05:58

Hi,

Thanks for the such a amazing report. I am facing a problem.
Assume that this is my first run and no json already exists. When I run a test case I see json file not found exception even though file exists. When I run a different test case now, I could see the report is generated for previous run perhaps using the json generated for last run. And this keeps happening every next run generates report for previous run. I tried adding report code in junit afterclass but no luck. Could you please help me to resolve this issue?

Reply
- suresh says:
  
  2016-09-16 at 06:40
  
  Hi Mukund,
  
  can u share the runner class how u can able to generate reports with graphical representation?
  
  Thanks,
  Suresh
  
  Reply
Mukund K says:

2016-09-16 at 03:39

Hi,

Could you please let me know if it is possible to include custom fields in the report dashboard.
For eg: Browser used = Firefox, environment = UAT etc.

Thanks

Reply
Anil Mishra says:

2016-09-30 at 09:38

Hi,
Could you please help me to understand why feature-overview.html is not generating. Only index.html is generating

Reply
- suresh says:
  
  2016-09-30 at 12:19
  
  ya anil even I too facing the same issue but I need feature-overview.html
  
  Reply
manu says:

2016-10-26 at 13:32

Guys, you need to run mvn verify after mvn test. i was able to generate the report.

Reply
- Damien FREMONT says:
  
  2017-07-06 at 13:53
  
  Thks for the fix. Added to the post.
  
  Reply
suresh says:

2016-10-26 at 13:48

Can anyone share the sample small project like that above reports generated I was not able to generate feature-overview.html file which is in a graphical representation of the reports

Reply
Revathi says:

2016-12-19 at 11:18

Hi Does these reports work if I use TestNG insted of Junit? if not, how can I get these detailed reports with TestNG.

Reply
Abhinav Goel says:

2017-01-09 at 11:23

In my case the cucumber-report folder is not getting generated.

Reply
- Abhinav Goel says:
  
  2017-01-09 at 11:24
  
  I am using cucumber with maven project
  
  Reply
Retesh says:

2017-01-15 at 04:58

Hi, thanks for the great tutorial !!
I followed thru your steps and if I run TestRunner with junit, it runs fine but my report don’t get updated I have to do mvn install for it to update. how do I run my test and update reports at the same time?

in other workd If I clean and run my TestRunner class thru junit it doesn’t generate cucumber-report unless I do mvn install.

Reply
useful website | Amy.S says:

2017-03-22 at 15:22

[…] How to Cucumber : Test Report Plugin 2 with Maven and Java […]

Reply
gopi says:

2017-05-25 at 12:28

HI
I am new to automation I wrote same code in pom.xml in eclipse but can not generate feature-overview.html, I am running my tests through maven build in eclipse run configration
@CucumberOptions(features = “src/test/resources/feature”, plugin = { “json:target/cucumber.json”, “html:target/site/cucumber-pretty” })
can somebody help me with this pls?

Reply
Raveendar Reddy says:

2017-07-05 at 17:39

Hi,I am getting below error..
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.6.1:compile (default-compile) on project XYZ: Compilation failure

Reply
- Raveendar Reddy says:
  
  2017-07-05 at 17:45
  
  this is solved.. Now I can able to generate the reports .Ran ‘mvn verify’ after ‘mvn test’. Thanks @manu.
  
  Reply
  - Damien FREMONT says:
    
    2017-07-06 at 13:54
    
    Thks for the fix. Added to the post.
  - Shweta says:
    
    2018-07-18 at 15:45
    
    @Raveendar Reddy – Hi, I am getting the same error. Could you please let me know what did you do to solve this error.
  - Raveemdar Reddy says:
    
    2018-07-19 at 09:25
    
    @Shweta,
    
    I did ‘mvn verify’ after ‘mvn test’ .. This solved the issue..
Shreejit says:

2017-11-04 at 17:04

Hi Damien,

How do we configure this for multiple runs and spit out the reports in a new directory each time so we do not lose or overwrite previous test reports?

Reply
- Damien FREMONT says:
  
  2017-11-04 at 22:14
  
  Hi,
  Usually by using a CI plateforme like Jenkins or Bamboo. Each run/build result (target and source) will be save in a different folder (automatically deleted after some time, or saved if the build is tagged as a release).
  
  Reply
  - shreejitnair18 says:
    
    2017-11-05 at 13:40
    
    Hi Damien,
    
    How about if we would be doing it offline?
    I even changed the directory in my POM to point to a new directory having timestamp information, but seems the code completely cleans up the reports directory
    This is what I have in POM.xml right now
    target/cucumber-reports/advanced-reports/${timestamp}
    
    but each run the advanced-reports is cleared up it seems
shreejitnair18 says:

2017-11-07 at 23:07

Hi Damien,

I figured a way to do that.
Could you tell me how to use the advanced reports feature if we were not using Maven?
How do I write a bunch of java code that could do the same for me? Probably in the @AfterClass testng runner to parse the cucumber json report and create this report

Reply
- Scooby says:
  
  2019-10-27 at 02:31
  
  I am running report using cucumber.api.cli.Main.main method is not generating reports except cucumbers-pretty/index.html, Json and xml but not generating reports for features,steps and tags.
  Do I need to run @AfterClass / @AfterSuite to generate reports explicitly a method? If so which json file I need to pass in there?
  The Mian class is getting exiting before running custom method any approach to achieve it?
  
  Reply
Deepak Kumar Rana says:

2018-01-09 at 14:03

Hi All,

When I run this locally it works but it doesn’t work on Jenkins. Can you please help me with the same?

Reply
Ilayaraja Palani says:

2018-05-30 at 18:46

Hello Damien, Is there a way that i can publish the feature report or tags report through email after?
Can you please share your inputs

Reply
john demichiel says:

2018-06-06 at 19:16

Hi Damien,
I had the reporting plugin working fine when I used the Surefire plugin, but I switch to the Failsafe plugin (running cucumber integration tests) and no longer get the cucumber reports from my runs. (cucumber.json is created).
Does the reporting plugin only work with Surefire?

Reply
Santhosh Surimani says:

2019-04-05 at 09:03

Hi Damien,
I am using testNG dependancy with Surefire plugin. I am able to generate the reports if all the tests are passed otherwise reports are not getting generated, but cucumber.json file getting generated.

Does this plugin expect to work with the only JUnit?

Please suggest what can we do to generate the reports properly.

Reply
Dennis Reda says:

2019-08-14 at 14:13

I see lots of comments, but no recent replies.

Is this the forum for getting help? If not, please point me in the right direction!

Reply