目录
- 技术方案
- 环境准备
- 扫描器配置
- 项目配置
- SonarQube配置
- jenkins接入
- 一些坑
技术方案
Sonar本身有对OC的代码扫描插件——SonarCFamily，但是是收费的。出于成本考虑，我们选用了Backelite团队出的sonar-oc插件（https://github.com/Backelite/sonar-objective-c）。
该插件支持情况如下：
| 功能 | 是否支持 | 细节 |
|---|---|---|
| Complexity-复杂性 | YES | 可支持Lizard的复杂性分析 |
| Design-设计 | NO | |
| Documentation-文档 | YES | |
| Duplications-重复性 | YES | |
| Issues-代码规则 | YES | 支持 OCLint:（71个规则） 和 Faux Pas（102个规则） |
| Size-尺寸 | YES | |
| Tests-测试 | YES | 以前是使用xctool，现在已变成 xcodebuild + xcpretty |
| Code coverage-代码覆盖率 | YES | Xcode7之前的版本使用gcovr，Xcode7以后选用 slather |
环境准备
根据插件官方文档给出的环境清单配置环境即可
- 装有Xcode、Homebrew、pip、ruby2.4的Mac
- 可访问的SonarQube
- Sonar-Scanner（ci上的版本3.0.3.778）
brew install sonar-scanner
- xcpretty，安装步骤如下
git clone [https://github.com/Backelite/xcpretty.git](https://github.com/Backelite/xcpretty.git) --找一个文件夹存放xcpretty的源码
cd xcpretty
git checkout fix/duration_of_failed_tests_workaround
gem build xcpretty.gemspec
sudo gem install --both xcpretty-0.2.2.gem
brew tap oclint/formule --添加第三方仓库
brew install oclint
gem install slather --如果ruby版本低于2.1.0，则需要更新ruby
根据上面给出的命令运行一次即可，环境正确的话，基本不会报错。（运行命令时由于要连接到github，所以在公司运行需要支持科学上网）
扫描器配置
上述安装完成后，需要修改Sonar-Scanner的配置以连接SonarQube。
由于我们是用homebrew安装的Sonar-Scanner，配置文件路径为/usr/local/Cellar/sonar-scanner/3.0.3.778/libexec/conf/sonar-scanner.properties
sonar-scanner.properties
项目配置
在需要执行扫描的项目根目录下，放置两个文件
- sonar-project.properties
- run-sonar.sh
sonar-project.properties
sonar-project.properties文件是关于项目扫描的配置，一般放在项目的根目录下。
sonar-project.properties填写说明
run-sonar.sh
这个同样是放置在项目的根目录下，是执行扫描的脚本。
在https://github.com/Backelite/sonar-objective-c可下载，但是使用时需要进行一定的调整才能正确运行。
SonarQube上的配置
将插件的jar包放置到sonar安装目录下存放插件的文件夹后重启sonarqube即可。（插件获取地址）
- 在Mac上使用brew安装的sonar插件路径：sonar/libexec/extensions/plugins
- 直接安装的sonar插件路径：sonar所在目录/libexec/extensions/plugins
注意：该插件的0.6.1在SonarQube6.3.1+MySQL上可正常解析，但在6.5版本上就会冲突导致SonarQube启动失败。
Jenkins接入
1、在jenkins执行的机器上，放置好run-sonar.sh脚本和sonar-project.properties文件，在脚本运行的时候需要拉取这两个文件到项目目录下。注意：构建前需设置好sonar-project.properties中的ProjectKey。
2、执行脚本如下
export LC_ALL="en_US.UTF-8"
# 加载终端配置
source ~/.bash_profile
source ~/.bashrc
source ~/.zprofile
# 首次执行需要运行pod install
if [ ! -e $WORKSPACE/PPMoneyPro.xcworkspace ]
then
pod install
fi
# 将sonar扫描所需文件复制到对应文件夹
if [ ! -e $WORKSPACE/run-sonar.sh ]
then
cp /${scriptdir}/run-sonar.sh $WORKSPACE
fi
if [ ! -e $WORKSPACE/sonar-project.properties ]
then
cp /${scriptdir}/sonar-project.properties $WORKSPACE
fi
# 执行扫描
sh run-sonar.sh -v
# 跑到底，就说明执行成功了
echo "Run_Success"
一些坑
直接运行run-sonar.sh执行通过，通过jenkins运行脚本就报错
即使是同一台主机，jenkins的shell执行环境和终端可能有一定差异，可通过在执行脚本前加载本地终端的环境配置解决。
网友评论