Aller au contenu

Installation de l'applicatif

L'application Squash TM est livrée sous différents packages :

  • un installeur Windows qui permet une installation rapide à des fins de démonstration
  • un package universel compatible Windows, Mac, Linux (.zip ou .tar.gz)
  • une image Docker

En version 1.X de Squash TM un paquet Debian (.deb) et Redhat (.rpm) étaient disponibles mais ces derniers sont aujourd'hui dépréciés. Une procédure indique comment basculer en tarball (tar.gz).

Attention

Il est IMPERATIF d’installer une JRE version 11 avant toute installation de Squash TM quel que soit l’environnement et quel que soit l’installeur.

Installation avec Linux

Installation avec le tarball Linux

Pour installer Squash TM avec le tarball Linux :

  1. Décompresser l’archive .tar.gz de Squash TM dans /opt

    tar -zxvf archivexsquashtm.tar.gz

  2. Créer un utilisateur et un groupe dédié à Squash TM

    adduser --system --group --home /opt/squash-tm squash-tm

  3. Définir squash-tm propriétaire de son dossier et ses fichiers

    chown -R squash-tm:squash-tm /opt/squash-tm

  4. Peupler la base de données grâce aux scripts présents dans : 

    /opt/squash-tm/database-scripts

    S'il s'agit d'une première installation passer le script <database>-full-install-version-4.X.X.RELEASE.sql correspondant au SGBD portant le numéro de version de Squash TM.
    S'il s'agit d'une montée de version, passer les scripts d'upgrade <database>-upgrade-to-X.X.X.sql correspondants au SGBD dans l'ordre des versions jusqu'à atteindre la version cible.

  5. Rendre startup.sh exécutable

    chmod +x /opt/squash-tm/bin/startup.sh

  6. Renseigner dans le fichier bin/startup.sh les informations de connexion à la base de données :

    DB_URL="jdbc:mysql://localhost:3306/squashtm" ou "jdbc:postgresql://localhost:5432/squashtm"
DB_TYPE="mysql" ou "postgresql"
DB_USERNAME="squash-tm"
DB_PASSWORD="password"

  7. Démarrer squash-tm via

    cd /opt/squash-tm/bin
nohup ./startup.sh &

  8. Faire Ctrl + C pour reprendre le contrôle sur le terminal.

Installation du service systemd sous Debian

Pour installer Squash TM comme service systemd sous Debian :

  1. Copier le fichier de service systemd qui est dans /opt/squash-tm.

    cp /opt/squash-tm/squash-tm.service /etc/systemd/system/

  2. Puis recharger les services :

    systemctl daemon-reload

  3. Faire en sorte que Squash-tm démarre avec le système :

    systemctl enable squash-tm

  4. Et enfin démarrer le service :

    systemctl start squash-tm

Il n’y a pas de fichier de service dans squash-tm-4.X.X.RELEASE.tar.gz. Il faut donc créer le fichier de service squash-tm.service avec le contenu qui suit :

[Unit]
Description=Squash-tm daemon
After=systemd-user-sessions.service time-sync.target

[Service]
WorkingDirectory=/opt/squash-tm/bin
ExecStart=/opt/squash-tm/bin/startup.sh
ExecStop=/bin/kill $MAINPID
KillMode=process
Type=simple
User=squash-tm
Group=squash-tm
Restart=on-failure
RestartSec=10
StartLimitInterval=120
StartLimitBurst=3
StandardOutput=null
StandardError=null

[Install]
WantedBy=multi-user.target

Installation avec Windows

Info

L’installeur Windows est livré à des fins d’évaluation et son utilisation dans un contexte de production est déconseillée.

Installation standard

Pour installer Squash TM sous Windows :

  1. Décompresser l'archive .zip de Squash TM dans votre répertoire de travail (le chemin sera appelé "<rep>" par la suite)

  2. Peupler la base de données grâce aux scripts présents dans :

    <rep>\squash-tm\database-scripts
    • S'il s'agit d'une première installation, passer le script <database>-full-install-version-4.X.X.RELEASE.sql correspondant au SGBD portant le numéro de version de Squash TM.
    • S'il s'agit d'une montée de version, passer les scripts d'upgrade <database>-upgrade-to-X.X.X.sql correspondants au SGBD dans l'ordre des versions jusqu'à atteindre la version cible.
    • Ou s'il s'agit d'une restauration d'une base existante, passer la commande associée au SGBD pour restaurer le dump.

  3. Renseigner dans le fichier startup.bat (<rep>\squash-tm\bin) les informations de connexion à la base de données

    DB_URL="jdbc:mysql://localhost:3306/squashtm" ou "jdbc:postgresql://localhost:5432/squashtm"
DB_TYPE="mysql" ou "postgresql"
DB_USERNAME="squash-tm"
DB_PASSWORD="password"

  4. Exécuter en double-cliquant directement le startup.bat ou installer Squash TM en tant que service

  5. Accéder à Squash TM via le navigateur à l'adresse suivante :

    http://localhost:8080/squash

    Les identifiants pour une installation nouvelle sont :

    login : admin
mot de passe : admin

Installation en tant que service Windows (.exe)

Pour installer Squash TM en tant que service Windows, il faut au préalable avoir fait les 3 premières étapes de l'installation standard. Puis suivre les étapes suivantes :

  1. Installer le service Squash TM via l'invite de commandes en administrateur (cmd) :

    <rep>\squash-tm\bin\squash-tm.exe install

  2. Aller dans Services (rechercher Services ou dans l'onglet Services au niveau du gestionnaire des tâches)

  3. Démarrer le service squash-tm

  4. Étape 5 de l'installation standard

Installation avec l'image Docker

Pour installer Squash TM avec l'image Docker consulter la documentation spécifique sur https://hub.docker.com/r/squashtest/squash-tm.

Passage d'une installation packagée (1.X) en tarball (tar.gz)

Les distributions packagées Redhat et Debian de Squash TM ne sont plus supportées en 2.X+. Cette section décrit la procédure à suivre pour basculer d'une installation packagée en version 1.X de Squash TM à une installation en tarball en version 2.X.

Focus

Avant de commencer la procédure, bien sauvegarder tous les binaires, fichiers de configuration, plugins, licences, base de données de Squash TM

Cette documentation est valable pour du Debian/Ubuntu ou Red Hat/CentOS, s'il y a des différences, celles-ci seront clairement notées.

Sauvegarde des éléments avant migration

Avant de procéder au transfert, il faut d'abord créer un répertoire de backup

mkdir -p /opt/squash-bckp/plugins
mkdir -p /opt/squash-bckp/conf
mkdir -p /opt/squash-bckp/ident

Pour Debian/Ubuntu :

cp -r /usr/share/squash-tm/plugins/*  /opt/squash-bckp/plugins
cp -r /etc/squash-tm/* /opt/squash-bckp/conf
cp /etc/default/squash-tm /opt/squash-bckp/ident

Pour Red Hat/CentOS :

cp -r /usr/lib/squash-tm/plugins/*  /opt/squash-bckp/plugins
cp -r /etc/squash-tm/* /opt/squash-bckp/conf
cp /etc/sysconfig/squash-tm /opt/squash-bckp/ident

Suppression de l'ancienne installation

Attention

Si la désinstallation de la base de données est proposée, choisir "No".

Pour Debian/Ubuntu :

apt purge squash-tm

Pour Red Hat/CentOS :

yum remove squash-tm

Installation

Info

Dans ce qui suit, il est supposé que l'archive de Squash TM de la 2.X a été téléchargée dans /opt

cd /opt
tar -zxvf squash-tmXXXX.tar.gz
chmod +x squash-tm/bin/startup.sh

Reprise de l'ancienne installation

Configuration

Si les fichiers de configuration n'ont pas été modifiés, cette section peut être passée, sinon il faut éditer chaque fichier qui se trouve dans /opt/squash-bckp/conf, reprendre les anciens paramètres de configuration et les reporter dans les fichiers se trouvant dans /opt/squash-tm/conf/

Connexion à la base de données

Pour récupérer la connexion à la base de données :

  • Éditer /opt/squash-bckp/ident/squash-tm
  • Reprendre les valeurs des variables :
    • DB_TYPE
    • DB_URL
    • DB_USERNAME
    • DB_PASSWORD
  • Les reporter dans le fichier /opt/squash-tm/bin/startup.sh

Focus

Ne pas oublier de passer les scripts d'upgrade sur la base de données pour faire la montée de version du schéma en 2.X.

Licence

Pour récupérer le fichier de licence de Squash TM : 

cp -ar /opt/squash-bckp/plugins/license /opt/squash-tm/plugins

Plugins

Les plugins évoluent entre la V1 et la V2 de Squash TM, il n'est donc pas possible de reprendre les anciens plugins en faisant un simple copier/coller :

  • Lister les plugins/jar se trouvant dans /opt/squash-bckp/plugins/
  • En cas de plugin inclus dans la distribution de Squash TM, la mise à jour est déjà faite dans /opt/squash-tm/plugins/
  • En cas de plugins gratuits, télécharger la mise à jour sur le site de Squash TM
  • En cas de plugins commerciaux, se rapprocher du Support Squash

Service sous systemd

  • Créer le fichier de service dans /etc/systemd/system/squash-tm.service
  • Le remplir avec cet exemple (à modifier si l'installation ne se fait pas dans /opt)
[Unit]
Description=Squash-TM daemon
After=systemd-user-sessions.service time-sync.target

[Service]
WorkingDirectory=/opt/squash-tm/bin
ExecStart=/opt/squash-tm/bin/startup.sh
ExecStop=/bin/kill $MAINPID
KillMode=process
Type=simple
#Restart=on-failure
User=squash-tm
Group=squash-tm

[Install]
WantedBy=multi-user.target
  • Recharger les services
systemctl daemon-reload
  • Mettre à jour la base de données

Les scripts de mise à jour se trouvent dans /opt/squash-tm/database-scripts/

  • Changer l'utilisateur de Squash-TM
useradd squash-tm
chown -R squash-tm: /opt/squash-tm/

  • Supprimer le repository

    • Pour Debian/Ubuntu

    sh rm /etc/apt/sources.list.d/squash-tm.list*

    • Pour Red Hat/CentOS

    sh rm /etc/yum.repos.d/squashtest.repo*

  • Lancer Squash-tm

systemctl enable squash-tm
systemctl start squash-tm

Pour vérifier le bon déroulement du démarrage de Squash TM regarder les logs dans /opt/squash-tm/logs/squash-tm.log.