I have published a GitHub repository at
Problem to solve
In the Katalon Community forum, there was a topic
Let me quote a part of the post here:
I´m trying to customize the html and pdf report in order to show some usefull information.
I would like to show the current branch of the repository that I´m testing in the Excecution environment section of the report
The original poster tried to customize the built-in HTML report compiled by Katalon Studio, but he could not find out the way. I knew the answer to him. The Katalon built-in report is not customizable at all. Then, what should he do?
Solution
In the following post, I suggested Extent Reports. Using it, he should be able to compile a new test execution report. It would be easy to insert the Git branch name, like GIT BRANCH: master.
Description
In the GitHub, I found a public repository by coty, Katalon CTO.
The repository contains a Katalon Studio project. Katalon users can learn how to use the Extent Reports in a Katalon project.
I forked the project to form a new GitHub repository at
I made some changes in the forked repository, and got a success to create a HTML report that displays :
Environment
I used
-
macOS Sonoma 14.7.3
-
Katalon Studio Free 10.1.0
How to run the demo
You can run the project and see the demonstration as follows:
-
Clone the Git repository https://github.com/kazurayam/extent-reports-applied-to-katalon-studio-project to your local machine.
-
Open the project with your Katalon Studio. Execute “Test Suites/Suite002”. It will take 30 seconds or so.
-
When the Test Suite finished, you will find
<projectDir>/Extent/yyyyMMdd_hhmmss/kseqatestreport.html, which looks something like this:
How the project is coded
My demo project is entirely a fork from the coty’s original project.
I made several changes in my demo project. You can find the exact differences between the original and my derivatives at the GitHub diff compare page at
- https://github.com/kazurayam/extent-reports-applied-to-katalon-studio-project/compare/original…0.1.0
Please note the following 3 points:
No change in com.katalon.extent.report.ExtentReport class
The com.katalon.extent.report.ExtentReport class
is the core part of the project, which implements the interface between your Katalon test scripts and the Extent Reports library. I made no change in it. The class source in my demo project is just
the same as the original.
Therefore, whenever the original repository is updated, I would not hesitate to do “git pull” from the original repository in to my fork.
A new class com.kazurayam.ks.ExtentReportsKeyword
I added a new class com.kazurayam.ks.ExtentReports. This class borrows all the methods of the com.katalon.extent.report.ExtentReport class as component. However, my class is capable to inject my own customization in to the report. For example, see the startEReport method:
@Keyword
def startEReport(TestCaseContext testCaseContext) {
component.startEReport(testCaseContext)
// customize the report!
component.extentTest.assignCategory("GIT BRANCH: " + getGitBranch())
}
Changed the TestListener
I edited the Test Listeners/ExtentReportsListener.groovy so that it no longer calls the original com.katalon.extent.ExtentReport keyword. Instead, It calls the new com.kazurayam.ks.ExtentReportKeyword. You can see the diff of old/new ExtentReportsListener at:
I would quote a small piece out of the changes:
@BeforeTestSuite
def sampleBeforeTestSuite(TestSuiteContext testSuiteContext) {
- //CustomKeywords.'com.katalon.extent.report.ExtentReport.deleteFolderContents'()
- CustomKeywords.'com.katalon.extent.report.ExtentReport.attachEReport'(testSuiteContext, "Extent Report", "KSE QA Test Report")
+ //CustomKeywords.'com.kazurayam.ks.ExtentReportsKeyword.deleteFolderContents'()
+ CustomKeywords.'com.kazurayam.ks.ExtentReportsKeyword.attachEReport'(testSuiteContext, "Extent Report", "KSE QA Test Report")
}
A warning. If the original repository by @coty is updated in future and if I do “git pull” into the fork, then it is likely to encounter some merge conflicts over the Test Listeners/ExtentReportsListener.groovy. However, I believe the original repository will be left unmaintained in future. So that, I wouldn’t mind this risk too much.
How the external dependancies are managed?
If you look into the <projectDir>/Drivers, you will find several jar files on which this project depends.
$ tree Drivers
Drivers
├── extentreports-5.1.1.jar
├── freemarker-2.3.32.jar
├── katalon_generated_extentreports-5.1.1.jar
├── katalon_generated_freemarker-2.3.32.jar
├── katalon_generated_gson-2.10.1.jar
├── katalon_generated_lombok-1.18.26.jar
├── katalon_generated_reactive-streams-1.0.4.jar
├── katalon_generated_rxjava-3.1.8.jar
├── reactive-streams-1.0.4.jar
└── rxjava-3.1.8.jar
1 directory, 10 files
I have a doubt about this list of dependencies. Do we need the
extentreport-5.1.1..jarandkatalon_generated_extentreports-5.1.1.jartogether? It looks duplicating, isn’t it? But for now I wouldn’t mind this point.
If you are going to use Extent Reports in your own Katalon project, you want to copy those jar files into the Drivers folder of your own project.
When you accidentaly removed all those files, you can restore them by invoking a Gradle build:
:~/katalon-workspace/extent-reports-applied-to-katalon-studio-project (master *)
$ rm Drivers/*
:~/katalon-workspace/
$ gradle katalonCopyDependencies
...
BUILD SUCCESSFUL in 1s
1 actionable task: 1 executed
:~/katalon-workspace/
$ ls Drivers/
katalon_generated_extentreports-5.1.1.jar
katalon_generated_freemarker-2.3.32.jar
katalon_generated_gson-2.10.1.jar
katalon_generated_lombok-1.18.26.jar
katalon_generated_reactive-streams-1.0.4.jar
katalon_generated_rxjava-3.1.8.jar
If you are interested in how Gradle works in this project, you should study the build.gradle file.
