Waiting on elements to appear using While Loops

Timing is everything. Certainly so when it comes to automation and waiting for elements to appear before moving on to the next step. While Katalon has several wait methods, including the new smart wait, there are times when you have to wait for a text change. In this case, we aren't waiting for an object, we are waiting for a condition to change. For example, we need the number of search results to increase or decrease. Or we already have a list of names, but the one we want isn't available yet.

In these cases we will use the while loop to get our status and add a delay until what we are searching for is available.

In the example below, we are waiting for a status change. We have previously created an item and now we need for the status to show as "Sold." When that happens, we can proceed with the next step.

The first thing we need to do is search for our item and read the status. If it already shows as "Sold," we can move on. If not, we reset our search criteria and search for the item again. We also add a 1 second delay. We keep repeating this until we get our "Sold" status.

itemStatus = WebUI.getText(findTestObject('select-Status Action'))
while (itemStatus.contains("Sold")!=true){
    //If the item is not set to Sold, search for it again to refresh the results
    WebUI.setText(findTestObject('input-Search Name'), GlobalVariable.itemList)
    WebUI.click(findTestObject('btn-Go Search'))
    WebUI.click(findTestObject('btn-Filter-All'))
    WebUI.delay(1)
    itemStatus = WebUI.getText(findTestObject('select-Status Action'))
}

This will certainly work, but there's a problem. If the status doesn't change, we have an endless loop. What we need is to check the condition and implement a counter. We can then check that our condition is met AND we haven't tried too many time. This can be done using the AND (&&) as part of our loop.

In this case, if we don't find the user name AND we try 20 times, it's time to bail out and fail the test.

In the example below, we are searching for a user. Since we already have a table of names, we can't wait for an element, because it's already visible. We also can't assume the first name we is correct since it may not have changed correctly and we will get a false positive.

We read the first name in the list to see if it's the one we want. If not, we add a delay of 1 second, then read the name again.

Additionally, we have added a counter that will increment up to 20 times. This equates to 20 seconds, which should be more than enough time for the name to appear.

If for some reason it doesn't, we won't be able to proceed, so the test is marked as Failed and stopped.

    //User Name in column 1, User Role in column 5
    userName=WebUI.getText(findTestObject('table-User Role Details', [('row') : 1, ('column') : 1]))
    while(userName!=GlobalVariable.UserName && counter<=20) {
        if (counter>=20){
            log.logError('ERROR: Login and User Name DO NOT match')
            log.logError('Could not find user: ' + GlobalVariable.UserName)
            KeywordUtil.markFailedAndStop('ERROR: Login and User Name DO NOT match')
        }
        WebUI.delay(1)
        userName=WebUI.getText(findTestObject('table-User Role Details', [('row') : 1, ('column') : 1]))
        counter++
    }

These are simple examples, but they show the process of waiting for something to change that isn't based on elements. In many cases, the page is loaded, we just need to wait for a certain piece of information to change. This is better than a forced delay WebUI.delay(1) because we can still have a dynamic test.

In one run it might take only a second for the status to change. In another run it might take 5 or even 10 seconds for the change to occur. With the while loop, we can handle both without the test waiting when the condition is actually correct.

Other articles of interest:

Leave a Reply

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

Recent Comments
  • 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...
  • Here is my drive cluster (2)
    • Don Pedro: While I still have those drives, the drive cluster looks nothing like that now. Almost all of my external drives have had the cases removed and they have been installed into a series of MediaSonic 8 Bay Drive Enclosures. I...
    • Marin Boucher: Hi! Verry funny blog with “go to the point” on many post! I spent good time reading some of your post. Regarding this one about NAS, “many NAS” in fact, I would be curious to see a screenshot of...