Backend Testing using Katalon Studio

Katalon Studio allows users to create custom keywords to address specific needs. With custom keywords, you can connect to databases and perform database testing. This tutorial describes details on how to create custom keywords for database testing in Katalon Studio.
Below is a code sample demonstrating how to
  • establish a database connection
  • execute a query
  • close  the connection
    package com.database
    import java.sql.DriverManager
    import java.sql.ResultSet
    import java.sql.Statement
    import com.kms.katalon.core.annotation.Keyword
    import com.mysql.jdbc.Connection
    public class DemoMySql {
       private static Connection connection = null;
        * Open and return a connection to database
        * @param dataFile absolute file path
        * @return an instance of java.sql.Connection
       //Establishing a connection to the DataBase
       def connectDB(String url, String dbname, String port, String username, String password){
       //Load driver class for your specific database type
       String conn = "jdbc:mysql://" + url + ":" + port + "/" + dbname
       //String connectionString = "jdbc:sqlite:" + dataFile
       if(connection != null && !connection.isClosed()){
       connection = DriverManager.getConnection(conn, username, password)
       return connection
        * execute a SQL query on database
        * @param queryString SQL query string
        * @return a reference to returned data collection, an instance of java.sql.ResultSet
       //Executing the constructed Query and Saving results in resultset
       def executeQuery(String queryString) {
       Statement stm = connection.createStatement()
       ResultSet rs = stm.executeQuery(queryString)
       return rs
        //Closing the connection
       def closeDatabaseConnection() {
       if(connection != null && !connection.isClosed()){
       connection = null
        * Execute non-query (usually INSERT/UPDATE/DELETE/COUNT/SUM...) on database
        * @param queryString a SQL statement
        * @return single value result of SQL statement
       def execute(String queryString) {
       Statement stm = connection.createStatement()
       boolean result = stm.execute(queryString)
       return result
    ips: Press Ctrl + Shift + o to automatically import missing libraries in test scripts.
    The Custom Keywords file will look like the following:
    Katalon Custom Keywords

    You can add the sample code above to your keyword file and modify the details as appropriated. Refer to these links for the formats of database connection strings:
    – For MSSQL: https://www.connectionstrings.com/sql-server/
    – For Oracle: https://www.connectionstrings.com/oracle/

    Use Defined Keywords in Test Cases for DB Testing

    1. Create new custom keywords for database connection (see above).
     2. Copy the DB script provided above and paste it into the new keyword editor as illustrated below:
    Database Testing using Katalon Studio
     3. Next, create a new test case with a name of your choice.
     4. Switch to Scripts View. The example below shows how to use the custom keywords that you have just created for database testing:

    import java.sql.ResultSet'Connect to database'
    CustomKeywords.'com.database.DemoMySql.connectDB'('', 'test', '3306', 'root', 'admin123')'Execute Query to get all data from Customers table’'
    ResultSet rs = CustomKeywords.'com.database.DemoMySql.executeQuery'("Select * from customers")'While loop to iterate through all record'
    while (rs.next())
    {       'get username value of record'
           Object username = rs.getObject("username")       'get password value of record'
           Object password = rs.getObject("password")

           System.out.println("Username: " + username + "\n"
                        +  "Password: " + password + "\n")

    'Close DB connection'
    The test case will look similar to the following:
    5. Congrats! You have just created your first project on how to use Custom Keyword for database testing.


Post a Comment