Extent Report Integration

Extent Reports is a customizable HTML reporting library for Java and .NET that provides rich, interactive, and detailed test reports. It offers features such as pie charts, logs, screenshots, and more, making it a popular choice for test reporting in auto

1.1K

Streamline Test Reporting with Extent Reports in Katalon Studio

Introduction:

In today's fast-paced software development landscape, ensuring the quality of applications is paramount. Automated testing has become a cornerstone in achieving this goal, with tools like Katalon Studio empowering teams to automate tests efficiently. However, effective test reporting remains essential for understanding test results and making informed decisions. In this blog post, we'll explore how to leverage Extent Reports within Katalon Studio to streamline test reporting and enhance visibility into test execution results.

What is an Extent Report?

Extent Reports is a flexible and interactive reporting library for Java and .NET. It generates detailed HTML reports that include:

  • Execution status (pass/fail/skip)
  • Step-by-step logs
  • Embedded screenshots
  • Pie charts, timelines, and more

This makes it a go-to tool for enhancing visibility into automated test results.

How to Integrate Extent Reports with Katalon Studio?

Install the Plugin

  • Install the Extent Report plugin from Katalon Store.
  • Alternatively, download this plugin offline from ChangeLog.

Configure Test Listeners:

Create a listener to hook into test lifecycle events (suite start/end, case start/end). This helps you:

  • Initialize and flush Extent Reports
  • Automatically log test status
import com.katalon.extent.ExtentReportManager
import com.kms.katalon.core.annotation.*
import com.kms.katalon.core.context.*

class ExtentReportListener {


@BeforeTestSuite
def beforeSuite(TestSuiteContext suite) {
    ExtentReportManager.startSuite(suite, "Extent Report", "KSE2 QA Test Report")
}

@BeforeTestCase
def beforeCase(TestCaseContext testCase) {
    ExtentReportManager.startTestCase(testCase)
}

@AfterTestCase
def afterCase(TestCaseContext testCase) {
    ExtentReportManager.endTestCase(testCase)
}

@AfterTestSuite
def afterSuite(TestSuiteContext suite) {
    ExtentReportManager.endSuite()
}

}

Add Logging and Screenshots to Test Cases

Use the following custom keywords in your test case to enhance the report:

 CustomKeywords.'com.katalon.extent.report.ExtentReport.attachLog'("Enter Description here")
 CustomKeywords.'com.katalon.extent.report.ExtentReport.addScreenshot'()

Additional Logging Options:

 CustomKeywords.'com.katalon.extent.report.ExtentReport.logPass'('Test Passed')
 CustomKeywords.'com.katalon.extent.report.ExtentReport.logFail'('Validation Failed')
 CustomKeywords.'com.katalon.extent.report.ExtentReport.logInfo'('Step Description')
 CustomKeywords.'com.katalon.extent.report.ExtentReport.logWarning'('Caution: Unexpected popup')

Note:

  • addScreenshot() works on both Web and Mobile platforms.
  • Set the Global Variable G_EnableStepScreenshots to true to automatically capture a screenshot after each test step.

Run the Tests

  • Execute any Test Suite or Test Suite Collection
  • Reports are automatically generated inside your project’s Extent folder.

Users can refer to Extent Report Form to learn how this plugin can be used with BDD Cucumber for Azure CI/CD.

Key Notes:

  • The Extent Report plugin empowers users to effortlessly generate advanced Extent Reports within Katalon.
  • Empower users to capture screens as needed.
  • Enable users to seamlessly incorporate logs and descriptions into their reports.
  • Facilitate automatic screenshot capture for failed test cases.
  • Automatically capture stack traces for failed scenarios.
  • Offer the functionality to delete existing reports and replace them with updated versions.
  • Enable users to maintain a comprehensive history of all reports.
  • Provide users with the flexibility to customize report names and titles.
  • Enable the generation of test reports in multiple languages with minimal adjustments.
  • Users can use this plugin with CI/CD tools like Jenkins and Azure DevOps to publish their report artifacts.
  • The plugin will generate reports exclusively for test suite and test suite collection executions. However, users retain the capability to execute individual test cases without encountering failures.

Conclusion:

By integrating Extent Reports with Katalon Studio, teams can enhance their test reporting capabilities and gain deeper insights into test execution results. With its interactive and customizable features, Extent Reports empower teams to create informative and visually appealing reports that facilitate better decision-making and collaboration across the project lifecycle. Whether you're a QA engineer, automation tester, or project manager, leveraging Extent Reports in Katalon Studio can significantly improve the effectiveness and efficiency of your test reporting process.

Visit Katalon Forum for Plugin related discussions.

3.4
5 Rating(s)
Kevinhuang undefined
April 30, 2025

When reload plugins from katalon studio, got "Zip headers not found. Probably not a zip file" error, how to solve this? installation is from Store

Krystlu undefined
April 1, 2025

The plugs very convenient and easy to use Thank you so much. And could you pls help to add a new function, For attachLog function could we set add new one and params are details and test or pass or skip status, so that we could set step status.

sesencayi undefined
August 8, 2024

14:34:13.506 [main] ERROR freemarker.runtime - Error executing FreeMarker template freemarker.core._MiscTemplateException: Template inclusion failed (for parameter value "partials/exceptıon.ftl"): Template not found for name "spark/partials/exceptıon.ftl". The name was interpreted by this TemplateLoader: ClassTemplateLoader(resourceLoaderClass=com.aventstack.extentreports.ExtentReports, basePackagePath="templates/" /* relatively to resourceLoaderClass pkg */). ---- FTL stack trace ("~" means nesting-related): - Failed at: #include "partials/${view.toString()}... [in template "spark/spark.spa.ftl" at line 27, column 36] what is this problem???

Keerthana Anbalagan
April 12, 2024

This plugin facilitates understanding the automation test coverage percentage across various instances by utilizing Testing Types tags. It is user-friendly, easy to install, and provides consolidated reports with diverse dimensions such as cross-browser testing and testing across different instances.

mohit.kumar
April 12, 2024

Thank you for utilizing this plugin. We trust that it will be immensely beneficial to you

mohit.kumar
April 12, 2024

The Katalon Extent Report Plugin is a powerful tool that enhances test reporting capabilities within the Katalon Studio automation framework. This plugin offers ease of use and generates user-friendly reports.

This plugin is included in Katalon Studio Enterprise subscription.
API keys are required in Katalon Studio Commandline Execution. Generate Key
Information
Project details
Version
10.0.0
Type
Custom Keywords Plugin
Last updated
July 18, 2025 7:46 pm
Publisher
Privacy and License Agreement