Sonar against a non-maven multi-modules project

I’ve explained a few monthes ago how to run Sonar against a non-maven project.

The workaround is to create a POM with an explicit source directory and set the Sonar property sonar.dynamicAnalysis to false.

What if the project has many source folders ?

For instance a WebSphere Commerce Server project with 3 sub-projects:

  • Stores which sources are in JavaSources
  • WebSphereCommerceServerExtensionsLogic which sources are in src
  • WebSphereCommerceServerExtensionsData which sources are in ejbModule

It looks like a Maven project with 3 modules, each module having a non standard source folder.

Step 1: The main POM

First of all, make a new directory besides the project root folder and create the main POM file.

Your directories now looks like

  • Project
    • Stores
    • WebSphereCommerceServerExtensionsLogic
    • WebSphereCommerceServerExtensionsData
  • MavenProject
    • pom.xml


pom.xml


<project xmlns= »http://maven.apache.org/POM/4.0.0&Prime;
xmlns:xsi= »http://www.w3.org/2001/XMLSchema-instance &raquo;
xsi:schemaLocation= »http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd »&gt;

<modelVersion>4.0.0</modelVersion>

<!–  project information –>

<groupId>my-commerce-web-site</groupId>
<artifactId>my-commerce-web-site</artifactId>
<name>My Commerce Site Project</name>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>

<build>

<!– Setup compiler options Java 1.4 –>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.4</source>
<target>1.4</target>
</configuration>
</plugin>
</plugins>

</build>

<modules>

<module>ExtensionsData</module>
<module>ExtensionsLogic</module>
<module>Stores</module>

</modules>

<properties>

<sonar.dynamicAnalysis>false</sonar.dynamicAnalysis>

</properties>

<pluginRepositories>

<!– Sonar may not be found on some repositories –>
<pluginRepository>
<id>Codehaus repository</id>
<url>http://repository.codehaus.org/</url&gt;
</pluginRepository>

</pluginRepositories>

</project>


Step 2: Modules directories

Create a directory  for each modules with respect to the module’s  names  in the main  pom.xml

Your directories now looks like

  • MavenProject
    • pom.xml
    • Stores
    • ExtensionsLogic
    • ExtensionsData

Step 3: Module’s POMs

Create the module’s pom.xml for each module.

Stores/pom.xml


<project xmlns= »http://maven.apache.org/POM/4.0.0&Prime;
xmlns:xsi= »http://www.w3.org/2001/XMLSchema-instance &raquo;
xsi:schemaLocation= »http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd »&gt;

<modelVersion>4.0.0</modelVersion>

<!–  project information –>
<groupId>my-commerce-web-site</groupId>
<artifactId>my-commerce-web-site-stores</artifactId>
<name>MyCommerceSite Stores</name>
<version>0.0.1-SNAPSHOT</version>
<parent>

<groupId>my-commerce-web-site</groupId>
<artifactId>my-commerce-web-site</artifactId>
<version>0.0.1-SNAPSHOT</version>

</parent>

<build>

<sourceDirectory>../../Project/Stores/JavaSource</sourceDirectory>
<outputDirectory>target/classes</outputDirector>

</build>

</project>


Parent’s groupId and artifactId should match the main pom’s groupId and artifactId.

Your directories now looks like

  • MavenProject
    • pom.xml
    • Stores
      • pom.xml
    • ExtensionsLogic
    • ExtensionsData


Similar posts:

Publicités

Running Sonar against a GAE Java project

The GAE SDK generates a project that is not Maven enabled. Namely, source and target directories does not follow Maven conventions.
Sonar may be run against such a project by using Sonar light mode configuration.

  • We will write a minimal POM project and instruct Sonar to run only static analysis (code violations, complexity).
  • For the time being, we will put dynamic analysis (unit test results and code coverage) aside as it requires code to be executed, therefore dependencies configuration. Sonar may actually report dynamic analysis if surefire and cobertura reports are available.
But let’s start with some simple configuration.
You will need Sonar (1.8 minimum) and Maven 2.

Write a POM

Open the Eclipse project generated by GAE SDK and create a pom.xml file at the project’s root.
Add your project’s information (replace cirrus in the snapshot below by your project’s information)
projet
Add GAE build information. You should not have to change these lines.
build
Add some Sonar configuration to skip dynamic analysis. You should not have to change these lines.
sonaroptions
Depending on your repository and mirror, you may have to download sonar jars from the Codehaus repository.
fin

Run Sonar

Now run sonar from the shell command line or configure an Eclipse launcher. As the Sonar maven plugin will send out data to Sonar during the build, the Sonar server must be running.
runsonar
It may take a while the first time, as maven will download tons of libraries and plugins.
runsonarfin
When it’s done, Sonar’s analysis report is available at http://localhost:9000.
sonarpage
You may find usefull information about Sonar configuration including « Non-Maven » projects in Analyzing Java Projects

Générer un rapport PDF Sonar

Depuis Sonar 1.8, il existe un plugin de génération de rapport PDF.

La mise en oeuvre est très très simple.
Lancez la commande ci-dessous depuis un shell de commande ou l’IDE :

>mvn org.codehaus.sonar-plugins:pdf-report:0.1:generate -Dsonar.base.url=http://nommachine:9000

L’option -Dsonar.base.url n’est pas obligatoire, mais il se trouve que je ne peux pas faire tourner Sonar sur le port standard 9000. Attention, pas de / à la fin de l’url sinon l’url générée contient un // au début du path et il ne parviendra pas à lire les données.

Il n’est pas nécessaire de télécharger le plugin, il automatiquement téléchargé et mis en place via maven.

Le rapport en PDF est généré dans le répertoire target du projet maven racine.
Il contient pour le projet et chaque module, les ratios du dashboard (voir image ci-dessous), les valeurs du radar par catégorie (Efficiency, Maintainability, Portability, Reliability, Usability) et les hotspots Most violated rules et Most violated files.

rapport-sonar

La page du plugin se trouve là Sonar PDF Plugin.

Sonar 1.8 et la Sonar Plugin Library

sonar posterPour ceux qui auraient raté les épisodes précédents, Sonar est un produit open source de qualimétrie pour le monde Java.

Cet outil pilote l’exécution des outils d’analyse de code (PMD, Checkstyle, Findbugs) et de test unitaire sous Maven, historise et fait la synthèse de toutes ces informations. Il peut être étendu par plugins (par exemple PL/SQL ou l’intégration Hudson).

Il se montre particulièrement indispensable sur des projets multi-modules où il est difficile d’avoir une vue d’ensemble de la qualité en utilisant chacun de ces outils et Maven Dashboard.
Sonar agrège ces informations selon les catégories ISO (Efficiency, Maintenability, Portability, Reliablity, Usability) et permet une identification rapide du type d’impact sur un radar. La navigation projet / module / package permet d’avoir ces informations à différentes granularités.

Plusieurs systèmes permettent de localiser facilement la classe et la portion de code où il faut agir en priorité pour améliorer la qualité :
– un pavage qui permet de visualiser à chaque niveau l’importance des éléments et leur niveau de qualité
– un nuage qui met en évidence les classes qu’il est facile d’améliorer et celles qui présentent le plus de risque
– depuis la version 1.8, Sonar a ajouté les hotspots, des top5 des classes les plus indisciplinées, les plus longues à tester, les plus complexes, les moins testées …

En plus des hotSpots, la version 1.8 ajoute en particulier le paramétrage de Findbugs, l’affichage des duplications sur le code source et le support de maven 2.1.

Vous cherchez encore des excuses pour ne pas évaluer la qualité de votre code ?
Allez le voir fonctionner sur Nemo et on en rediscute après.