Skip to content

Automation with Agilitest

This feature is available only in the Ultimate version of Squash.

Test reference in Squash TM

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

[repository]/[script]

with:

  • [repository]: Name of the Git repository.

  • [script]: Path and name of the ActionTestScript file, from the root of the project (with the .ats extension).

Focus

The ATS script must be located in src/main/ats/* , as in any regular ATS project architecture.

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]
Execution ID TC_EXECUTION_ID
Test case reference TC_REFERENCE
Test case internal UUID TC_UUID
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

Availability of the execution ID

TC_EXECUTION_ID is only available with Squash TM 8.0 or later.

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 documentation for more information about custom fields.

Parameters usage

It is possible, when running Agilitest 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 the case of a launch from a CI/CD pipeline with the agilitest/params action.

The parameters are available in Agilitest as environment variables and can be retrieved using the $env(parameter_name) function (see the Agilitest 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 an Agilitest test file and the corresponding Squash TM test case automation:

Agilitest example

Agilitest example

Supported versions

Squash has been validated with the following versions of Agilitest. More recent versions should work properly.

Testing Technology Version
Agilitest 💎 2.3.0