Guide d'Installation

Sécurité

En raison de problèmes de sécurité, il est fortement conseillé d'utiliser Squash TM 1.22.9 (ou 1.X.Y postérieure), 2.2.0 (ou 2.X.Y postérieure), ou 3.0.0 (ou 3.X.Y postérieure).

Squash Orchestrator†

Installation

Squash Orchestrator se présente sous la forme d'un ensemble de services fonctionnant ensemble. Ils peuvent ou non être lancés sur une même machine, et être ou non démarrés simultanément.

Le seul prérequis est que le service EventBus, qui permet la communication entre les différents micro-services, soit disponible au moment du lancement des autres micro-services.

Pour faciliter l'installation de Squash Orchestrator, une image Docker "all-in-one" est mise à disposition. Elle contient l'ensemble des services nécessaires de l'OpenTestFactory Orchestrator et des services spécifiques Squash.

Pour récupérer la dernière version de l'image de Squash Orchestrator, la commande suivante est à exécuter :

docker pull squashtest/squash-orchestrator:latest

Les préconisations pour dimensionner le conteneur Docker sont :

2 CPU
RAM : 5 Go (8 Go recommandé)
disque : prévoir la capacité de stocker les rapports d’exécution et leurs attachements pour une heure d'utilisation

Accessibilité de l'instance Squash TM

Vérifier que l'instance de Squash TM est accessible depuis Squash Orchestrator. Pour cela se mettre sur l'hôte Docker et exécuter la commande (en remplaçant https://squashtm.example.com/squash par l'URL de votre instance) :

curl https://squashtm.example.com/squash/isSquashAlive

La réponse doit être :

Squash is Alive!

Si ce n'est pas le cas, résoudre le problème avec les administrateurs de votre réseau.

Usage

Configuration de l'image

La commande suivante permet de démarrer Squash Orchestrator en lui permettant d'utiliser un environnement d'exécution existant, avec auto-génération d'une clé approuvée (ce qui n'est pas recommandé dans un environnement de production).

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

Cette commande expose les services suivants sur les ports correspondants :

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

Lancement de l'image en mode Premium

Si vous disposez d'une licence Squash AUTOM Premium et avez déployé la version Premium du plugin Squash TM Result Publisher, vous devez démarrer Squash Orchestrator en mode Premium pour profiter du comportement Premium pour la remontée de résultats vers Squash TM. Pour cela, il faut ajouter le paramètre suivant dans la commande de démarrage de Squash Orchestrator : -e SQUASH_LICENCE_TYPE=premium

Pour une configuration plus complète de Squash Orchestrator, vous pouvez vous reporter à la documentation de l'OpenTestFactory qui sert de base au Squash Orchestrator.

Outils de l'orchestrateur†

Installation

Les outils de l'orchestrateur sont destinés à simplifier l'exploitation de ce dernier.
Ils requièrent Python 3.8 ou supérieur. Ils fonctionnent sur un environnement Linux, macOS ou Windows.

Afin d'installer ces outils, la commande suivante est à exécuter :

pip3 install --upgrade opentf-tools

Aperçu des capacités des outils

opentf-ready attend que l'orchestrateur soit prêt à accepter les workflows.
opentf-done attend que l'orchestrateur puisse être arrêté en toute sécurité (c'est-à-dire qu'il n'a plus de tâches en attente).
openf-ctl peut être utilisé pour
- démarrer / suivre / arrêter un workflow
- générer un jeton signé
- lister les abonnements sur le bus d'événements
- lister les agents
- générer / modifier un fichier de configuration

Agent OpenTestFactory†

Installation

L'agent OpenTestFactory est une application Python à installer sur un environnement d'exécution de tests automatisés. Il requiert Python 3.8 ou supérieur. Il fonctionne sur un environnement Linux, macOS ou Windows.

L'agent se présente comme un simple script. Il possède seulement une dépendance, vers la librairie python requests (elle sera installée si elle n'est pas déjà présente sur l'environnement d'exécution).

Afin d'installer l'agent, la commande suivante est à exécuter :

pip3 install --upgrade opentf-agent

Vous pouvez vérifier l'installation en exécutant la commande suivante :

opentf-agent --help

Usage

Résumé

$ 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.

Exemple

En considérant qu'un Squash Orchestrator est lancé sur orchestrator.example.com, avec un jeton stocké dans la variable d'environnement TOKEN, la commande suivante enregistre l'environnement d'exécution Windows et recevra les commandes ciblant windows et/ou robotframework :

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

L'agent contactera l'orchestrateur toutes les 5 secondes, et exécutera les commandes receptionnées.
La commande chcp configure la console en Unicode. Il s'agit d'une spécificité Windows. Cette configuration peut être nécessaire suivant le framework de test disponible sur l'environnement d'exécution.

Environnements de test†

Certaines technologies de test nécessitent que des composants particuliers soient installés dans l'environnement de test, ceux-ci sont indiqués dans la page décrivant les spécificités de la technologie.

Plugins Squash TM

Installation

Pour l’installation des plugins Squash TM, merci de vous reporter au protocole d’installation d’un plugin Squash TM.

Plugin	Version de Squash TM	Version compatible du plugin	Télécharger la dernière version Community
Result Publisher†	1.22.9, ou 1.X.Y postérieure	1.1.X	1.1.0 : .tar.gz ou .zip
	2.2.0, ou 2.X.Y postérieure	2.2.X	2.2.0 : .tar.gz ou .zip
	3.0.0, ou 3.X.Y postérieure	3.0.X	3.0.0 : .tar.gz ou .zip
Test Plan Retriever	1.22.9 ou 1.X.Y postérieure	1.0.X	1.0.0: .tar.gz or .zip
Test Plan Retriever	2.2.0, ou 2.X.Y postérieure 3.0.0, ou 3.X.Y postérieure	2.0.X	2.0.0: .tar.gz or .zip

Plugin pour Jenkins

Installation

Le plugin est sous la forme d’un fichier .hpi (opentestfactory-orchestrator-1.3.1.hpi) librement téléchargeable.

Pour l’installation, soumettez le plugin depuis l’onglet Avancé de l’écran de gestion des plugins de Jenkins :

jenkins-plugin-upload

Compatibilité du plugin

Ce plugin est compatible avec une version 2.164.1 ou supérieure de Jenkins.

† indique un composant commun à Squash AUTOM et Squash DEVOPS. Il ne doit être installé qu'une seule fois pour les deux.