Using Dockerized Agents for ACCELQ test execution

ACCELQ enables users to run test executions using Dockerized agents. This guide explains how to pull the latest ACCELQ Docker image, configure environment variables, and run Dockerized agents either for individual users or at the tenant level.

Pull ACCELQ Agent Docker Image

There are 2 ways you can get the ACCELQ agent docker image

1. You can directly pull the image from docker hub.
   

   For latest image:

   docker pull accelq/accelq-agent:latest 

   
   This Docker image, pulled from Docker Hub, is a generic image. After starting the container from this image (using the docker run command), the agent process takes some time to fully start. This delay occurs because the Docker agent needs to download all the necessary dependencies from the ACCELQ server based on the arguments passed in the docker run command. Once all dependencies are fetched and the agent is initialized, it becomes ready for test execution.
   
   
2.  You can build the image locally using the below article:
   Building a Self-Contained ACCELQ Docker Agent Image with Dependencies: A Step-by-Step Guide
   
   This method allows you to build the Docker image locally with all the dependencies on your machine or VM (Linux - Ubuntu). This means the locally built image will contain all the required dependencies for your tenant. Upon executing the docker run command, the ACCELQ Agent Docker container will start instantly. This method is ideal for users who have their own private Docker repository for their organization. You can build the image locally and upload it to your preferred Docker repository.

Run ACCELQ Docker Agent(s) 

ACCELQ docker image need to take the agent.properties file’s key-values as environment variables 

You can pass any of the following keys as environment variable to docker run command 

• agent_port 
• agent_type
  
  • tenant
  • project
  • user
• accelq_server_url 
• user_id 
• api_key 
• agent_type 
• provider_type 
• provider_username 
• provider_password 
• provider_hostname 
• provider_port 
• project_code 
• tenant_code 
• num_concurrent_jobs 
• num_parallel_tc_per_job 
• http_proxy_host 
• http_proxy_port 
• http_proxy_user 
• http_proxy_password 
• http_proxy_nonproxyhosts 
• https_proxy_host 
• https_proxy_port 
• https_proxy_user 
• https_proxy_user 
• https_proxy_nonproxyhosts 

Start Agent from docker image [For a Dedicated User]

docker run -d -e agent_name=<agent_name> -e num_concurrent_jobs=1 -e num_parallel_tc_per_job=3 -e accelq_server_url=<url> -e user_id=<user_Id> -e api_key=<apikey> -e project_code=<projcode> -e tenant_code=<tenant_code> -e sharing_type=0 -e agent_type=user accelq/accelq-agent:latest

Start Agent from docker image [At Tenant Level]

docker run -d -e agent_name=<agent_name> -e num_concurrent_jobs=1 -e num_parallel_tc_per_job=3 -e accelq_server_url=<url> -e user_id=<user_Id> -e api_key=<apikey> -e project_code=<projcode> -e tenant_code=<tenant_code> -e sharing_type=1 -e agent_type=Tenant accelq/accelq-agent:latest

Once the docker run command succeeds, you will see local agent registered with ACCELQ server.

You may login to ACCELQ and navigate to Resources > Local Agents tab and verify the agent with the given name is displayed. 

Docker Run Command Generator (Live Tool)

To simplify the process, use the live web utility below to generate the full docker run command by filling in the necessary details like Tenant ID, Access Key, and other configuration parameters.

Running Test on Chrome browser with Docker Agent 

Use the below driver profile 

{
"headless": "new",
"args": [
"window-size=2000,1600",
"--no-sandbox",
"--disable-dev-shm-usage",
"--disable-gpu",
"--ignore-certificate-errors"
]
}