squashtest/squash-tf-chrome-ui-execution-agent

What is Squash TF Chrome UI Execution Agent ?

This specialized agent provides additionally a working graphical session and comes equipped with a guaranteed compatible Chrome/Chromedriver couple. The graphical stack is built using Xvfb as a fully in-memory X-11 server.

No graphical components should be needed on the underlying machine servicing the Docker host and running the images.

Supported tags

• "latest" tag for the X.Y.Z-latest image of the most recent X.Y.Z version.
• "RELEASE-latest" tag for the latest image of the most recent X.Y.Z-RELEASE version.
• "X.Y.Z-RELEASE" tag for each X.Y.Z release version.
• "X.Y.Z-latest" tag for the latest image of a X.Y.Z version.

Pre-requisites

The following pre-requisites are needed in order to perform the installation :

• A Jnlp open port on the Jenkins Master (Squash TF Execution Server) that can be used by the agent to connect to the master.
• A Docker compatible operating system on the machine(s) where the images will be running
• A valid Docker installation with a Docker host.

Setup Procedure

Follow the setup procedure from steps 2 to 8 in our documentation available https://squash-tf.readthedocs.io/projects/execution-server/en/doc-stable/admin/agent/agent-install.html#id2.

Quick Start

Run the Squash-TF-execution-agent image :

docker run --publish 5900:5900 --name demo-tf-agent --user jenkins --privileged --env "JENKINS_AGENT_NAME={agent_name}" --env "JENKINS_SECRET={secret}" squashtest/squash-tf-chrome-ui-execution-agent:{version} -url http://{jenkins_url} --x11-vnc-debug

The command should be understood as following :

• docker run : Runs a docker container
• --publish option ***ds the port 5900 of the container to a physical port of the machine hosting Docker. This is compulsory to do this if you want to run the docker image in “debug mode” using the --x11-vnc-debug option. For more information, please consult our documentation https://squash-tf.readthedocs.io/projects/execution-server/en/doc-stable/admin/agent/agent-install.html#particularity-of-graphical-session-providing-docker-images.
• --name demo-tf-agent : The nickname of the container that will be created. Can be choose to one’s liking. If not set a random name will be assigned to the container.
• --user jenkins : The technical user with proper rights to run Jenkins.
• --privileged : Due to Chrome own limitations the user shoud be in “Privileged” mode.
• --env “JENKINS_AGENT_NAME={agent_name}” : Enables one to specify the name of the declared node in Jenkins. Modify {agent_name} accordingly.
• --env “JENKINS_SECRET={secret}” : Enables one to specify the secret of the declared node in Jenkins. Modify {secret} accordingly.
• -url http://{jenkins_url} : Enables one to specify the URL of the Jenkins master server.

Once done, the node should appear as online on the Jenkins interface and its build queue should be in “idle”.

The agent is now ready to execute its first Squash-TF tests.

Troubleshooting

Please consult our documentation https://squash-tf.readthedocs.io/projects/execution-server/en/doc-stable/admin/agent/agent-install.html#troubleshooting.