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
  • Custom Keywords for Custom Functions (1)
    • Sarah: Thank you for this. It helped me understand these better.
  • How To Disable the Quicken Registration Prompt (26)
    • Denise Defoor: I have a Quicken SE Version 6 .. My computer crashed a few weeks ago and I finally got it up and running. Now Quicken is telling me I must registered it. What? I have had this program for 20 years. How can I disable the...
    • 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...
  • Parsing Strings in Katalon – Split, Substring and Readlines (4)
    • Anjana: Hey thanks for the response It is quite strange but initializing variable for delimiter and it worked String splitFormat = ‘-‘ WebUI.println(var_CampaignDura tion.toString().split(splitFor mat)[0])...
    • Don Pedro: I’m not really sure what the difference is, but I don’t think the “-“ in the split is the same as the one in the date. String var_CampaignDuration = “05/13/2019-06/07/2019&# 8221; String[] parsedDateRange =...
    • Anjana: Hi, I tried the same thing to split the string, but does not work for me, Could you plz point out whats wrong Variable var_CampaignDuration has value “05/13/2019-06/07/2019&# 8221; String[] parsedDateRange =...
    • Ellen: Thanks for sharing!! I like your contributions to Katalon topics.
  • How to Block games by Title and Tag on Steam (2)
    • Marcus861: I made an acc just to say: Same bro
    • JACK: Thanks, same just wanted to block anime games in my discover
  • Create a new and random UUID for an API call (1)
    • Anonymous: Hi ! I found this blog few weeks ago and it’s really helping me out with my tests! Thanks a lot for the Katalon tips and tricks ! Keep up the good work 🙂
  • 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)