SonarQube是一个开源的代码管理平台,不仅能够提供代码质量的数据报告,还能够有效的管理代码质量。
Sonar 通过一些小组件可以显示代码测试覆盖率、复杂度、坏味道等各种代码的统计数据报告,并且可以很轻松的进行查找和比较。
Sonar 支持很多种语言,都是通过插件来提供支持,针对各种语言的编译器执行之后产生的日志文件对代码的情况进行分析统计,通过插件转化成统一的数据结构上传至Sonar 平台,随之形成可视化报表数据。
官方提供了一些语言(Java、JavaScript 等)的插件,但是Swift 、 Objective-c等语言的插件需要licence才能使用,而且还不便宜。当然,你只要遵循官方的API,也可以写出平台语言的插件。
For Swift
不过,好消息是,Swift语言 这里已经有人完成了这个工程 sonar-swift ,可以通过这里直接下载到,所以就不用造轮子了。
插件整合了多个工具来完成 Swift 的复杂度、代码规范、测试覆盖率 的统计。所以在整合之前需要对这些工具进行安装。
安装 sonar-scanner
官方提供的sonar 命令行工具,可以通过命令完成日志文件上传。
brew install sonar-scanner
安装 xcpretty
xcpretty为xcodebuild 命令提供的附加功能,可以对整个编译构建的过程中产生的日志进行统计,并生成格式化报表。比如类编译时间,编译的错误等等。
sudo gem install xcpretty
安装 SwiftLint
SwiftLint 是Swift 代码规范的检测工具,集成之后,会在Xcode编译之后提示出代码不符合规范的地方,也能生成相应的Lint报告。 最简单的安装方式就是直接下载 pkg 进行安装
安装 slather
slather 是统计测试覆盖率的工具,可以生成报告日志文件,和静态网页报表对测试覆盖率进行分析。
sudo gem install slather
安装 lizard
lizard 是一个简单的代码复杂度分析工具,支持很多流行的语言,这当然也包括了Swift。工具使用python 开发,所以可以通过下载源码后通过 python build 安装,或者通过pip 来安装。
pip install lizard
到这里所有需要的工具都已经安装完成了。
安装plugin
将sonar-swift 插件 jar 文件下载至$SONARQUBE_HOME/extionsions/plugins 目录,然后重启Sonar 服务,插件安装完成,如果之前已经安装了官方或者其他的Swift 插件,建议删除,以免发生冲突。
通过脚本上传相关数据
将sonar-project.properties 配置文件拷贝至你Swift 项目的根目录,然后根据项目信息进行修改,具体配置属性可以通过Sonar scanner 官方文档进行查看。
最重要的是将sonar.host 修改成你Sonar 服务器的Host地址。
将 run-sonar-swift脚本文件拷贝至你Swift 项目的根目录,直接执行就可以了。
完成
等脚本执行完成之后,打开Sonar 的地址就可以看到你相关项目的统计信息了。