SonarQube系列-架构与外部集成

sonarqube,系列,架构,外部,集成 · 浏览次数 : 192

小编点评

**Sonar 是一个代码质量管理平台,基于 Java 开发的,用于管理源代码的质量。** **主要功能:** * **代码可靠性支持**:提前捕获和提示代码中的错误,从而避免未定义的行为影响到终端用户。 * **应用安全支持**:修复可能危害到应用程序的漏洞,并通过安全热点学习AppSec(简单理解就是会学习和识别新的漏洞)。 * **技术债务支持**:确保管理的代码库干净并且可维护,以便提高开发人员的开发效率。 **版本选择:** * **免费版本**:集成了数千种自动的静态代码分析规则,旨在提高开发人员的代码质量和安全性。 * **付费版本**:提供更强大的功能,例如自定义漏洞分类、搜索服务和数据库存储。 **集成方式:** * **CI/CD管道**:只需一行命令即可轻松集成到 CI/CD 管道中。 * **Maven 和 Gradle 构建周期**:可以在构建周期中检查代码质量。 * **ElasticSearch 搜索**:用于返回通过 UI 搜索内容。 * **计算引擎报告**:用于处理代码分析后的报告。 **其他:** * **SonarQube 服务器**:用于发布应用,在线浏览、配置分析等。 * **SonarQube Plugins**:扩展平台功能的插件。 * **外部集成**:与其他 ALM 工具集成,例如 SonarLint、SonarQube Studio 等。

正文

介绍

Sonar是一个代码质量管理的开源平台,基于Java开发的,用于管理源代码的质量,通过插件形式,可以支持包括java、C#、JavaScript等二十余种编程语言的代码质量管理与检测。

它具有免费的社区版本和其他付费版本。

SonarQube之采购选型参考

利用SonarQube的主要好处是:它集成了数千种自动的静态代码分析规则,旨在提高开发人员的代码质量和安全性,使得开发人员编写更加干净,更加安全的代码。

主要提供了三个比较大的功能:

  • 代码可靠性支持:提前捕获和提示代码中的错误,从而避免未定义的行为影响到终端用户。

  • 应用安全支持:修复可能危害到应用程序的漏洞,并通过安全热点学习AppSec(简单理解就是会学习和识别新的漏洞)。

  • 技术债务支持:确保管理的代码库干净并且可维护,以便提高开发人员的开发效率。

这可以帮助你确保代码在合并之前达到预期的质量!

  • 只需一行命令即可轻松集成到CI/CD管道中。

  • 也可以集成到Maven和Gradle构建周期中

  • 检查几乎所有内容,如代码质量,格式,变量声明,异常处理等。

实际上,研发团队可以基于SonarQube做下面的事情:

  • CI/CD流程加入一个SonarQube扫描的环节

  • 实施代码质量阈值,只有通过了这个质量阈值检测才能进入下一个流程

  • 代码质量低于阈值的项目要及时调整对应的代码

质量阈值可以进行自定义,SonarQube中针对每个项目会有详细的面板信息,里面会给出项目当前的健康状态,不同级别漏洞的分类和明细,漏洞对应提交者等多维度的统计信息,方便进行问题的追踪和修复。

针对不同的项目,SonarQube可设定了不同等级的阈值,对于老项目,会使用最低等级的阈值:阻断性的错误数量要求为0,对于一些新的项目,则严格要求质量如严重性的错误要求为0等,只要无法通过质量阈值检查,那么项目是无法上线的。

组成

1、SonarQube服务器

sonarqube是sonar的服务端,相当于一个web服务器,用来发布应用,在线浏览、配置分析等。

  • 开发人员和管理员操作频繁,用于浏览代码质量和配置服务器。

  • 集成ElasticSearch做搜索服务,用于返回通过UI搜索内容。

  • 集成计算引擎处理代码分析后的报告,并将报告保存到数据库。

每个文件夹的作用

bin:sonarqube运行命令文件夹

conf:sonarqube配置文件夹

data:嵌入式数据库的数据(H2数据库引擎),建议只用于测试和演示

extensions:sonarqube的插件等存放文件夹

lib:sonarqube存放的运行库文件夹(jar)

logs:sonarqube日志文件夹

temp:sonarqube临时文件夹  

web:sonarqube系统UI界面文件夹

2、SonarQube数据库

  • 存储代码分析数据报告。

  • 支持oracle、PostgreSQL、MySQL。

3、Sonarqube-Scanner

sonarqube-scanner相当于sonar客户端, sonarqube-scanner如下图所示。每个文件夹的作用和sonar类似,具体不在赘述。

  • 客户端工具,用于扫描项目。

  • 将扫描结果上传到服务器。

4、SonarQube Plugins

  • 通过插件使平台功能更加强大,

  • 常用的插件分类:SCM、集成、身份验证、管理维护等插件。

外部集成

下面的模式展示了SonarQube如何与其他ALM工具集成,以及使用SONARQUE的各种组件。

  1. 开发人员在IDE中编写代码,并使用SonarLint来运行本地分析。

  2. 开发人员将他们的代码推到他们最喜欢的SCM:Git,Svn,TFVC,…

  3. 连续集成服务器触发自动构建,执行SONARQUE扫描器需要运行SONARQUE分析。

  4. 分析报告被发送到SONARQUE服务器进行处理。

  5. SONARQUE服务器在SONARQUE数据库中处理和存储分析报告结果,并将结果显示在UI中。

  6. 开发人员审查、评论、挑战他们的问题,通过SONARQUE UI管理和减少他们的技术债务。

  7. 管理者从分析中得到报告;使用API来自动配置并从SONARQUE中提取数据;使用JMX监控SONARQUBE服务器

SonarLint

SonarLint是一个Sonar IDE插件,可以接收和连接SonrarQube对代码库扫描的结果从而通知Developer, SonarLint本身也可以基于一些规则对代码IDE中的代码进行即时的检测。它的目的是在您键入代码时提供即时反馈。

注意:为了获得最佳性能,Sonar Qube服务器和数据库应安装在单独的主机上,并且服务器主机应为专用主机。服务器和数据库主机应位于同一网络上。

所有主机都必须进行时间同步


与SonarQube系列-架构与外部集成相似的内容:

SonarQube系列-架构与外部集成

介绍 Sonar是一个代码质量管理的开源平台,基于Java开发的,用于管理源代码的质量,通过插件形式,可以支持包括java、C#、JavaScript等二十余种编程语言的代码质量管理与检测。 它具有免费的社区版本和其他付费版本。 SonarQube之采购选型参考 利用SonarQube的主要好处是:

SonarQube系列-通过配置扫描分析范围,聚焦关键问题

在许多情况下,你可能不希望分析项目中每个源文件的各个方面。例如,项目可能包含生成的代码、库中的源代码或有意复制的代码。在这种情况下,跳过这些文件分析的部分或全部方面是有意义的,从而消除干扰并将焦点缩小到真正重要的问题上。 如果SonarQube的结果不相关,那么没有人会想要使用它。这就是为什么精确配

SonarQube系列-认证&授权的配置

参考文档:https://docs.sonarqube.org/latest/instance-administration/security/ 概述 SonarQube具有许多全局安全功能: 认证和授权机制 强制身份认证 委派认证 除此之外,还可在group/user级别配置: 查看一个已存在的项

Azure DevOps(二)Azure Pipeline 集成 SonarQube 维护代码质量和安全性

一,引言 对于今天所分析的 SonarQube,首先我们得了解什么是 SonarQube ? SonarQube 又能帮我们做什么?我们是否在项目开发的过程中遇到人为 Review 代码审核规范?带着以上问题,开始今天的分析内容吧 !!! 1)什么是 SonarQube ? SonarQube 是一

Azure DevOps(三)Azure Pipeline 自动化将程序包上传到 Azure Blob Storage

一,引言 结合前几篇文章,我们了解到 Azure Pipeline 完美的解决了持续集成,自动编译。同时也兼顾了 Sonarqube 作为代码扫描工具。接下来另外一个问题出现了,Azure DevOps 由于有人员限制,项目上不能给非开发人员或者外包成员开权限,这个时候就需要将编译好的程序包上传到公

.NET周刊【9月第1期 2023-09-03】

## 国内文章 ### 如何正确实现一个自定义 Exception https://www.cnblogs.com/kklldog/p/how-to-design-exception.html 最近在公司的项目中,编写了几个自定义的 Exception 类。提交 PR 的时候,sonarqube 提