【DevOps】代码质量检查平台SonarQube的搭建

﹏ヽ暗。殇╰゛Y 2023-07-04 14:18 20阅读 0赞

> 在SCM服务端进行自动化地静态检查来改进代码质量的举措执行一段时间之后，另外一个非常现实的问题也渐渐浮出水面：“我们如何界定每次代码提交对代码库代码质量的影响？”，也就是"我们应该如何量化每次代码更新的影响？"。本文将尝试解决这个问题。

### 1. 前言 ###

正如管理学之父彼得德鲁克所说：“如果你不能度量它，你就无法改进它”。本文我们就将借助SonarQube来量化SCM仓库的代码质量。

### 2. 安装SonarQube(Docker方式) ###

本次我们将在Centos下采用Docker的方式进行SonarQube的安装。（不得不说，如果没有下面提到的这些坑，是真的快呀！）

##### 2.1. Docker方式安装pgsql #####

# -p 5432:5432 (向外映射开放给外部访问)
    docker run -d --name pgdb -e POSTGRES_USER=sonar  -e POSTGRES_PASSWORD=sonar -v /data/pgdata:/var/lib/postgresql/data-d docker.io/postgres:latest

##### 2.2. Docker方式安装sonarqube #####

docker run --name sq --link pgdb -e SONARQUBE_JDBC_URL=jdbc:postgresql://pgdb:5432/sonar -e SONARQUBE_JDBC_USERNAME=sonar -e SONARQUBE_JDBC_PASSWORD=sonar -p 9000:9000 -v /data/sonarqube/data:/opt/sonarqube/data -v /data/sonarqube/extensions:/opt/sonarqube/extensions -d sonarqube

##### 2.3. 可能出现的问题 #####

就笔者遇到的情况，Docker安装pgsql并没有遇到什么问题，问题主要出现在使用Docker方式启动sonarqube的过程中。

1.  上面说的坑点之一就是这里，在这里你很有可能出现的一个问题就是"文件夹权限不足"（尤其是如果你在阿里云ECS这样的服务器上进行测试搭建时候），此时请进行如下操作：
    
        sudo chmod 777 -R /data/sonarqube/
2.  问题之二：“max virtual memory areas vm.max\_map\_count \[65530\] is too low, increase to at least \[262144\]”。 解决方案如下：
    
        # 在宿主机执行：
        sysctl -w vm.max_map_count=262144

##### 2.4. 验证 #####

解决完所有的异常情况，重启sonarqube之后，访问 http://127.0.0.1:9000 ，默认用户名和密码均为admin。（这里注意sonarqube的启动过程比较慢，读者可以稍微等一下，当然更直接的方式就是通过`docker logs`监视sonarqube的启动情况，确认启动完毕之后再访问）。

### 3. 插件安装 ###

因为总所周知的原因，我们一般情况下都是采用离线的方式进行插件的安装。本小节我们主要解释四款插件的安装，安装方式大同小异，看明白一种，其它的就都清楚了。

推荐将需要的插件全部下载完毕之后，再进行Docker的重启。当然"小步快跑"也不失为一个更稳妥的方式。

1.  汉化插件
    
    从 https://github.com/SonarQubeCommunity/sonar-l10n-zh/releases 中下载与你sonarqube版本对应的汉化插件jar包，笔者的版本为7.9.2。对应的汉化plugin为`sonar-l10n-zh-plugin-1.29.jar`。
    
        cd /data/sonarqube/extensions/downloads
        # 断点续传, 防止悲剧
        wget -c https://github.com/SonarQubeCommunity/sonar-l10n-zh/releases/download/sonar-l10n-zh-plugin-1.29/sonar-l10n-zh-plugin-1.29.jar
        
        # 重启sonarqube
        docker restart sq
2.  SonarJava插件
    
        cd /data/sonarqube/extensions/downloads
        wget -c https://binaries.sonarsource.com/Distribution/sonar-java-plugin/sonar-java-plugin-6.0.2.20657.jar
3.  Checkstyle插件
    
        wget -c https://github.com/checkstyle/sonar-checkstyle/releases/download/4.29/checkstyle-sonar-plugin-4.29.jar
4.  PMD插件
    
        wget -c https://github.com/jensgerdes/sonar-pmd/releases/download/3.2.1/sonar-pmd-plugin-3.2.1.jar

重启Docker之后，“配置” > ”应用市场“ > "插件"应该就可以看到安装好的插件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]

##### 如何找到上述插件下载地址？ #####

相信读者更关心的是这个问题。这里我们需要分两种情况分别进行说明

1.  第三方扩展插件，这里以 PMD插件 为例。
    
    访问 `http://127.0.0.1:9000/admin/marketplace` ，定位到PMD插件。  
    ![PMD Plugin][]  
    点击"首页"，访问插件的更新地址，找到文档中的如下类似内容，然后从中找到与所安装的SonarQube版本契合的插件版本下载并放置到对应目录即可：  
    ![离线下载方式][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 1]
2.  官方提供的插件，这里以 SonarJS插件 为例。  
    读者可以直接从如下地址进行查找 `https://binaries.sonarsource.com/Distribution` 。例如我们这里的 SonarJS。在打开的页面搜索关键字"javascript"即可找到相应的下载地址。（注意版本的选择——参见下图）。  
    ![版本的选择][20200213110036780.png]  
    ![下载地址][20200213110116166.png]

### 4. 关于Sonar ###

1.  Sonar是一个用于代码质量管理的开源平台，用于管理Java源代码的质量。
2.  通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。
3.  同时 Sonar 还对大量的持续集成工具提供了接口支持，可以很方便地在持续集成中使用 Sonar。
4.  此外，Sonar 的插件还可以对 Java 以外的其他编程语言提供支持，对国际化以及报告文档化也有良好的支持。

### 5. Links ###

1.  [【DevOps】SVN集成Checkstyle实现代码自动静态检查][DevOps_SVN_Checkstyle]
2.  [【DevOps】SVN集成PMD实现代码自动静态检查][DevOps_SVN_PMD]
3.  [基于docker搭建sonar代码质量检测平台][docker_sonar]
4.  [docker启动elasticsearch报错][docker_elasticsearch]
5.  [解决新版sonar-java插件需要配置sonar.java.binaries参数的问题][sonar-java_sonar.java.binaries]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200211233502436.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[PMD Plugin]: https://img-blog.csdnimg.cn/20200213105203173.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200213105340378.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM=,size_16,color_FFFFFF,t_70
[20200213110036780.png]: https://img-blog.csdnimg.cn/20200213110036780.png
[20200213110116166.png]: https://img-blog.csdnimg.cn/20200213110116166.png
[DevOps_SVN_Checkstyle]: https://blog.csdn.net/lqzkcx3/article/details/103477780
[DevOps_SVN_PMD]: https://blog.csdn.net/lqzkcx3/article/details/103958695
[docker_sonar]: https://www.cnblogs.com/fangyuan303687320/p/9858690.html
[docker_elasticsearch]: https://www.jianshu.com/p/1e6763f0b817
[sonar-java_sonar.java.binaries]: https://blog.csdn.net/u013111003/article/details/79927668