Skip to main content

TestCloud Tunnel

TestCloud Tunnel​

A tunnel is used to secure the movement of data from one network to another.

TestCloud Tunnel enables a secure connection to local resources so that users can test their software/application in a restricted environment, avoiding unwanted external access from the global network.

TestCloud tunnel services can:

  • Scale up with team size and work requirements.
  • Reduce latency to a minimum by deploying the QUIC technology.
  • Prevent overload and crashes when running many tunnel clients.
  • Provide security by limiting access to authorized users with API keys.
  • Save time by running multiple concurrent tests using multiple Edge servers.

Configure TestCloud Tunnel​

TestCloud tunnel can be configured to be used with Katalon TestOps or Katalon Studio. See:

The tunnel-sharing feature is only available in TestOps. The tunnel created in Studio is separate from the one created in TestOps. You cannot use tunnels from TestOps and Studio interchangeably.

Some key information​

After starting the run command, the tunnel client does two things:

  • Spin up a fresh virtual machine (VM) that is used only for testing.
  • Connect you to the TestCloud Tunnel server.

By default, the tunnel is closed after 30 minutes if there is no request or traffic (i.e. the tunnel is idle for 30 minutes). Consequently, the VM is shut down.

To start the tunnel again, enter the run command in the tunnel client.

TestCloud Tunnel usage recommendations​

We recommend the following practices to optimize your tunnel usage:

  • Use a single tunnel or tunnel pool for each test suite or build, then tear it down at the end of your test.

  • Launch the tunnel client before the test suite is triggered, then shut the tunnel client down once the test suite is finished.

  • Use a machine with stable internet connection and large bandwidth to connect the tunnel client. This is to prevent test failure.

  • Use a machine with high specs (e.g., RAM, CPU) when you run many concurrent tests.

  • Run one tunnel client on one machine to avoid timeout and bandwidth issues that could cause test failure.

  • To save your machine's bandwidth and resources, you can quickly close the tunnel using the shortcut Ctrl+C in the command-line interface (CLI) after you finish running tests.

Reuse your TestCloud Tunnel configuration in a new machine​

In the case that you encounter a test failure and decide to change your machine, first copy the current tunnel configuration to a new machine. Then delete the client_id in the command-line interface. You can then run the tests on the new machine.

Network configurations for TestCloud Tunnel​

If you have any trouble with Tunnel client connectivity, you can start the Tunnel client in debug mode with verbose flag:
./kt start -vvv

With this flag, the Tunnel client displays logs for troubleshooting.

Configure proxy settings​

When you configure TestCloud Tunnel with the /kt config command, Tunnel client produces the tunnelconfig file that stores settings information.

If you are running the Tunnel client behinds an HTTP/HTTPS proxy, make sure you add the proxy settings to the tunnelconfig file. The required proxy variables are:

  • proxy_host, proxy_port: Proxy address and port, e.g. localhost:9070.

  • proxy_username, proxy_password

Whitelist TestCloud domains​

In case you cannot connect to TestCloud Tunnel when execute tests in private site, you might need to ask your network administrator to whitelist TestCloud domains. See: Network security errors.