Local Agent is a software component that communicates with ACCELQ server to take up test execution assignments and runs tests in your local application environment. It enables the cloud-based ACCELQ server to run tests remotely in your local network, thereby avoiding the need to expose the test application to the internet.
This article explains the Agent installation process using the Command Line installer when the host machine lacks desktop UI.
You can use the wizard-based installer in general on machines with desktop UI.
Download the Installable
To install the local agent on a machine, log in to ACCELQ and navigate to Resources > Local Agents.
Click on the "Download Agent" button and choose the installable depending on the target system's OS.
Download the installable and follow the steps as described below. Navigate to the folder where the zip file is downloaded.
> tar -xvf .\acc_installer_win_cli.zip
$ unzip acc_installer_linux_cli.zip
$ chmod +x ./ACCELQAgentInstaller
$ unzip acc_installer_mac_cli.zip
$ chmod +x ./ACCELQAgentInstaller
Note: If ACCELQ Agent is already installed on this system, you may be provided with the options to update, reinstall or uninstall the existing installation.
[Step 1] Checking JDK Compatibility
Local Agent requires a compatible JDK version (Version 8 or 11) to be able to run automation tests. If the installer does not find a suitable JDK already installed on the system, you are provided with an option to download open source Zulu JDK as part of the Agent installation.
[Step 2] Authenticate and Proceed
Next, provide information to authenticate with the ACCELQ server. You can input the proxy information if your network requires one, to connect with the server.
In this step, you are asked to provide the following details:
Local Agent name which will appear in your Run modal. Here you can provide any name to your Agent which is easily identifiable, subject to the following naming convention:
- Agent name must be unique across all projects in the tenant and can only contain alphabets, numbers, and "_" (underscore) characters.
- You can go up to a maximum of 32 characters long.
ACCELQ Server URL
ACCELQ server URL along with the port number (if applicable).
For example, "https://app.accelq.io/".
User ID which you use for login to your ACCELQ instance.
For example, "email@example.com".
API Key that can be found in the profile menu under the auth properties once you login to your ACCELQ instance. Simply click on your profile icon and then Auth properties to access the API key information.
HTTP and HTTPS Proxy Information (Optional)
Here you can provide proxy information configured for your local system (where the Agent is being installed) for both HTTP and HTTPS protocols. This information includes hostname, port number, username, password, and non-proxy hostname with respect to each of the supported protocols.
[Step 3] Select Automation Runtime
In this step you will be provided with the ability to select from a list of the optional platform supports available as per your subscription. If your subscription does not contain any optional platform support, this step will be ignored.
[Step 4] Set Installation Path
Now, select an installation path and proceed. Be sure to choose a folder that does not contain a "space" character in the path, and the path should be the absolute path pointing to the location of the chosen folder in your system.
All your ACCELQ Local Agents and relevant software components (if any) will be installed in this location.
[Step 5] Download & Install
In this step, the installer will download and install all the required software components and the progress is updated in real-time.
[Step 6] Summary
Once you complete the installation process, you are presented with an option to choose whether you want your ACCELQ Local Agent to auto-start on system startup or not.
If selected, the Agent will be configured to start automatically each time the system is restarted. This is a preferred option.
Configuring the Agent
ACCELQ Agent is configurable with a wide range of attributes. Learn more about the available Agent configurations to review/update as part of the post-installation steps.