Skip to main content
Version: legacy

Run TestCloud with Katalon Runtime Engine

Katalon TestCloud is a cloud-based test execution environment where you can automate test scripts across the most common and updated browsers and/or operating systems (OS) and/or a combination of both. See: TestCloud Overview.

From version 8.2.5 onwards, you can run test suites/test suite collections (TS/TSC) with TestCloud in Katalon Runtime Engine (KRE).

You can also configure TestCloud Tunnel to run tests in private domains. For detailed information on TestCloud Tunnel and how to utilize it, see TestCloud Tunnel.

Important:
  • Katalon Runtime Engine version 8.2.5 onwards.
  • A Katalon Runtime Engine license.
Note:
  • To use your proxy for TestCloud integration, you should configure both Authentication Proxy and System Proxy in Preferences. Learn more about proxy configurations at Proxy Options.

Run test suites/test suite collections with TestCloud in Katalon Runtime Engine

To integrate TestCloud with KRE and configure TestCloud Tunnel, use the following Katalonc command-line options:

No. Katalonc Command-line Option Description Data type Mandatory
1 -testcloudEnvironmentId The ID of the environment which corresponds to a combination of OS, browser type and browser version to execute.

Note: This parameter already contains the information about the browser type. Therefore, the browserType parameter is not generated in this integration.

Text Y
2 -testcloudTunnel Allow the execution to be performed via a tunnel. Boolean (case-insensitive) N
Note:

Generate Command with Command Builder

You can use Command Builder in Katalon Studio (KS) to generate commands quickly and precisely.

Important:

Follow these steps:

  1. Open KS and click on the Build CMD button in the main toolbar.

    build cmd button

    The Generate Command for Console Mode appears as below.

    generate cmd dialog

  2. Configure your execution as follows:

    • Test Suite: select the TS/TSC you want to execute.
    • Executive Platform:

      • Run with: Click Edit to display the Select an environment dialog, select TestCloud, then click OK.

        run config tsc

        The Run Configuration option appears after you choose TestCloud as your test environment.

      • Run Configuration: Click Edit to display the TestCloud Configuration (Beta) dialog, select your desired remote OS, browser, and browser version.

        tc config dialog

        Note:
        • To run tests using the TestCloud tunnel, check the Execute with Tunnel for private domain testing box and refer to Configure TestCloud Tunnel for detailed instruction.

    • Authentication: the API key is auto-filled.

    Note:
  3. Click Generate Command.

    The Generated Command dialog appears as below.

    generate cmd dialog

    Note:
    • After configuring your desired remote OS, browser, and browser version, TestCloud generates a TestCloud environment ID accordingly. You can get this ID in the Generated Command dialog (e.g. -testcloudEnvironmentId="38").

    For example, the sample command is:

    ./katalonc -noSplash -runMode=console -projectPath=“your_project_path” -retry=0 -testSuitePath=“your_test_suite_path” -browserType=“TestCloud” -testcloudEnvironmentId=“your_testcloud_id” -testcloudTunnel=“false” -executionProfile=“default” -apiKey=“your_api_key” -orgID=your_ogrID --config -proxy.auth.option=NO_PROXY -proxy.system.option=NO_PROXY -proxy.system.applyToDesiredCapabilities=true
  4. Click Copy to Clipboard and paste the command to your cmd/terminal for execution.