Extent report plugin for cucumber framework

Extent Reports are the most popular reporting used with Selenium. ExtentReport API makes our life easy to generate interactive report with simple configuartions. It supports almost all Java and .NET test frameworks such as TestNG, JUnit, NUnit etc

Here we are discussing about a plugin which is build on Extent Report specially for Cucumber.This plugin is used to simple out the implementation of Extent Report in Cucumber Framework. 

We are creating a maven project to implement the integration of our plugin with cucumber

1. Create new maven project in any tool eclipse/sts/intellij

2. Open pom.xml and update below entries.

Step 1 : Add Cucumber Extent Reporter library to Maven Project

Add cucumber-extentsreport

<dependency>
    <groupId>com.vimalselvam</groupId>
    <artifactId>cucumber-extentsreport</artifactId>
    <version>3.0.2</version>
</dependency>

Add below  dependencies:

   <dependency>
            <groupId>info.cukes</groupId>
            <artifactId>cucumber-java</artifactId>
            <version>1.2.5</version>
        </dependency>

        <dependency>
            <groupId>info.cukes</groupId>
            <artifactId>cucumber-core</artifactId>
            <version>1.2.5</version>
        </dependency>

Note:  If you are using Java 8+,  add the dependency of ExtentReport v3.0.6 + as well.

Add Extent Report library

<dependency>
    <groupId>com.aventstack</groupId>
    <artifactId>extentreports</artifactId>
    <version>3.1.2</version>
</dependency>

Step 2 : Add Extent Config to the Project

We need to set few configurations which is required by the Cucumber Extent Report plugin. 

We can set configuration via XML configuration file.

1. Create New folder configs under src/test/resources/

2. Create a New File in folder config and name it as extent-config.xml.

Few properties explanation .

• Global Time Format  : <timeFormat> : Like this HH:mm:ss

• Title of the Report : <documentTitle> : This will display on the Browser Tab

• Document Encoding : <encoding> : UFT-8
• Global Date Format : <dateFormat> : Like this yyyy-MM-dd
• Report Theme : <theme> : standard or dark
• Name of the Report : <reportName> : This will display at the top of the Report

extent-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<extentreports>
  <configuration>
    <!-- report theme --> <!-- standard, dark -->
    <theme>standard</theme>
   
    <!-- document encoding -->  <!-- defaults to UTF-8 -->
    <encoding>UTF-8</encoding>
     
    <!-- protocol for script and stylesheets -->   <!-- defaults to https -->
    <protocol>https</protocol>
     
    <!-- title of the document -->
    <documentTitle>Cucumber Framework</documentTitle>
     
    <!-- report name - displayed at top-nav -->
    <reportName>My Project- Cucumber Report</reportName>
     
    <!-- global date format override -->  <!-- defaults to yyyy-MM-dd -->
    <dateFormat>yyyy-MM-dd</dateFormat>
     
    <!-- global time format override -->   <!-- defaults to HH:mm:ss -->
    <timeFormat>HH:mm:ss</timeFormat>
     
    <!-- custom javascript -->
    <scripts>
      <![CDATA[
        $(document).ready(function() {
         
        });
      ]]>
    </scripts>
     
    <!-- custom styles -->
    <styles>
      <![CDATA[
         
      ]]>
    </styles>
  </configuration>
</extentreports>

Step 3: Read the extent-config.xml path

1. Create a "Configuration.properties" file under src/test/resources/configs folder and 

2. Make an entry for the Path of the config in the Configuration.properties file.

Configuration.properties

reportConfigPath= C:/Users/vikas/my-project/src/test/resources/configs/extent-config.xml

Step 4: Create Reader class ConfigFileReader

ConfigFileReader.java:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

import java.io.BufferedReader; import java.io.FileNotFoundException; import java.io.FileReader; import java.io.IOException; import java.util.Properties; public class ConfigFileReader { private Properties properties; private final String propertyFilePath = "src//test//resources//configs//Configuration.properties"; public ConfigFileReader() { BufferedReader reader; try { reader = new BufferedReader(new FileReader(propertyFilePath)); properties = new Properties(); try { properties.load(reader); reader.close(); } catch (IOException e) { e.printStackTrace(); } } catch (FileNotFoundException e) { e.printStackTrace(); throw new RuntimeException("Configuration.properties not found at " + propertyFilePath); } } public String getReportConfigPath() { String reportConfigPath = properties.getProperty("reportConfigPath"); if (reportConfigPath != null) return reportConfigPath; else throw new RuntimeException("Report Config Path not specified in the Configuration.properties"); } }

Step 4 :  Modify TestRunner to Implement Cucumber Extent Reporter

1. Modify the runner class with below plugin using 

@CucumberOptions( plugin = {“com.cucumber.listener.ExtentCucumberFormatter:target/cucumber-reports/report.html”})

The above setup will generate the report in taget directory with the name of report.html.

2. Write Extent Reports

Add a method createExtentReport() in the TestRunner class to write the report.This will load the extent configurations from extent-config.xml and write the report in the desired path.

TestCaseRunner.java:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

package com.home.runners; import com.cucumber.listener.Reporter; import cucumber.api.CucumberOptions; import cucumber.api.junit.Cucumber; import managers.FileReaderManager; import org.junit.AfterClass; import org.junit.runner.RunWith; import java.io.File; @RunWith(value = Cucumber.class) @CucumberOptions(features = "src/test/resources/features/myfirstRequirement.feature", glue = { "com.home.stepDefinitions" }, plugin = { "pretty", "com.cucumber.listener.ExtentCucumberFormatter:target/cucumber-reports/report.html" }, tags = { "@functional" } ) public class TestCaseRunner { @AfterClass public static void createExtentReport() { Reporter.loadXMLConfig(new File(FileReaderManager.getInstance().getConfigReader().getReportConfigPath())); Reporter.setSystemInfo("User Name", System.getProperty("user.name")); Reporter.setSystemInfo("Time Zone", System.getProperty("user.timezone")); Reporter.setSystemInfo("Machine", "Windows 7:-" + "64 Bit"); Reporter.setSystemInfo("Maven", "3.5.2"); Reporter.setSystemInfo("Java Version", "1.8.0_151"); Reporter.assignAuthor("Vikash"); } }

If you noted above we have used FileReaderManager class to get the instance of ConfigFileReader class, so below is the imlementation of the same.

FileReadManager.java:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

package managers; import dataProviders.ConfigFileReader; public class FileReaderManager { private static FileReaderManager fileReaderManager = new FileReaderManager(); private static ConfigFileReader configFileReader; private FileReaderManager() {} public static FileReaderManager getInstance() { return fileReaderManager; } public ConfigFileReader getConfigReader() { return (configFileReader == null) ? new ConfigFileReader() : configFileReader; } }

Step 5: Run as JUnit

Now we are all set to run the Cucumber test. 

1. Right Click on TestRunner class 

2. Click Run As  >> JUnit Test. 

3. Find the report at target\cucumber-reports\report.html.