sonarqube mysql mac_MAC下SonarQube+Sonar-runner的安装与使用及遇到的问题

sonarqube

SonarQube是管理代码质量一个开放平台，可以快速的定位代码中潜在的或者明显的错误，下面将会介绍一下这个工具的安装、配置以及使用；

一、环境准备

1、jdk

这里我下载的是jdk1.8

首先打开https://www.oracle.com/index.html

oracle

jdk

JDK

sonar-runner

2.4

下载解压

image.png

4、mysql(这里不用介绍，不过需注意下载5.6以上版本)

二、安装

1、下载完SonarQube之后，打开bin目录下的对应OS文件夹，如：

image.png

这里我们执行sonar.sh start 可能会没有反应，这时我们可以输入sh sonar.sh start

image.png

这里如果没有安装jdk是会提示错误，所以请提前安装好jdk。

2、安装成功后 我们在浏览器打开localhost:9000,如下图则表示成功

image.png

三、配置

1、这里我们打开mysql并建一个新的数据库，数据库名可以任意定，这里我建了一个名为sonar的数据库。

数据库

2、打开sonarQube安装目录下的sonar.properties文件，目录为

sonar.properties

3、在sonar.properties中mysql下添加如下信息

image.png

注：这里我数据库端口为8889，默认为3306；

sonar.jdbc.username是数据库用户名

sonar.jdbc.password是数据库用户密码

sonar.login是SonarQube的登录用户名

sonar.password是SonarQube的登录密码 (默认为admin)

4、重启sonarqube服务

sh sonar.sh restart

5、这时我们再打开localhost:9000,这里会稍微有点慢，因为要初始化数据库，大家耐心等待一下

6、当初始化成功后，我们就能看到登录界面，输入用户名密码

image.png

7、这里登录后看到的都是英文，而作为我们最讨厌的就是英文，所以我们将其转化成中文，安装中文语言包

image.png

如图，先点击位置1，再点击位置2，在位置3中输入chinese，即可看见Chinese Pack,最后点击位置4以安装中文语言包。等待安装完成。出现如下图界面即安装完成：

image.png

8、重启sonarqube服务，重启后，我们便能看到我们喜欢的中文界面

image.png

2.4

解压后我们就看到如图所示

sonar-runner

2、配置

打开sonar-runner下conf下的sonar-runner.properties文件，配置该文件

sonar-runner.properties

这里配置基本和sonar.properties相同，

注意：

(1)如果待测试项目与SonarQube服务不在同一台机器，则需要添加SonarQube服务的IP：

image.png

(2)端口填写自己数据库端口，默认3306

3、配置环境变量

在文件末尾添加如下字段：

export SONAR_RUNNER_HOME=path to your Sonar-Scanner directory

export PATH=$PATH:$SONAR_RUNNER_HOME/bin

保存修改

使配置立即生效：source ~/.bash_profile

bash_profile

注：这里配置特别容易出错，一定要写清楚sonar-runner的位置，并且最后执行source ~/.bash_profile命令

4、测试sonar-runner是否配置成功

打开终端，执行命令sonar-runner -v

sonar-runner -v

出现如下图则代表配置成功

image.png

到这里 sonarqube，sonar-runner的配置基本完成，而接下来就是最为关键也是问题最多的地方，如何检测我们的项目(重点)

5、打开待测试的项目根目录

image.png

新建sonar-project.properties文件并输入如下信息

sonar-project.properties

注意：

sonar.projectKey是我们项目的名称

sonar.projectName是我们项目的名称

sonar.sources是源文件所在的目录(因为这里使用的框架是slim框架，入口为public，TP同理)

6、打开终端，进入待测试项目根目录，执行如下命令：

sonar-runner

注注注：这里一定要进去待测试项目根目录，如项目为test，你应该通过终端cd到test目录下执行该命令

执行会有一点时间，完成之后会出现以下界面

sonar-runner

这里是操作成功的界面，而我们在执行sonar-runner命令时，会遇到很多问题，包括我自己，在执行命令的时候，也遇到一大堆问题，下面我列出自己所遇到的问题，给大家做个参考。

问题一、

ERROR: Error during SonarQube Scanner execution

ERROR: Failed to upload report - 500: An error has occurred. Please contact your administrator

原因：mysql参数设置问题，设置数据库允许接收的最大包

解决：

检查mysql参数：

mysql> SHOW VARIABLES LIKE 'max_allowed_packet';

修改/etc/my.cnf文件：

max_allowed_packet = 50M

重启mysql服务

问题二、

ERROR: Re-run SonarQube Scanner using the -X switch to enable full debug logging.ERROR: SonarQube scanner exited with non-zero code: 1Finished: FAILURE

原因：sonar配置界面未开启scm

解决：在配置->SCM菜单中将Disable the SCM Sensor设置为TRUE，并在下面的SVN配置选项中配置自己的SVN路径及访问账号密码等信息。

scm

问题三、

RROR: Error during Sonar runner execution

ERROR: Unable to execute Sonar

ERROR: Caused by: You must install a plugin that supports the language 'objc'

ERROR:

ERROR: To see the full stack trace of the errors, re-run SonarQube Runner with the -e switch.

ERROR: Re-run SonarQube Runner using the -X switch to enable full debug logging.

原因：说明sonar-objective-c-plugin-0.3.2-SNAPSHOT.jar没有加载到/etc/sonarqube/extensions/plugins

当然我们在执行的时候还会遇到其他问题，我们要学会查看日志，同时学会寻求度娘的帮助

log

当都完成时，我们便能看到我们所执行的项目，查看项目的bug，漏洞及其他问题

image.png

image.png

image.png

总结：通过SonarQube工具，作为码农可以及时审查自己的代码水平和问题，进行及时修复，优化代码的质量，这种工作我们要持之以恒的态度，才能使项目始终保持高可用，高效，干净整洁的状态。

由于本人也是小白一枚，大家有问题可以一起探讨；想要了解更多sonarqube的使用，请登录官网学习。