Difference between revisions of "Sonar + maven configuration + Jenkins"
Line 141: | Line 141: | ||
=Surefire (UT tests)= | =Surefire (UT tests)= | ||
− | |||
− | |||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
Line 182: | Line 180: | ||
* Each module has its own surefire-reports + Sonar report | * Each module has its own surefire-reports + Sonar report | ||
* The exclusion list is something that depends on your own situation | * The exclusion list is something that depends on your own situation | ||
+ | |||
+ | |||
Line 199: | Line 199: | ||
Even better, you can check out this excellent tutorial: | Even better, you can check out this excellent tutorial: | ||
* https://github.com/dgageot/coverage | * https://github.com/dgageot/coverage | ||
+ | |||
+ | |||
+ | |||
+ | =Appendices= | ||
+ | |||
+ | |||
+ | ==Run tests in specific order== | ||
+ | |||
+ | If for some reasons you need to run your tests in a particular order you can say so in the POM: | ||
+ | |||
+ | <syntaxhighlight lang="xml"> | ||
+ | <build> | ||
+ | <plugins> | ||
+ | <plugin> | ||
+ | SUREFIRE or FAILSAFE | ||
+ | |||
+ | <configuration> | ||
+ | <!-- JVM settings --> | ||
+ | <argLine>-Xmx1024m -XX:maxPermSize:256m</argLine> | ||
+ | <forkCount>1</forkCount> | ||
+ | <reuseForks>true</reuseForks> | ||
+ | <runOrder>alphabetical</runOrder> | ||
+ | <!-- Jacoco execution --> | ||
+ | <argLine>${jacoco.agent.it.arg}</argLine> | ||
+ | ... | ||
+ | </configuration> | ||
+ | </plugin> | ||
+ | |||
+ | </plugins> | ||
+ | </build> | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | The <code>runOrder</code> is a nice trick. | ||
+ | |||
+ | |||
+ | '''Warning''' : if you have to run your tests in a particular order then you should refactor your tests! This trick should not let you escape from that! | ||
Revision as of 16:09, 20 May 2015
SonarQube requires quite some configuration to be fully useful!
This article explains how to configure your maven projects to use SonarQube properly, bringing both Unit and Integration tests coverage.
Contents
Principle
To work well SonarQube requires 4 configuration steps:
TODO: nice picture
Key points:
- SONAR is configured for JAVA language and it will use Jacoco as coverage tool.
- Each maven module will have its own Unit Tests results (Surefire reports + .exec file) inside its own
target
directory - The Integration Tests results are common. Meaning, all modules will write in the same directory. That directory is relative to the maven execution.
Sonar properties
First of all you need to configure SONAR by setting up some properties and paths.
Technical details:
- Surefire unit tests plugin
- Outputs in
${project.build.directory}
- 1 XML file per test class in:
${sonar.junit.reportsPath}
- SONAR report file (jacoco-ut.exec) will be available at
${sonar.out.unitTestsReport}
- Outputs in
- Failsafe integration tests plugin
- All outputs in the same directory, relative to the local execution:
${session.executionRootDirectory}
- All outputs in the same directory, relative to the local execution:
POM.xml extract:
<properties>
...
<!-- Maven plugins -->
<maven-surefire-plugin.version>2.18.1</maven-surefire-plugin.version>
<maven-failsafe-plugin.version>2.18.1</maven-failsafe-plugin.version>
<!-- Test frameworks -->
<junit.version>4.12</junit.version>
<!-- ==== SONARQUBE quality metrics ==== -->
<maven.jacoco.version>0.7.4.201502262128</maven.jacoco.version>
<!-- Global Sonar settings. Do not change them! -->
<sonar.language>java</sonar.language>
<sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>
<sonar.core.codeCoveragePlugin>jacoco</sonar.core.codeCoveragePlugin>
<jacoco.lib.path>
${settings.localRepository}/org/jacoco/org.jacoco.agent/${maven.jacoco.version}/org.jacoco.agent-${maven.jacoco.version}-runtime.jar
</jacoco.lib.path>
<javaagent>${jacoco.lib.path}</javaagent>
<!-- Don't let Sonar execute tests. We will let Maven do it during build phase -->
<sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
<!-- Report -->
<!-- IMPORTANT: integration test path must be ABSOLUTE, especially for muli-modules projects -->
<!-- ${session.executionRootDirectory} = directory from where the "mvn" command is run -->
<!-- a) Where sonar will find the standard test reports -->
<sonar.surefire.reportsPath>${project.build.directory}/surefire-reports</sonar.surefire.reportsPath>
<sonar.failsafe.reportsPath>${session.executionRootDirectory}/target/failsafe-reports</sonar.failsafe.reportsPath>
<!-- b) Sonar specific reports -->
<sonar.jacoco.reportPath>${project.build.directory}/jacoco-unit.exec</sonar.jacoco.reportPath>
<sonar.jacoco.itReportPath>${session.executionRootDirectory}/target/reports/jacoco-it.exec</sonar.jacoco.itReportPath>
</properties>
Jacoco plugin (coverage agent)
This is how you should configure this plugin:
<build>
<plugins>
<!-- == Jacoco agent configuration == -->
<!-- This will auto-generate the right jacoco command for Unit | Integration tests -->
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>${maven.jacoco.version}</version>
<executions>
<!-- Unit tests configuration -->
<execution>
<id>prepare-unit-test-agent</id>
<phase>process-test-classes</phase>
<goals>
<goal>prepare-agent</goal>
</goals>
<configuration>
<destFile>${sonar.jacoco.reportPath}</destFile>
<propertyName>jacoco.agent.ut.arg</propertyName>
<append>true</append>
</configuration>
</execution>
<!-- Integration tests configuration -->
<execution>
<id>prepare-integration-test-agent</id>
<phase>pre-integration-test</phase>
<goals>
<goal>prepare-agent</goal>
</goals>
<configuration>
<destFile>${sonar.jacoco.itReportPath}</destFile>
<propertyName>jacoco.agent.it.arg</propertyName>
<append>true</append>
</configuration>
</execution>
</executions>
</plugin>
<plugin> Surefire (UT) </plugin>
<plugin> Failsafe (IT) </plugin>
</plugins>
</build>
This will defined 2 properties, depending on the maven phase:
Phase | ArgLine | Value | |
---|---|---|---|
Unit Tests | process-test-classes | jacoco.agent.ut.arg | -javaagent:${jacoco.lib.path}=destFile=${sonar.jacoco.reportPath},append=true |
Integration Tests | pre-integration-test | jacoco.agent.it.arg | -javaagent:${jacoco.lib.path}=destFile=${sonar.jacoco.itReportPath},append=true |
These properties will be re-use in the corresponding maven plugin.
Surefire (UT tests)
<build>
<plugins>
<plugin> Maven-jacoco </plugin>
<!-- == process UNIT tests == -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>${maven-surefire-plugin.version}</version>
<configuration>
<!-- Do not run if no tests -->
<skipTests>${skipTests}</skipTests>
<!-- a) Surefire must create junit reports where sonar can find it later during analysis -->
<reportsDirectory>${sonar.jacoco.reportPath}</reportsDirectory>
<!-- b) Jacoco specific settings (command auto-generate by Sonar plugin) -->
<argLine>${jacoco.agent.ut.arg}</argLine>
<!-- Exclude integration tests -->
<excludes>
<exclude>**/*IT.java</exclude>
<exclude>**/*IntegrationTest.java</exclude>
<exclude>**/*Gwt.java</exclude>
</excludes>
</configuration>
</plugin>
<plugin> Failsafe (IT) </plugin>
</plugins>
</build>
Notes:
- No tests will be run if
mvn clean install -DskipTests
- Each module has its own surefire-reports + Sonar report
- The exclusion list is something that depends on your own situation
Failsafe configuration (IT tests)
Real life example
You can check out one of my GitHub project:
Even better, you can check out this excellent tutorial:
Appendices
Run tests in specific order
If for some reasons you need to run your tests in a particular order you can say so in the POM:
<build>
<plugins>
<plugin>
SUREFIRE or FAILSAFE
<configuration>
<!-- JVM settings -->
<argLine>-Xmx1024m -XX:maxPermSize:256m</argLine>
<forkCount>1</forkCount>
<reuseForks>true</reuseForks>
<runOrder>alphabetical</runOrder>
<!-- Jacoco execution -->
<argLine>${jacoco.agent.it.arg}</argLine>
...
</configuration>
</plugin>
</plugins>
</build>
The runOrder
is a nice trick.
Warning : if you have to run your tests in a particular order then you should refactor your tests! This trick should not let you escape from that!
References
This article is based on my daily work in VEHCO.
To update to SonarQube I used the following articles and code examples:
- http://www.aheritier.net/maven-failsafe-sonar-and-jacoco-are-in-a-boat/
- VERY good GitHub example, provided by the same author: https://github.com/dgageot/coverage
- http://stackoverflow.com/questions/26253277/jacoco-agent-for-integration-tests-on-remote-machine