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做静态代码分析

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