Setting up Local Agent

Feature Availability      Version 3.0 or above

accelQ Local Agent allows you to run tests locally inside your firewall, while the test assets are still managed centrally either on the cloud or on your on-premise server. This facilitates execution of tests on systems that are otherwise not exposed outside your network, while at the same time not requiring opening ports for such applications.

accelQ Local Agent is a REST-based Java client running in pull-only mode with accelQ server. Once registered with the server, accelQ Agent communicates test execution information using REST API. On your local network, this amounts to outgoing traffic from the Agent machine to accelQ server.

No incoming port needs to be opened on your network.

Run this agent on a machine where the AUT and other dependent resources are accessible.

Before we begin with setup instructions, here are the hardware and software requirements for installing local agent. Please make sure that the machine where you want to set up the local agent satisfies these prerequisites.

Hardware/Software requirement

Windows desktop or a Linux or Mac OS machine. You do not need server class machine for Local Agent.
Quad-core processor
8 GB RAM
250 GB Hard-drive
JDK 11. Make sure to have the Java Development Kit, not just the runtime or JRE and check that you have correct version of JDK. Click here to review your JDK setup.
If you are using Linux Operating System for agent, make sure it has GUI or Desktop environment enabled.

Installation Steps

Navigate to Resources > Local Agents on accelQ application. Download the zip file for either Windows, Linux or Mac as per your requirement.
Download the zip file and unzip to a preferred location. (Preferably unzip it in your root drive). Make sure there are no spaces in the folder name path.
In accelQ application, Navigate to Resources > Local Agents and click on the link “Click to generate” in step 3.
In the Configure Agent Properties modal:

Agent Name: Provide a unique name for this agent, so you can recognize this agent during test execution. Do remember only alpha-numeric and underscore characters are allowed, space is not allowed in the Agent name.

Agent Type: Indicates the scope or visibility of the Agent. The agent visibility can be set at User (only you can view the agent), Project (all the users assigned to the project can access the agent) or Tenant level (all users across all projects can access the Agent).

Concurrent Jobs Count: Indicates the maximum number of concurrent jobs this Agent can accept. If the count of jobs exceeds the threshold then the subsequent jobs will be queued up for execution.

Parallel Test Cases per Job: If you choose to run in parallel mode, multiple Test Cases can run simultaneously.
On accelQ, click on “Generate” button in the Configure Agent Properties modal.
Download the Agent Properties file or you can also copy the configuration to clipboard.
Navigate to the location in your machine where you have unzipped the Local Agent Folder. Open the folder, the folder should have these files:
Replace the “agent.properties” file with the new Agent Properties file that you have downloaded.
Start the Agent by executing the shell script in the Agent folder. The file name should be “start_agent_windows.bat” (or, in case of Linux it should be “start_agent_linux.sh”).
Navigate to Resources > Local Agents on accelQ application (click on the tab once again, to refresh). You should see your configured Local Agent listed in the grid.
Congratulations !!!, you can now use the Local Agent when running a test.