Generating Cucumber Reports for Selenium Java Tests

When it comes to Behavior-Driven Development (BDD), Cucumber paired with Selenium and Java is a popular combination. Cucumber allows you to write test scenarios in plain English using Gherkin syntax, which makes test cases easy to understand and maintain. However, to evaluate the results of these tests efficiently, it's essential to generate readable and insightful reports. Cucumber provides several reporting options that integrate seamlessly with Selenium Java tests.

In this blog, we'll guide you through how to generate Cucumber reports for Selenium tests written in Java, using plugins and tools such as the built-in Cucumber HTML reports and third-party reporting frameworks like Extent Reports and Cucumber Reporting Plugin.


Why Reports Matter

Test reports are crucial in any test automation framework because they:

Offer a summary of passed, failed, and skipped scenarios

Provide error logs and stack traces for debugging

Help stakeholders and QA teams understand test coverage and quality

Serve as documentation for test execution history


Project Setup

Before diving into report generation, ensure you have a Maven-based Selenium-Cucumber Java project set up.


Key dependencies in pom.xml:

xml


<dependency>

  <groupId>io.cucumber</groupId>

  <artifactId>cucumber-java</artifactId>

  <version>7.14.0</version>

</dependency>


<dependency>

  <groupId>io.cucumber</groupId>

  <artifactId>cucumber-junit</artifactId>

  <version>7.14.0</version>

  <scope>test</scope>

</dependency>


<dependency>

  <groupId>org.seleniumhq.selenium</groupId>

  <artifactId>selenium-java</artifactId>

  <version>4.19.1</version>

</dependency>


Step 1: Cucumber HTML Reports

Cucumber natively supports HTML report generation with a simple plugin configuration in your runner class.

Example Test Runner:

java


import org.junit.platform.suite.api.ConfigurationParameter;

import org.junit.platform.suite.api.IncludeEngines;

import org.junit.platform.suite.api.SelectClasspathResource;

import org.junit.platform.suite.api.Suite;


import static io.cucumber.junit.platform.engine.Constants.*;


@Suite

@IncludeEngines("cucumber")

@SelectClasspathResource("features")

@ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "pretty, html:target/cucumber-reports.html")

public class TestRunner {

}

This will generate a readable HTML report at:

target/cucumber-reports.html


Step 2: Cucumber Reporting Plugin (Advanced)

For more detailed, visually rich reports, use the Cucumber Reporting Plugin by masterthought.

Add plugin to pom.xml:

xml


<plugin>

  <groupId>net.masterthought</groupId>

  <artifactId>maven-cucumber-reporting</artifactId>

  <version>5.7.5</version>

  <executions>

    <execution>

      <id>generate-cucumber-html-reports</id>

      <phase>verify</phase>

      <goals>

        <goal>generate</goal>

      </goals>

      <configuration>

        <projectName>Selenium Cucumber Report</projectName>

        <reportOutputDirectory>${project.build.directory}/cucumber-report</reportOutputDirectory>

        <cucumberOutput>${project.build.directory}/cucumber.json</cucumberOutput>

      </configuration>

    </execution>

  </executions>

</plugin>

Modify the runner to include JSON output:

java

@ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "pretty, json:target/cucumber.json")

Then run:


bash


mvn clean verify

Find the report in:

target/cucumber-report/index.html


Step 3: Extent Reports with Cucumber

To use Extent Reports, add dependencies:

xml


<dependency>

  <groupId>tech.grasshopper</groupId>

  <artifactId>extentreports-cucumber7-adapter</artifactId>

  <version>1.7.0</version>

</dependency>

Then, update your runner to include:


java


@ConfigurationParameter(key = PLUGIN_PROPERTY_NAME, value = "pretty, io.qameta.allure.cucumber7jvm.AllureCucumber7Jvm")

And add extent.properties file in your src/test/resources:


ini


extent.reporter.spark.start=true

extent.reporter.spark.out=target/extent-report/spark.html


Final Thoughts

Cucumber reports play a vital role in the success of automated Selenium test frameworks by providing detailed feedback to developers and QA teams. Whether you're using the built-in HTML reports or integrating powerful tools like Extent Reports or Masterthought Reporting, you'll gain deeper insights into test results, coverage, and overall project health.

Learn Selenium with Java Training

Read More: Implementing Hooks in Selenium Java Cucumber Tests

Read More: Data Tables in Cucumber for Selenium Java Automation

Read More: Mapping Step Definitions in Selenium Java Cucumber Framework


Visit Our IHUB Talent Institute Hyderabad
Get Direction 

Comments

Post a Comment

Popular posts from this blog

How to Use Tosca's Test Configuration Parameters

Tosca by Tricentis is a powerful model-based test automation tool widely used in enterprise environments for end-to-end testing. One of its most useful features is Test Configuration Parameters (TCPs), which provide flexibility and control in managing test execution. TCPs enable testers to create reusable test cases by passing dynamic values without hardcoding them. This significantly enhances test maintenance, scalability, and efficiency. In this blog, we’ll explore what Test Configuration Parameters are, how to create and use them, and the best practices to follow when working with TCPs in Tosca. What Are Test Configuration Parameters? Test Configuration Parameters are custom-defined key-value pairs that can be associated with test cases, test case folders, or execution lists in Tosca. They help manage configuration data such as environment URLs, browser types, credentials, or any other variable data that may differ across test runs. By using TCPs, you can avoid duplicating test case...
Read more

Tosca Licensing: Types and Considerations

 Tosca by Tricentis is a widely used, enterprise-level automation testing tool known for its model-based approach, scriptless testing, and support for a wide range of applications (web, desktop, mobile, API, etc.). As organizations look to implement Tosca into their quality assurance processes, one of the key areas to understand is its licensing model. In this blog, we’ll explore the various types of Tosca licenses, key considerations for choosing the right license, and best practices to manage licensing efficiently within your test automation ecosystem. 🔑 Why Licensing Matters in Tosca Tosca is a commercial tool, and proper licensing is crucial to access its full range of capabilities, manage costs, scale efficiently, and remain compliant with Tricentis’s usage policies. The right licensing setup ensures that testers and teams can collaborate effectively without disruptions due to access or resource limitations. 📌 Types of Tosca Licenses Tricentis offers several licensing types ...
Read more

Using Hibernate ORM for Fullstack Java Data Management

In the world of fullstack Java development, managing data efficiently and seamlessly across the application is critical. One of the most powerful tools in the Java ecosystem for handling database operations is Hibernate ORM (Object-Relational Mapping). Hibernate simplifies the interaction between Java applications and relational databases, reducing boilerplate code and improving maintainability. This blog explores how Hibernate ORM works, why it’s widely used, and how it fits into the data management strategy of a fullstack Java application. What is Hibernate ORM? Hibernate ORM is an open-source Java framework that provides a powerful and flexible mechanism for mapping Java objects to database tables. It abstracts the low-level JDBC code, allowing developers to work with high-level object-oriented concepts. Instead of writing raw SQL queries, Hibernate allows developers to define database interactions using simple Java classes (also known as POJOs) and annotations or XML configurations...
Read more