Linux搭建sonarqube+sonarScanner

2021-03-02

SonarQube是市场上很受欢迎的代码质量和安全性分析工具。
它在开源社区的支持下，目前可以分析超过25种编程语言的程序。
它具有免费的社区版本和其他付费版本。

搭建步骤

安装JDK
安装SonarQube
安装MySQL
连接SonarQube与MySQL
安装Sonar-Scanner
SonarQube添加离线插件
运行Scanner

安装JDK

Java JDK在linux系统有两个版本，一个是开源版本Openjdk，还有一个是oracle官方版本jdk。

更新软件包列表

sudo apt-get update

安装openJDK-8

sudo apt-get install openjdk-8-jdk

检查java是否安装成功

java -version

安装SonarQube

下载SonarQube安装包

地址：https://www.sonarqube.org/downloads/

解压安装包

安装包放合适位置，并解压。

unzip sonarqube-7.6.zip

启动Sonar

进入目录：sonaqube-7.6/bin/{os}，os为系统类型。
可通过命令行查看系统类型。

启动Sonar

./sonar.sh start

如果在启动过程中出现如下错误：
Starting SonarQube… Failed to start SonarQube.
请在 sonarqube-5.6.6/bin/{os} 目录下新建文件 SonarQube.pid ，然后重新启动。

检查启动结果

启动浏览器，访问：http://localhost:9000，出现SonarQube界面则表示安装成功。

安装中文插件

中文插件下载地址
https://github.com/xuhuisheng/sonar-l10n-zh/releases/tag/sonar-l10n-zh-plugin-1.16

将下载的插件放到 sonarqube-7.6/extensions/plugins/ 下

进入SonarQube的bin目录，重启SonarQube

./sonar.sh restart

安装MySQL

查看SonarQube支持的MySQL版本

查看文件：sonarqube-7.6/conf/sonar.properties，获取支持的MySQL版本。
一般的MySQL支持范围：MySQL >=5.6 && <8.0

CentOS安装数据库MySQL-5.7

详细参考文章：https://jz.wohunlfry.top/2020/11/12/CentOS7%E9%80%9A%E8%BF%87yum%E5%AE%89%E8%A3%85MySQL/

连接SonarQube与MySQL

创建数据库sonarqube

CREATE DATABASE sonarqube;

修改sonar.properties配置信息

打开文件：sonarqube-7.6/conf/sonar.properties，取消配置注释并修改

# 连接数据库的用户名
sonar.jdbc.username=root
# 连接数据库的密码
sonar.jdbc.password=yegetaier570
# sonar编码
sonar.sorceEncoding=UTF-8

# sonarqube登录用户名
sonar.login=admin
# sonarqube登录密码
sonar.password=admin

# 数据库url及相关设置
sonar.jdbc.url=jdbc:mysql://{IP}:3306/sonarqube?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false
# IP为数据库的地址

重启sonar，再次访问

./sonar.sh restart

安装Sonar-Scanner

安装包下载

地址：https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/

配置Sonar-Scanner

将Sonar-Scanner安装包放合适位置
编辑文件：sonar-scanner-cli-4.6.0.2311-linux/conf/sonar-scanner.properties

#----- Default SonarQube server
sonar.host.url=http://localhost:9000
sonar.jdbc.username=root
sonar.jdbc.password=yegetaier570
sonar.jdbc.url=jdbc:mysql://172.18.101.121:3306/sonarqube?useUnicode=true&characterEncoding=utf8
＃sonar.login=admin
＃sonar.password=admin
sonar.login=ac3238b68c831878edc8e41189fdc1a7b2d64a8a
sonar.password=
#-- 如果未使用token，则使能username+password，否则使能token+空密码  

#----- Default source code encoding
sonar.sourceEncoding=UTF-8

在sonarqube网站创建项目

输入项目key和项目名创建项目，并保存生成的token。

在程序目录添加sonar-project.properties

sonar-project.properties文件放在需要审查的代码的同一目录
如项目目录：RT_Linux/quality
则sonar-project.properties放在RT_Linux/quality目录下

sonar-project.properties内容：

# 项目的key
sonar.projectKey=itil:change
# 项目的名字(可以随便写，这个名字在sonar显示的)
sonar.projectName=RT_Linux
# 项目的版本
sonar.projectVersion=1.2
# 需要分析的源码的目录
# 此处使用了绝对路径
sonar.sources=/home/yegetaier/Desktop/RT_Linux/quality/
# 这是target(如果没编译可以不写)
sonar.java.binaries=/home/yegetaier/Desktop/RT_Linux/quality/main
# 语言
sonar.language=c++
# 编码格式
sonar.sourceEncoding=UTF-8