Installer les plugins et la licence Squash TM

Installation des plugins Squash TM

Pour installer les plugins sur Squash TM, il faut suivre la procédure suivante quel que soit l'OS d'installation :

Télécharger le plugin depuis le site https://www.squashtest.com/ ou depuis les liens fournis par l'Équipe Support Squash
Décompresser le plugin
Récupérer la totalité des fichiers .jar qu'il contient et les déposer dans le dossier suivant :
- /opt/squash-tm/plugins : pour un tarball
- C:\\squash-tm\plugins : pour Windows
Sous Linux, attribuer les droits de lecture à l’utilisateur squash-tm sur les .jar.
S'il s'agit d'un plugin commercial, s'assurer que le fichier de licence 'squash-tm.lic' est bien présent dans le dossier 'license'
Redémarrer Squash TM pour que l'installation des plugins soit prise en compte

Info

Les plugins peuvent également être installés dans des sous-répertoires du répertoire 'plugins'.

Info

La liste des plugins installés peut être consultée directement dans Squash TM par un administrateur fonctionnel dans les informations système.

Une fois installés, certains plugins sont directement opérationnels, c'est le cas pour les plugins d'API, de reporting ou encore la Bibliothèque d'actions. D'autres nécessitent par contre une configuration au niveau serveur ou au niveau de l'administration.

Pour en savoir plus sur la configuration des plugins au niveau serveur, consulter la page Configurer les plugins. Pour les autres configurations, consulter le Guide Administrateur pour plus d'informations.

Installation de la licence commerciale

L'utilisation des plugins commerciaux de Squash TM est conditionnée par la présence d'un fichier de licence : squash-tm.lic. Ce fichier est nécessaire pour démarrer Squash TM avec les plugins commerciaux.
Il est fourni au client par le Support Squash suite à la contractualisation d'une nouvelle licence ou d'un renouvellement.

Le fichier de licence est unique pour chaque client. Il comporte les informations suivantes :

une date de fin de validité,
un nombre d'utilisateurs,
la liste des plugins commerciaux autorisés en fonction de la licence ou de la combinaison de licences contractées

Ce fichier de licence peut être utilisé par le client aussi bien pour ses instances de production et que pour ses instances de préproduction.

Pour installer le fichier sur Squash TM, voici les actions à réaliser :

Dans le répertoire 'plugins' de Squash TM, créer un sous-répertoire intitulé 'license'. Attention, le répertoire s'écrit 'license', avec un S.
Déposer le fichier 'squash-tm.lic' communiqué par l'Équipe Support Squash
Puis redémarrer Squash TM

Le fichier de licence contrôle le nombre d'utilisateurs actifs sur Squash TM. Un message s'affiche pour alerter les administrateurs lorsque le nombre maximum d'utilisateurs est dépassé. Si ce nombre est dépassé de plus de 20%, la création de nouveaux utilisateurs est bloquée.

Deux mois avant la date de fin de validité de la licence, un message alerte les administrateurs. Passé cette date, un message indique à l'ensemble des utilisateurs que la licence est expirée. Si la licence n'est pas renouvelée deux mois après la date de fin, Squash TM s'éteint. Il faut alors retirer les plugins commerciaux pour pouvoir redémarrer l'application.

Installation du Xsquash pour Jira Server

Xsquash est un composant additionnel disponible sur l’Atlassian Marketplace pour Jira Server et Jira Data Center qui renforce l’intégration entre Squash TM et Jira. Il affiche les données des cas de tests et des exécutions Squash TM directement dans les tickets Jira qui ont été synchronisés dans Squash TM via Xsquash4Jira.

Info

Les données sont affichées dans Jira via l'API REST de Squash TM, ce plugin n'écrit pas dans la base de données de Jira.

Ce plugin requiert à minima les prérequis suivants pour son installation :

Jira Server ou Data Center 8+
Squash TM version 1.19.0+
Squash REST API 1.1.0+
Xsquash4Jira 1.2.0+ : Le plugin Xsquash4Jira doit avoir été installé dans Squash TM et être configuré pour au moins un projet.

Pour plus d’informations sur la configuration du plugin Xsquash4Jira, se référer à la page dédiée Configurer Xsquash4Jira dans Squash TM

Pour installer le plugin Xsquash sur Jira Server ou Jira Data Center, voici la procédure à suivre :

Se connecter à l’instance Jira en tant qu’administrateur.
Aller sur l’'Administration Jira' et cliquer sur 'Gérer les Apps'. 'L'Atlassian Marketplace pour Jira' s'affiche.
Rechercher Xsquash sur la Marketplace. Les résultats de recherche incluent les versions de l’application compatibles avec l'instance Jira.
Cliquer sur [Installer] pour télécharger et installer l’application.
Cliquer sur Fermer dans la fenêtre de dialogue.

Le plugin Xsquash nécessite une configuration pour être opérationnel.

Pour plus d’informations sur la configuration du plugin Xsquash, se référer à la page dédiée Configurer Xsquash dans Jira

Installation de l'application Xsquash Cloud sur Jira Cloud

Xsquash Cloud est une application hébergée sur un serveur interne à l’entreprise Henix qui renforce l’intégration entre Squash TM et Jira Cloud. Il affiche les données des cas de tests et des exécutions Squash TM directement dans les tickets Jira qui ont été synchronisés dans Squash TM via Xsquash4Jira.

Cette application n'est accessible qu'aux clients disposant d'une licence.

Info

Les données sont affichées dans Jira via l'API REST de Squash TM, cette application n'écrit pas dans la base de données de Jira Cloud.

Elle requiert à minima les prérequis suivants pour son installation :

Jira Cloud
Squash TM version 1.19.0+
Squash REST API 1.1.0+
Xsquash4Jira 1.2.0+ : le plugin Xsquash4Jira doit avoir été installé dans Squash TM et être configuré pour au moins un projet.

Pour plus d’informations sur la configuration du plugin Xsquash4Jira, se référer à la page dédiée Configurer Xsquash4Jira dans Squash TM

Il existe deux façons d’installer l’application Xsquash Cloud sur Jira Cloud :

Installer manuellement Xsquash Cloud

Pour installer manuellement Xsquash Cloud, voici la procédure à suivre :

Se connecter à l’instance Jira Cloud en tant qu’administrateur.
Cliquer sur le bouton et choisir 'Apps' puis l’option 'Gérer les apps'.
Cliquer sur 'Paramètres' pour ouvrir la fenêtre 'Settings'.
Cocher l’option 'Enable development mode' puis cliquer sur le bouton [Apply].
Sur la page 'Gérer les apps', cliquer sur 'App importable' pour ouvrir la fenêtre 'Upload app'.
Renseigner l’url qui vous aura été fournie par l’Équipe Support Squash puis cliquer le bouton [Upload].
L’application Xsquash Cloud apparaît ensuite dans liste des applications installées.

Installer Xsquash Cloud via l’API

Avant d’installer l’application Xsquash Cloud dans Jira Cloud par API, il faut au préalable un compte administrateur disposant d’un jeton d’API.

Pour générer un jeton d’API, il faut suivre la procédure suivante :

Être connecté avec le compte administrateur puis dans "Votre profil et vos paramètres", cliquer sur "Profil"
Cliquer sur "Gérer votre compte"
Cliquer sur "Sécurité"
Dans la section 'Jeton d'API', cliquer sur "Créer et gérer des jetons d'API"
Cliquer sur "Créer un jeton d'API" puis saisir un libellé
Saisir un libellé puis cliquer sur "Créer"
Copier le jeton

Voici la procédure à suivre pour l’installation de l’application Xsquash Cloud via l’API :

Faire une requête GET en BASIC AUTH à l’URL suivante :
```
https://Url-de-Jira.atlassian.net/rest/plugins/1.0/?os_authType=basic
```
avec dans le header, l’information suivante :
```
Accept: application/vnd.atl.plugins.installed+json
```
Pour l’authentification, utiliser le Username de l’administrateur et son jeton d’API.
Récupérer la valeur du header « upm-token » dans la réponse
Faire une requête POST en BASIC AUTH à l’URL suivante en remplaçant 'Upm-Token' par la valeur du header « upm-token » récupéré précédemment :
```
https://Url-de-Jira.atlassian.net/rest/plugins/1.0/?token=Upm-Token
```
avec dans le header, l’information suivante :
```
Content-type: application/vnd.atl.plugins.uri+json
Accept: application/json
```
et dans le body la commande suivante avec l’url qui vous aura été fournie par l’Équipe Support Squash :
```
{
"pluginUri": "https://Url-Xsquash-Cloud.com/atlassian-connect.json",
"pluginName": "Xsquash Cloud"
}
```
et pour l’authentification, utiliser le Username de l’administrateur et son jeton d’API.
L’application Xsquash Cloud apparaît ensuite dans liste des applications installées au niveau de l'administration Jira Cloud.

Il faut ensuite configurer l'application pour pouvoir l'utiliser.

Pour plus d’informations sur la configuration de l'application Xsquash Cloud, se référer à la page dédiée Configurer Xsquash Cloud sur Jira Cloud