Skip to content

Automation with SoapUI

Test reference in Squash TM

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

[repository]/[project]#[suite]#[test_case]
or
[repository]/[project]#[suite]
(The reference contains one or two # characters.)

with:

  • [repository]: Name of the Git repository.

  • [project]: Path and name of the SoapUI test file, from the root of the project (with the .xml extension).

  • [suite]: Name of the test suite.

  • [test_case]: Name of the test case to execute.
    This parameter is optional, i.e. it may be absent.

Determination of the result of the test case

If a test case [test_case] is not specified, the result of the Squash TM test case is calculated by taking into account the individual results of each test in the suite [suite]:

  • 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 ones has an Error status, the status of the execution will be Failed.
  • If all tests succeed, the status of the execution will be Success.

Nature of the exploitable Squash TM parameters

The exploitable Squash TM parameters will differ depending on whether you're using the Community/Premium or Ultimate version of Squash.

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 Community/Premium Ultimate
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 SoapUI 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 soapui/params action.

The parameters are available in SoapUI as environment variables and can be retrieved using the ${#Project#parameter_name} function for the test parameters and ${#Global#parameter_name} function for the global parameters (see the SoapUI documentation).

Example

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

SoapUI example

SoapUI example

Supported versions

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

Testing Technology Version
SoapUI 5.6.0