squashtest/squash-tf-execution-agent repository overview

⁠What is Squash TF Execution Agent ?

Squash TF Execution Server is Jenkins based. As such, one can setup a master/slave architecture with clear separation of concerns. The Jenkins master schedules test related tasks whereas slave agents are solely responsible for their executions.

The base image brings the tools needed to:

• be ran as a Jnlp agent,
• run headless Squash TF test.

The image is built on the the open-jdk image and is thus Debian based. The image includes a JDK, a Maven, a Git client, a Mercurial client and last but not least, it contains the jars and configured entry-point to run it as a Jnlp agent.

⁠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 here⁠.

⁠Quick Start

Run the Squash-TF-execution-agent image :

docker run --name demo-tf-agent --user jenkins --env "JENKINS_AGENT_NAME={agent_name}" --env "JENKINS_SECRET={secret}" squashtest/squash-tf-execution-agent:{version} -url http://{jenkins_url}

The command should be understood as following :

• docker run : Runs a docker container
• --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.
• --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

For more information, please consult our documentation here⁠.