Sonar Rapport
Sonar permet la présentation synthétique de rapport sur les projets en fonction des métriques mises en place.
Gestion des branches
Dans le cadre des projets, il n'est pas rare d'utiliser les possibilités de branches sur le code source. Ceci permet d'avoir une version "stable", des versions de travail dites "branches" et potentiellement des forks. Or il peut être souhaité de pouvoir réaliser des rapports sur l'ensemble de ces branches simultanément.
Par défaut, les rapports vont venir en collision car les modules auront le même nom dans chacune des branches et les métriques viendront s'écraser.
Dans le cadre de TIKA, les études ont été réalisées sur les différentes versions (1.0 à 1.5) de ce framework. Le code et les résultats pouvant être différents d'une étude à l'autre, il était important d'avoir un rapport pour chacun des projets. Pour rappel, la définition d'une des branches de l'étude, où est spécifiée la version du projet.
<?xml version="1.0" encoding="UTF-8"?>
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>tika</artifactId>
<groupId>fr.ejn.tutorial</groupId>
<name>Tika Study</name>
<packaging>jar</packaging>
<version>1.4</version>
<description>Example for Tika.</description>
<dependencies>
<dependency>
<artifactId>commons-io</artifactId>
<groupId>commons-io</groupId>
<version>${commons.io.version}</version>
</dependency>
<dependency>
<artifactId>commons-lang3</artifactId>
<groupId>org.apache.commons</groupId>
<version>${commons.lang.version}</version>
</dependency>
<dependency>
<artifactId>log4j</artifactId>
<groupId>log4j</groupId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<artifactId>tika-core</artifactId>
<groupId>org.apache.tika</groupId>
<version>${org.apache.tika.version}</version>
</dependency>
<dependency>
<artifactId>tika-parsers</artifactId>
<groupId>org.apache.tika</groupId>
<version>${org.apache.tika.version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-eclipse-plugin</artifactId>
<version>2.8</version>
<configuration>
<downloadJavadocs>true</downloadJavadocs>
<downloadSources>true</downloadSources>
<wtpversion>2.0</wtpversion>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.6</source>
<target>1.6</target>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>sonar-maven-plugin</artifactId>
<version>1.0</version>
</plugin>
</plugins>
</build>
<properties>
<commons.io.version>2.4</commons.io.version>
<commons.lang.version>3.3</commons.lang.version>
<log4j.version>1.2.16</log4j.version>
<org.apache.tika.version>1.4</org.apache.tika.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<checkstyle.location>http://www.jouvinio.net/dev/checkstyle.xml</checkstyle.location>
<junit.version>4.11</junit.version>
<maven.compile.source>1.6</maven.compile.source>
<maven.compile.target>1.6</maven.compile.target>
</properties>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<source>1.6</source>
<target>1.6</target>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>cobertura-maven-plugin</artifactId>
<version>2.4</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>2.6</version>
<configuration>
<configLocation>${checkstyle.location}</configLocation>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>2.5</version>
<configuration>
<targetJdk>1.6</targetJdk>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>2.3.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
<version>2.8</version>
<configuration>
<argLine>-Dfile.encoding=${project.build.sourceEncoding}</argLine>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>report-only</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
</project>Heureusement, ce cas est prévu avec la variable sonar.branch permettant de distinguer les différentes versions d'un même projet. L'utilisation de Sonar étant essentiellement réalisée à travers Jenkins, aucune modification des variables d'environnement, du pom ou autre n'est réalisée. Tout ceci s'effectue au niveau de la configuration du projet sous Jenkins.
Un projet pour chacune des versions de l'étude est créé sous Jenkins.
Au niveau des paramètres du job, il faut modifier la configuration de la section Sonar. Attention celle-ci est repliée par défaut et il est nécessaire de cliquer sur le bouton Avancé.
Une fois la section dépliée, l'option Branche, par défaut vide, est alors disponible. Dans le cadre de l'étude de TIKA, le numéro de version du pom est repris dans cette option.
Une fois les analyses effectuées, un rapport par version configurée est constaté dans l'interface Sonar.
