前提
需要一个平台把代码的相关指标(格式检查,覆盖率等)展示出来,并跟踪变化
使用环境
-
a Mac with Xcode 7 or +
-
数据库(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;
截图如下:


相关软件

-
SonarQube (http://www.sonarqube.org/downloads/)
我使用的是5.6版本
-
SonarQube Runner installed (HomeBrew installed and brew install sonar-runner)
Screen Shot 2016-07-25 at 3.07.27 PM.png
-
SwiftLint (brew install swiftlint)

- Slather (gem install slather). Version 2.1.0 or above.

-
lizard
(PIP install)
Screen Shot 2016-07-25 at 2.33.16 PM.png
(sudo pip install lizard)

-
xcpretty
xcpretty_1.png
![Uploading sonar_1_822030.png . . .]
运行sonar
- 解压sonarqube-5.6.zip
- 修改sonarqube-5.6中conf文件夹下的sonar.properties
# User credentials.
# Permissions to create tables, indices and triggers must be granted to JDBC user.
# The schema must be created first.
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
#----- Embedded Database (default)
# H2 embedded database server listening port, defaults to 9092
#sonar.embeddedDatabase.port=9092
#----- MySQL 5.6 or greater
# Only InnoDB storage engine is supported (not myISAM).
# Only the bundled driver is supported. It can not be changed.
sonar.jdbc.url=jdbc:mysql://localhost:3307/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
- 进入
sonarqube-5.6/bin/macosx-universal-64/
下 ./sonar.sh start
- 浏览器访问 http://localhost:9000
- 访问后出现如下页面:表示安装成功

swift sonar 插件
-
关闭sonar 执行
./sonar.sh stop
-
因为插件对于校验规则的支持有误,使用以下地址进行获取https://github.com/caiwenshu/sonar-swift/tree/master/jar
-
拷贝插件(backelite-sonar-swift-plugin-0.2.3.jar) 到 sonarqube-5.6/extensions/plugins/下
-
重新启动sonar 执行
./sonar.sh start
-
登录sonar 账号:
admin
密码:admin
-
访问页面出现以下内容表示插件安装成功
swift_1.png
项目提交结果到sonar
- 下载相关配置文件https://github.com/caiwenshu/sonar-swift/tree/master/files
- 在项目根目录创建
run-sonar.sh
和sonar-project.properties
- 编辑
sonar-project.properties
文件中跟项目相关内容
##########################
# Required configuration #
##########################
sonar.projectKey=swift-rosetta-sonarqube-runner
sonar.projectName=rosetta analyzed with the SonarQube Runner
sonar.projectVersion=2.1.3
sonar.language=swift
# Project description
sonar.projectDescription=rosetta analyzed with the SonarQube Runner
# Path to source directories
sonar.sources=RosettaTobMainApp
# Path to test directories (comment if no test)
#sonar.tests=testSrcDir
# Destination Simulator to run tests
# As string expected in destination argument of xcodebuild command
# Example = sonar.swift.simulator=platform=iOS Simulator,name=iPhone 6,OS=9.2
sonar.objectivec.simulator=platform=iOS Simulator,name=iPhone 6,OS=9.3
# 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=RosettaTobMainApp.xcodeproj
sonar.objectivec.workspace=RosettaTobMainApp.xcworkspace
# Scheme to build your application
sonar.objectivec.appScheme=RosettaTobMainApp
# Scheme to build and run your tests (comment following line of you don't have any tests)
sonar.objectivec.testScheme=RosettaTobMainApp
##########################
# 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/
# 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
# 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=sonar-reports/oclint.xml
# Paths to exclude from coverage report (tests, 3rd party libraries etc.)
# sonar.objectivec.excludedPathsFromCoverage=pattern1,pattern2
#sonar.objectivec.excludedPathsFromCoverage=.*Tests.*
sonar.objectivec.excludedPathsFromCoverage=.*Tests.*,*.h,*.m
# Project SCM settings
# sonar.scm.enabled=true
# sonar.scm.url=scm:git:https://...
- 运行项目根目录的
./run-sonar.sh -v
- 结果如下

Jenkins集成
在Jenkins的项目配置流中执行 ./run-sonar.sh -v
即可
参考资料
swift插件地址:https://github.com/Backelite/sonar-swift
SonarQube环境的安装配置 http://www.cnblogs.com/huey/p/4340850.html
遇到问题

- xcodebuild 执行失败


- 如果遇到swiftlint不能上传的问题。需要修改sonar-swift jar包中的profile-swiftlint.xml 和 rules.json文件



网友评论