Local testing with Test Execution - Cloud in Katalon Studio

This document shows you how to set up Test Execution - Cloud Tunnel in Katalon Studio and perform local testing.

If your application under test is locally hosted in a private network, you need to set up a tunnel for Test Execution - Cloud server to access the application. See: Local testing with Test Execution - Cloud.

In Katalon Studio, you can use the Tunnel Setup Helper to download and configure Test Execution - Cloud Tunnel.

Configure Test Execution - Cloud Tunnel

Requirements

• Test Execution - Cloud integration is enabled in Katalon Studio (KS), see: Enable Test Execution - Cloud integration in Katalon Studio.
• Test Execution - Cloud Tunnel Server hostnames are whitelisted. See: Common network issues and solutions.
• 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 Test Execution - Cloud Tunnel with Tunnel Setup Helper.

1. In Katalon Studio, select the dropdown Run menu and choose to run with Cloud Execution.

2. In the Test Execution - Cloud Configuration dialog, select your testing environment, then enable the Private/Local Testing option. You'll see a message, 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](mailto:myusername@katalon.com)" --organization-id "myid" --api-key "myapikey"

   note

   For users from EU region or other regions outside of US region: after step 2, you need to update the server URL in the tunnelconfig file before continuing with Step 3.

   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 should see the message: "Tunnel is available".

   

6. Select Run to start executing your test suite / test suite collection with Test Execution - Cloud Tunnel.

Configure tunnelconfig file

When you configure Test Execution - Cloud Tunnel with the /kt config command, the client produces the tunnelconfig file that stores settings information. You can edit this file to optimize tunnel traffic and configure proxy settings.

Optimizing traffic with allow_host

By default, Test Execution - Cloud may route all browser traffic through the tunnel, including hosts outside your application under test (AUT). To reduce unnecessary traffic and improve performance, use the allow_hosts setting in tunnelconfig. This allows:

• Requests whose hostname matches a pattern in allow_hosts are routed through the tunnel.
• All other requests are served directly from Test Execution - Cloud infrastructure, bypassing the tunnel entirely.

Proxy settings

If the tunnel client runs behind an HTTP/HTTPS proxy, configure the following settings:

• proxy_host, proxy_port: Proxy address and port, e.g. localhost:9070.
• proxy_username, proxy_password: Username and password.

Update server URL

1. Open the folder where your terminal or command prompt is currently located.

   Example: If your terminal is opened at Desktop, open the Desktop folder.

2. In that folder, locate and open the tunnelconfig file using a text editor.

3. Update the server URL to match your region.
   EU region: https://tunnel-manager.eu.katalon.com

4. Save the changes to the tunnelconfig file.
5. Return to the Tunnel Setup Helper dialog and continue with Step 3.