01 Mar 2018

Things On Sonar Test

# below command can use to run in local
# Attention, the command must in order, and exactly the same
mvn clean findbugs:findbugs cobertura:cobertura sonar:sonar -Dsonar.host.url=http://localhost:9000 -Ddeployment.environment=jenkins -DskipTests=false -Dlogback.level=ERROR -fn
# if only want to test single class
mvn clean findbugs:findbugs cobertura:cobertura sonar:sonar -Dsonar.host.url=http://localhost:9000 -Ddeployment.environment=jenkins -DskipTests=false -Dlogback.level=ERROR -fn -Dtest=AAA
# if want to test single method
mvn clean findbugs:findbugs cobertura:cobertura sonar:sonar -Dsonar.host.url=http://localhost:9000 -Ddeployment.environment=jenkins -DskipTests=false -Dlogback.level=ERROR -fn -Dtest=AAA#BBB

mvn clean -> regular MAVEN command

findbugs:findbugs -> findbug plugin help find all kinds of java issue

cobertura:cobertura -> run for coverage (some may use Jacoco, but insight so far only work for Cobertura)

sonar:sonar -> run sonar test

-Dsonar.host.url=http://localhost:9000-> customize the sonarQube, default sonar:sonar will go to http://localhost:9000/

-Ddeployment.environment=jenkins -> used for some customize setting when run in jenkins

-DskipTests=false -> must add this, means don't skip the tests

-Dlogback.level=ERROR -> the parameters dependent on module's logback.xml setting, can change different log level

<properties>
	<sonar.skip>true</sonar.skip>
</properties>

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<start-class>com.xxx.Application</start-class>
	<sonar.exclusions>
		<!-- Excluding domain objects from sonar report -->
		src/main/java/com/xxx/Application.java,
		src/main/java/com/xxx/WebInitializer.java,
		src/main/java/com/xxx/ExceptionControllerAdvice.java,	
	</sonar.exclusions> 
	<tomcat.version>7.0.61</tomcat.version>
	<spring-boot.version>1.1.9.RELEASE</spring-boot.version>
	<slf4j.version>1.7.7</slf4j.version>
</properties>

<plugin>
	<groupId>org.codehaus.mojo</groupId>
	<artifactId>cobertura-maven-plugin</artifactId>
	<version>${cobertura-maven-plugin.version}</version>
	<configuration>
	   <maxmem>1024m</maxmem>
		<formats>
			<format>xml</format>
		</formats>
		<!--if run in multi-level, use the aggregate parameter-->
		<!--aggregate>true</aggregate-->
		  <instrumentation>
			 <excludes>
				<!-- Excluding model package from cobertura code coverage -->
				<exclude>com/xxx/international/model/**/*.class</exclude>
				<!-- Excluding com.xxx from cobertura coverage as these are model objects  -->
				<exclude>com/xxx/calc/**/*.class</exclude>
				<!-- Excluding yyy model objects from cobertura code coverage -->
				<exclude>com/yyy/model/*.class</exclude>
				<exclude>com/yyy/model/**/*.class</exclude>
				<exclude>com/yyydatum/*.class</exclude> 
				<exclude>com/yyy/download/*.class</exclude>
				<exclude>com/yyy/service/*DownloadServiceImpl.class*</exclude>	
			</excludes>
		</instrumentation>
	</configuration>
	<executions>
		<execution>
			<phase>package</phase>
			<goals>
				<goal>cobertura</goal>
			</goals>
		</execution>
	</executions>
</plugin>