onar接入测试结果

项目执行mvn test指令生成的 测试用例文件在标红位置

将生成的测试用例导入到sonar中

执行命令将测试结果上传到sonarqube中

默认

SONARQUBE_TOKEN=22e813fd70f53cac585ced071058a79fa2a91ff6

#执行测试，把默认位置的测试结果上传
mvn clean test sonar:sonar \
  -Dmaven.test.failure.ignore=true \  #忽略测试失败
  -Dsonar.host.url=http://192.168.132.128:9000   \ #sonar 服务器地址
  -Dsonar.login=$SONARQUBE_TOKEN \
  -Dsonar.ws.timeout=300 \   # 超时时间
  -Dsonar.projectKey=litemall-$USER \  
  -Dsonar.projectName=litemall-$USER

使用自定义位置上传测试结果

find . -name "surefire*" ./litemall-db/target/surefire-reports

mvn clean test sonar:sonar   \
  -Dmaven.test.failure.ignore=true \
  -Dsonar.host.url=http://192.168.132.128:9000   \ #sonar 服务器地址
  -Dsonar.login=$SONARQUBE_TOKEN   \
  -Dsonar.ws.timeout=300 \
  -Dmaven.test.skip=false \
  -Dsonar.junit.reportPaths='./litemall-db/target/surefire-reports,./litemall-db/target/surefire-reports'

覆盖率工具

jacoco底层使用asm框架对代码所生成的类文件进行修改，加入统计指令，从而得知代码有没有被覆盖

ASM:所有字节码插桩框架的底层，性能最高，apm框架的核心基础

JavaAssist:简单易用

ByteBuddy、BTrace、 JVM- Sandbox

jacoco mvn插件使用

https://www.jacoco.org/jacoco/trunk/doc/maven.html

jacoco 命令行使用

https://www.jacoco.org/jacoco/trunk/doc/cli.html

手工统计覆盖率

• 对被测应用进行插桩，然后启动on the fly模式javaagent模式可以在内存中动态修改class字节码，不会修改jar包，所以jar包大小不变offline模式，修改jar包中的class文件，文件会变大
• 执行测试行为
• 导出覆盖率统计结果
• 生成报告

agent下载地址 https://repo1.maven.org/maven2/org/jacoco/org.jacoco.agent/0.8.6/ 5
cli工具下载地址 https://repo1.maven.org/maven2/org/jacoco/org.jacoco.cli/0.8.6/ 2

下载jar到本地服务器

#以on the fly模式启动被测应用
java -javaagent:./org.jacoco.agent-0.8.6-runtime.jar -jar apache-jmeter-5.4.1/bin/ApacheJMeter.jar 
#执行后正常结束被测程序会得到覆盖率统计文件，被测应用只要得到执行就可以统计到覆盖率，
可以跟测试用例不在同一个服务器上。
ls jacoco.exec 
#生成无源代码的报告 
java -jar org.jacoco.cli-0.8.6-nodeps.jar report jacoco.exec --classfiles apache-jmeter-5.4.1/bin/ApacheJMeter.jar --html jacoco_html 
#生成有源代码关联的报告
java -jar org.jacoco.cli-0.8.6-nodeps.jar report jacoco.exec --classfiles apache-jmeter-5.4.1/bin/ApacheJMeter.jar --html jacoco_html_src --sourcefiles apache-jmeter-5.4.1_src/apache-jmeter-5.4.1/src/launcher/src/main/java/ 

动态生成覆盖率

mvn clean \ 
org.jacoco:jacoco-maven-plugin:0.8.5:prepare-agent \ 
test \ 
org.jacoco:jacoco-maven-plugin:0.8.5:report \ 
 -Dmaven.test.failure.ignore=true \ 
 -Dmaven.test.skip=false

覆盖率导入sonarqube 默认路径

mvn sonar:sonar \
  -Dsonar.host.url=http://sonarqube.ceshiren.com:9000   \
  -Dsonar.login=$SONARQUBE_TOKEN \
  -Dsonar.ws.timeout=300 \
  -Dsonar.projectKey=litemall-core-$USER \
  -Dsonar.projectName=litemall-core-$USER

生成jacoco的覆盖率报告

上传报告到sonar

### 覆盖率导入sonarqube

默认路径
```
mvn sonar:sonar \
  -Dsonar.host.url=http://sonarqube.ceshiren.com:9000   \
  -Dsonar.login=$SONARQUBE_TOKEN \
  -Dsonar.ws.timeout=300 \
  -Dsonar.projectKey=litemall-core-$USER \
  -Dsonar.projectName=litemall-core-$USER
```

自定义路径
```
SONARQUBE_HOST=http://sonarqube.ceshiren.com:9000 
sonar-scanner \
  -Dsonar.host.url=$SONARQUBE_HOST    \
  -Dsonar.login=$SONARQUBE_TOKEN   \
  -Dsonar.projectKey=litemall_$USER \
  -Dsonar.projectName=litemall_$USER \
  -Dsonar.sources=$(echo **/src | sed 's# #,#g')  \
  -Dsonar.java.binaries="**/target" \
  -Dsonar.junit.reportPaths=$(find . -name "surefire-reports"  | xargs  | sed 's# #,#g') \
  -Dsonar.coverage.jacoco.xmlReportPaths="**/jacoco/jacoco.xml"

pom文件加入jacoco插件

├── bin
│ ├── jsw-license
│ ├── linux-x86-64
│ ├── macosx-universal-64
│ └── windows-x86-64

./sonar.sh start

version: '3.1'
services:
 postgres:
 image: postgres:10
 restart: always
 environment:
 - POSTGRES_USER=itmuch
 - POSTGRES_PASSWORD=itmuch
 - POSTGRES_DB=sonar
 ports:
 - "5432:5432"

#----- PostgreSQL 9.3 or greater
# By default the schema named "public" is used. It can be overridden with the parameter "currentSchema".
#sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube?currentSchema=my_schema

sonar.jdbc.url=jdbc:postgresql://localhost/sonar?currentSchema=public
sonar.jdbc.username=itmuch
sonar.jdbc.password=itmuch

<profile>
 <id>sonar</id>
 <activation>
 <activeByDefault>true</activeByDefault>
 </activation>
 <properties>
 <sonar.jdbc.url>jdbc:postgresql://localhost/sonar?currentSchema=public</sonar.jdbc.url>
 <sonar.jdbc.driver>org.postgresql.Driver</sonar.jdbc.driver>
 <sonar.jdbc.username>itmuch</sonar.jdbc.username>
 <sonar.jdbc.password>itmuch</sonar.jdbc.password>
 <sonar.host.url>http://127.0.0.1:9000</sonar.host.url>
 </properties>
</profile>

mvn sonar:sonar -Dsonar.java.binaries=target/sonar

[INFO] Spring Cloud YES ................................... SUCCESS [ 12.431 s]
[INFO] turbine-stream-server .............................. SKIPPED
[INFO] zuul-server ........................................ SKIPPED
[INFO] hystrix-dashboard .................................. SKIPPED
[INFO] commons ............................................ SKIPPED
[INFO] ms-content-sample-mybatis .......................... SKIPPED
[INFO] ms-consumer-sample ................................. SKIPPED

mvn sonar:sonar \
 -Dsonar.host.url=http://localhost:9000 \
 -Dsonar.login=62b615f477557f98bc60b396c2b4ca2793afbdea \
 -Dsonar.java.binaries=target/sonar

过前面章节我们可以看到,不论怎么构建,单元测试覆盖率一栏总是0%

这是因为单元测试覆盖率报告需要额外集成.这一节我们就讲解如何在sonarqube里集成单元测试覆盖率报告.

这里需要借助Opencover来生成单元测试覆盖报告文档,Opencover前面章节我们介绍过,不了解的朋友可以查看一下前面相关部分的章节.

我在本地有一个包含单元测试项目(大家可以自己建一个包含单元测试的项目,关于单元测试前面章节也有详细讲解,这里不再赘述).进入包含项目sln或者csproj的文件,执行以下命令.

MSBuild.SonarQube.Runner.exe begin /k:"mytest" /n:"mytest" /v:"v1.0" /d:sonar.cs.opencover.reportsPaths="%CD%\testcover.xml"

msbuild.exe

"E:\personalproject\newTest2018\ConsoleApp1\packages\OpenCover.4.6.519\tools\OpenCover.Console.exe" -output:"%CD%\testcover.xml" -register:user -target:"C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\Common7\IDE\CommonExtensions\Microsoft\TestWindow\vstest.console.exe" -targetargs:"%CD%\bin\Debug\NunitTest.dll"

MSBuild.SonarQube.Runner.exe end

Begin 和end是固定格式,这里begin部分多了一个/d选项,/d为dynamic properties 动态属性.通过动态属性指定单元测试报告的位置.%CD%即为当前目录

第二段 msbuild.exe执行构建.
第三段 这里是生成单元测试覆盖率报告的关键. 首先指定Opencover所在位置,-register user 为注册当前windows用户以使其有权限执行.-output 指定覆盖率文件输出位置,这里必须和上面的 sonar.cs.opencover.reportsPaths保持一致. -target为要指定的单元测试runner,这里使用的是visual studio自带的vstest.console.exe targetargs指定要进行单元测试的目标dll.

执行完成以后,我们再打开sonarqube web管理界面就会看到刚刚生成的mytest项目

通过上图我们可以看到mytest项目的单元测试覆盖率为56.7%

我们进入mytest这个项目,然后点击单元测试覆盖率数字下面的链接

点击后进入以下页面:

通过这个界面,我们可以看到每一个类的的单元测试覆盖率和未覆盖的行数.我们点击类名,便可以进入具体的类.

这个图中,蓝杠部分为单元测试覆盖到的代码,红框部分则为未覆盖到的代码.

代码大视窗显示.

对于管理员来说,可能仅仅需要大致浏览一下代码,然后告知具体开发者需要修改.对于开发者来说,可能需要详细查看代码.以上截图只截了主视窗,实际上左侧还有固定的导航栏.这样对于查看代码可能不是很友好,详细查看代码的时候我们可能想在更大的视窗里查看.这时候我们可以点击右上角的"四杠图标"

选择open in new window便可以在新窗口中打开代码.此时整个区域都是代码,无关的内容都没了

以上代码虽然在一个单独的视窗里显示,但是仍然有蓝杠和红杠标识,有些童鞋可能感觉不是很舒服,想要看到清洁代码,此时点击四框图标选择Show raw source即可显示原始代码.

原文地址：https://www.cnblogs.com/tylerzhou/p/11253855.html