TestProject Agent in Docker
Leverage TestProject Agents to run in Docker containers and setup virtual labs
Docker is the de-facto standard to build, run and share containerized apps from your desktop to the cloud. A Docker container image is a lightweight, standalone, executable package of software that includes everything needed to run an application: code, runtime, system tools, system libraries and settings.
Containers are a perfect companion to the agile movement. Organizations today need fast paced & efficient software teams & with that comes the hefty practice of continuous pushing of source code from development to testing & production multiple times. With Docker’s ability to isolate environments with specific dependencies & the flexibility to ship them from or to different environments makes the work more efficient & reliable.
Docker containers can accelerate your test automation platform using "dockerized" TestProject Agents. What makes the docker agent useful is that it saves a bunch of resources & provides the ability to run tests with just a simple command. For most cases you’ll need to set up the TP_API_KEY from the web console which is a way of authorizing the docker agent to an account. Optionally, you’ll need a Job id TP_JOB_ID if you want the containers to execute directly instead of waiting for instructions from the web UI.
You can set up the agent in two ways:
- Giving signals to execute jobs right from the web UI.
- Or providing dedicated tokens beforehand for seamless execution of jobs without the need for manual intervention.
- All you need is a TestProject account, that's it! If you don't already have one, you can sign up and open your free account here.
The TestProject Agent docker container can be used in two distinct ways, as also described in our DockerHub page:
- Permanent Execution Engine - The agent is registered once, and then can be used to execute tests and jobs from the TestProject web application
- Ephemeral Instances - In this scenario the agent is started up in order to perform a specific task, and will self terminate upon completion of said task.
The operation mode of the agent is controlled by environment variables that are passed to the container upon creation.
Let’s say you want to run multiple jobs & don’t want a fresh container for each test run. Your test capitalizes on a cache previously saved from a test run to continue further execution. Running tests from the start is a bit of an overkill even when using containers.
This is where instances that have saved states come in to the picture.
The flexibility to resume or carry on jobs with the ability to save data can become crucial for any testing environment as the testing phase matures.
The Docker agent of TestProject comes with this feature built in. You can easily start images that run for indefinite time & you can save the data with the help of attached volumes in case a running container fails. To get started aforementioned we need the TP_API_KEY to grant access to the project & an TP_AGENT_ALIAS to set a custom name for the agent.
When starting an instance with these variables, the agent is automatically registered to the account. This name can be referred to if you want to view the agent in your account.
TestProject Agents
You can also set up manual registration of the agent from the Web UI by mapping the containers port 8585 to 8585 TCP port on the host. A volume can also be set up to store the images data. Here’s how a sample command looks like to run the permanent instance with an attached volume:
docker run --name testproject-agent \
-e TP_API_KEY="REPLACE_WITH_YOUR_KEY" \
-e TP_AGENT_ALIAS="My First Agent" \
-v </path/to/host/folder>:/var/testproject/agent \
testproject/agent:latest
Attaching a volume also enables seamless updates for the TestProject Agents.
In its current state, the agent is idle & is waiting for a job to run. Let’s bring the container into action by sending it the job signal using TestProject’s Jenkins plugin. The plugin is available for installation from: Manage Jenkins > Manage Plugins:
Using the API_KEY, you can link the plugin to your TestProject account seamlessly. All you need to do is to navigate to Manage Jenkins > Configure System & scroll down to TestProject Global Configuration, enter the APi_KEY & you’re good to go!
Create a Freestyle project under the build section and add a build step with Run TestProject Job selected:
In order to have test environments that resemble production environments we can either configure it at the source code level, or have tests run on actual servers with the dependencies like db etc. installed.
The story at the source code level brings unwanted configurations to the code, making it hard to maintain with newer updates & bug fixes. However, running it on an actual hardware is also a burnout as stuff can get overwhelmed pretty quick & comes with a lot of setup and maintenance overheads. In addition, since resources are shared among tests we can only run them one at a time to ensure they don’t interfere with each other’s executions.
version: "3.1"
services:
Testproject-agent:
image: testproject/agent:latest
container_name: testproject-agent3
depends_on:
- chrome
- firefox
environment:
TP_API_KEY: "your_api_key"
TP_AGENT_ALIAS: "Docker Agent"
TP_JOB_ID: "job_id"
TP_JOB_PARAMS: '"jobParameters" : { "browsers": [ "chrome", "firefox" ] }'
CHROME: "chrome:4444"
FIREFOX: "firefox:4444"
chrome:
image: selenium/standalone-chrome
volumes:
- /dev/shm:/dev/shm
firefox:
image: selenium/standalone-firefox
volumes:
- /dev/shm:/dev/shm
Let’s have a look at Docker Compose which enables us to get the best of both worlds. It makes it easier to replicate the parts we have in environments & create them in the form of containerized solutions. We get the freedom to test in a real physical environment.
The TestProject Agent is responsible for handling the test cases with the given api_key & job_id. The Docker compose file also sets up multiple browsers to run the tests on. After running the test it exits so that any cache left is cleared.
Let’s set up a Docker compose file to run from a Jenkins pipeline. With the Docker TestProject Jenkins plugin we can run tests directly from the pipeline enabling a seamless CI set up. Here’s a sample jenkinsfile that pulls & runs a nodejs application initiates the test on the containers via the TestProject plugin & cleans up in the end:
pipeline {
agent any
stages {
stage('Build') {
steps {
// Get some code from a GitHub repository
git 'https://github.com/collabnix/testapp.git'
}
}
stage('Run') {
steps {
sh "node index.js &"
}
}
stage('Test') {
steps {
tpJobRun agentId: 'ph3CXXXXXXXX', jobId: 'o7wS4nXXXXXXX', projectId: 'DzkGyzxkMXXXXXXXX', waitJobFinishSeconds: 180
sh "killall -9 node"
}
}
}
}
The following pipeline will start a job on a ephemeral instance. Notice the usage of the --rm flag, which will cause the container to be deleted once the TestProject agent finishes the job's execution and exits.
pipeline {
agent any
stages {
stage('RunJob') {
steps {
bat 'docker run --rm -e TP_API_KEY="MY_API_KEY" -e TP_JOB_ID="MY_JOB_ID" testproject/agent:latest'
}
}
}
}
In case of a permanent execution engine scenario, one should ensure that their active account is linked & registered. You can verify registered agents & their status from the top Navigation Bar under the Agents tab.
TestProject Agents
In case a test contains a "Pause" step of 5 minutes(or more), an error might happen, and a timeout will probably occur - causing a test failure.
This happens because the selenium/standalone-chrome and the selenium/standalone-firefox only keep the session live up to 5 minutes.
To avoid the occurrence of a timeout, the docker’s environment variable, SE_NODE SESSION_TIMEOUT, which is usually set to 300 sec in Chrome and Firefox containers, must be edited in the docker-compose file:
Add SENODE_SESSION_TIMEOUT in your compose file
The containerized version of the TestProject Agent takes testing to the next level by eliminating the need to set up entire servers for testing & provides the flexibility to create temporary & permanent instances for automated testing.