第一阶段:搭建平台
安装MySQL
1、首先到官网下载MySQL,
注意安装MySQL的版本号不能太高,因为在sonar7.9中已经不支持MySQL了,并且低版本的sonar仅支持 5.6 <= version < 8.0的MySQL,目前定的是5.7.26,进行傻瓜式的安装。。。
安装完成之后,会提示下面的弹框,一定要记住(LZ16mQqnlh2密码,表示当前的数据库初始化密码是多少;
2019-12-05T08:39:30.194952Z 1 [Note] A temporary password is generated for root@localhost: (LZ16mQqnlh2
If you lose this password, please consult the section How to Reset the Root Password in the MySQL reference manual.
在接下来的MySQL中,我们需要重置MySQL密码,先写入当前的(LZ16mQqnlh2,再重新更改密码。提示参考链接
当我们在启动的数据库的时候,需要把数据库初始密码输入进来,在下边的配置中会讲到
安装完之后,在偏好设置中,会发现下图:
2、开始在程序中配置路径
输入:
vim ~/.bash_profile
选择E,进入下一界面,然后输入i,可以在其中插入需要添加的路径内容;路径如下:
PATH=$PATH:/usr/local/mysql/bin
保存之后,退出,最后在终端界面输入,即可完成路径配置。
source ~/.bash_profile
参考文章:mysql : https://www.jianshu.com/p/9239ff6c20b8
3、登录MySQL,并创建sonar数据库
//1、登陆MySQL
mysql -u root -p
//2、输入密码
如果第一次输入那么,那么密码输入(LZ16mQqnlh2**(mysql初始化)
否则,输入之前设置的密码
如果首次登录完成,那么我们需要修改初始密码new_password,执行下列命令:
ALTER USER 'root'@'localhost' IDENTIFIED BY 'new_password';
创建MySQL数据库,并且数据库名和密码都是sonar,如果需要自定义可以自定义输入名字和密码
CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER 'sonar' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
FLUSH PRIVILEGES;
如果在这个数据库操作中出现,表示当前设置的密码不符合MySQL密码规范,需要注意密码规范,或者修改MySQL配置:
mysql> CREATE USER 'sonar' IDENTIFIED BY 'sonar';
ERROR 1819 (HY000): Your password does not satisfy the current policy requirements
所以密码尽量的复杂一些,重新配置MySQL
4、如果下一次程序启动了,直接在偏好设置中启动MySQL就可以了。安装JDK
1、目前安装的是sonarqube-6.7.7,装了JDK1.8 +;因为新版7.9.1需要jdk11支持,而8.0已经不支持MySql了。
注意:sonarqube的版本必须和JDK版本号匹配,否则本地sonar根本运行不起来下载JDK
2、安装之后,配置系统的环境变量
进入当前用户的home目录:
cd ~/
打开.bash_profile并编辑:
open .bash_profile
在文件的末尾加入这一行语句:
export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_211.jdk/Contents/Home
3、验证JDK1.8是否安装成功
java -version
参考文章:JDK安装
sonarqube安装
1、下载指定版本的sonarqube,在官网下载社区版是免费的,当前下载的是6.7.7版本
2、下载完之后,将sonar解压缩之后放到桌面中的sonar文件夹中
3、然后打开终端,进入到此文件夹下的bin/macosx-universal-64目录下,输入命令:
sh ./sonar.sh start
启动sonar,在http://localhost:9000中打开
至此环境初步搭建完成
sonar参考文章1
sonar参考文章2
sonar参考文章3
sonar参考文章4
在启动http://localhost:9000过程中遇到的一些问题:
1、由于之前安装的MySQL版本和sonar版本不匹配,所以自己将本地安装的MySQL卸载重新安装,安装完之后,创建数据库,出现如下:
其实是将原来的MySQL清除干净了,需要重启电脑,再重新安装新的MySQL即可😳
2、执行CREATE USER 'sonar'@'%'IDENTIFIED BY 'sonar';时发现
是因为之前的user已经创建过了,需要删除之前的用户,参考
ERROR 1396 (HY000): Operation CREATE USER failed for 'sonar'@'%'
3、最开始用MySQL创建完数据库sonar之后,执行sonar启动脚本,http://localhost:9000找不到服务,通过sonar log,打印web.log,报
Web server startup failed: Database was upgraded to a more recent of SonarQube ...
报错有点长,原因是我们创建的数据库的问题,所以用
drop database sonar;然后重新创建一个数据库用来存放sonar分析之后的数据。
bin/macosx-universal-64目录下,输入命令:
sh ./sonar.sh restart
重启sonar
第二阶段:sonar配置其他插件,展示内容数据
配置sonar插件
1、sonar文件添加
sonar社区版中其实是不支持OC的,所以需要添加一个OC插件,添加支持OC的插件sonar-objective-c,当前的插件最新版本是0.6.3。
2、将我们的插件经过编译之后,放到sonar文件中的extensions/plugins目录下。
中文插件
在sonar报告界面,都是英文状态下展示,所以为了提高可读性,需要下载sonar对应的中文版本插件,由于自己的sonar是6.7.7,所以插件版本选择 1.19。
下载完毕之后,将插件放到sonar文件中的extensions/plugins目录下。
设置sonar中property
路径如下:打开之后,我们需要配置主要的几项:
//sonar和数据库账户绑定
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
安装sonar-runner
SonarQube是服务器端,它主要有两个功能:
1.分析源代码;
2.因为它内嵌了Apache模块,所以提供Web端的界面访问。
3.SonarQube Runner是一个利用SonarQube服务端分析代码的命令行工具,可以把它简单理解为客户端。
演示环境使用sonar-runner-2.4
下载后解压到
/usr/local/sonar-runner/
完成后配置bin环境变量PATH~
编辑 ~/.bash_profile文件,在文件头部添加一行
# 注意这个路径是sonar-runner的安装路径
export PATH=$PATH:/usr/local/sonar-runner/bin
编辑完之后,在根目录执行source .bash_profile,立即生效
sonar-runner.properties配置文件/usr/local/sonar-runner/conf/sonar-runner.properties,修改用户名和login等
sonar.host.url=http://localhost:9000
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.sourceEncoding=UTF-8
sonar.login=admin
sonar.password=admin
使用Homebrew来安装xctool、oclint、gcovr。
命令行安装
brew install xctool
brew tap oclint/formulae
brew install oclint
brew install gcovr
OCLint 是基于 Clang 的静态分析工具,支持对 C、C++ 和 Objective-C 代码进行静态分析,它基于 Clang 输出的抽象语法树对代码进行静态分析,支持与现有的 CI 集成,部署之后基本不需要维护,简单方便。
安装sonar-scanner
下载扫描器,用于扫描我们的源码。
下载的文件解压或者直接移动到你的目标文件夹,配置环境变量(放置在原有Path变量前面):
export PATH=$PATH:/usr/local/sonar-scanner/sonar-scanner-4.2.0.1873-macosx/bin
然后通过source .bash_profile使其生效。然后通过命令sonar-scanner -v查看版本信息。
使用:
在待扫描项目的根目录新建一个sonar-project.properties(注意⚠️命名不要错)文件,并输入以下信息:
# 项目标识,多个项目一定要改此值来区分
sonar.projectKey=***
sonar.projectName=***
sonar.projectVersion=1.0
sonar.language=objc
# Project description
sonar.projectDescription=***
# Path to source directories 工程文件目录
sonar.sources= .
# Path to test directories (comment if no test) 测试文件目录
# sonar.tests=***
# Code Sign 注意是Release版本的前面与描述文件 (V2.1版本已经不需要此设置)
# sonar.objectivec.codesign=
# sonar.objectivec.profilename=
# Xcode project configuration (.xcodeproj or .xcworkspace)
# -> If you have a project: configure only sonar.objectivec.project
# -> If you have a workspace: configure sonar.objectivec.workspace and sonar.objectivec.project
# and use the later to specify which project(s) to include in the analysis (comma separated list)
# !! 以下二选一 !!
sonar.objectivec.project=**.xcodeproj
# Scheme to build your application
//app的scheme
sonar.objectivec.appScheme=***
# Scheme to build and run your tests (comment following line of you don't have any tests)
# sonar.objectivec.testScheme=
##########################
# Optional configuration #
##########################
# Encoding of the source code
sonar.sourceEncoding=UTF-8
# JUnit report generated by run-sonar.sh is stored in sonar-reports/TEST-report.xml
# Change it only if you generate the file on your own
# The XML files have to be prefixed by TEST- otherwise they are not processed
# sonar.junit.reportsPath=sonar-reports/
sonar.objectivec.junit.reportsPath=TEST-report.xml
# Cobertura report generated by run-sonar.sh is stored in sonar-reports/coverage.xml
# Change it only if you generate the file on your own
# sonar.objectivec.coverage.reportPattern=sonar-reports/coverage*.xml
sonar.objectivec.cobertura.reportPath=sonar-reports/coverage-SuYun.xml
# OCLint report generated by run-sonar.sh is stored in sonar-reports/oclint.xml
# Change it only if you generate the file on your own
sonar.objectivec.oclint.reportPath=oclint.xml
# Paths to exclude from coverage report (tests, 3rd party libraries etc.)
# sonar.objectivec.excludedPathsFromCoverage=pattern1,pattern2
# sonar.objectivec.excludedPathsFromCoverage=.*Tests.*
# Project SCM settings
sonar.scm.enabled=false
# sonar.scm.url=scm:git:https://...
sonar.host.url=http://localhost:9000
sonar.scm.provider=git
兼容xcode8的脚本:
为了兼容xcode8,需要引入一个脚本run-sonar_v2.1.sh,这个脚本放入项目中的sonar-project同级目录下即可