squashtest/squash-tf-execution-server repository overview

⁠What is Squash TF Execution Server ?

Squash TF Execution Server is our server to execute test on distributed environments

It uses the master - agents architecture :

• The master: It’s the scheduler which handle the jobs to execute.
• The agents: The handle execution on multiple environments or technologies:
  • Environments: development, acceptance, integration, …
  • Technologies:
    • OS : windows /linux
    • Browser : chrome/firefox/…

All documentation is available here⁠.

⁠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 Docker compatible operating system on the machine(s) where the images will be running
• A valid Docker installation with a Docker host.

⁠Quick Start

Run the Squash-TF-execution-server image :

docker run --publish 8080:8080 --publish {jnlp_port_number}:{jnlp_port_number} --name squash-execution-server squashtest/squash-tf-execution-server:{VERSION}

• The --publish option binds a port of the physical machine to the one of the to be created container. Here it binds the 8080 port of the physical machine to the 8080 port of the container. This is mandatory since the Jenkins installed on the image will listen to the 8080 of the container. If the port 8080 is already in use on your machine, replace --publish 8080:8080 by --publish XXXX:8080 where XXXX is an available port on your machine.

• {jnlp_port_number} : In order to be able to use the Master/Slave architecture, you need to publish your Jnlp port number (for example, you can use the port 3000).

• The --name option is optional, but quite handy since it allows one to give a non arbitratry name to the container about to be be created.

Please allow a few seconds for the application to start.

You can now access to Jenkins at the following URL: http://IP.of.your.machine:8080/jenkins⁠ (don't forget to change the port in the URL if you specified another one).

In Jenkins, go to Configure Global Security > TCP port for JNLP agents. Please indicate the same number of port that the one you chose for the {jnlp_port_number} in the --publish option (For example, indicate 3000 if you chose --publish 3000:3000).

Stop Squash-TF-execution-server :

docker stop squash-tf-execution-server

Restart Squash-TF-execution-server :

Use the docker start command to restart your server properly and retain your previous configuration and non-volatile data:

docker start squash-tf-execution-server