java sonar maven svn_Maven结合SonarQube的使用笔记

前提： 1，SonarQube已经安装好且已经安装了sonar-php-plugin，并且在测试服务器上也安装并配置好了sonar-scanner 2，安装了Maven 这个非常简单，直接从官网上下载Maven的zip包，解开然后配置下面这个配置文件即可

export MAVEN_HOME=/usr/local/maven333

export PATH=$MAVEN_HOME/bin:$PATH

一，Maven简单项目

配置pom.xml，使之产生Junit单元测试报告

org.apache.maven.plugins

maven-surefire-plugin

2.19.1

false

默认就是产生在target目录下面的surefire-reports目录里，所以不需要配置reportsDirectory。

配置pom.xml ,使之产生代码测试覆盖率报告，在这里使用Jacoco工具来产生。

org.jacoco

jacoco-maven-plugin

0.7.2.201409121644

default-prepare-agent

prepare-agent

default-report

prepare-package

report

default-check

check

BUNDLE

COMPLEXITY

COVEREDRATIO

0.60

默认就产生在target目录下，覆盖率报告文件名为jacoco.exec

在项目的根目录下创建一个配置文件sonar-project.properties

sonar.projectKey=org.sonarqube:parent

sonar.projectName=Java :: JaCoco Multi Modules :: Parent

sonar.projectVersion=1.0-SNAPSHOT

sonar.sources=src/main/java

sonar.tests=src/test/java

sonar.binaries=target/classes

sonar.language=java

#Tells SonarQube where the unit tests execution reports are

sonar.junit.reportsPath=target/surefire-reports

#Tells SonarQube where the integration tests code coverage report is

#sonar.jacoco.itReportPath=target/jacoco-it.exec

sonar.jacoco.reportPath=target/jacoco.exec

# Encoding of the source files

sonar.sourceEncoding=UTF-8

注意，一定要配置这个sonar.binaries，否则会报: INFO: No JaCoCo analysis of project coverage can be done since there is no class files.

另外，配置sonar.jacoco.itReportPath或sonar.jacoco.reportPath视产生的覆盖率报告文件而定

二，Maven多模块项目

配置pom.xml，使之产生Junit单元测试报告，同“Maven简单项目 ”的配置方法。

配置pom.xml ,使之产生代码测试覆盖率报告 ，同“Maven简单项目 ”的配置方法。

在项目的根目录下创建一个配置文件sonar-project.properties

sonar.projectKey=com.dangdang:elastic-job

sonar.projectName=elastic-job

sonar.projectVersion=1.1.0

# Set modules IDs

sonar.modules=elastic-job-api-core,elastic-job-console,elastic-job-core,elastic-job-spring

# Modules inherit properties set at parent level

sonar.sources=src/main/java

sonar.tests=src/test/java

sonar.java.binaries=target/classes

sonar.language=java

#Tells SonarQube where the unit tests execution reports are

sonar.junit.reportsPath=target/surefire-reports

#Tells SonarQube where the integration tests code coverage report is

sonar.jacoco.reportPath=target/jacoco.exec

# Encoding of the source files

sonar.sourceEncoding=UTF-8

elastic-job-api-core.sonar.projectBaseDir=elastic-job-api/elastic-job-api-core

这里，需要注意的就是配置sonar.modules，这样下面的sonar.sources,sonar.tests等配置项就是指各个模块下面的相对目录。

指定代码的目录的目的是为了把代码文件上传到Sonar服务器上。

模块必须是非父模块，也就是不再包含子模块了，只有这样，统计代码质量才有意义。

在这里，elastic-job-api-core这个子项目的目录不是在当前目录下面，而是又深入了一级目录，就可以使用elastic-job-api-core.sonar.projectBaseDir来指定这个完整的相对路径。

三，测试步骤都一样：

1，在顶级目录下执行

mvn clean test

这时候就会在顶级目录下得到一个文件夹reports，里面有两个测试报文文件，分别是测试报告和测试覆盖率报告

2，在顶级目录下执行以下命令，就会将两个测试报告文件和src和tests目录下的文件都提交给SonarQube服务器(前提是Sonar已经都配置好了) (D:\sonar-scanner-2.6.1\bin\sonar-scanner.bat这个路径或者在linux就放入PATH环境变量中)

sonar-scanner