Jenkins集成iOS代码静态分析工具Infer实践

为了提高代码质量，减少coderewview的工作量，我最近调研了iOS代码静态分析工具。主要研究了Infer安装使用工作原理以及如何结合Jenkins生成iOS代码静态分析报告。本文简单介绍了Jenkins和Infer的使用，主要是介绍Jenkins如何使用Infer，以及集成Infer过程中所遇到的问题

Jenkins 概述

Jenkins是最流行的开源免费持续集成工具，他提供了一种易于使用的持续集成系统，使开发者从繁杂的集成（例如app打包）中解脱出来，专注于更为重要的业务逻辑实现上。同时 Jenkins 能实时监控集成中存在的错误，提供详细的日志文件和提醒功能，还能用图表的形式形象地展示项目构建的趋势和稳定性。Jenkins提供了丰富的管理和配置的功能，包括系统配置、管理插件、查询系统信息、系统日志、节点管理、Jenkins命令行窗口、信息统计等功能。而且，Jenkins提供了非常丰富的插件支持，这为提高软件开发效率并保障软件开发质量提供很多便利。

Infer 概述

Facebook的Infer是一个由 OCaml 编写的静态分析工具。他并不是简单纠正一下语法，而是一种代码静态分析工具。它可以在不运行代码（一般开发者的调试方式都是编译、运行，查看结果，然后人工分析代码）的方式下，通过词法分析、语法分析、控制流、数据流分析等技术对程序代码进行扫描，来验证代码是否存在问题或满足技术指标。Infer 可以分析 Objective-C， Java 或者 C 代码，重点作用于分析APP（Android/iOS）项目，报告潜在的问题。Infer能将代码分解，小范围分析后再将结果整合在一起，兼顾分析的深度和速度，支持增量及非增量分析。

Infer原理

下面的图描述了Infer的工作流：

图片

Infer run的时候分两个阶段：

捕获阶段: Infer通过编译工具把代码转译为Infer自己的中间语言来做静态分析。转译依赖于编译，转译之后的中间文件存储在infer-out 文件夹中。
分析阶段:
在这个阶段，infer-out文件夹下的中间件文件会被Infer分析，当检测到一个函数错误的时候，会暂停对这个函数的分析，但是不会停止对其他函数的分析。当你修复完发现的错误的后，再次运行Infer可以检查bug是否被修复。最终Infer的分析结果会保存在infer-out/report.txt文件中。可用通过Infer 命令转成html格式和xml格式。
object-c中Infer检测的问题类型都有哪些？
1. 内存泄露，循环引用
2. 变量过早设置nil导致的问题
3. Parameter not null checked
4. Ivar not null checked

Infer 安装

Mac OS 系统通过brew安装：

brew install infer

Infer 使用

针对project项目：

//xxxApp 是你project中App target名称
infer -- xcodebuild -target xxxApp -configuration Debug -sdk iphonesimulator

针对workspace工程项目

infer -- xcodebuild -workspace 你的workspac名称.xcworkspace  -scheme 工程中scheme名称 -configuration Debug -sdk iphonesimulator

可以指定分析哪些文件，即whitelist和blacklist

项目根目录下创建一个‘.inferconfig’的文件，格式如下：

{
    "infer-whitelist-path-regex":[
    ],
    "infer-blacklist-path-regex":[
     "Pods/AFNetworking",
     "Pods/SDWebImage"
    ]
}

导出生成html的命令，infer运行完成之后再终端输入如下命令：
```
infer-explore --html
```

这之后会生成infer-out/report.html文件

生成pmd xml文件方便Jekins 的pmd插件展示结果。

infer --pmd-xml  -- xcodebuild -workspace 你的workspac名称.xcworkspace  -scheme 工程中scheme名称 -configuration Debug -sdk iphonesimulator

这个命令执行的时候可能会出错，要求你安装pyhton的lxml 库，这时在终端输入下面的命令即可安装lxml:

STATIC_DEPS=true sudo pip install lxml

安装lxml成功后，再次运行生成xml命令，最终会在infer-out文件加下生成report.xml文件。

Infer 非增量分析命令

infer --reactive -- xcodebuild -target xxxApp -configuration Debug -sdk iphonesimulator

Jenkins集成Infer步骤

Jenkins 构建项目的不是本文的重点，这里不再叙述，主要写一下Infer脚本配置。

Jenkins构建Infer脚本

首先进入项目的配置界面，选择构建栏目，点击增加构建步骤，具体如下图：

构建1.png

选择Execute shell , 输入如下图所示的命令：

构建2.png

这些命令就是分析工程内文件，最终通过infer 生成xml文件供Jenkins PMD 分析展示分析报告。

PMD 插件设置

首先Jenkins需要安装PMD插件，这个网上搜索教程安装即可。其次在项目配置里面配置PMD 具体如下图所示：

PMD1.png

在构建后操作栏目下面，代价增加构建后操作，选择Publish PMD analysis results 选项，结果如下图：

PMD2.png

输入 report.xml路径，如下图：

PMD3.png

最后点击保存。回到项目主页，点击立即构建。构建完成后，最终在会有PMD Warings 菜单栏，如下图所示：

result1.png

如上图所示PMD Thrend图表可以看到项目多次构建后代码质量的趋势。这里就可以看出代码质量近期内的波动。

点击PMD Warnings 可以看到本次构建的详细错误情况，结果如下图：

result2.png

这里我可以看到总的分析结果，Detail 栏目下各个选项能够看到错误所在的文件，以及错误类型等等。具体说Detail下各个栏目的作用

Files 是发生错误的文件列表
People是git代码库贡献的人员
Types 检查出的代码错误类型
Warnings是警告
Origin定位错误产生的开发人员的提交的commit ID
Details 具体产生bug代码的位置，能够定位代码到行。
New 展示新增bug列表
Fix 展示已修复bug问题列表