一.run-sonar-swift脚本
sonar-swift官方提供了一个专门用于代码扫描的脚本,无需我们自己去编写脚本处理编译工程,输出编译log文件等操作,👉传送门。
这个脚本需要搭配sonar-prooject.properties文件来使用。先看一下脚本关键内容;
vflag=""
nflag=""
unittests=""
swiftlint="on"
tailor="on"
lizard="on"
oclint=""
infer="on"
fauxpas=""
sonarscanner=""
sonarurl="http://localhost:9000"
sonarlogin="admin"
sonarpassword="123456"
这一部份是指你需要哪些插件参与扫描过程,如果有需要就赋值为on
,前提是你有安装这些插件,其次就是你需要上传的地址以及登录信息。
# Source directories for .swift files
srcDirs=''; readParameter srcDirs 'sonar.sources'
# The name of your application scheme in Xcode
appScheme=''; readParameter appScheme 'sonar.swift.appScheme'
# The app configuration to use for the build
appConfiguration=''; readParameter appConfiguration 'sonar.swift.appConfiguration'
# The name of your test scheme in Xcode
testScheme=''; readParameter testScheme 'sonar.swift.testScheme'
# The name of your other binary files (frameworks)
binaryNames=''; readParameter binaryNames 'sonar.coverage.binaryNames'
# Get the path of plist file
plistFile=`xcodebuild -showBuildSettings -project "${projectFile}" | grep -i 'PRODUCT_SETTINGS_PATH' -m 1 | sed 's/[ ]*PRODUCT_SETTINGS_PATH = //'`
# Number version from plist if no sonar.projectVersion
numVersionFromPlist=`defaults read "${plistFile}" CFBundleShortVersionString`
# Read destination simulator
destinationSimulator=''; readParameter destinationSimulator 'sonar.swift.simulator'
# Read tailor configuration
tailorConfiguration=''; readParameter tailorConfiguration 'sonar.swift.tailor.config'
# The file patterns to exclude from coverage report
excludedPathsFromCoverage=''; readParameter excludedPathsFromCoverage 'sonar.swift.excludedPathsFromCoverage'
# Skipping tests
skipTests=''; readParameter skipTests 'sonar.swift.skipTests'
这一部份是你的项目工程信息,比如你要检测的文件夹srcDirs
,项目的SchemeappScheme
等内容,你可以选择直接填在脚本文件中,也可以填在sonar-prooject.properties里面,注意看readParameter srcDirs 'sonar.sources'
这一句,它的意思就是如果这里没填写,就会读取sonar-prooject.properties文件中的sonar.sources
字段。
以下是sonar-prooject.properties中必填的几个选项
sonar.swift.project=TestDemo.xcodeproj
sonar.swift.workspace=TestDemo.xcworkspace
sonar.swift.appScheme=TestDemo
sonar.projectKey=TestDemo //用于sonar平台获取项目的key
sonar.projectName=TestDemo //用于sonar平台展示项目名称
sonar.sourceEncoding=UTF-8
sonar.language=swift,objc
sonar.sources=ComponentModules
sonar.projectVersion=1.0.2
如果你的sonar-prooject.properties文件中已经填写了这些内容,就无需在run-sonar-swift脚本中进行改动。
继续看run-sonar-swift脚本;
# Objective-C code detection
hasObjC="yes"
compileCmdFile=compile_commands.json
minimumSize=3
actualSize=$(stat -f%z "$compileCmdFile")
if [ $actualSize -ge $minimumSize ]; then
hasObjC="yes"
fi
如果你的项目是混编,一定要在这个地方进行设置,不然就会跳过后续的oc代码检测。OCLint,FauxPas这两个插件是专门检测OC代码的,如果这个地方不设置为yes
便会跳过。
二.坑人的-ivfsstatcache
如果你突然发现此前跑的好好的OCLint,infer等插件突然不好好工作了,这个就是罪魁祸首,因为clang编译器现在输出的文件会新增一个-ivfsstatcache
字段,这些通过compile_commands.json文件来分析语法问题的插件就会无法识别,这是一个神坑,查了好久资料才找到解决办法,使用脚本删除所有这个字段对应的key-value即可。
sed 's/-ivfsstatcache [^ ]*//g' < compile_commands.json > icompile_commands.json
mv icompile_commands.json compile_commands.json
三.拉取sonar平台的数据
sonar平台提供了对外的api接口,但是无法通过token进行数据的拉取,即使填对了token也不行,因为提交token的时候需要进行处理,需要将token后面加一个:
,然后整体进行base64编码,得出结果再在前面加一个basic才可以,例子如下:
curl -G -H'Authorization:basic 你的token+:然后再进行base64编码' http://localhost:9000/api/measures/component\?component\=TestDemo\&metricKeys\=ncloc
这样才能正常的进行数据拉取。