Skip to main content

Integrate TestCloud with Studio

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.

To learn more about how TestCloud can enhance your test automation projects, refer to this document: TestCloud Overview.

This guide shows you how to configure TestCloud integration (Beta) in Katalon Studio (KS) and execute tests/view reports with TestCloud.

Important:
  • Katalon Studio version 8.2.5 onwards.

Integrate TestCloud with Studio

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 Preferences.

Follow these steps:

  1. Open KS.
  2. Go to Project > Settings > Katalon TestCloud.

    Note:
    • You can also click on the TestCloud icon in the top right corner of KS to open the settings.tc icon in ks

    The Project Settings dialog appears as below.

    tc icon in ks

  3. Ensure that the Enable Katalon TestCloud integration box is checked.

  4. Choose the organization you wish to run your test with.

    Note:
    • If you cannot find your desired organization, click Fetch Organization to refresh. This action retrieves the list of all available organizations you have joined. You can select the organization you want from the dropdown menu.

  5. Click Apply and Close.

    You have now enabled TestCloud integration in KS and have the option to run a test suite/test suite collection (TS/TSC) with TestCloud.

Once you have enabled TestCloud integration, you have the option to run a test suite/test suite collection (TS/TSC) with TestCloud.

Follow the guidelines below for TS and TSC executions.

Run test suites with TestCloud

Note:
  • You cannot run test cases with TestCloud.

To run TS with TestCloud, follow these steps:

  1. Open your TS.

  2. Click on the dropdown icon of the Run button and choose to run with TestCloud.

    tc config dialog

    The TestCloud Configuration (Beta) dialog appears as below.

    tc config dialog

  3. Select the OS, browser, and browser version in the Configuration section.

    Note:
    • We currently only support Linux and Windows (remote OS). For browsers, we support Chrome, Edge Chromium, and Firefox.
    • The Tunnel checkbox is cleared by default. TestCloud Tunnel is for running tests in private domains. See: Configure TestCloud Tunnel.
  4. Click Run.

Run test suite collections with TestCloud

To run TSC with TestCloud, follow these steps:

  1. Open your TSC and double-click the Run with column.

    run with testcloud

    The Select an environment dialog appears as below.

    run config tsc

  2. Choose TestCloud as your test environment, then click OK.

  3. Double click on the Run Configuration column to open the TestCloud Configuration dialog.

    The TestCloud Configuration (Beta) dialog appears as below.

    tc config dialog

  4. Select the OS, browser, and browser version in the Configuration section.

    Note:
    • We currently only support Linux (remote OS). For browsers, we support Chrome and Firefox.
    • The Tunnel checkbox is cleared by default. TestCloud Tunnel is for running tests in private domains. See: Configure TestCloud Tunnel.
  5. Click OK.

Configure TestCloud Tunnel

If you want to execute TS/TSC in private domains, you must use a TestCloud Tunnel.

For detailed information on TestCloud Tunnel and how to utilize it, see TestCloud Tunnel.

Important:
  • To allow User Datagram Protocol (UDP) connections, the proxy must be configured.
  • If you use a Man-in-the-Middle (MITM) proxy, it must be configured to allow Transport Layer Security (TLS) connections.

TestCloud Tunnel can be configured with Tunnel Setup Helper.

Follow these steps:

  1. Open the TestCloud Configuration (Beta) dialog.

  2. Select the Execute with Tunnel for private domain testing checkbox.

    You will see a message in red, as follows:

    tc config dialog

  3. Click on the Tunnel Setup Helper link in the message.

    The Tunnel Setup Helper dialog appears as below.

    tunnel setup helper

  4. Follow the step-by-step instructions in the dialog to set up the tunnel client in your local machine:

    • Step 1: Select your OS and download the .zip file, then unzip it.

    • Step 2: Open the command-line interface (CLI), copy the command line from the dialog, then run it in the CLI.

      An example command looks like this:

      ./kt config --tenant KatalonStudio --username "your_username" --organization-id "your_organization_id" --api-key "your_api_key"

      You have set up the tunnel client in your local machine.

    • Step 3: Copy the command in the dialog and run it in your CLI to start the tunnel.

      A sample command looks like this:

      ./kt start

      kt start

    Note:
    • Keep your CLI (cmd/terminal) open until you have finished running tests.
  5. Go back to the Tunnel Setup Helper dialog and click Close.

    Once you have started the tunnel in your local machine, the TestCloud Configuration (Beta) dialog displays a green Status: Available message.

    tunnel setup helper

    Note:
    • You can also click on the Refresh button to have the status updated.

  6. Click Run to start executing TS/TSC with TestCloud Tunnel.

View TestCloud reports

After executing tests, execution data is consolidated in logs and reports. You can view TestCloud reports in the following formats: CSV, PDF, JUnit, HTML.

See: Test Suite and Test Suite Collection Reports.