简介

SonarQube(原名 Sonar) 是一个开源的代码质量管理系统,可以扫描项目中重复代码、编码标准、单元测试、代码覆盖率、代码复杂度、潜在 Bug、注释等.

支持 Java、C/C++、C#、PHP、Flex、Groovy、JavaScript、Python 等多种语言.

代码扫码的好处在于通过配置规则扫描代码设计缺陷和代码优化从而提高代码的质量.

本文介绍使用 docker 技术搭建 SonarQube 环境并扫描代码.

环境搭建

快速启动

这种方式启动 sonarqube 是没有数据存储的,docker 重新加载后数据不会 reload 数据.

docker run -d --name sonarqube -p 9000:9000 -p 9092:9092 sonarqube:lts

浏览器打开:0.0.0.0:9000
帐号密码:admin、admin

全配置启动

docker 启动 mysql

使用 mysql 作为数据存储,通过如下命令启动:

docker run --name mysql-5.6 -v /Users/xinxi/mysql:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123321 
-p 8888:3306 -d mysql:5.6

sonarqube 不支持 mysql5.5 版本,最低支持 5.6 版本

docker 启动 sonarqube

需要注意两点:

db_sonar 数据库需要手动先创建,否则会报找不到
本地搭建 ip 地址不能写 localhost,需要写内网 ip

启动命令如下:

docker run -d --name Sonarqube -p 8185:9000 -p 8186:9092 
-e "SONARQUBE_JDBC_USERNAME=root" 
-e "SONARQUBE_JDBC_PASSWORD=123321" 
-e "SONARQUBE_JDBC_URL=jdbc:mysql://192.168.129.25:8888/
db_sonar?useUnicode=true&characterEncoding=utf8" 
-d sonarqube:lts

效果

启动成功以后,第一次页登录成功后会设置 token,这个 token 是以后被扫描代码工程中需要配置的,用于通过 token 的方式连接 Sonarqube 平台传数据结果

Android 项目配置

Android 项目是使用 gradle 管理插件,所以需要配置 gradle 文件.

在项目根目录的 gradle 配置如下:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:2.5"
  }
}

plugins {
  # 添加插件信息
  id "org.sonarqube" version "2.6-rc1"
}

apply plugin: "org.sonarqube"

执行命令:

gradle sonarqube \
  -Dsonar.host.url=http://localhost:8186 \
  -Dsonar.login=a1cf2c8dbdc187441c3f908b79b562404b9a4f6b

另外配置方式是在 gradle.properties 配置文件

上传结果成功

扫描结果

mvn 项目配置

运行命令

mvn sonar:sonar   -Dsonar.host.url=http://localhost:9000   -Dsonar.login=c8ce928f1497f1fa5591cdcf5357aa4e44920796

扫描结果

iOS 项目配置

安装

先需要安装如下工具

brew tap oclint/formulae
brew install oclint
brew install sonar-scanner
brew install gcovr

项目配置

需要在项目根目录增加 run-sonar.sh 和 sonar-project.properties 两个文件

具体配置请参考Demo 代码

运行命令

在项目根目录下,sh run-sonar.sh

踩坑

提示没有 oc 插件

需要oc插件.png

通过 sonarqube 安装的 oc 插件是收费的,下载免费的 oc 插件.

https://github.com/Backelite/sonar-objective-c

然后把 backelite-sonar-objective-c-plugin-0.6.3.jar 放到 sonarqube 的 extensions/plugins 中,然后重启镜像.

效果展示

走通扫描.jpg

oc扫描结果.png

制作镜像

sonarqube 原生不支持中文、并且没有 oc 插件.可以把汉化中文包和 oc 插件打包成新的 docker 镜像

把 sonar-l10n-zh-plugin-1.16.jar、backelite-sonar-objective-c-plugin-0.6.3.jar 和 dockerfile 放到一个目录下

dockerfile 如下:

dockfile:
FROM sonarqube
ADD sonar-l10n-zh-plugin-1.16.jar /opt/sonarqube/extensions/plugins/
ADD backelite-sonar-objective-c-plugin-0.6.3.jar /opt/sonarqube/extensions/plugins/

执行:docker build -t sonarqube:zh .