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.