Show the currently executing Test Case both before and after it runs

After putting dozens of Test Cases together, I wanted a way to show where one test ended and another began. That way if something failed, I would at least have an idea which Test Case needed debugging or what sort of data was being read that caused the error.

This lead me to add a log.logWarning() command at the start and end of every test case. While this is fine, and works, there is a better way to handle it that requires less user intervention and it’s all but built in to Katalon.

The process is to use a Test Listener. This allows code to be executed at the start and end of every Test Case. In my simple example, the name and the status of the test are written to the log file during execution.

To make the Test Listener, right-click on Test Listener within Katalon Studio and select the options for Before and After a Test Case. Within the sample code, 99% is already written for you. I adjusted it to contain my Logging statements.

The two elements of interest are:

testCaseContext.getTestCaseId()
testCaseContext.getTestCaseStatus()
As reference, this is what my Test Listener looks like. For each test, the "Begin Test" text block is written out, along with the Test Case name. At the end, it's the closing block text and the Test Case name. This is followed by the status of the test case, PASS or FAIL. While this is a pretty meager use of the function, it's extremely handy and since this is the default sample, quite a few people were asking for just this functionality.

class GetTestCaseName {
KeywordLogger log = new KeywordLogger()

/**
* Executes before every test case starts.
* @param testCaseContext related information of the executed test case.
*/

@BeforeTestCase
def sampleBeforeTestCase(TestCaseContext testCaseContext) {
log.logWarning('--- Begin Test --- ' + testCaseContext.getTestCaseId() + ' ---')
}

/**
* Executes after every test case ends.
* @param testCaseContext related information of the executed test case.
*/

@AfterTestCase
def sampleAfterTestCase(TestCaseContext testCaseContext) {
log.logWarning('--- End Test --- ' + testCaseContext.getTestCaseId() + '---')
log.logWarning('Status:= ' + testCaseContext.getTestCaseStatus())
}
}

Other articles of interest:

Leave a Reply

Your email address will not be published. Required fields are marked *

Recent Comments
  • Integrating DevonAgent Pro with Alfred (1)
    • J. Garr: Beautiful, sweet, and simple. I love it; thanks for posting this solution.
  • Round and Round with the For..Next in Katalon Studio (1)
    • Sweet Ophaline Labador: Hello can you help me how to loop this scenario. Checking the elements is just the same. I want to check that the following function is available in www.siacargo.com: Track Shipment – clicking on this can...
  • How To Disable the Quicken Registration Prompt (30)
    • David: A BIG Thank you! I regularly reinstall Windows OS’s using different hardware configs. In short, Quicken 2011 (it’s March of 2020 as I write this) has been a program I’ve been very happy with and continue to use....
    • Karen L: Today I rang Reckon Australia again, got a different guy and he talked me through the process of getting me a new product key to enter since I already had the licence and it had been extended. Reckon have only extended it by 1...
    • Karen L: I have Australian Quicken 2008 on Windows 8.1. It keeps asking me to renew my licence which Reckon did for me however the activation won’t work. I tried this to disable the registration prompt however it did not stop the...
  • Parsing Strings in Katalon – Split, Substring and Readlines (6)
    • Don Pedro: String tempText=”Date Month January. Revenue $1,355,721.00″ println(tempText.split(“ \$”)[1]) You need to escape the $ with \$ The [1] on the split captures characters on the right of the split [0]...
    • Prasad: Hi, I need to get the substring from the below string ‘Date Month January. Revenue $1,355,721.00’ I want to extract text after $ value. Please help Thank you
  • Working with Dates and Date Formatting in Katalon Studio (15)
    • Sangeethaa: How to get previous day’s date(Yesterday’s date)? Actually I was using today.previous() before,it was working fine till today morning.Now its not retrieving right date. Can anyone please guide me on this.
    • Don Pedro: That could be a little tricky. First, is the text/format always going to be the same? You will need to do some parsing. Separate the first but of text at 2019. After that, split the text again to get rid of Central Standard...
    • Don Pedro: It should be of the same Date type as today. You could then do some calendar trickery with Calendar /*Calendar c = Calendar.getInstance(); //c.set(Calendar.MONTH, 1) //Set the month, 0=January, 11=December println...
    • josh: I’m testing a page with a string like “Updated November 21, 2019 16:25:32 PM Central Standard Time.” How might I capture the date and time and compare it to current time to verify that the update time was within...
    • zakir hussain: today = new Date() lastWeek = (today – 1.week) can u please help me in understanding what is the return type of lastweek? and I wanted to set nextyear date how can i do it
  • Output status messages and test information by writing to the Log File Viewer in Katalon Studio (6)
    • Saranya: Good One. Could you plz share link to access all your katalon related blogs. ThankQ
    • Rodrigo Calabretta: I’m using the KeywordUtil.markFailed or KeywordUtil.markError and my test stops is being shown as Error and If I use in the @afterTestCase the testCaseContext.getTestCaseSta tus() to show the status test case...
  • Setting up Environment Profiles in Katalon Studio (2)
    • Don Pedro: Not quite sure I understand. The term “Execution Profile” is normally used now, but they are still GlobalVariables and are created in the same way for version 7 as previous. You make a new execution profile, then...