【 Sonarqube】可视化Java项目单元测试覆盖率统计框架搭建

一、项目背景:

一个小公司的朋友反应他们那边Java项目单元测试有,但还没有可视化统计覆盖率数据,没法统计就不能直观的看到单测的覆盖率,Java的覆盖率统计框架还是比较成熟,部署起来也不是很难,下面我们逐一讲解怎么部署, 提高单元测试覆盖率和规范代码编写规范

二、方案


工程中引入jacoco进行代码覆盖率统计,通过sonarqube scanner扫描工程编写规范,编写单元测试代码后,结合Jenkins每次的编译部署自动执行代码规范扫描和单元测试代码,并将结果推送到sonarqube平台进行图形展示。


     步骤

            1、选择合适的测试框架:选择一个适合项目的单元测试框架,例如JUnit(Java项目)。

            2、设置测试环境:确保在测试环境中安装和配置所有必需的软件和工具,包括构建工具、依赖项管理器和代码覆盖率工具等。

             3、编写测试代码:编写单元测试代码,测试各个单元功能是否按预期工作。确保覆盖代码的不同路径和边界情况。需要开发配合。

             4、自动化测试:使用持续集成工具Jenkins设置自动化测试流程,以便在每次代码提交或定期基准测试时运行单元测试。

             5、代码覆盖率检查:使用代码覆盖率工具JaCoCo来检测测试代码覆盖的代码范围,以确保测试足够全面。

             6、测试结果:jenkins将结果推送到sonarqube平台进行图形展示。

       选用的工具及框架

               Sonarqube、sonarqube Scanner、Jenkins、jacoco

三、环境配置:

安装JDK11

由于SonarQube和JDK及数据库有对应版本要求,本次平台搭建使用版本如下:

  • SonarQube 8.9.6
  • OpenJDK 11,
  • PostgreSQL 12

1、安装OpenJDK 11:

sudo apt-get install openjdk-11-jdk

2、配置环境变量:
在安装OpenJDK 11后,需要更新环境变量以指向新的JDK版本。vi ~/.bashrc
在文件末尾添加以下行:

export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 
export PATH=$JAVA_HOME/bin:$PATH

2、使配置生效:
在终端中执行以下命令以加载配置的环境变量:source ~/.bashrc

4、验证安装:
运行以下命令来检查是否已正确安装OpenJDK 11并使其生效:java -version

 

修改配置信息

1、/etc/security/limits.conf 配置文件
ulimit -n 是用来设置当前用户的文件描述符限制(file descriptor limit)的命令。该限制用于控制一个进程可以同时打开的文件数。
ulimit -u 是限制用户最大可用进程数。

/etc/security/limits.conf 中增加以下内容:

解释

* soft nofile 65536 * hard nofile 65536 * soft nproc 655350 * hard nproc 655350

2、/etc/sysctl.conf 配置文件
max_map_count 文件包含限制一个进程可以拥有的VMA(虚拟内存区域)的数量;
fs.file-max 设置系统所有进程一共可以打开的文件数量

/etc/sysctl.conf 中增加以下内容:

vm.max_map_count = 524288 
fs.file-max = 9223372036854775807

配置文件生效:sudo sysctl -p

3、查看配置结果

Docker部署框架组件(SonarQube、postgreSQL、pgAdmin4 )

1、新建目录/usr/local/docker/sonarqube_docker

2、该目录下新增docker-compose.yml文件
配置信息如下:

#docker-compose.yml
version: "3"services:sonarqube:image: sonarqube:8.9.6-communityrestart: alwayscontainer_name: sonarqubedepends_on:- dbenvironment:SONAR_JDBC_URL: jdbc:postgresql://db:5432/sonarSONAR_JDBC_USERNAME: sonarSONAR_JDBC_PASSWORD: sonarvolumes:- sonarqube_data:/opt/sonarqube/data- sonarqube_extensions:/opt/sonarqube/extensions- sonarqube_logs:/opt/sonarqube/logsports:- "9000:9000"db:image: postgres:12container_name: postgresqlports:- "5432:5432"environment:POSTGRES_USER: sonarPOSTGRES_PASSWORD: sonarvolumes:- postgresql:/var/lib/postgresql- postgresql_data:/var/lib/postgresql/datapgadmin4:image: dpage/pgadmin4container_name: pgadmin4ports:- "5433:80"environment:- PGADMIN_DEFAULT_EMAIL=test@123.com- PGADMIN_DEFAULT_PASSWORD=123456volumes:sonarqube_data:sonarqube_extensions:sonarqube_logs:postgresql:postgresql_data:

配置信息说明
在这个文件中,我们定义了三个服务:sonarqube、postgresql和pgadmin4。
sonarqube 服务运行代码扫描服务,并将容器端口9000映射到主机端口9000。
postgresql 服务将运行PostgreSQL数据库,并将容器端口5432映射到主机端口5432。
pgadmin4 服务将运行pgAdmin 4可视化工具,并将容器端口80映射到主机端口5433。
postgresql和pgadmin4两个服务都使用postgresql_data卷来共享数据。

3、容器启动命令
启动: sudo docker-compose up -d
重启sonarqube容器: sudo docker restart sonarqube

4、访问
sonarqube:http://宿主机IP:9000/ 用户名/密码:admin/123456
pgAdmin4:http://宿主机IP:5433/ 邮箱:test@123.com 密码:123456

5、配置sonarqube
1)汉化:
配置-->应用市场-->插件,搜索chinese-->安装插件-->重启容器

2)开启SCM:
配置-->SCM-->Disable the SCM Sensor,打开

 

3)得到登录token令牌:
我的账号-->安全-->输入字符串:jenkinsTest-->得到登录token令牌

sonarqube的令牌:
jenkinsTest:e698cc590cc8f7362b30e6b987fd1e835bcb1186

4)创建项目
创建项目:esmc-->得到项目令牌-->得到maven扫描SonarQube的命令
项目令牌:

esmc-test: 9aad77f4ad3f3ecfc23c9178c7305e144991d0f6
maven扫描SonarQube的命令:
mvn clean verify sonar:sonar \-Dsonar.projectKey=esmc-test \-Dsonar.host.url=http://宿主机IP:9000 \-Dsonar.login=9aad77f4ad3f3ecfc23c9178c7305e144991d0f6

 

说明:登录token令牌和项目令牌,在后续配置jenkins的时候会用到,需要提前保存好。

6、配置pgAdmin4数据库
1)登录pgAdmin4,使用docker-compose.yml文件中配置的邮箱和密码。
pgAdmin4:http://宿主机IP:5433/
用户名:test@123.com 密码:123456

2)新增server:
点击Add New Server按钮
--> General填写name:目前改成了PostgreSQL12
--> connection填写宿主机IP、用户名、密码:与docker-compose.yml配置文件中一致
--> 保存

 

 

四、Jenkins集成sonarScanner

说明:如果已经在Docker中安装了SonarQube,一般不需要在服务器上单独安装SonarScanner。
SonarScanner是用于执行SonarQube分析的命令行工具,通常在Jenkins或其他CI/CD工具中集成并使用。
1、jenkins安装sonarQube插件

 

3、Jenkins配置sonarQube
1)添加凭证:
选择 Secret text 类型,输入 SonarQube令牌,然后Secret中填入之前生成的登录Token,ID只要不跟之前重复就行。

2)系统管理:填写sonar的地址,凭证

 

3)全局工具管理:SonarQube servers配置项,增加 SonarQube
 

4)项目流水线配置修改
构建环境勾选:Delete workspace before build starts
构建环境勾选:Prepare SonarQube Scanner environment

Build Steps将目标修改为:

clean verify sonar:sonar -Dsonar.projectKey=esmc-test -Dsonar.host.url=http://宿主机ip:9000 -Dsonar.login=9aad77f4ad3f3ecfc23c9178c7305e144991d0f6 package -Dmaven.test.skip=true

保存后重新构建。

六、扫描结果

 点击SonarQube,跳转到SonarQube平台查看结果:

下图展示扫描发现的bug数量,覆盖率百分比展示,重复率百分比及重复的模块数量 

 

1)结果分析

后端应用esmc,待解决的BUG有32个,其中主要BUG有26个,次要BUG有6;严重漏洞有3个;异味有3.3K。
可靠性比率为D;安全性比率为D;安全审核等级为E;可维护性即SQALE评级为A;覆盖率为0.0%;重复行密度为4.5%;总代码行数为69961;圈复杂度为7126,认知复杂度为4589;违规问题3349,均为开启问题。 

2)结论

Java代码覆盖率工具在软件开发中起到了不可或缺的作用。它们不仅帮助开发者识别耒覆盖的代码、还可以通过生成详细报告提高代码质量和可靠性。通过适当的使用和定期的维护,开发团队可以显著提升代码的测试覆盖率,从而提升软件的稳定性与用户的满意度。希望本文能帮助你理解并有效地利用这些工具,提高开发效率。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/891127.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

PTA数据结构编程题7-1最大子列和问题

我参考的B站up的思路 题目 题目链接 给定K个整数组成的序列{ N 1 ​ , N 2 ​ , …, N K ​ },“连续子列”被定义为{ N i ​ , N i1 ​ , …, N j ​ },其中 1≤i≤j≤K。“最大子列和”则被定义为所有连续子列元素的和中最大者。例如给定序列{ -2, 1…

jangow-01-1.0.1靶机

靶机 ip:192.168.152.155 把靶机的网络模式调成和攻击机kali一样的网络模式,我的kali是NAT模式, 在系统启动时(长按shift键)直到显示以下界面 ,我们选第二个,按回车。 继续选择第二个,这次按 e 进入编辑页面 接下来,…

在Windows上读写Linux磁盘镜像的一种方法

背景 嵌入式开发中,经常会把系统的Linux磁盘镜像保存到Windows上,以便上传到网盘备份或发送给工厂,但是如果想读取/修改镜像中的某个文件,一般有2种方案: 直接访问 就是用虚拟磁盘软件将镜像文件挂载成磁盘&#xf…

apisix的hmac-auth认证

目录 1、apisix的hmac认证Authorization头信息 2、signature的lua生成源码 3、java生成签证的简单示例 4、postman调用如下 apisix的hmac-auth认证,介绍可以看官方文档 hmac-auth | Apache APISIX -- Cloud-Native API Gateway 照着官方文档,发现生…

大数据导论汇总

第一章 作业 2、请阐述把数据变得可用需要经过哪几个步骤. 答:一共要经历三个步骤:数据清洗、数据管理、数据分析。 第一步:数据清洗。使用数据的第一步通常是数据清洗,也就是把数据变成一种可用的状态。这个过程需要借助工具去…

React 组件的通信方式

在 React 应用开发中,组件之间的通信是构建复杂用户界面和交互逻辑的关键。正确地实现组件通信能够让我们的应用更加灵活和易于维护。以下是几种常见的 React组件通信方式。 一、父子组件通信 1. 通过 props 传递数据(父组件向子组件传递数据&#xff0…

【JDBC】转账案例

回顾 使用工具类查询表 需求: 查询student表的所有数据,把数据封装到一个集合中 数据准备 #创建表 CREATE TABLE student( sid INT, name VARCHAR(100), age INT, sex VARCHAR(100) ) #插入数据 INSERT INTO student VALUES(1,张三,18,女),(2…

dede-cms关于shell漏洞

一.文件式管理器 1.新建文件 新建一个php文件,内容写个php脚本语言 访问,可以运行 2.文件上传 上传一个php文件,内容同样写一个php代码 访问,运行成功 二.模块-广告管理 来到模块-广告管理——>增加一个新广告 在这里试一下…

k-Means聚类算法 HNUST【数据分析技术】(2025)

1.理论知识 K-means算法,又称为k均值算法。K-means算法中的k表示的是聚类为k个簇,means代表取每一个聚类中数据值的均值作为该簇的中心,或者称为质心,即用每一个的类的质心对该簇进行描述。K-Means算法接受参数K;然后将…

Opencv之对图片的处理和运算

Opencv实现对图片的处理和修改 目录 Opencv实现对图片的处理和修改灰度图读取灰度图转换灰度图 RBG图单通道图方法一方法二 单通道图显色合并单通道图 图片截取图片打码图片组合缩放格式1格式2 图像运算图像ma[m:n,x:y]b[m1:n1,x1:y1] add加权运算 灰度图 读取灰度图 imread(‘…

【算法思想04】二分查找

文章目录 1. 基本思想与实现1.1 基本思想1.2 值m的计算方式1.3 查找失败时的返回值1.4 代码实现1.4.1 循环1.4.2 递归 2. 性能分析2.1 时间复杂度2.2 与顺序查找的效率比较 3. 应用3.1 前提3.2 变体3.2.1 最基本的二分查找3.2.2 寻找左侧边界的二分查找3.2.3 寻找右侧边界的二分…

【brainpan靶场渗透】

文章目录 一、基础信息 二、信息收集 三、反弹shell 四、提权 一、基础信息 Kali IP:192.168.20.146 靶机 IP:192.168.20.155 二、信息收集 似乎开放了9999,10000端口,访问页面没有太多内容,扫描一下目录 dirs…

matlab reshape permute

1.reshape 将向量按照顺序重新构建 矩阵,新矩阵 先排完第一列, 再第二列… 2.permute 将向量 维度变换

comctl32.dll没有被指定在window运行怎么解决?

一、文件丢失问题:comctl32.dll没有被指定在Windows上运行怎么解决? comctl32.dll是Windows操作系统中的一个重要组件,它负责提供用户界面元素,如按钮、对话框和列表视图等。当系统提示“comctl32.dll没有被指定在Windows上运行”…

Qt下使用AES进行字符串加密解密

文章目录 前言一、获取QAESEncryption库二、加密与解密实现三、示例完整代码四、下载链接总结 前言 引用:AES(Advanced Encryption Standard)是一种对称加密算法,被广泛用于数据加密,提供128、192、256位三种密钥长度&…

docker 安装minio

docker pull minio/minio #启动 mkdir -p /root/minio/config mkdir -p /root/minio/datadocker run -d \--name minio \-p 9002:9000 \-p 9001:9001 \--restartalways \-v /root/minio/data:/data \-v /root/minio/config:/root/.minio \-e "MINIO_ACCESS_KEYminioadmin…

Linux系统下安装配置 Nginx 超详细图文教程

一、下载Nginx安装包 nginx官网:nginx: download[这里是图片001]http://nginx.org/en/download.html 找到我们所需要版本,把鼠标移动到上面,右键打开链接进行下载 或者如果Linux联网,直接在Linux服务上使用wget命令把Nginx安装包…

爬虫与反爬虫实现全流程

我选取的网页爬取的是ppt nba版 需要的工具:pycharm,浏览器 爬虫需要观察它的网页信息,然后开始首先爬取它的html,可以看到有人气,标题,日期,咨询 可以看到用get方法 import requests url"https://img-home.csdnimg.cn/images/20230724024159.png?origin_urlhttps%3A%2…

最新版Edge浏览器加载ActiveX控件技术——alWebPlugin中间件V2.0.28-迎春版发布

allWebPlugin简介 allWebPlugin中间件是一款为用户提供安全、可靠、便捷的浏览器插件服务的中间件产品,致力于将浏览器插件重新应用到所有浏览器。它将现有ActiveX控件直接嵌入浏览器,实现插件加载、界面显示、接口调用、事件回调等。支持Chrome、Firefo…

OSPFv2协议状态切换(状态机)基本原理-RFC2328

个人认为,理解报文就理解了协议。通过报文中的字段可以理解协议在交互过程中相关传递的信息,更加便于理解协议。 自动换行 OSPFv2: 关于 OSPFv2 协议基本原理,可参考RFC2328-OSPF Version 2。 其他相关资料可参考: …