Skip to content

Installation Guide

Security

Due to some security issues, it is strongly advised to use Squash TM 1.22.9 (or higher 1.X.Y), 2.2.0 (or higher 2.X.Y), or 3.0.0 (or higher 3.X.Y).

Squash Orchestrator†

Installation

Squash Orchestrator is a set of services running together. They may or may not run on the same machine, and they may or may not be started at the same time.

The only prerequisite is that the EventBus, the service they use to communicate together, is available when they launch.

To facilitate the installation of the orchestrator, an ‘all-in-one’ Docker image is provided. It contains all core services (part of the OpenTestFactory Orchestrator) and some Squash specific services.

To get the latest image of Squash Orchestrator, use the following command:

docker pull squashtest/squash-orchestrator:latest

Preconizations for sizing the Docker container are:

  • 1 CPU
  • RAM: 1 GB (2 GB recommended)
  • disk: provide the capacity for storing the execution reports and their attachements for one hour of usage

Accessibility of the Squash TM instance

Check that the Squash TM instance is accessible from Squash Orchestrator. To do this, go onto the Docker host and run the command (replacing https://squashtm.example.com/squash with the URL of your instance): 

curl https://squashtm.example.com/squash/isSquashAlive
The answer should be: 
Squash is Alive!
If not, resolve the issue with your network administrators.

Usage

Configuring the ‘all-in-one’ image

The execution of the following command will start the Squash Orchestrator using an existing execution environment, with self-generated trusted keys (which is not recommended in a production setup):

docker run -d \
         --name orchestrator \
         -p 7774:7774 \
         -p 7775:7775 \
         -p 7776:7776 \
         -p 38368:38368 \
         -e SSH_CHANNEL_HOST=the_environment_ip_or_hostname \
         -e SSH_CHANNEL_USER=user \
         -e SSH_CHANNEL_PASSWORD=secret \
         -e SSH_CHANNEL_TAGS=ssh,linux,robotframework \
          squashtest/squash-orchestrator:latest

It exposes the following services on the corresponding ports:

  • receptionnist (port 7774)
  • observer (port 7775)
  • killswitch (port 7776)
  • eventbus (port 38368)

Run the image in Premium mode

If you have a Premium license for Squash AUTOM and have deployed the Premium version of the Result Publisher Squash TM plugin, you must run Squash Orchestrator in Premium mode in order to have access to Premium behavior for result publishing in Squash TM. In order to do that, you have to add the following parameter in the Squash Orchestrator's run command: -e SQUASH_LICENCE_TYPE=premium

For more details about Squash Orchestrator configuration, please check the OpenTestFactory Orchestrator documentation on which Squash Orchestrator is based.

Orchestrator tools†

Installation

The orchestrator tools aim at simplifying the use of that one.
They require Python 3.8 or later. They are usable on Lunix, maxOS or Windows.

These tools can be installed using the following command:

pip3 install --upgrade opentf-tools

Overview of the tool capabilities

  • opentf-ready waits until the orchestrator is ready to accept workflows.

  • opentf-done waits until the orchestrator can be safely stopped (i.e. it has no more pending tasks).

  • opentf-ctl can be used to

    • start / track / stop a workflow
    • generate a signed token
    • list the subscriptions on the event bus
    • list the agents
    • generate / modify a configuration file

OpenTestFactory Agent†

Installation

The OpenTestFactory agent is a Python application that is installed in the execution environment. It requires Python 3.8 or higher. It works on Linux, macOS, and Windows.

The agent is a simple script. It only has one external dependency, the well known requests library (it will be installed if not already present on the execution environment).

To install the agent, use the following command:

pip3 install --upgrade opentf-agent

You can test your installation by running the following command:

opentf-agent --help

Usage

Summary

$ opentf-agent --help
usage: opentf-agent [-h] --tags TAGS --host HOST [--port PORT] [--path_prefix PATH_PREFIX] [--token TOKEN] [--encoding ENCODING] [--script_path SCRIPT_PATH] [--workspace_dir WORKSPACE_DIR] [--name NAME] [--polling_delay POLLING_DELAY] [--liveness_probe LIVENESS_PROBE] [--retry RETRY] [--debug]

OpenTestFactory Agent

optional arguments:
  -h, --help            show this help message and exit
  --tags TAGS           a comma-separated list of tags (e.g. windows,robotframework)
  --host HOST           target host with protocol (e.g. https://example.local)
  --port PORT           target port (default to 24368)
  --path_prefix PATH_PREFIX
                        target context path (default to no context path)
  --token TOKEN         token
  --encoding ENCODING   encoding on the console side (defaults to utf-8)
  --script_path SCRIPT_PATH
                        where to put temporary files (defaults to current directory)
  --workspace_dir WORKSPACE_DIR
                        where to put workspaces (defaults to current directory)
  --name NAME           agent name (defaults to "test agent")
  --polling_delay POLLING_DELAY
                        polling delay in seconds (default to 5)
  --liveness_probe LIVENESS_PROBE
                        liveness probe in seconds (default to 300 seconds)
  --retry RETRY         how many time to try joining host (default to 5,
                      0 = try forever)
  --debug               whether to log debug informations.

Example

Assuming there is a Squash Orchestrator running on orchestrator.example.com, with a known token stored in the TOKEN environment variable, the following command will register the Windows-based execution environment and will possibly receive commands from Squash Orchestrator targeting windows and/or robotframework tagged environments:

chcp 65001
opentf-agent --tags windows,robotframework --host http://orchestrator.example.com/ --token %TOKEN%

The agent will poll the Orchestrator every 5 seconds, and will execute the received commands. The chcp command sets the console to Unicode. It is Windows-specific. It is not mandatory but may be needed depending on the test framework available in the execution environment.

Test environments†

Some test technologies require that some particular components are installed in the test environment, these ones are indicated in the page describing the specifities of the technology.

Squash TM plugins

Installation

For details on the installation, please refer to the installation protocol of a Squash TM plugin.

Plugin Squash TM version Compatible plugin version Download latest Community version
Result Publisher† 1.22.9, or later 1.X.Y 1.1.X 1.1.0 : .tar.gz ou .zip
2.2.0, or later 2.X.Y 2.2.X 2.2.0 : .tar.gz ou .zip
3.0.0, or later 3.X.Y 3.0.X 3.0.0 : .tar.gz ou .zip
Test Plan Retriever 1.22.9 (or later 1.X.Y) 1.0.X 1.0.0: .tar.gz or .zip
2.2.0, or later 2.X.Y
3.0.0, or later 3.X.Y		 2.0.X 2.0.0: .tar.gz or .zip

Plugin for Jenkins

Installation

The plugin is freely downloadable, as a .hpi file (opentestfactory-orchestrator-1.3.1.hpi).

To install it, you have to submit the plugin in the Upload Plugin area accessible by the Advanced tab of the Plugin Manager in Jenkins configuration:

jenkins-plugin-upload

Compatibility of the plugin

This plugin is compatible with version 2.164.1 or higher of Jenkins

† indicates a component which is common to Squash AUTOM and Squash DEVOPS. It must be installed only once.

Back to top