Installer les plugins et la licence SquashTM

Installation des plugins SquashTM

Il y a deux manières d'installer des plugins sur SquashTM :

En utilisant les fichiers des plugins embarqués dans la distribution de SquashTM

1. Récupérer le plugin dans le dossier squash-tm/plugin-files ;
2. Déplacer ou copier le dossier correspondant au plugin à installer dans le dossier suivant :
   • /opt/squash-tm/plugins : pour un tarball ;
   • C:\<rep>\squash-tm\plugins : pour Windows ;
3. Sous Linux, attribuer les droits de lecture à l'utilisateur squash-tm sur les .jar ;
4. 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 ;
   • le plugin SquashTM Premium est présent dans le dossier mentionné ci-dessus à l'étape 2 ;
5. Redémarrer SquashTM pour que l'installation des plugins soit prise en compte.

En téléchargeant les plugins

1. Télécharger le plugin depuis la page Téléchargements ;
2. Décompresser le plugin ;
3. 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:\<rep>\squash-tm\plugins : pour Windows ;
4. Sous Linux, attribuer les droits de lecture à l'utilisateur squash-tm sur les .jar ;
5. 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 ;
   • le plugin SquashTM Premium est présent dans le dossier mentionné ci-dessus à l'étape 3 ;
6. Redémarrer SquashTM pour que l'installation des plugins soit prise en compte.

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

Installation de la licence commerciale

L'utilisation des plugins commerciaux de SquashTM est conditionnée par :

• la présence d'un fichier de licence : squash-tm.lic ;
• l'installation du plugin SquashTM Premium.

Le fichier de licence est fourni au client par le Support SquashTM 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 que pour ses instances de préproduction.

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

1. Dans le répertoire plugins de SquashTM, créer un sous-répertoire intitulé license. Attention, le répertoire s'écrit license, avec un S ;
2. Déposer le fichier squash-tm.lic communiqué par l'Équipe Support SquashTM ;
3. Installer le plugin SquashTM Premium ;
4. Puis redémarrer SquashTM.

Le fichier de licence contrôle le nombre d'utilisateurs actifs sur SquashTM. 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, SquashTM s'éteint. Il faut alors retirer les plugins commerciaux pour pouvoir redémarrer l'application.

Installation du Xsquash pour Jira Data Center

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

Ce plugin requiert à minima Jira Data Center 8.4+.

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

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

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

Installation de l'application Xsquash Cloud (Forge) sur Jira Cloud

Xsquash Cloud (Forge) est une application disponible sur l’Atlassian Marketplace.

Installer Xsquash Cloud (Forge)

Vous pouvez accéder directement à l'application en cliquant ici, puis l'installer en cliquant sur [Get it now].

Vous pouvez également suivre la procédure suivante :

1. Connectez-vous à votre instance Jira Cloud avec un compte administrateur ;
2. Dans le menu situé à gauche, développez [Apps], puis cliquez sur [Explorer plus d'apps] ;
3. Saisissez "Xsquash" dans la barre de recherche, puis cliquez sur [Rechercher] ;
4. Cliquez sur l'application Xsquash ;
5. Vérifiez que la version Cloud est sélectionnée ;
6. Cliquez sur [Get it now] ;
7. Suivez ensuite les étapes d'installation pour ajouter l'application à votre instance Jira Cloud.

Exigences d'accès à l'API pour Xsquash Cloud

Xsquash Cloud récupère les données des cas de test et des exécutions via l'API REST de SquashTM. Les points de terminaison spécifiés dans cette spécification OpenAPI doivent être accessibles depuis le serveur hébergeant votre instance Jira.

De plus, Xsquash Cloud vérifie ce point de terminaison lors de l'installation afin de s'assurer de la connectivité : /api/rest/latest/docs/api-documentation.html. Cette page doit également être accessible depuis le serveur Jira.