Vous devez préalablement avoir installé le plugin Adélia sur le serveur SONAR, puis installé et configuré Maven pour accéder au référentiel SONAR (comme décrit dans l'aide en ligne de SONAR) sur le poste effectuant l'analyse.
L'analyse est séparée en deux phases :
- Une première phase d'exécution du gestionnaire de qualité Adélia en ligne de commandes et de préparation des sources et des données de qualité pour l'intégration dans SONAR (adelqual:adelqual).
- Une deuxième phase d'intégration des données générées dans SONAR (sonar:sonar).
La première phase est prise en compte par un plugin Maven (Adelia quality plugin). Cela restreint donc la compatibilité à Maven (le Java Runner autonome n'est pas pris en charge).
Vous pouvez ensuite utiliser le script exemple ci-dessous, en définissant les propriétés permettant d'accéder au référentiel Adélia, à savoir au minimum (adelqual.environ = <nom_environnement>, sonar.sources = <répertoire_sources_générés> et les paramètres de connexion à SONAR).).
Attention :
Les paramètres par défaut de JAVA peuvent être trop restreints en ce qui concerne l'allocation de la mémoire. Il est recommandé de les augmenter, notamment la taille maximale de la pile.
En ce qui concerne l'analyse par Maven, cela peut être fait en définissant la variable d'environnement MAVEN_OPTS.
La valeur recommandée de cette variable pour Adélia est la suivante :
set MAVEN_OPTS=-Xmx512m -XX:MaxPermSize=128m -Xss1m
Attention :
La propriété "sonar.profile" est dépréciée dans l'ensemble des versions de Sonar prises en compte par le plugin en version 3.x, et n'est pas prise en compte par le plugin adelqual. L'analyse se fait toujours à l'aide du profil de règles associé au projet dans Sonar, ou à l'aide du profil par défaut dans le cas d'une première analyse (création du projet).
Il est possible de créer le projet en avance dans Sonar et de lui affecter un profil de règles. Assurez-vous que la clé du projet respecte le standard suivant "groupId:artifactId", groupId et artifactId correspondant aux informations indiquées dans votre projet maven.
Par exemple si votre projet contient les informations suivantes :
<groupId>com.mycompany</groupId>
<artifactId>test</artifactId>
<name>Test</name>
Le projet Test doit être crée dans Sonar avec la clé "com.mycompany:test".
Exemple
L'exemple suivant reprend le modèle de projet fourni sur le site Sonar en commentant les informations à renseigner et en spécifiant les paramètres superflus en gris.
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>[ORGANISATION]</groupId>
<artifactId>[ID PROJET]</artifactId>
<name>[NOM PROJET]</name>
<version>[VERSION PROJET]</version>
<properties>
<sonar.host.url>[URL_HOST]</sonar.host.url>
<sonar.login>[LOGIN]</sonar.login>
<sonar.password>[MOT_PASSE]</sonar.password><sonar.sources>[REPERTOIRE SOURCES]</sonar.sources>
</properties>
<build>
<plugins>
<plugin>
<groupId>com.hardis.maven.plugins</groupId>
<artifactId>adelqual-maven-plugin</artifactId>
<version>1.1</version>
<configuration>
<environ>[NOM_ ENVIRONNEMENT]</environ>
</configuration>
</plugin>
</plugins>
</build>
</project>
Paramètres à renseigner :
ORGANISATION |
Nom de l'organisme (ex : Hardis) |
ID PROJET |
Nom interne du projet dans SONAR. Ce nom n'est pas affiché et doit représenter de façon unique votre projet. Ex : test_va.projet_test |
NOM PROJET |
Nom externe du projet. Doit correspondre au nom du projet défini dans le gestionnaire de qualité Adélia. Ex : Projet de test |
VERSION PROJET |
Version de votre projet. Ex : 1.0 |
URL_HOST |
URL d'accès au repository SONAR. |
| LOGIN | Profil de connexion (si nécessaire). |
MOT_PASSE |
Mot de passe du profil de connexion. |
NOM ENVIRONNEMENT |
Nom de l'environnement Adélia. |
| REPERTOIRE SOURCES | Répertoire des sources générés. |
Propriétés spécifiques des plugins Adélia :
sonar.sources |
obligatoire |
Le plugin Adélia extrait les fichiers source et les données de qualité dans un répertoire lors de la phase d'analyse (plugin Adelqual). Ces données seront importées dans SONAR dans la phase d'intégration (plugin Sonar). |
||||||
adelqual.environ |
obligatoire |
Environnement Adélia. |
||||||
adelqual.genMode |
optionnel |
Cette option permet de déterminer comment Adélia va recalculer les données de qualité des programmes avant de les intégrer dans Sonar. Valeurs possibles :
Remarque : les versions courantes de SONAR ne permettent pas de détecter les modifications du profil de règles. Si le profil de règles est modifié, il est de votre responsabilité de relancer l'analyse en mode "full" lorsque vous modifiez la configuration de SONAR. |
||||||
| adelqual.createObjects | optionnel |
Cette option permet de créer les travaux de compilation lors de l'analyse d'un projet. Attention : le plugin n'exécute pas ces travaux, ils sont pris en charge par le gestionnaire de travaux Adélia. Valeurs possibles : "true" "false" (par défaut) |
||||||
| sonar.adelia.locale | optionnel |
Locale à utiliser pour la connexion à Adélia et la génération des messages de violations. Valeurs possibles : "fr" ou "en". Valeur par défaut : "en". |
Pour exécuter l'intégration, vous devez sauvegarder le fichier sous le nom "pom.xml" dans un répertoire, vous positionner dans ce répertoire et lancer la commande "mvn adelqual:adelqual sonar:sonar". Le projet sera automatiquement créé dans SONAR si nécessaire.
Note sur l'intégration :
Le plugin Maven Adélia a été développé de manière à maintenir une compatibilité ascendante avec la version antérieure.
Les propriétés spécifiques du plugin sont initialisées par défaut avec leur équivalent dans l'ancienne version (par exemple adelqual.environ est initialisé avec la valeur de sonar.adelia.environ).
Cela signifie que si Maven est configuré proprement pour la résolution du préfixe, les anciens projets peuvent être utilisés sans modification. Il est néanmoins préférable de réécrire proprement les projets au nouveau format.
Pour résoudre automatiquement le plugin adelqual (i.e. pour ne pas avoir besoin de l'inscrire explicitement dans le pom.xml), vous devez ajouter le groupe "com.hardis.maven.plugins" à la section "pluginGroups" du fichier de configuration de Maven (settings.xml).
<pluginGroups>
<pluginGroup>com.hardis.maven.plugins</pluginGroup>
</pluginGroups>