Output status messages and test information by writing to the Log File Viewer in Katalon Studio

One of my more heavily used functions in the Selenium IDE was writing to the LOG file. It was an excellent way of debugging code and displaying what values were read. It was also used to show which test was running and other status information. As a comparison, writing to the log file in the IDE looked like:

LOG.warn("-- Begin name of test Script  --");

LOG.warn("The calculated value is " + storedVars['variable'] + " --- The site value is " + storedVars['variable']);

Katalon has a similar log view, that looks like the following:

log-file

While Katalon Studio has a log file, several of them in fact, finding out how to write to them takes some digging. To get right to it, there is an import file and a keyword definition that need to be added to your Test Case.

The following import statement needs to be added:

import com.kms.katalon.core.logging.KeywordLogger as KeywordLogger

At the end of the import statements, add the following line:

KeywordLogger log = new KeywordLogger()

Now the log file can be accessed with the following commands:

log.logError("")
log.logFailed("")
log.logInfo("")
log.logNotRun("")
log.logPassed("")
log.logWarning("")

For my tests, I write information I’m interested in into the Warning log. The Info log is far too busy and so is the Passed log. While not warnings, the Warning log gives me a visual output of what the test is reading so I can follow along. The log outputs text as well as the value of variables.

log.logWarning(‘The import date listed on the site is: ‘ + importDate)

Using the IF statement from before, I can output the decision of a conditional loop:

if (customerSalesPlan != ytdSalesPlanTotal) {
    log.logWarning('ERROR: The Budget Sales Plan Amount Does Not Equal the YTD Sales Plan Total')
} else {
    log.logWarning('SUCCESS: The Budget Sales Plan Amount Matches the YTD Sales Plan Total')
}

As the test case is running, I can see what sort of results are being generated and where problems may occur. If a variable comes back as blank or the wrong value, I can see that visually using the log files. I can also write custom messages.

The test itself may run just fine, meaning all the commands executed, but I can use the log files to show the values are in error or outside a given range.

Using the example above, I could change the script slightly to write information to the error log if the two value don’t match. The test executed correctly, but an error was encountered with the data.

The text of my message will now show in the Error log, in red, indicating the test completed, but manual investigation is needed.

I have to admit, just about every test I create uses log.logWarning. In many cases it can be as simple as:

log.logWarning('--- Begin Sales Plan Test ---')

This appears in the log file to show me which test is currently being executed. This information also show up in the Report generated after each Test Suite run. Since I display the value I read from the site and the value I calculated from the script I have confirmation as to what is being tested.

I find the log file helpful to display status information and for debugging. It’s a simple place to write information, but very powerful.

Other articles of interest:

6 Responses to Output status messages and test information by writing to the Log File Viewer in Katalon Studio

  • Prashant Pednekar says:

    Thanks for the informative article but can we also put some variable values to make it more exciting.

  • Don Pedro says:

    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 ‘ + filterListNames[loop] + ‘:=’ + filterResults)
    log.logWarning(‘Total Number of rows on the page:= ‘ + totalNumberOfRows)
    log.logWarning(‘SUCCESS: Site and Calculated Total do not match, but are CLOSE ENOUGH for Column: ‘ + columnName + ‘, with a difference of ‘ + errorTotal)

  • Nadim says:

    This is really helpful … the only problem when log.logFailed executed it doesn’t update the results Failures count … still show Failures: 0

  • Don Pedro says:

    That is correct. You will need to add KeywordUtil.markFailed to change the Failures count. Other commands in the library are:

    KeywordUtil.markPassed
    KeywordUtil.markFailed
    KeywordUtil.markError
    KeywordUtil.markWarning

  • Rodrigo Calabretta says:

    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.getTestCaseStatus() to show the status test case gets printed PASSED. Maybe is some error related to katalon

  • Saranya says:

    Good One. Could you plz share link to access all your katalon related blogs.
    ThankQ

Leave a Reply

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

Recent Comments
  • 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...
  • Working with Dates and Date Formatting in Katalon Studio (14)
    • 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
    • ALLAN FORD: Useful !
    • Don Pedro: Not sure I understand what you are trying to do.
    • Don Pedro: formattedDate = mydate.format(“M/dd/yyy& #8221;)
  • 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...
    • Aparna: Hello, Your documentation is excellent and has helped me understand many things. But this article above seems outdated and I need help in creating my own Global variables and all the documentation out there seems to be point to...
  • 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...
  • How To Disable the Quicken Registration Prompt (27)
    • debra: didn’t work for me… my 2007 – which I am keeping on my older mac.
  • Adding entries to an open Excel spreadsheet during runtime (1)
    • IanG: Hi: Seems like nobody else has described (in detail) how Katalon can be configured to test an API by reading the first entry from a multi-row multi column XLSX spreadsheet, executing a test, writing the result to another column (or...