Round and Round with the For..Next in Katalon Studio

Another big improvement with Katalon Studio is the looping mechanisms. The Selenium IDE could use loops with the addition of the SelBlocks plugin, but Katalon and Groovy support that natively and I use it frequently to read values from a table.

From the old BASIC days, the FOR loop is:

For A=1 to 5 (Step 1)

Print("hello world")

Next A

We have quite a few shortcuts and it now looks like this:

for (loop = 1; loop <=5; loop++) {

  println("hello world")

}

To get started, Katalon offers a way to set up a FOR loop in Manual view. If you click the down arrow next to Add, there is an option for Looping Statements and within there, For Loop Statement.

for-next

Choosing this option, creates a FOR loop that looks like:

for (def index : (0..0)) {

}

While either format is acceptable, I actually prefer:

for (loop = 1; loop <=5; loop++)

For my inexperienced mind, it’s a little easier to understand at a glance. It’s also the way SelBlocks did it, so it looks more natural to me.

Following that example, here is a loop that counts from 1 to 10 in order to read the 10 categories listed on a page. For each row it reads the Category name, the YTD Sales value and the YTD Plan value. Since there are always 10 categories, the boundary of loop is set at a specific number.

//Read the Product Category, the YTD Sales, YTD Plan from the table

for (loop = 1; loop <=10; loop++) {

 planCategory=WebUI.getText(findTestObject('Page_/Customer Search/Customer 2018 Plan Tab/Plan Tab Category', [('Variable') : loop]))

 planYTDSales=WebUI.getText(findTestObject('Page_/Customer Search/Customer 2018 Plan Tab/Plan Tab YTD Sales', [('Variable') : loop]))

 planYTDPlan=WebUI.getText(findTestObject('Page_/Customer Search/Customer 2018 Plan Tab/Plan Tab YTD Plan', [('Variable') : loop]))

 log.logWarning('Category: ' + planCategory + ' -:- ' + 'YTD Sales: ' + planYTDSales + ' -:- ' + 'YTD Plan: ' + planYTDPlan)

  }

The FOR loop can also be set to a variable, something determined based on information read from the site.

The code below is an example of the FOR loop being used to read values off the Sales Dashboard and sum them up. The loop uses a secondary counter (monthOfYear.toInteger() – 1) to determine how many iterations are needed. It then reads the Plan Value by passing in the value of loop to the Variable configured as part of the object. In this case, the variable represents the row we are reading.

As part of the loop, the $ and , are removed from the figure, so the values can be summed. This total is then checked against the total read from the site to make sure the calculation is correct.

Since the values being read are of type String the Integer.valueOf command is used to turn the values into Integers so they can be summed correctly.

for (loop = 1; loop <= (monthOfYear.toInteger() - 1); loop++) {

    tempText = WebUI.getText(findTestObject('Page_/Sales Dashboard/YTD Gross Profit Plan Value - By Month tab', [('Variable') : loop]))

    grossProfitMonth = tempText.replaceAll('[$,]', '')

 grossProfitPlanTotal = (Integer.valueOf(grossProfitPlanTotal) + Integer.valueOf(grossProfitMonth))

}

There are plenty of other uses for the FOR loop, but the basic structure is the same. For my cases, the loop is used to read a series of values from a table. Depending on where I place my Variable definition within the Objects XPATH definition, that can be reading down a column or reading across rows. It’s a simple command, but it provides a lot of power.

Other articles of interest:

Leave a Reply

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

Recent Comments
  • Create a Dynamic Object at Runtime (1)
    • 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.
    • Don Pedro: Added a screenshot to show some examples of how I have shortcuts configured for Groovy code. TypeIt4Me supports groups, so you can create shortcuts related to Groovy, Selenium, and other topics to keep them organized. You can...
    • Manual: Hi Don, I like the idea of using the TypeIt4Me for scripting test code. Could you please share how I can create. I also like the idea of creating code templates to use with code editors. Thanks, Manual
  • Another success with Katalon Studio (2)
    • Don Pedro: Since Katalon is free, a very practical demonstration of what it can would be to create the code needed to fill in forms. That was one of my first tasks as Katalon could fill in a lengthy form in seconds versus the minute or...