SonarQube +Jenkins +JaCoCo 实现Java单元测试，单节点集成覆盖率测试，集群集成覆盖率测试（三）~集成测试篇

最新推荐文章于 2024-07-21 14:22:25 发布
最新推荐文章于 2024-07-21 14:22:25 发布
阅读量3.4k 收藏 8
点赞数 2
分类专栏： SonarQube Jenkins Jacoco 文章标签： java jenkins
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_28226519/article/details/107468574
版权
Jenkins 同时被 3 个专栏收录
6 篇文章 2 订阅
订阅专栏
SonarQube
3 篇文章 2 订阅
订阅专栏
Jacoco
2 篇文章 1 订阅
订阅专栏

写在最前：

本文主要讲解SonarQube实现对Java代码的集成覆盖率扫描，代码质量扫描。
其中，集成覆盖率分为单节点，集群两种模式，文内都有详解。

参考链接：

环境版本和安装

SonarQube单元测试覆盖率详解

流程说明

本篇内容实际为4-7步，1-3步骤配置可以参考Jenkins发布配置
在这里插入图片描述

  1. Jenkins拉取被测项目，编译打包，发送到服务器并启动，此处在应用服务器JVM中添加了JacocoAgent，动态获取覆盖率
  2. Jenkins拉取被测代码和测试代码
    被测代码：扫描java代码，扫描代码质量；扫描class类，和Ant获取到的覆盖代码行进行对比，生成覆盖率文件（能在SonarQube上展示覆盖率和每个代码文件的详细覆盖率）
    测试代码：执行测试类，通过Ant获取覆盖率文件
  3. Ant
    获取覆盖率文件，整合覆盖率文件（集群模式），生成xml报告（新版本SonarQube推荐扫描xml报告生成页面展示内容而不是直接获取到的原始覆盖率文件）
  4. SonarScanner
    扫描被测项目，获取代码质量报告
    扫描Ant覆盖率报告：获取详细覆盖率结果，和扫描class类结合使用
    扫描class文件，生成SonarQube覆盖率索引（如果不扫描只能看到一个覆盖率，扫描之后能看详细每个文件，每行覆盖了多少）

应用服务器配置

1. 安装Jacoco
在被测应用服务器上需要安装JaCoCo，参考环境版本和安装，直接将整个jacoco文件夹复制到应用服务器即可
2. 修改应用启动参数
项目启动jvm 参数中添加：注：下面参数必须添加在jvm参数最前面，否则可能不生效
-javaagent:jacocoagent.jar=includes=*,output=tcpserver,address=项目服务器本机ip,port=自定义端口,append=false

并且pom中不能配置跳过test，否则单元测试类不执行
在这里插入图片描述

分布式单节点环境覆盖率扫描配置

1. 被测项目（需要扫描的项目）配置
pom.xml 同级目录下添加sonar-project.properties文件， 内容如下：

#sonarqube key
sonar.projectKey=ncba_interface_account
#sonarqube ui job name
sonar.projectName=ncba_interface_account
#sonarqube job version
sonar.projectVersion=1.0.0
#more than one branch , set branch name
#sonar.branch.name=account-develop
#code language
sonar.language=java
#exclusion code file
#**/entity/**,*/*BO.java,
sonar.exclusions=**/service/detailedness/**,**/service/accounting/**,**/service/account/**,**/action/wallettransaction/**,**/action/saaquery/**
#more than one moudle,set this
#模块名，多个模块就配置多个，如果就一个可以省略
sonar.modules=account-api,account-web
#↓↓↓这个是目录名，对应↑↑↑↑↑，这里是模块↓↓↓↓↓↓↓代码路径
account-api.sonar.projectBaseDir=account-api
account-web.sonar.projectBaseDir=account-web
#code file path
sonar.sources=src/main/java
sonar.tests=src/test/java
sonar.sourceEncoding=UTF-8
sonar.java.binaries=target/classes
#SonarQube username and password
sonar.login=user
sonar.password=password
#jacoco config
sonar.java.coveragePlugin=jacoco
#report file path
#这个路径是覆盖率文件生成覆盖率报告的位置，这个位置是用于本配置文件去读取的
sonar.coverage.jacoco.xmlReportPaths=/home/jenkins/interface_test/account/report.xml

git路径演示：
在这里插入图片描述
2. 测试项目配置

测试项目需要添加build.xml，是一个ant build文件，负责获取到远程覆盖率，并且在本地生成覆盖率文件，导出覆盖率报告，供上面配置的sonarqube读取。

build.xml 内容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<project name="testCodeCoverage" xmlns:jacoco="antlib:org.jacoco.ant" default="run" ><!--默认执行run方法-->

    <property name="result.exec.file" location="/home/jenkins/interface_test/account/jacocoremote_account.exec"/><!--存放覆盖率文件的位置-->
    <property name="reportfolderPath" value="/home/jenkins/interface_test/account"/> <!--生成覆盖率报告的路径-->
    <property name="result.jar.file" location="/home/jenkins/jacoco/lib/jacocoant.jar"/><!--指定的jacocoant.jar所在位置-->
    <property name="result.exec.ip" value="192.168.0.1"/><!--部署被测项目的服务器ip-->
    <property name="result.exec.port" value="40007"/><!--部署被测服务器开发的jacoco端口,ip和端口对应应用jvm启动参数的jacoco ip和端口-->
    <!--此处取的jenkins workspace总路径，多余文件在下面排除-->
    <property name="Model1JavaPath" value="/var/lib/jenkins/workspace/interface_test/account"/>  <!--java代码-->
    <property name="Model1ClassPath" value="/var/lib/jenkins/workspace/interface_test/account"/>  <!--class代码-->

    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
        <classpath path="${jacoco.jar.file}"/>
    </taskdef>

    <target name="run"><!--设置总体调度器-->
        <echo message="start..."/>
        <echo message="dump..."/>
        <antcall target="dump"/>
        <echo message="report..."/>
        <antcall target="report"/>
    </target>
    <!--生成覆盖率二进制文件-->
    <target name="dump">
     <!--删除历史报告-->
        <delete dir="${reportfolderPath}" />
        <mkdir dir="${reportfolderPath}" />
        <jacoco:dump address="${result.exec.ip}" reset="false" destfile="${result.exec.file}" port="${result.exec.port}" append="flase"/>
    </target>
    <!--生成报告-->
    <target name="report">
        <jacoco:report>
            <executiondata>
                <!--jacoco.exec二进制文件位置-->
                <file file="${result.exec.file}"/>
            </executiondata>
            <structure name="JaCoCo Report">
                <!--api-->
              <!--  <group name="account-api">
                    <sourcefiles encoding="UTF-8">
                        <fileset dir="${Model1ClassPath}/account-api/src/main/java">
                            <exclude name="*/*BO.java"/>
                            <exclude name="**/model/**"/>
                            <exclude name="**/Application.java"/>
                            <exclude name="**/entity/**"/>
                            <exclude name="**/dal/**"/>
                            <exclude name="**/common/**"/>
                            <exclude name="**/test_project/**"/>
                        </fileset>

                    </sourcefiles>
                    <classfiles>
                        <fileset dir="${Model1JavaPath}/account-api/target/classes"/>
                    </classfiles>
                </group>-->
                <!--web-->
                <group name="account-web">
                    <sourcefiles encoding="UTF-8">
                        <fileset dir="${Model1JavaPath}/account-web/src/main/java">
                            <exclude name="*/*BO.java"/>
                            <exclude name="**/model/**"/>
                            <exclude name="**/Application.java"/>
                            <exclude name="**/entity/**"/>
                            <exclude name="**/dal/**"/>
                            <exclude name="**/common/**"/>
                            <exclude name="**/test_project/**"/>
                        </fileset>

                    </sourcefiles>
                    <classfiles>
                        <fileset dir="${Model1ClassPath}/WEB-INF/classes"/>
                    </classfiles>
                </group>
            </structure>
            <!--生成报告格式，html,csv,xml-->
            <html destdir="${reportfolderPath}" encoding="utf-8"/>
            <csv destfile="${reportfolderPath}/report.csv"/>
            <xml destfile="${reportfolderPath}/report.xml"/>
        </jacoco:report>
    </target>
</project>

3. Jenkins 配置
关键配置 ：
在这里插入图片描述
在这里插入图片描述
上面几步基本都是固定写法，不用动
在这里插入图片描述
重点说明：

说明1. 我将覆盖率文件存在了/home/jenkins 目录下，jenkins workspace 只支持相对路径，娶不到 覆盖率文件，所以软连接过来

说明2. 将打好的war包移动到workspace根下并解压，该操作为必须，多次测试发现，如果不用mvn package打包，只用mvn compline ，实际上在jacoco 上，他会认为 编译方式所生成的classes文件的classID不相同，认为是不同的class文件，简单来说，就是覆盖率结果为0（部分情况可能不为0，因为有mvn私服模块是提前打包，可能打包方式相同，不理解的忽略这段话）

说明3. 此处是用于自动导出美化后的测试结果文件，暂时忽略

其他说明. 如果项目有单测，集群集成测试，单节点集成测试
sonar扫描配置文件起名请不要用sonar-project.properties
因为jenkins如果有叫sonar-project.properties的文件，直接就使用这个文件，即便配置了其他文件名也不好使

效果图：图中显示错误是 代码问题，忽略在这里插入图片描述

分布式集群环境下覆盖率扫描配置

和单节点相比，不同的点就是涉及到服务分发，那么覆盖率分散的问题，我们需要做的就是覆盖率整合。

应用服务器配置

配置和上面无变化

sonar-project.properties文件配置

只改了下覆盖率文件路径

#sonarqube key
sonar.projectKey=ncba_interface_account
#sonarqube ui job name
sonar.projectName=ncba_interface_account
#sonarqube job version
sonar.projectVersion=1.0.0
#more than one branch , set branch name
#sonar.branch.name=account-develop
#code language
sonar.language=java
#exclusion code file
#**/entity/**,*/*BO.java,
sonar.exclusions=**/service/detailedness/**,**/service/accounting/**,**/service/account/**,**/action/wallettransaction/**,**/action/saaquery/**
#more than one moudle,set this
sonar.modules=account-api,account-web
account-api.sonar.projectBaseDir=account-api
account-web.sonar.projectBaseDir=account-web
#code file path
sonar.sources=src/main/java
sonar.tests=src/test/java
sonar.sourceEncoding=UTF-8
sonar.java.binaries=target/classes
#SonarQube username and password
sonar.login=user
sonar.password=password
#jacoco config
sonar.java.coveragePlugin=jacoco
#report file path
sonar.coverage.jacoco.xmlReportPaths=/home/jenkins/interface_test/app/acm/report.xml

build.xml 文件配置

以三节点为例

<?xml version="1.0" encoding="UTF-8" ?>
<project name="testCodeCoverage" xmlns:jacoco="antlib:org.jacoco.ant" default="run" ><!--默认执行run方法-->
    <property name="result.exec.file.dir" location="/home/jenkins/interface_test/account/"/><!--存放临时覆盖率文件的位置-->
    <property name="result.exec.file1" location="/home/jenkins/interface_test/account/jacocoremote_account.exec1"/><!--存放临时覆盖率文件的位置-->
    <property name="result.exec.file2" location="/home/jenkins/interface_test/account/jacocoremote_account.exec2"/><!--存放临时覆盖率文件的位置-->
    <property name="result.exec.file3" location="/home/jenkins/interface_test/account/jacocoremote_account.exec3"/><!--存放临时覆盖率文件的位置-->
    <property name="result.exec.file" location="jacocoremote_account.exec"/><!--存放最终覆盖率文件的位置-->
    <property name="reportfolderPath" value="/home/jenkins/interface_test/app/acm"/> <!--生成覆盖率报告的路径-->
    <property name="result.jar.file" location="/home/jenkins/jacoco/lib/jacocoant.jar"/><!--指定的jacocoant.jar所在位置-->
    <property name="result.exec.ip1" value="192.168.1.1"/><!--部署被测项目的服务器ip-->
    <property name="result.exec.ip2" value="192.168.1.2"/><!--部署被测项目的服务器ip-->
    <property name="result.exec.ip3" value="192.168.1.3"/><!--部署被测项目的服务器ip-->
    <property name="result.exec.port" value="40007"/><!--部署被测服务器开发的jacoco端口-->
    <!--此处取的jenkinsworkspace总路径，多余文件在下面排除-->
    <property name="Model1JavaPath" value="/var/lib/jenkins/workspace/interface_test/account"/>  <!--模块1java代码-->
    <property name="Model1ClassPath" value="/var/lib/jenkins/workspace/interface_test/account"/>  <!--模块1class代码-->

    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
        <classpath path="${jacoco.jar.file}"/>
    </taskdef>

    <target name="run"><!--设置总体调度器-->
        <echo message="start..."/>
        <echo message="dump1..."/>
        <antcall target="dump1"/>
        <echo message="dump2..."/>
        <antcall target="dump2"/>
        <echo message="dump3..."/>
        <antcall target="dump3"/>
        <echo message="merge..."/>
        <antcall target="merge"/>
        <echo message="report..."/>
        <antcall target="report"/>
    </target>
    <!--生成覆盖率二进制文件-->
    <target name="dump1">
        <delete dir="${reportfolderPath}" />
        <mkdir dir="${reportfolderPath}" />
        <jacoco:dump address="${result.exec.ip1}" reset="false" destfile="${result.exec.file1}" port="${result.exec.port}" append="flase"/>
    </target>
    <target name="dump2">
        <jacoco:dump address="${result.exec.ip2}" reset="false" destfile="${result.exec.file2}" port="${result.exec.port}" append="flase"/>
    </target>
    <target name="dump3">

        <jacoco:dump address="${result.exec.ip3}" reset="false" destfile="${result.exec.file3}" port="${result.exec.port}" append="flase"/>
    </target>
    <!--合并覆盖率文件-->
    <target name="merge">
        <jacoco:merge destfile="${result.exec.file}">
            <fileset dir="${result.exec.file.dir}" includes="**/*.exec*"/>
        </jacoco:merge>
    </target>
    <!--生成报告-->
    <target name="report">
        <!--删除历史报告-->

        <jacoco:report>
            <executiondata>
                <!--jacoco.exec二进制文件位置-->
                <file file="${result.exec.file}"/>
            </executiondata>
            <structure name="JaCoCo Report">
                <!--web-->
                <group name="account-web">
                    <sourcefiles encoding="UTF-8">
                        <fileset dir="${Model1JavaPath}/account-web/src/main/java">
                            <exclude name="*/*BO.java"/>
                            <exclude name="**/model/**"/>
                            <exclude name="**/Application.java"/>
                            <exclude name="**/entity/**"/>
                            <exclude name="**/dal/**"/>
                            <exclude name="**/common/**"/>
                            <exclude name="**/test_project/**"/>
                        </fileset>

                    </sourcefiles>
                    <classfiles>
                        <fileset dir="${Model1ClassPath}/WEB-INF/classes"/>
                    </classfiles>
                </group>
            </structure>
            <!--生成报告格式，html,csv,xml-->
            <html destdir="${reportfolderPath}" encoding="utf-8"/>
            <csv destfile="${reportfolderPath}/report.csv"/>
            <xml destfile="${reportfolderPath}/report.xml"/>
        </jacoco:report>
    </target>
</project>

jenkins配置

只需要更改这一步，其他完全不变

在这里插入图片描述

OK，大功告成！

大黄是只猫
关注
  • 2
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【异常】写了很多单元测试用例，但是SonarQube上显示的单元测试覆盖率依旧为 0.0%，原来是maven-surefire-plugin插件没有配置！
本本本添哥
04-08 1826
写了很多单元测试用例，但是Sonar上显示的单元测试覆盖率依旧为 0.0%
K8s+Jenkins+GitLab+Harbor+CICD+SonarQube持续集成、持续部署实战
作者的博客园已搬家到CSDN，访问博客园主页将默认跳转至CSDN
05-20 1265
通过`Jenkins`新建项目，以`pipelin`的方式从`GitLab`拉取代码，通过`Maven`编译代码、`docker`构建镜像并推送到`Harbor`仓库，最后以`docker`方式用`docker`命令部署到服务器。 ### Pipeline部署到K8s 通过`Jenkins`新建项目，以`pipelin`的方式从`GitLab`拉取代码，通过`Maven`编译代码、`docker`构建镜像并推送到`Harbor`仓库，最后以`k8s`的`yaml`配置清单方式，用`kubectl`命令部
单元测试覆盖率（Jenkins+sonarqube）
热门推荐
我有一只小傲娇
07-21 3万+
越来越懒得写总结了   好多都是几句话搞定orz... 搭建了Jenkins+sonar的环境（很久之前搭得了  靠回忆写吧）  Jenkins的搭建就不再赘述。 sonar负责检测代码质量与查看代码覆盖率。这个工具先搭建起来可以正常使用， 但页面上各个功能都是做什么的还没有研究。 sonar有sonarqube和sonarscanner（旧称sonar-runner
深入解析SonarQube中的代码覆盖率：原理、设置与最佳实践
最新发布
m0_59657800的博客
07-21 974
经过充分测试且代码覆盖率高的代码库可以增强开发人员的信心，并减少对在生产中引入新错误的担忧。代码覆盖率（也称为测试覆盖率）用于衡量自动化测试在代码库中所占的百分比。它突出显示了代码库的哪些部分已被测试覆盖，哪些部分未被覆盖，哪些部分被部分覆盖，从而为需要更好测试覆盖的潜在领域提供见解。相反，它是一个中心枢纽，用于从流行的代码覆盖率工具读取报告，并将这些结果与静态代码分析结果一起作为代码的通过/未通过指标呈现出来。更高的代码覆盖率表明更多的代码路径得到了测试的检验，从而在开发生命周期的早期识别并修复bug。
Sonarqube-8.9版本测试单元测试覆盖率
鬼刺
09-30 2431
sonarqube单元测试覆盖率
单元测试代码覆盖率浅谈
11-30
单元测试代码覆盖率浅谈，供大家参考学习
pytest执行测试前置和后置环境信息处理
qq_35653145的博客
10-03 823
测试框架结构 ├─config ----配置文件目录 ├─report ----测试报告目录 │ ├─allure ----allure测试报告 │ │ ├─allure_report │ │ ├─assets │ │ └─tmp │ └─htmlcov ----覆盖率测试报告 ├─run_interface_test ----接口测试运行入口 ├─service ----封装业务操作 │ ├─api │ │ ├─Business │
sonar分析工程并统计单元测试
n8765的专栏
10-26 4733
一)sonar是什么 Sonar 是一个开源的质量管理平台，专注于从项目组合到类方法的持续的分析和测量技术质量，它把代码质量相关软件集成到一起统一管理。可以使用开源的插件来扩展Sonar，查看扩展可以访问 open source plugins forge。以下是sonar环境及相关技术的一个关联图：   二）安装与使用 windows下安装
JaCoCo集成SonarQube和Jenkins检查代码测试覆盖率
锐意工作室
07-24 5594
文章目录JaCoCo集成SonarQube和Jenkins检查测试覆盖率参考文档引入Jacoco插件集成JaCoCo和SonarQube集成JaCoCo和Jenkins JaCoCo集成SonarQube和Jenkins检查测试覆盖率 参考文档 https://www.eclemma.org/jacoco/trunk/index.html https://www.mkyong.com/ma...
Jacoco在K8S集群项目中部署小妙招
OneOS是中国移动针对物联网领域推出的轻量级操作系统
05-24 3268
本文主要讲解了代码覆盖工具Jacoco在K8S集群项目中的部署小妙招。从对Jacoco的简介入手，介绍了Jacoco在K8S项目应用中常出现的问题及其解决方式，最后给出了部署配置的详细步骤，能够帮助开发者快速应用。单元测试、功能测试、压力测试
软件测试10-软件测试工程师需要掌握的非测试知识有哪些？
qq_53280238的博客
06-28 951
为了应对技术发展趋势，做好软件产品的测试工作，软件测试工程师需要掌握非常多的非测试专业知识，包括：网站架构、容器技术、云计算技术、DevOps 思维，以及前端开发技术的核心知识以及实践。对于这类新技术的学习，我强烈推荐你直接阅读官方网站的文档以及代码示例。这种方式，可以让你少走弯路，同时保证所学内容是最新的。当然，我跟你分享的这些非测试专业知识，只是众多技术的冰山一角，你在实际的测试工作中也会遇到更多的技术，希望你可以举一反三，不断扩充自己的知识面，向着一个优秀测试工程师、架构师努力！
jacoco-sonarqube-maven覆盖率统计参考项目
10-29
一个解决maven项目使用了jacoco插件,在sonarqube平台下,覆盖率总是显示为0的参考项目
Jenkins持续集成与自动化测试实践
# 第一章：理解持续集成和自动化测试 ## 1.1 什么是持续集成？ 持续集成是一种软件开发实践，旨在通过持续自动化的构建和测试过程，尽早地、频繁地集成新代码，从而能够快速、高效地...自动化测试包括单元测试、集成
Python 接口并发测试详解
悦分享
10-23 6904
性能测试是通过自动化测试工具模拟多种正常、峰值及异常负载条件对系统的各项性能指标进行的测试。负载测试和压力测试都属于性能测试，两者可以结合进行。通过负载测试，确定在各种工作负载下系统的性能，目标是测试当负载逐渐增加时，系统各项性能指标的变化情况。压力测试是通过确定一个系统的瓶颈或者不能接受的性能点，来获得系统能提供的最大服务级别的测试。性能测试的重点是测试在并发条件下服务或系统的瓶颈所在，从而优化相关功能，可能涉及软件及硬件的多方面改进。由此可见，性能测试对整个产品非常重要，甚至可以决定一个产品是否能长久发
maven+jacoco+sonarqube显示单元测试覆盖率
云原生，DevOps，Kubernetes
08-10 1519
首先pom.xml中需要引入jacoco依赖 <build> <plugins> <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.7.8</version>
代码质量管理平台SonarQube安装、配置及集成Jacoco方案
justyman的博客
02-26 5783
目录 1、SonarQube简介 1.1 介绍 1.2 使用范围 1.3 工作原理 1.4 扩展性 2、SonarQube安装、配置 2.1 前置条件 2.2 配置工作 3、Sonar Scanner安装、配置 3.1 配置工作 3.2 运行 4、Jacoco、maven与SonarQube的集成 4.1 前置条件 4.2 配置工作 4.3 运行 5、结束语 1、...
sonar-单元测试
aece82688的博客
09-10 1156
单元测试 　　大学以及实习期间，就是web方向的，也没搞过什么单元测试次，这是工作以来第一次搞这玩意儿。 　　我是用junit4来做单元测试的，目前测试的内容全是service层的代码，被测试的方法也是差不多局限于queryInfo和getCount方法，方法名也能说明方法的作用了，对于增删改的方法测试，由于框架问题还没实现。 　　说到框架，插一句，针对action层做单元测试有难...
SonarQube +Jenkins +JaCoCo 实现Java单元测试，单节点集成覆盖率测试，集群集成覆盖率测试（一）~ 安装篇
DevOps之路
07-19 1272
SonarQube简介 SonarQube 是一个用于代码质量管理的开源平台，用于管理源代码的质量。 通过插件形式，可以支持包括 java, C#, C/C++, PL/SQL, Cobol, JavaScrip, Groovy 等等二十几种编程语言的代码质量管理与检测，SonarQube用于提高代码质量，了解自己在编码过程中犯过的错误，让自己的代码更具有可读性和维护性，并且大公司代码交付时都有覆盖率要求。 版本环境 环境 版本 Jenkins jenkins 2.19.e RedHat
jenkins 集成单元测试
qq_31564573的博客
12-27 4776
jenkins pipline集成java单元测试
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值