Skip to content

Automation with Katalon

This feature is available only in the Premium version of Squash AUTOM.
Katalon support is available starting with Squash TM 3.0.

Configuration of the test environment

katalonc must be present in the test environment and accessible by the PATH system environment variable.

The following three system environment variables must be set and populated in the runtime environment:

Variable Content Example
KATALON_API_KEY Katalon API license key 123a4567-123a-1ab2-1234-1234567890ab
KATALON_ORG_ID Organisation ID at Katalon 123456
KATALON_BROWSER_TYPE Default browser type Web Service

Test reference in Squash TM

Info

The result of each executed Squash TM test case is calculated by taking into account the individual results of each test case belonging to the test suite collection or to the test suite, of the Katalon project file ( .prj) processed:

  • If at least one test has an Error status (in case of a technical issue), the status of the execution will be Blocked.

  • If at least one test fails functionally and none of the other has an Error status, the status of the execution will be Failed.

  • If all tests succeed, the status of the execution will be Success.

In order to bind a Squash TM test case to a Katalon automated test, the content of the Automated test reference field of the Automation block of a test case must have the following format:

[1] / [2] # [3] # [4] # [5]

With:

  • [1]: Name of the project on the source code repository.

  • [2]: Path to the name of the Katalon project file (with its .prj extension) from [1].

  • [3]: Relative path from the Katalon project folder to the name of the test suite collection.
    This parameter is exclusive with respect to [4].

  • [4]: Relative path from the Katalon project folder to the name of the test suite.
    This parameter is exclusive with respect to [3].

  • [5]: Relative path from the Katalon project folder to the name of the specific test case to be parsed for which you want to obtain a particular result. This parameter is optional.

Automated test reference and execution

The relative path from the Katalon project folder to the name of the specific test case precision [5] in the test reference, has no impact on the execution, but only on test result determination.
So, even when defining the specific level of the specific test case, all test cases defined in the test suite collection or in the test suite will be executed (this means, for example, that if several Squash TM test cases point toward the same test suite collection or toward the same test suite, but toward different test cases, then all the test cases will be executed several times).
The test reports include the traces of all executed requests. But, only the Error / Failed / Success status corresponding to the specific test case is used to determinate the test case result.

Exclusive choice of test suite collection or test suite

The [3] and [4] sections are mutually exclusive: either the test suite collection or the test suite must be populated, but not both.
In the end, the field Automated test reference must contain 3 characters #.

Nature of the exploitable Squash TM parameters

Here is a table showing the exploitable parameters (these parameters are transmitted as test parameters, see below, Squash TM does not generate global parameters):

Nature Key
Name of the dataset DSNAME
Dataset parameter DS_[name]
Test case reference TC_REFERENCE
Test case custom field TC_CUF_[code]
Iteration custom field IT_CUF_[code]
Campaign custom field CPG_CUF_[code]
Test suite custom field TS_CUF_[code]

Legend:

  • [code]: Value of the "Code" of a custom field
  • [name]: Parameter name as filled in Squash TM

As indicated, Squash TM adds a prefix to the code of the transmitted custom field. Make sure to take it into account.

Refer to the Squash TM documentation for more information about custom fields.

Parameters usage

It is possible, when running Katalon tests, to exploit parameters within it. A parameter can be a test parameter or a global parameter. Squash TM transmits only test parameters. Test parameters and global parameters can be used in Squash DevOps with the kalaton/params action.

The test parameters and the global parameters are usable as global variables in Katalon using the GlobalVariable.param_name syntax (see the Katalon documentation). If the same name is used both for a global parameter and a test parameter, the last one is used.

Example

Below is an example of a Katalon collection file and the corresponding Squash TM test case automation:

Katalon example

Katalon example

Katalon example

Katalon example

Katalon example

Supported versions

Squash AUTOM and Squash DEVOPS have been validated with Katalon 8.2.0. Any recent version should work properly.

Back to top