Use TestCloud in Katalon Studio

Katalon TestCloud is a test automation service that allows you to execute tests on common browsers and operating systems on the cloud. With Katalon TestCloud, you can easily configure those test environments.

This guide shows you how to configure TestCloud in Katalon Studio and execute tests, view reports.

To learn more about how TestCloud can enhance your test automation projects, see:

• TestCloud Overview
• Supported environment for TestCloud
• Local testing with TestCloud: Local testing with TestCloud

Note:

• From version 8.6.0 onwards, Katalon Studio enables executing tests on mobile browsers of TestCloud. By default, the mobile browsers are Chrome for Android, and Safari for iOS. See: Supported environments for Katalon TestCloud.

Requirements

• An active Katalon TestCloud subscription or trial. See TestCloud Trial.
• Katalon Studio version 8.2.5 onwards.
• TestCloud integration enabled in Katalon Studio. To learn how to enable the integration, see: Integrate Katalon TestOps and Katalon TestCloud with Katalon Studio.

Run test suites with TestCloud

To run a test suite with TestCloud in Katalon Studio, follow these steps:

1. Open a test suite.
2. Click on the dropdown icon of the Run button and choose to run with TestCloud.
   

   The TestCloud Configuration dialog appears as below.

   Note:

   The Tunnel checkbox is cleared by default. TestCloud Tunnel is for running tests in private domains. See: Configure TestCloud Tunnel

   You can check the Tunnel option to set up TestCloud Tunnel. See: Configure TestCloud Tunnel

3. Select the execution environment for your tests.

   Select between Desktop or Mobile environment.

   • For Desktop browser environment: Select the desired OS, browser, and browser version.
   • For Mobile browser environment (available for Katalon Studio from 8.6.0): Select the desired OS, OS version, and devices. The default browser is Chrome for Android, and Safari for iOS.
4. Click Run.

You can view the execution progress in Log Viewer with detailed information on the status of each test step:

Run test suite collections with TestCloud

To run a test suite collection with TestCloud Katalon Studio, follow these steps:

1. Open your test suite collection and double-click the Run with column.
   
   
   

   The Select an environment appears as below.

   
   
   

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 dialog appears.

   Note:

   You can check the Tunnel option to set up TestCloud Tunnel. See: Configure TestCloud Tunnel

   Note:

   The Tunnel checkbox is cleared by default. TestCloud Tunnel is for running tests in private domains. See: Configure TestCloud Tunnel.

4. Select the execution environment for your tests and click OK.

   Select between Desktop or Mobile environment.

   • For Desktop browser environment: Select the desired OS, browser, and browser version.
   • For Mobile browser environment (available for Katalon Studio from 8.6.0): Select the desired OS, OS version, and device. The default browser is Chrome for Android, and Safari for iOS.
5. Click Execute.

You can view the execution progress in Log Viewer with detailed information on the status of each test step:

Configure TestCloud Tunnel

TestCloud integration is enabled in Katalon Studio Enterprise (KSE), see: Integrate Katalon TestOps and Katalon TestCloud with Katalon Studio.

Note:

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

Follow these steps to set up TestCloud Tunnel with Tunnel Setup Helper.

1. In Katalon Studio, click on the dropdown icon of the Run button and choose to run with TestCloud. The TestCloud Configuration dialog appears.
2. Tick the Tunnel option.
   You'll see a message in red, as follows:
3. Click the Tunnel Setup Helper link.

   The Tunnel Setup Helper dialog appears.

4. Follow the step-by-step instructions in the dialog to set up the tunnel client in your local machine:
   1. Select your OS and download the .zip file, then unzip it.
   2. Open the command-line interface (CLI) and navigate to the directory containing the tunnel executable file. Copy the command line from the dialog, then run it in the CLI.
      An example command looks like this:

      /Applications/kt config --tenant KatalonStudio --username "myusername@katalon.com" --organization-id "myid" --api-key "myapikey"
   3. Use the kt start command to start the tunnel.
      

      Note:

      Keep your CLI open until you have finished running tests.

5. Switch back to Tunnel Setup Helper and click Close.
   Click Refresh and you can see the available status.
6. Click Run to start executing your test suite / test suite collection with TestCloud Tunnel.

View TestCloud reports

After executing tests with TestCloud from Katalon Studio, 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.