1.源代码审计工具之:SonarQube
2.SonarQube8.3中的配配置Maven项目的测试覆盖率报告
3.SonarQube+jenkins+maven平台搭建
4.Sonarqube代码质量管理工具搭建
源代码审计工具之:SonarQube
SonarQube是一个开源的代码分析平台,用于持续分析和评估项目源代码的置源质量。它能检测出项目中的规则重复代码、潜在bug、配配置代码规范和安全性漏洞等问题,置源并通过web UI展示结果。规则天眼系统指标公式源码
1. Sonar简介
1.1 SonarQube是配配置什么?
1. 代码质量和安全扫描和分析平台。
2. 多维度分析代码:代码量、置源安全隐患、规则编写规范隐患、配配置重复度、置源复杂度、规则代码增量、配配置测试覆盖率等。置源
3. 支持+编程语言的规则代码扫描和分析,包括Java、Python、C#、JavaScript、Go、C++等。缠论箱体主图源码
4. 涵盖了编程语言的静态扫描规则:代码编写规范和安全规范。
5. 能够与代码编辑器、CI/CD平台完美集成。
6. 能够与SCM集成,可以直接在平台上看到代码问题是由哪位开发人员提交。
7. 帮助程序猿写出更干净、更安全的代码。
静态扫描主要针对开发人员编写的源代码。
通过定义好的代码质量和安全规则,对开发人员编写的代码进行扫描和分析。
将分析的结果多维护的呈现出来,以方便开发人员进行代码的优化和规范编写。
1.2 SonarQube的各个功能:
1.2.1 代码可靠性
1. BUG检测
2. 设置需要的代码标准
3. 代码异味
4. 代码安全性
5. 对于开发的各个路径进行检测
1.2.2 软件安全性
1. Security Hotspots: 代码存在安全问题的部分
2. Vulnerabilities: 代码是否存在漏洞
1.3 SonarQube如何工作?
Sonar静态代码扫描由两部分组成:SonarQube平台和sonar-scanner扫描器。
SonarQube: web界面管理平台。
1)展示所有的项目代码的质量数据。
2)配置质量规则、管理项目、配置通知、配置SCM等。
SonarScanner: 代码扫描工具。按键精灵apk源码提取
专门用来扫描和分析项目代码。支持+语言。
代码扫描和分析完成之后,会将扫描结果存储到数据库当中,在SonarQube平台可以看到扫描数据。
SonarQube和sonarScanner之间的关系:
2 检测
Sonar是一个用于代码质量管理的开源平台,用于管理源代码的质量,可以从七个维度检测代码质量。通过插件形式,可以支持包括Java、C#、C/C++、PL/SQL、Cobol、JavaScript、Groovy等等二十几种编程语言的代码质量管理与检测。
2.1 Rules提示
2.1.1 Rule界面
2.1.2 Rule正确实例提示
2.2 糟糕的复杂度分布
文件、类、方法等,如果复杂度过高将难以改变,仿微商截图器源码这会使得开发人员难以理解它们,且如果没有自动化的单元测试,对于程序中的任何组件的改变都将可能导致需要全面的回归测试。
2.3 重复
显然程序中包含大量复制粘贴的代码是质量低下的,Sonar可以展示源码中重复严重的地方。
2.4 缺乏单元测试
Sonar可以很方便地统计并展示单元测试覆盖率。
2.5 没有代码标准
Sonar可以通过PMD、CheckStyle、Findbugs等等代码规则检测工具规范代码编写。
2.6 没有足够的或者过多的注释
没有注释将使代码可读性变差,特别是当不可避免地出现人员变动时,程序的可读性将大幅下降,而过多的注释又会使得开发人员将精力过多地花费在阅读注释上,亦违背初衷。
2.7 潜在的bug
Sonar可以通过PMD、CheckStyle、Findbugs等等代码规则检测工具检测出潜在的bug。
2.8 糟糕的设计(原文Spaghetti Design,意大利面式设计)
通过Sonar可以找出循环,展示包与包、本地服务预约上门源码类与类之间的相互依赖关系,可以检测自定义的架构规则;通过Sonar可以管理第三方的jar包,可以利用LCOM4检测单个任务规则的应用情况,检测耦合。
3. Sonar组成
4. Sonar集成过程
开发人员在他们的IDE中使用SonarLint运行分析本地代码。
开发人员将他们的代码提交到代码管理平台中(SVN、GIT等),
持续集成工具自动触发构建,调用SonarScanner对项目代码进行扫描分析,
分析报告发送到SonarQube Server中进行加工,
SonarQube Server加工并且保存分析报告到SonarQube Database中,通过UI显示分析报告。
SonarQube8.3中的Maven项目的测试覆盖率报告
从SonarQube 6.2版本开始,测试报告整合为一份全面的报告,因此在Maven项目中,如果单元测试(由Maven Surefire插件执行)与集成测试(由Maven Failsafe插件执行)分开进行,如何配置JaCoCo Maven插件以生成涵盖这两种测试类型的报告?本文将指导你如何配置Maven项目结构、测试运行、测试报告生成以及在SonarQube中可视化测试报告。
首先,查看Maven项目的默认结构,通常包含生产源代码目录(src/main/java)和测试源代码目录(src/test/java)。为了将单元测试和集成测试分开,可添加一个名为src/it/java的新目录,并分别将它们放置于src/test/java和src/it/java中。
对于单元测试运行,Maven默认配置已包含在构建生命周期的测试阶段中。集成测试运行需手动完成,可通过Maven插件实现。确保在POM文件中配置BuildHelperMaven插件以将src/it/java目录添加到测试类路径中。同时,设置Maven安全插件的目标集成测试,自动绑定到集成测试阶段,以防集成测试失败导致构建取消。
使用JaCoCo Maven插件生成测试报告,它能为单元测试和集成测试生成合并报告。为此,需要配置两个代理并在测试运行期间生成报告。在POM文件中添加JaCoCo的目标prepare-agent和prepare-agent-integration,同时确保创建报告以供SonarQube读取。添加目标报告和报告集成到POM中,以便SonarQube识别报告位置。
在完成构建后,运行SonarMaven3插件(命令mvn sonar:sonar),告知Sonar Maven插件报告位置。在SonarQube仪表板中打开项目时,可查看总体测试覆盖率报告。
本文旨在为Maven项目在SonarQube中生成并可视化测试覆盖率报告提供详细指导,包括项目结构调整、测试运行配置、报告生成及SonarQube中报告的可视化。
SonarQube+jenkins+maven平台搭建
本文主要介绍如何在SonarQube、Jenkins和Maven的组合中搭建平台,以进行代码质量管理。
首先,需要配置JDK和Maven。在Jenkins的全局工具配置中,查找并添加JDK安装路径,例如/usr/local/java/jdk1.8.0./bin/java。然后,在Maven安装路径中添加类似/var/tmp/maven/apache-maven-3.5.4/bin/mvn的指令。
接着,进行SonarQube的环境配置。在系统管理中找到并安装SonarQube servers插件,再安装Jacoco插件。配置SonarQube服务器时,注意选择Secret text类型,将Secret和ID填写为Sonar首次登录时提供的token。
然后,在Jenkins中创建一个新的job,输入项目名称,并选择构建一个自由风格的软件项目。在丢弃旧的构建设置中,设置节点、源码管理、构建前删除workspace,并勾选“准备SonarQube Scanner环境”。
在Maven构建过程中,执行如下命令:mvn org.jacoco:jacoco-maven-plugin:prepare-agent clean install -Dmaven.test.skip=true $SONAR_MAVEN_GOAL -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$SONAR_AUTH_TOKEN。此命令用于设置SonarQube参数,如项目键、名称、版本、语言、编码以及源代码和二进制文件路径。
最后,可以查看报告以评估代码质量。报告参考文档可在此处获取:docs.sonarqube.org/disp...
Sonarqube代码质量管理工具搭建
SonarQube是一款专注于持续分析和评估项目源代码质量的平台,它具备代码质量检查、安全漏洞扫描以及代码规范验证等功能,旨在辅助开发者编写更加清晰和安全的高质量代码。
以下是关于SonarQube搭建和Jenkins集成的简要说明:
1. SonarQube搭建
在搭建SonarQube时,可以选择社区版本,但请注意社区版本不支持多分支功能,因此需要安装第三方分支插件sonarqube-community-branch-plugin。
1.1 环境准备
由于SonarQube依赖ES,因此需要确保ES的vm.max_map_count大于,并且进程打开文件数量要足够。
通过修改/etc/sysctl.conf文件来调整vm.max_map_count值,同时修改/etc/security/limits.conf文件以增加相应的配置。
1.2 SonarQube安装
下载并解压SonarQube,然后修改conf/sonar.conf文件,通过环境变量设置Java执行路径。
1.3 安装分支插件
下载并选择1..0版本,将下载的jar文件复制到SonarQube安装目录下的extensions/plugins中,并在conf/sonar.conf中添加相应配置。
1.4 启动SonarQube
启动正常后,在http://hostip:访问,登录默认账号/密码为admin/admin,第一次登录需修改密码。
2. Jenkins集成
将SonarQube集成到Jenkins中,包括安装SonarQube插件,并在构建配置中设置分析步骤。
3. 踩坑总结
1. ES环境检测问题
2. Sonar分支插件安装版本匹配问题
3. 分支插件启动后需添加执行参数sonar.branch.name,否则会报错
4. Node.js版本要求,Java版本要求,在Jenkins流水线中可以通过tool选择当前工具版本
5. 代码排除格式