Creating and Calling Methods for Test Cases in Katalon Studio

While it’s possible, and encouraged to set up Custom Keywords to perform repeatable code blocks, the same thing can be done within the Test Case itself. Methods can be defined with the Test Case and called as many times as needed.

As an example, let’s say there are 5 filter boxes on the site. Each filter has a value for a certain type of result. A simple test would be to click each filter and confirm the results in the table match the filter type.
Using the brute force method, there would be 5 code blocks with almost identical code. We would want to read the type of filter, perhaps count the results, click the filter, then confirm the values in table of results.

If we built a method within the Test Case, we could pass in the filter object details, then capture the information we need.

To create the Method, we set it up the same way as it would appear for a Custom Keyword. We omit the @Keyword label and define our procedure. Once the Method has been defined, all we need to do is call it and pass any parameters it calls for. In the example below, the index value of the filter and it’s name are passed to the Method.

The Method below reads the number of results available from the filter. If there are more than 3, it only checks the first 3. If there are 0, an entry is logged stating there are no results. From there, it clicks the filter, then reads the status column from the table of results. The status can be Started, In Progress, Complete or Expired. When we click the Complete filter, the status for each result in the table should Complete. If not, there is something wrong and an error is written to the log.

Again, this is a simple example, but it demonstrates that Methods can be written for the Test Case itself and aren’t just for Custom Keywords.

Additionally, when it comes to Groovy, if you want the Method to return a result, adding the “return” statement at the end takes care of that.
Such as:

return totalNumberOfRows

It’s then possible to set a variable to the result of the Method with:

rowResults=CustomKeywords.'commonCode.selenium.countRowsPerPage'(xpath)
    WebUI.navigateToUrl(GlobalVariable.baseurl)

def checkFilterStatus(int buttonIndex, String filterType){
    KeywordLogger log = new KeywordLogger()
    log.logWarning('Checking Filter Type - ' + filterType)
    WebUI.click(findTestObject('Home/filter-Status Filters', [('buttonIndex') : buttonIndex]))
    String tempText=WebUI.getText(findTestObject('Home/filter-Status Filters', [('buttonIndex') : buttonIndex])).replaceAll(filterType+' |\\(|\\)','')
    int filterText=Integer.valueOf(tempText)
    if (filterText>3){
        filterText=3
    }
    if (filterText==0){
        log.logWarning('NOTE: There are no results to verify for the filter')
    }
    for (int loop = 1; loop <=filterText; loop++) {
        tempText=WebUI.getText(findTestObject('Home/label-Status', [('row') : loop, ('column') : 2]))
        log.logWarning('Checking result: ' + loop)
        if (tempText!=(filterType.toLowerCase())){
            log.logError('ERROR: The Status type of ' + filterType + ' does not match the filter type')
            KeywordUtil.markFailed('ERROR: The Status type of ' + filterType + ' does not match the filter type')
        } else {
            log.logWarning('SUCCESS: The Status type of ' + filterType +' matches the filter type')
        }
    }
}

//Check Filter Status - Pass button index and text of the button
checkFilterStatus(2, "Started")
checkFilterStatus(3, "In Progress")
checkFilterStatus(4, "Complete")
checkFilterStatus(5, "Expired")

Other articles of interest:

Leave a Reply

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

Recent Comments
  • 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...
  • Output status messages and test information by writing to the Log File Viewer in Katalon Studio (2)
    • Don Pedro: That would be things like: log.logWarning(‘The import date listed on the site is: ‘ + importDate) log.logWarning(‘The value from the site is: ‘ + salesFigure) log.logWarning(‘Filter Results for ‘ +...
    • Prashant Pednekar: Thanks for the informative article but can we also put some variable values to make it more exciting.
  • Setting up a repeatable Search Method in Katalon Studio (1)
    • RJ: Thanks a lot! This is very helpful 🙂
  • Filling forms with random numbers in Katalon Studio (3)
    • Patrick Clough: We created a handy random string generator custom keyword. The method takes in a string for the type of string you want, and an integer for the length. Looks like this: static String RANDOM_ALPHANUM =...
    • Don Pedro: randomNumber is the variable that holds the result of generating a new random number. Depending on how things work on your site, you might need to convert the number to a String before it’s recognized correctly....
    • Seth: When you are setting up randomNumber is this a new keyword or a new variable? I am trying to randomly generate unique socials and can’t seem to connect my generator to my Set Text.
  • Working with Dates and Date Formatting in Katalon Studio (5)
    • Ann: THANK YOU ! That worked perfectly !
    • Don Pedro: import groovy.time.TimeCategory currentDate = new Date() println currentDate use( TimeCategory ) { after30Mins = currentDate + 30.minutes } println after30Mins https://stackoverflow.com/ques tions/21166927/incrementing...
    • ricky julianto nugroho: hay can u gave me an example for plus a hour in the time ? example : now is 15 pm i want to print 16 in the text thank you
  • Boostnote for Code Snippets (1)
    • Manual: Hi Don, Regarding the code snippets and examples that you have created. Is there any GitHub repo or something that can be shared? Thanks
  • Using TypeIt4Me with Katalon Studio (3)
    • Manual: That’s great thanks for sharing.