Create a Local Test Environment with an Agent
An Agent manages a local server for executing the scheduled Test Runs in a Local Test Environment.
Katalon TestOps supports compatible Agents for different executing environments.
Once you install the Agent in your local test machine, you have created a Local Test Environment for Test Runs execution.
You can share the Agents among Users and Projects within a Team.
Set up an Agent
You have a Katalon account.
Download an Agent from Katalon TestOps
To install an Agent, follow these steps:
-
Sign in to Katalon TestOps.
-
Go to your Project > Configurations > Agent Setup > Local Environment.
The Agent Setup page appears as below.
Note:You use the commands in the Generate configuration and Start an agent sections when setting up an Agent in your local machine.
-
Choose your Operating System (Windows, MacOS, etc.) in Select OS, then click Download Agent.
You have downloaded the Agent file (.zip file) to your computer.
-
Create a name for the Agent in the Agent Name section (e.g., My Agent).
Leave the Agent Setup page open while following the instructions to set up the Agent in your local machine.
Set up an Agent in a local machine
For Windows
Follow these steps:
-
Unzip the Agent file you have downloaded.
-
Open a new CMD window.
-
Copy the command in the Generate configuration section on the Agent Setup page, and paste it into the CMD window, then click Enter on the keyboard to run.
-
Copy the command in the Start an agent section, and paste it into the CMD window, then click Enter to run.
Wait for a minute.
-
Go to the Agent Setup page and click on Test Environments (in the Schedule a test run section) to see the added Local Test Environment.
For MacOS
-
Double click on the Agent file and select New Terminal at Folder.
-
Copy the command in the Generate configuration section on the Agent Setup page, and paste it into the Terminal, then click Enter on the keyboard to run.
Note:Make sure you have enabled Terminal for Developer Tools in your MacOS's Security & Privacy settings (as shown below).
-
Copy the command in the Start an agent section, and paste it into the Terminal, then click Enter to run. Wait for a minute.
Go to the Agent Setup page and click on Test Environments (in the Schedule a test run section).
You have created a Local Test Environment with an Agent.
Manage the Agent status
Go to Configurations > Test Environments to check the Agent status.
You can delete an Agent by clicking on the Trash bin icon.
The Delete Agent box pops up.
Click Delete to confirm your action.
You cannot undo this action.
Agent Authentication
serverurl
and apikey
inagentconfig to:activate Katalon Runtime Engine.
send test results to Katalon TestOps.
You can see the serverurl
and apikey
in the Generate configuration section on the Agent Setup page.
Configure Proxy for Agents
You can set up Proxy for the Agent in the agentconfig file, using the proxy
option. For example, proxy=http://localhost:8080
.