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
  • How to Block games by Title and Tag on Steam (1)
    • JACK: Thanks, same just wanted to block anime games in my discover
  • How To Disable the Quicken Registration Prompt (25)
    • Greg: For me, holding the *LEFT* CTL + Shift then clicking Online, One Step Update worked. I originally tried holding the right CTL + Shift, and it didn’t work. I’m using Quicken 2006, so I don’t know if it will work...
    • Joe SR>: My monthly income is deposited into my Credit Union account. I use debit whenever possible. I write checks manually and mail them. I use Quicken 2012 off-line only. I have entered all my money and investment accounts. I...
    • Prtet: Never say never….every time I swear I will never use Quicken again, I discover that there are still no viable alternatives. Amazing that there is no decent personal finance software.
    • Joe D.: Holding CTRL + Shift keys and selecting On Line | One Step Update from the main menu worked for my Quicken 2004. I’m grateful that you wrote a synopsis (“Simply put, …”) just beneath the link to the blog...
    • Susan Long: I bought my quicken disc in the beginning and it came with a registration number. I rang the helpline and they gave me the code to put in and talked me through it. It you downloaded your version then you don’t own it...
    • Peter: You might consider running your old version of Quicken on an ancient computer. This is what I have done for years. The newer versions are fraught with problems- criminal, in my opinion. One version made mathmatical errors when...
    • Roslyn Chamberlain: Can I stop the countdown in quicken 2001 says only 8 sessions left. and what will happen after?
  • Parsing Strings in Katalon – Split, Substring and Readlines (1)
    • Ellen: Thanks for sharing!! I like your contributions to Katalon topics.
  • Working with Dates and Date Formatting in Katalon Studio (6)
    • Ajoo: Thank you for the details. How do i remove leading “0” from dates. i.e. while formatting i receive 04/21/2019, but i need 4/21/2019. (same applies for date)
  • What is Katalon Studio? A Distro of Selenium, Groovy and Eclipse (1)
    • Mahesh: Looking for more posts on katalon studio.your katalon stuffs are always exiting
  • Simple wildcard searches for pattern matching (2)
    • Don Pedro: For that scenario it seems .contains would be your choice. For example, variable.contains(‘amazo n.com’) to see if the url had amazon.com. In that case, www.amazon.com, forum.amazon.com, retail.amazon.com would all...
    • Jony: Hi, How can I use a wild card to assert a URL is the one I want. I just want to verify the domain ==expected but not anything after it. Tried * but not working and only works when I have full URL.
  • Create a Dynamic Object at Runtime (2)
    • Saish: How to add shadow root parent to this runtime object..
    • Jeremy Brien: I appreciate this! I saw this post on LinkedIn this morning and was able to find a use case for it! I found that defining my xpath with an iterable variable allows me to loop through and capture text from tables created...