OClint实现代码静态分析(IOS)

2018年4月24日
一.远端垃圾桶上用jenkins运行静态分析脚本老是不成功 【但用终端命令运行脚本就ok:sh PMDOclint.sh】
1.报如下错误:
env: ruby_executable_hooks: No such file or directory
2.原因分析:
我是用hu317登录,用如下命令安装的sudo gem install -n /usr/local/bin xcpretty
因为用终端运行运行脚本正常,应该不是脚本的问题(其实终端用户也是hu317);
但jenkins构建用的是jenkins账号,xcpretty命令里面有些依赖命令可能用的是相对路径,导致用jenkins执行时报命令找不到错误。【不是所有命令都有问题,oclint就正常】


image.png

3.解决:指定对应路径下的命令(用wrappers 参考这个链接

export xcpretty=/Users/hu317/.rvm/gems/ruby-2.3.0/wrappers/xcpretty

#!/bin/bash

function oclintForProject () {
# 指定编码
export LANG="zh_CN.UTF-8"
export LC_COLLATE="zh_CN.UTF-8"
export LC_CTYPE="zh_CN.UTF-8"
export LC_MESSAGES="zh_CN.UTF-8"
export LC_MONETARY="zh_CN.UTF-8"
export LC_NUMERIC="zh_CN.UTF-8"
export LC_TIME="zh_CN.UTF-8"
export xcpretty=/Users/hu317/.rvm/gems/ruby-2.3.0/wrappers/xcpretty
export LC_ALL=

myworkspace=317hu.xcworkspace # 替换workspace的名字
myscheme=317hu # 替换scheme的名字

# 清除上次编译数据
if [ -d ./derivedData ];
then
echo '-----清除上次编译数据derivedData-----'
rm -rf ./derivedData
fi

xcodebuild -workspace $myworkspace -scheme $myscheme clean
#xcodebuild clean

# 生成编译数据
xcodebuild -workspace $myworkspace -scheme $myscheme -configuration Debug | $xcpretty -r json-compilation-database -o compile_commands.json

if [ -f ./compile_commands.json ]
then
echo '-----编译数据生成完毕-----'
else
echo "-----生成编译数据失败-----"
return -1
fi

# 生成报表
/usr/local/bin/oclint-json-compilation-database -e Pods -- \
-report-type pmd -o pmd.xml \
-rc LONG_LINE=200 \
-disable-rule ShortVariableName \
-disable-rule ObjCAssignIvarOutsideAccessors \
-disable-rule AssignIvarOutsideAccessors \
-max-priority-1=100000 \
-max-priority-2=100000 \
-max-priority-3=100000

if [ -f ./pmd.xml ]
then
rm compile_commands.json
echo '-----分析完毕-----'
return 0
else
echo "-----分析失败-----"
return -1
fi
}

oclintForProject

效果:


image.png

2017年11月7日

前提条件先安装如下两个命令 oclint xcpretty

#! /bin/sh
if which oclint 2>/dev/null; then
    echo 'oclint exist'
else
    brew tap oclint/formulae
    brew install oclint
fi
if which xcpretty 2>/dev/null; then
    echo 'xcpretty exist'
else
    gem install xcpretty
fi

一.xcode9 + Cocoapods项目 实现代码静态分析
方法1:直接终端命令运行。【比较耗时大概要半个小时上下】

1.直接切换到工程目录,运行如下命令。 报如下(oclint: error: one compiler command contains multiple jobs:)

myworkspace=317hu.xcworkspace
myscheme=317hu
xcodebuild -workspace $myworkspace -scheme $myscheme clean&&
xcodebuild -workspace $myworkspace -scheme $myscheme \
-configuration Debug \
| xcpretty -r json-compilation-database -o compile_commands.json&&
oclint-json-compilation-database -e Pods -- \
-report-type html -o oclint_result.html \
-rc LONG_LINE=200 \
-max-priority-1=100000 \
-max-priority-2=100000 \
-max-priority-3=100000; \
rm compile_commands.json;
if [ -f ./oclint_result.html ]; then echo '-----分析完毕-----'
else echo "-----分析失败-----"; fi

解决:相关配置COMPILER_INDEX_STORE_ENABLE 全部设置为NO
1.工程设置


image.png

2.Podfile 文件设置

post_install do |installer|
    installer.pods_project.targets.each do |target|
        target.build_configurations.each do |config|
            config.build_settings['COMPILER_INDEX_STORE_ENABLE'] = "NO"
        end
    end
end
image.png

3.修改好后再次运行如上脚本 大概30分钟时间,工程目录下面多了如下分析文件oclint_result.html


image.png

二.jenkins+OClint 实现代码静态分析
1.效果如下 (首次启动花时间用了44分钟,第二次就快了)


image.png

image.png

2.实现
第一步jenkins安装PMD Plugin插件
第二步 编写如下脚本
【如果报/PMDOclint.sh: line 18: xcpretty: command not found xcodebuild: error: 'Gold.xcworkspace' does not exist.】
像我如下代码用全路径即可
/usr/local/bin/xcpretty
/usr/local/bin/oclint

#!/bin/bash
function oclintForProject () {
# 指定编码
export LANG="zh_CN.UTF-8"
export LC_COLLATE="zh_CN.UTF-8"
export LC_CTYPE="zh_CN.UTF-8"
export LC_MESSAGES="zh_CN.UTF-8"
export LC_MONETARY="zh_CN.UTF-8"
export LC_NUMERIC="zh_CN.UTF-8"
export LC_TIME="zh_CN.UTF-8"
export LC_ALL=

    myworkspace=317hu.xcworkspace # 替换workspace的名字
    myscheme=317hu-DEV # 替换scheme的名字

    # 清除上次编译数据
    if [ -d ./derivedData ];
    then
        echo '-----清除上次编译数据derivedData-----'
        rm -rf ./derivedData
    fi

    xcodebuild -workspace $myworkspace -scheme $myscheme clean
    #xcodebuild clean

    # 生成编译数据
    xcodebuild -workspace $myworkspace -scheme $myscheme -configuration Debug | /usr/local/bin/xcpretty -r json-compilation-database -o compile_commands.json

    if [ -f ./compile_commands.json ]
    then
        echo '-----编译数据生成完毕-----'
    else
        echo "-----生成编译数据失败-----"
        return -1
    fi

    # 生成报表
    /usr/local/bin/oclint-json-compilation-database -e Pods -- \
    -report-type pmd -o pmd.xml \
    -rc LONG_LINE=200 \
    -disable-rule ShortVariableName \
    -disable-rule ObjCAssignIvarOutsideAccessors \
    -disable-rule AssignIvarOutsideAccessors \
    -max-priority-1=100000 \
    -max-priority-2=100000 \
    -max-priority-3=100000

    if [ -f ./pmd.xml ]
    then
        rm compile_commands.json
        echo '-----分析完毕-----'
        return 0
    else 
        echo "-----分析失败-----"
        return -1
    fi
}

oclintForProject

第三步(别忘了工程属性参照终端命令方法1修改)

jenkins如下配置即可
image.png
# OCLint
cd ${WORKSPACE}
echo "-----分析${WORKSPACE}-----}"
bash $JENKINS_HOME/PMDOclint.sh

三.补充

1.OCLint安装 有时候网络问题导致会安装失败(多试几次会成功的,我早上试了一次就安装ok了,昨天下午试了N次都不行)
image.png

参考

1:https://github.com/fastlane/fastlane/issues/742

Finally, I solved this issue. I set the command´s path in the script (/usr/local/bin) and everything works fine.

Thanks a lot @xfreebird @KrauseFx

2:
iOS使用OCLint做静态代码分析

如果您发现本文对你有所帮助,如果您认为其他人也可能受益,请把它分享出去。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容

  • 大致的流程是使用Jenkins来进行持续构建,执行OCLint来进行代码分析,然后将OCLint生成的分析报告传给...
    孙博士阅读 2,550评论 0 7
  • 初识OCLint OCLint是一个静态代码分析工具,提高质量和减少缺陷通过检查C 、C++ 和Objective...
    這Er阅读 14,342评论 97 61
  • 那是一汪沼泽 平静的外表 有着魔鬼般的内在 那是一汪沼泽 偶尔冒个泡 显示出峥嵘的面貌 那是一汪沼泽 散发出淡香 ...
    含糖阅读 361评论 0 0
  • 问题:一份表单调查问卷需要出现多个单选按钮怎么实现? 答案:主要在于name的属性值,例如:第一个单选按钮所属的选...
    元气静静的日常阅读 1,074评论 0 0
  • 山径拾红叶, 信手两行书。 遥望南归雁, 谁识白云初?
    文海观心阅读 182评论 0 0