Getting started with Katalon Studio

You don't have automate an entire website to gain a benefit from automation. Even for yourself, there are plenty of ways Katalon Studio can help you save time. One of the main goals of automation is to perform repetitive tasks and emulate the same functions you do on a daily basis. And on one of the best places to start is filling in forms.

Entering form data is by no means a difficult job, but it's tedious and after a couple of passes, you really don't care what you type as long as the field isn't blank. Plus, it can be a waste of time. If it takes 5 minutes to fill in a form accurately and wait for it to save, that's roughly 10 forms an hour. And that's an hour that can be invested in something more meaningful.

With some simple automation code, filling in the entire form can be reduced to 30 seconds. Plus, it will be filled out correctly each time with predictable data you can search for and confirm exists. So instead of spending 5 minutes for each form, it would be possible to create 10 contacts in 5 minutes, or 10 times the amount of work with 1/10th the effort. And that savings of nearly 45 minutes can be put toward other projects like training, self-study, or for improving the automation code itself.

Filling in form data is one of the easier tasks to accomplish with automation. In most cases, the objects will follow a similar naming pattern such as:

css=input[name="contact_email"]
//div[@id='add-Contact']/form/input[7]

It would be a matter of copy/paste to change the xpath to the correct name, or use a variable for multiple inputfield objects.

The same should be true for entering text:

WebUI.setText(findTestObject('Object Location/inputfield-Contact-Contact Email'), 'user@domain.com')

After creating one SetText entry, copy/paste the rest, change the object and entered text and the job is done.

With a little bit of prep work, it would be possible to spend an hour or so and put together a script that will give a return on the time investment after the first couple of runs. And keep giving back time every time it's run.

Running the Test Case to create a new contact is something I run regularly. I can make dozens of entries while working on something else. That is a very big win in my opinion.

The core of the script could be some as simple as:

WebUI.setText(findTestObject('Object/inputfield-Contact-First Name Last Name'), 'Bob Smith')
WebUI.setText(findTestObject('Object/inputfield-Contact-Role or Title'), 'Customer Title)
WebUI.setText(findTestObject('Object/inputfield-Contact-Contact Phone'), '5552221112')
WebUI.setText(findTestObject('Object/inputfield-Contact-Contact Mobile'), '5553331113')
WebUI.setText(findTestObject('Object/inputfield-Contact-Contact Office'), '5554441114')
WebUI.setText(findTestObject('Object/inputfield-Contact-Contact Email'), 'user@domain')
WebUI.setText(findTestObject('Object/inputfield-Contact-Address Line'), '12 West Upper Court')
WebUI.setText(findTestObject('Object/inputfield-Contact-City'), 'Tempe')
WebUI.setText(findTestObject('Object/inputfield-Contact-State'), 'AZ')
WebUI.setText(findTestObject('Object/inputfield-Contact-Zip Code'), '85281')
WebUI.setText(findTestObject('Object/inputfield-Contact-Phone Number'), '3335551212')
WebUI.setText(findTestObject('Object/inputfield-Contact-Email Address'), 'user@domain.com')
WebUI.click(findTestObject('Object/btn-Contact-Save Button'))

Other articles of interest:

Simple wildcard searches for pattern matching

For a search test I was working on, I needed to verify what was returned for the name of a warehouse location. Normally the .contains command would be used, but for this test, I needed to check for multiple criteria. I need to check the warehouse is assigned to a certain coast and contains certain city values. The warehouse could be East or West with several city names listed afterward in any given order. For example, the warehouse location could look like:

String branchName="Warehouse East #585 Palm Beach, FL Charlottesville, VA Nampa, ID Charlottesville, VA"
String branchName="Warehouse West Los Angeles, CA, San Francisco, CA, San Diego, CA"

I want to verify "Warehouse East" is part of the text and I want to verify "Palm Beach" is in the text. Since these two strings are not next to each other and the city could appear anywhere on the line the .contains will not work in this instance.

However, the .matches command can be used which supports the wildcards, * and ?. The usage is the same as we see for filenames. For example *image* matches all filenames with the word image such as image, images, fileimage. The only difference is we have to "escape" the wildcard with the use of .*

With that in mind we can make the following command verify our chosen text strings exist in the returned result.

println(branchName.matches("Warehouse East .*Palm Beach.*"))

To use the single wildcard .? we could write the line as:

println(branchName.matches(".?arehouse .?ast .*Palm Beach.*"))

This ignores the case for the W and E, so Warehouse East is the same as warehouse east

It is also possible to use a more "regex" style and write the above line as:

println(branchName ==~/.?arehouse .?ast .*Plam Beach.*/)

This falls into the brute force category of pattern matching, but I have pretty simple needs and taking the time to write a custom parser isn't necessary and ins't in the cards.

Other articles of interest:

Some new tools to tackle the job in 2019

With 2019 practically upon us, I have some new tools to help with project management, task management, along with code and document organization.

Since there is plenty of manual testing to be done, I've brought in Pagico to help manage projects and 2Do, to help with task management and test management. I've got MWeb for note taking, DevonThink Office to organize and manage all my notes, Coderunner to help write code pieces and SnippetsLab to store code pieces I'm working on.

With Pagico, I can create lists, link documents, and group together the information I need for a given project. For example, I can enter due dates, store the links to Requirements and JIRA tickets, create reminders, track open tickets, and link to PDF files. In many respects it's my replacement for Freeter. I've tracked two projects so far with great success.

2Do is for task management, both for personal and project items. It's easy to create a list, set reminders, and even make a test plan without having to resort to Excel. To be honest, I've made one too many checklists using a spreadsheets and it's a terrible experience. 2Do is much easier to organize and structure.

DevonThink Office Pro is the command center of note taking and storage. It can create notes in a variety of formats as well as store documents like .doc, .xls, .pdf and pretty much everything else. Documents and topics can be tagged with keywords and linked together. Web pages can be imported and stored. To be honest, it's feature set is kind of massive. If you need to store information for a topic, this is the tool to handle it.

Coderunner 3 is a very nice tool for working on small code projects, whether they be Groovy, Java, Python or Shell Scripts. It's a very nice editor that keeps things simply and tidy. You can try out a new code idea in an IDE that takes a second to load rather than waiting for all the libraries and plugins to initialize for something like IntelliJ. It's very quick and nimble and I'm quite taken with it.

MWeb is great note taking and markdown tool. It runs very quickly, supports multiple themes as well as making your own, organizes documents into folders and allows multiple tabs. Documents can be exported in a variety of formats such as HTML, Rich Text, ePub, PDF, and Doc. DevonThink can also be used to track and index whatever notes you create.

You wouldn't ask a carpenter to make a fine table using nothing but a hacksaw and a screwdriver. I'm coming to the table with a variety of tools to get the job done and track what it took to complete.

Pagico
2Do
DevonThink Office Pro
Coderunner 3
SnippetsLab

Other articles of interest:

Create a Dynamic Object at Runtime

I'm not quite at the point to need to make an object outside of the Object Repository, but I've seen reference to it multiple times and wanted to put together a simple example because who knows when it might come up. There have been several comments about keeping the size of the Object Repository small so it's better to programmatically create a one-off object rather than commit it to the project.

Katalon Studio allows creating objects during runtime through the TestObject library.

import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.testobject.ConditionType

The object is created by giving it a name and associating a property to it. In the very simple example below, "xpath" is set with the location of a tab on the page.

TestObject is created with the name "dynamicObject"

The "dynamicObject" is given an xpath value that equals the contents of the xpath String

Once the object has been created, it can then be clicked.

The main work is done through this command:

TestObject dynamicObject = new TestObject('dynamicObject').addProperty('xpath', ConditionType.EQUALS, xpath, true)

xpathOfObject="//a[contains(text(),'Contacts')]"
TestObject dynamicObject = new TestObject('dynamicObject').addProperty('xpath', ConditionType.EQUALS, xpathOfObject, true)

WebUI.click(dynamicObject)

There is one important thing to note, since this object is not part of the project Object Repository, the call to manipulate it is slightly different. Note there is no, findTestObject, or the path of the object as part of the command. If the object were part of the project, the command would look like this:

WebUI.click(findTestObject('Project/Customer Profile/Tabs/tab-Contacts'))

The same would be true if this object were passed to a Custom Keyword:

WebUiCommonHelper.findWebElement(objectReference,5)
vs

WebUiCommonHelper.findWebElement(findTestObject(objectReference,5))

Again, I don't know that I have a use case for this scenario, but others have brought it up, and Katalon fully supports it. A dynamic object is quite an easy thing to create and the only real change is how the object is referenced by telling Katalon not to look in the Object Repository, but "locally" if you will.

Other articles of interest:

Get the xpath of an object in the Object Repository using findPropertyValue(‘xpath’)

In order to write a Custom Keyword to sum any column within a table, I need to know the number of rows in that table. I already have a Custom Keyword to count objects using the WebDriver, but is it possible to use the same method without having to define and pass the xpath separately?

The answer is, yes, you can get the xpath of an object that exists in the Object Repository using:

findTestObject and findPropertyValue('xpath')

This property can be read and then passed to a Custom Keyword such as countRowsPerPage. The String will look like:
"//div[@id='byMonth']/div/table/tbody/tr" as though you defined it manually.

To get things started, I have an object in the Object Repository called, Home/table-ytd-totals, which accepts Row and Column as variables to locate the cell in a table. This object will be used as part of the Test Case and is defined as:

String katalonObject="Home/table-ytd-totals"

Using that reference, I want to create an Object variable so I can get the properties, in this case the xpath, for that table. Since this object is a table, I pass the parameters of Row and Column to make it complete definition.

myPredefinedObject = findTestObject(katalonObject, [('row') : 1, ('column') : 1])

I can now use findPropertyValue('xpath') to get the properties.

log.logWarning("xpath= " + myPredefinedObject.findPropertyValue('xpath'))

And there it is, the full path of whatever has been defined for my table. For my case, the property would be returned as:

//div[@id='byMonth']/div/table/tbody/tr[1]/td[1]

In order to correctly count the rows for my table, I need to remove the trailing TD references and only keep the TR portion. That can be done with a ReplaceAll.

xpath=myPredefinedObject.findPropertyValue('xpath').toString().replaceAll('tr\\[1\\]/td\\[1\\]','tr')
* Note the escape characters to remove the brackets \\[ and \\]

I now have:

//div[@id='byMonth']/div/table/tbody/tr

Which can be passed to my countRowsPerPage method as:

int rowsInTable=CustomKeywords.'tools.commonCode.countRowsPerPage'(xpath)

The rowsInTable variable is then used as the counter in the loop, so I can sum the column. This is passed as a parameter, along with the name of the table from the Object Repository and the column I wish to sum:

int siteColumnTotal=sumColumnTotal(katalonObject, 3, rowsInTable)

I might a little overly excited by this! I can define a single object in the Object Repository and not redefine the xpath each time I need to use the WebDriver. With this in place, I can sum the column of any table on the site. This will eliminate a lot of repetitive code and make maintenance a whole lot easier. No more one-off xpath references inside the code.

The whole code block looks like this:

//Define variables that reference the table objects
String katalonObject="Home/table-ytd-totals"
myPredefinedObject = findTestObject(katalonObject, [('row') : 1, ('column') : 1])
xpath=myPredefinedObject.findPropertyValue('xpath').toString().replaceAll('tr\\[1\\]/td\\[1\\]','tr')

//Count the number of Rows in the table, then sum the column
int rowsInTable=CustomKeywords.'tools.commonCode.countRowsPerPage'(xpath)
int siteColumnTotal=sumColumnTotal(katalonObject, 3, rowsInTable)


def sumColumnTotal(String objectName, int columnToSum, int tableRows){
    /* Sum the column of a table
     * @param objectName - The Object Repository reference to the table
     * @columnToSum - The column to perform the sum on
     * @tableRows - The number of rows in a table
     * @return - the sum of the column
     */
    KeywordLogger log = new KeywordLogger()
    int columnTotal=0
    log.logWarning('Rows in the table: ' + tableRows)
    for (int loop = 1; loop <=tableRows; loop++) {
        int tempText=WebUI.getText(findTestObject(objectName, [('row') : loop, ('column') : columnToSum])).replaceAll("[^0-9-]","").toInteger()
        if (tempText==''){
            tempText=0
        }
        log.logWarning('Value from the table: ' + tempText)
        columnTotal=columnTotal+tempText
    }
    log.logWarning('Total from the site is: ' + columnTotal)
    return columnTotal
}

sumColumnTotal on Github

Other articles of interest:

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...