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. It provides a secure tunnel to communicate and exchange information with the server without having to open up any incoming ports on your local network.
Setting up Local Agent
Follow these instructions to setup a local agent on your machine
- Navigate to Resources > Local Agents on accelQ.
- Download the zip file and unzip to a preferred location.
- In the folder created above, open and update agent.properties file with relevant information.
- Start the agent by executing applicable batch or shell script found in the agent folder.
Note: From the Resources > Local Agents tab, you can follow a guided process to create content for agent.properties instead of manually updating the information.
agent.properties file needs to be updated with relevant information before starting the agent. Here are some important parameters
- Agent Name: Provide a unique name for this agent, so you can recognize this agent during test execution. Only alpha numeric and underscore characters are allowed.
- Note: Space character is not allowed in the agent name. Only alpha numeric and underscore characters are valid.
- User ID: accelQ user on whose behalf this agent will invoke. This is the user ID you use to login to accelQ.
- API Key: Unique API key assigned to the user. You can find the API Key from the user's profile information on accelQ.
- Project code and tenant code: As applicable for the user. This information is also found in the user's profile on accelQ.
- Type: Indicates the scope or visibility for the agent. Accepts one of three values: user/project/tenant. Accordingly, this agent will be accessible only to the current user (across all projects) or all users on current project or all users across all projects of this tenant.
- Number of concurrent jobs: Indicates the max number of concurrent jobs this agent can accept. If this threshold is exceeded, subsequent runs will be queued up for execution.
- Number of parallel test cases per job: Indicates the parallel execution count in a given test job. When a test job is invoked and the user chooses to run in Parallel mode, multiple test cases can run in parallel according to this setting.
Local agent requires following minimum hardware/software configuration
- Quad-core processor
- 8 GB RAM
- 500 GB hard-drive (or more, depending on the number of test executions)
- JDK 8 (make sure to have Java Development Kit, not just the runtime/JRE). Higher versions of JDK are not supported.
- Windows, Linux or Mac Operating System. For Linux machines, make sure it has GUI or desktop environment enabled.
Important Note: Make sure to run the agent on command prompt. Do not setup the agent as a service.
Important Note: If you are selecting Linux operating system for local agent, make sure it has proper desktop environment.
Note on sizing local agent
Make sure to setup local agent with necessary hardware and memory configuration to support execution requirements. Typically, an 8 GB RAM supports execution of up to 2 jobs concurrently. Depending on the need for additional concurrency, appropriately scale up the RAM size, with about 1.5 GB RM for every additional concurrent job. For example, with 16 GB RAM, you could scale up to 6 concurrent jobs.