360Qtest专栏 [Jenkins 新插件] 兼容阿里开发手册 (P3C) 的火线插件安装使用教程

丁老九 · 2017年12月04日 · 最后由丁老九回复于 2017年12月08日 · 2618 次阅读

火线（Fireline）的 Jenkins 官方插件已经上线，目前火线不仅能检查出安卓代码中的安全类问题和内存泄露问题，还兼容了阿里开源的 Java 开发规约（P3C 项目），本文将以教程的形式帮助大家了解如何在 Jenkins 中使用火线插件做静态代码扫描。

提示：如果您是第一次使用 Jenkins，请先前往文章[新手教程] Jenkins 下载安装配置教程

Jenkins 安装火线（Fireline）插件

点击左上角的Jenkinslogo，依次点击系统管理->管理插件，
在插件页面点击可选插件按钮，
在过滤栏输入fireline，勾选查询出来的Fireline Plugin插件，点击直接安装。
等待安装成功后，点击返回首页，开始配置。

Jenkins 配置火线

点击创建一个新任务，输入任务名称，选择构建一个自由风格的软件项目，点击确定。
在配置页面的General栏输入项目名称，我这里输入的CodeScan。
在 “源码管理” 栏配置你想扫描的代码，我这里输入的是火线专属测试项目的 git 地址：https://github.com/ariesliu/TestCasesProject
跳过构建触发器和构建环境配置栏，在构建栏点击增加构建步骤，在下拉列表中选择Execute FireLine选项。
“构建” 栏会出现火线相关的配置，报告路径会有一个默认的地址，不需要输入，默认报告会放在你的个人用户的report目录下，如图所示。配置完成，点击保存按钮。
保存成功后，在调转后的页面点击立即构建。
此时页面会看到有一个任务正在执行，点击任务编号，此处为#1。
在此次任务的详情列表点击Console Output栏，可以看到任务的执行过程。等待任务执行完成后，可以看到火线报告的路径，如下图所示。
打开该目录的testReport.html，可以看到本次的代码扫描结果。

在 Jenkins 中直接查看火线扫描结果

在以上所述的配置完成后，我们查看扫描结果报告需要每次自己手动打开文件夹，比较麻烦。我们可以通过一个配置，实现在 Jenkins 中直接查看火线的扫描结果。
首先我们要安装一个新的插件HTML Publisher plugin，再次去往系统管理-> 管理插件 ->可选插件，搜索HTML Publisher plugin，点击直接安装，安装成功后返回。
回到我们的项目CodeScan进行配置，这次只需要配置构建后操作栏，点击增加构建后操作步骤下拉框，选择Publish HTML reports选项。
点击增加按钮。
在HTML directory to archive栏输入火线报告的生成路径，即在构建栏中火线默认的结果报告路径，复制过来即可。在Index page[s]栏输入testReport.html，这是火线默认生成的 HTML 报告的名称。这两项配置完成后点击保存。
此时还没有完成，因为火线的 HTML 报告用了 JS 进行更好的效果展示，我们需要在 Jenkins 中配置运行执行 JS 脚本，否则火线报告在 Jenkins 中的展示会错乱。
前往系统管理->脚本命令行，在文本框中输入System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")这行代码，点击右下角的运行按钮。
此时回到我们的项目CodeScan，点击立即构建，构建完成后就可以点击HTML Report栏直接查看火线报告了。
Jenkins 中的火线结果报告。火线将比较严重的问题，例如安全类问题列为最高级别Block级别，内存泄露问题列为风险级别，代码规范类问题（阿里 Java 规约）列为警告和优化级别。更多级别详情可参考火线官网的规则文档。
点击问题详情列表栏，可以看到问题的详情。点击每一行最右侧的加号图标，可以看到错误的代码片段。
在Search栏输入p3c关键字，可以过滤出所有阿里巴巴开发手册 (P3C) 的规则发现的问题。