JenkinsFile添加FindBug和PMD插件

前言

使用Jenkins作为CI、CD工具，以流水线方式运行，需要在构建页面看到FindBug和PMD的分析界面，具体效果如下：

image.png

思路

• Jenkins下载相关依赖插件
• JenkinsFile配置相关插件使用

环境

• Jenkins ver.1.121.2
• FindBugs Plugin ver.4.72
• PMD Plugin ver.3.50
• Static Analysis Collector Plug-in ver.1.52
• Report Info Plugin ver.1.0

涉及到的知识点

1. Jenkins插件的下载与安装

   

   image.png

点击系统配置，在右边选择管理插件，在可选插件中过滤需要安装的插件，勾选后点击安装。

2. JenkinsFile配置

   stage('Check') {
       steps {
           sh "./gradlew findbugsMain"
           sh "./gradlew pmdMain"
           sh "./gradlew check -xtest --info"
       }
      post {
               always {
                   step([$class: 'FindBugsPublisher', pattern: '**/findbugs/main.xml', canRunOnFailed : true])
                   step([$class: 'PmdPublisher', pattern: '**/pmd/main.xml', canRunOnFailed : true])
               }
            }
   }
   

   在代码中添加了以上配置。

   说明：

   • ./gradlew check -xtest —info命令会顺序执行当前项目下所有check相关插件，如checkstyle、findbugs、pmd等，如果前面某个check失败，则会导致build failed，不会生成其他插件的报告信息，所以在之前要执行相关命令或直接分别使用check命令；

   • post执行是跟其位置相关，always属性是代表不管执行steps是否成功都会执行，还有其他success、fail等属性；

   • FindBugsPublisher和PmdPublisher都是触发Jenkins插件的class，这里需要传递生成的报告文档路径，可以是模糊匹配，canRunOnFailed代表失败后时候run该命令；

   • findbugs配置时生成的报告文档只能是xml或者html，插件可分析文档为xml格式，所以需要在build.gradle文件中设置，如下图（ignoreFailures 代表即使出现代码格式错误也可以继续build）：

     tasks.withType(FindBugs) {
         reports {
             xml.enabled true
             html.enabled false
         }
     }
     tasks.withType(Pmd) {
         ignoreFailures = true
         ruleSetFiles =files("${project.rootDir}/config/pmd/PmdRuleSets.xml")
         source 'src/main/java'
         include '**/*.java'
         exclude '**/gen/**'
         reports {
             xml.enabled = true
             html.enabled = true
         }
     }