Use TestCloud in CI/CD pipelines

To execute tests in TestCloud environments with Katalon Runtime Engine, you only need a TestCloud subscription or trial; Katalon Runtime Engine license is not required. This also enables you to use TestCloud in any CI/CD pipelines configured with KRE.

Test suite execution

To trigger test suite execution with TestCloud environments from KRE, you need to specify the following arguments:

Command-line argument	Description	Data type	Mandatory
-browserType="TestCloud"	The browser type used for test suite execution. The "TestCloud" value means you are using TestCloud environments.	String	Required (for single test suite execution)
-testcloudEnvironmentId	The ID of the environment which corresponds to a combination of OS, browser type and browser version to execute. This ID can be generated with Command Builder.	String	Required (for single test suite execution)
-testcloudTunnel	Allow the execution to be performed via TestCloud Tunnel.	Boolean	Optional
-testcloudMobileDeviceId	The unique ID of the TestCloud mobile device.	String	Required (for single test suite execution)
-testcloudMobileId	The ID of the TestCloud mobile OS version.	String	Required (for single test suite execution)
-testcloudAppId	The ID of the TestCloud application. KRE generates this command when the Override with application from TestCloud Application Repository option is selected.	String	Optional

Note

To execute API testing with TestCloud, make sure to specify -browserType="TestCloud" in your command. Additionally, set the -testcloudEnvironmentId to match a supported environment—for example, Desktop > Linux > Chrome (any version).

Example

With GitHub Actions, to execute a test suite from KRE command to TestCloud environment, you can use the following workflow template:

name: CI
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: windows-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v3.0
    - name: Katalon Studio Github Action
      uses: katalon-studio/katalon-studio-github-action@v3.0
      with:
          version: '8.6.5'
          projectPath: '${{ github.workspace }}'
          args: '-noSplash -retry=0 -testSuiteCollectionPath="Test Suites/Sample Test Suite" -browserType="TestCloud" -testcloudEnvironmentId="256" -apiKey= ${{ secrets.API_KEY }} --config -webui.autoUpdateDrivers=true'

Test suite collection execution

The TestCloud environments for individual test suites are already included in the test suite collection file. Therefore, the browserType and testcloudEnvironmentId arguments are not required. The test suites configured with TestCloud are automatically uploaded to TestCloud environments. See: Manage test suite collections in Katalon Studio.