使用docker 搭建 SonarQube 代码质量管理平台

一、概述

Sonar是一个用于代码质量管理的开源平台，用于管理源代码的质量，可以从多个维度检测代码质量，通过插件形式，可以支持包括java、python、C#、go、scala、kotlin、JavaScrip、Groovy等二十几种编程语言的代码质量管理与检测。

下面使用docker 启动一个 sonarqube , 便于快速体验此平台提供的功能。

二、安装 SonarQube

你可以下载zip文件的传统方式安装SonarQube，也可以使用docker 镜像的方式启动 SonarQube容器。

1、 下载zip文件安装SonarQube https://www.sonarqube.org/downloads/

image.png

• 下载上图中的zip文件
• 解压缩zip文件，例如在C：\ sonarqube或/ opt / sonarqube中
• 运行下面的命令启动 SonarQube Server

# 在windows中，执行如下命令
C:\sonarqube\bin\windows-x86-64\StartSonar.bat

# 在linux等其他系统中执行如下命令
/opt/sonarqube/bin/[OS]/sonar.sh console

2、使用docker 安装 SonarQube

image.png

• 在docker hub 中找到 sonarqube
• 使用 docker pull sonarqube 拉取镜像
• 运行下面的命令启动 SonarQube Server

docker run -d --name sonarqube -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true -p 9000:9000 sonarqube:latest

3、登录SonarQube Server

实例启动并运行后，使用系统管理员凭据登录到 http://localhost:9000

• 用户名：admin
• 密码：admin

登录成功后需要重置密码

重置密码

三、分析项目

登录成功后，如下图所示：

image.png

1、安装中文包

image.png

中文包安装成功后如下图

image.png

2、分析项目

• 单击创建新项目按钮。

  
  
  

  image.png

• 给您的项目一个项目键和一个显示名称，然后单击设置按钮。

  
  
  

  image.png

• 在“提供令牌”下，选择“生成令牌”。为您的令牌命名，点击生成按钮，然后点击继续。

  
  
  

  image.png

• 在“对项目运行分析”下选择项目的主要语言，然后按照说明分析项目。在这里，您将在代码上下载并执行扫描程序（如果您使用的是Maven或Gradle，则会自动下载该扫描程序）。

  
  
  

  image.png

使用Maven执行SonarQube分析是非常简单的。只需要在你的项目目录下执行如下命令。

mvn sonar:sonar \
  -Dsonar.projectKey=test \
  -Dsonar.host.url=http://localhost:9000 \
  -Dsonar.login=a98ea942c2c4bd02b1621ee26653fe1b7007d83d

分析完成后，页面会自动刷新，您将在SonarQube上看到第一个分析：

image.png

image.png

四、遇到的问题

执行上面的mvn命令，出现如下问题：

image.png

[ERROR] Failed to execute goal org.sonarsource.scanner.maven:sonar-maven-plugin:3.8.0.2131:sonar (default-cli) on project quarkus-demo: Your project contains .java files, please provide
 compiled classes with sonar.java.binaries property, or exclude them from the analysis with sonar.exclusions property.

原因：项目只包含 .java 文件，没有编译成 .class 文件
解决：需要编译先项目，先执行 mvn pakage 再执行 mvn sonar: sonar ,也可以合并执行下面的命令

mvn package sonar:sonar \
  -Dsonar.projectKey=test \
  -Dsonar.host.url=http://localhost:9000 \
  -Dsonar.login=a98ea942c2c4bd02b1621ee26653fe1b7007d83d

参考文章
sonarqube 镜像仓库地址
docker 启动 sonarqube 官方文档