显示SonarQube私有项目徽章方案流程
背景
sonarQube 目前不支持私有项目的徽章图片获取,这个问题早在 2018 年就在 sonar 社区里有过激烈的讨论。后面 sonar 官方也关注到了这个需求的必要性,也着手排期在做了。但是从 2020年2月份创建好了项目计划后,到现在一年过去了,还没有任何的动静,所以不等官方的版本计划了,只能自己寻求一种可以快速实施的方案
- 社区讨论:https://community.sonarsource.com/t/badges-on-private-projects/4894
- 官方排期实现计划:https://jira.sonarsource.com/browse/MMF-1942
SonarQube 架构简介
先简单了解下 sonar 的运行机制。如图,运行 SonarQube app,其实同时运行了4 个进程,app 进程负责统筹调度其他三个进程,当有插件安装需要重新加载时, app 就可以发出重启的指令。下面是详细的描述:
- App Process:用户操作的进程,这个进程是门面,由用户控制开启或者关闭。同时也是其他三个进程的调度器,开启 app 后,会自动启动 Es、web、ce 等进程。
- Es Process:ElasticSearch 的进程,Sonar 将 Es 的发行包内置到了Sonar 中,作为独享的搜索引擎使用,issue ,代码等数据会被 es 管理起来。
- Web Process:web 页面 、api 的进程
- Ce Process:ce 全称 Compute Engine 。分析计算引擎,是 sonar 的核心
分析徽章的生成
如下,是一个获取 bugs徽章的链接,我们从这个链接开始,深入分析下,在 sonar 服务的内部是怎么生成这个徽章的。在分析前,先说明下,sonar 内部没有采用 spring mvc 等任何web 框架,是自己封装的一套mvc框架,数据库查询用的 mybatis。
https://qa-sonar.dev.com/api/project_badges/measure
project=server_services_developer_AXaIXEx52AMDJFWZUd_4&metric=bugs
根据徽章资源的 /api/project_badges 找到徽章的web入口文件 ProjectBadgesService.java ,可以看到接口支持的入参情况。通过 action 模块名 measure 找到 MeasureAction.java ,生成徽章的主要逻辑都在这个里面,所在模块的目录结构如下:
从这里得知,通过徽章链接获取到的 svg 图片,是通过 project_Id 实时查出来数据,实时生成的图片。并不是每次扫描都会生成静态图片资源。也在这个模块里找到了私有项目无法生成代码的逻辑。
实施方案
1、改社区代码去掉私有的限制
这个是最简单的,但是限制也比较多。改了代码需要自己发版,功能没法和社区同步。而且如果你使用的是付费的,这个路也行不通。
2、新建一个项目,自己生成 svg
尝试获取 sonar 的所有元数据信息,然后自己生成 svg 徽章,在 url 设计上,尽量保持和 sonar 自己的风格保持一致,用法也一样。生成的徽章的风格也保持一致
结语
最后准备采用方案二,新建专门处理 sonar徽章的项目,实施过程就不在详细说明了。sonarqube 私有项目徽章获取显示,是一个社区众望所期的功能。所以如果这个方案最后成功实施的话,项目也会在 github 开源出来,敬请期待
以上就是显示SonarQube私有项目徽章方案流程的详细内容,更多关于SonarQube私有项目徽章显示的资料请关注脚本之家其它相关文章!
相关文章
Spring中@EnableScheduling实现定时任务代码实例
这篇文章主要介绍了Spring中@EnableScheduling实现定时任务代码实例,@EnableScheduling 注解开启定时任务功能,可以将多个方法写在一个类,也可以分多个类写,当然也可以将方法直接写在上面ScheddulConfig类中,需要的朋友可以参考下2024-01-01Java中Json与List、Map、entity的互相转化
在开发中,Json转换的场景往往也就是那么几个,本文主要介绍了Java中Json与List、Map、entity的互相转化,具有一定的参考价值,感兴趣的可以了解一下2022-07-07如何使用@Value和@PropertySource注入外部资源
这篇文章主要介绍了如何使用@Value和@PropertySource注入外部资源的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教2021-06-06Java 实现使用Comparable按照我们指定的规则排序
这篇文章主要介绍了Java 如何使用Comparable按照我们指定的规则排序,通过练习创建TreeSet集合使用无参构造方法,并按照年龄从小到大的顺序排序,若年龄相同再按照姓名的字母顺序排序展开内容,需要的朋友可以参考一下2022-04-04CompletableFuture并行处理List分批数据demo
这篇文章主要介绍了CompletableFuture并行处理List分批数据实现实例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2023-11-11Java实现读取resources目录下的文件路径的九种方式
本文主要介绍了Java实现读取resources目录下的文件路径的九种方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2022-04-04
最新评论