Docker+Jenkins持续集成环境（3）集成PMD、FindBugs、Checkstyle静态代码检查工具并邮件发送检查结果...

最新推荐文章于 2021-03-19 23:46:02 发布
最新推荐文章于 2021-03-19 23:46:02 发布
阅读量272 收藏
点赞数
文章标签： 运维 java

为了规范代码，我们一般会集成静态代码检测工具，比如PMD、FindBugs、Checkstyle，那么Jenkins如何集成这些检查工具，并把检查结果放到构建邮件里呢？

今天做了调研和实现，过程如下

首先看，最终效果：

构建结果邮件

1.pom.xml

build。plugins 增加：

<plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <finalName>${project.artifactId}-${project.version}</finalName>
                            <appendAssemblyId>false</appendAssemblyId>
                            <descriptors>
                                <descriptor>src/assembly/assembly-descriptor.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>findbugs-maven-plugin</artifactId>
                <version>3.0.5</version>
                <configuration>
                    <threshold>High</threshold>
                    <effort>Default</effort>
                    <findbugsXmlOutput>true</findbugsXmlOutput>
                    <findbugsXmlWithMessages>true</findbugsXmlWithMessages>
                    <xmlOutput>true</xmlOutput>
                    <formats><format>html</format></formats>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-pmd-plugin</artifactId>
                <version>3.8</version>
            </plugin>

reporting 增加：

    <reporting>
        <plugins>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>3.0.0</version>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>checkstyle</report>
                        </reports>
                    </reportSet>
                </reportSets>
            </plugin>

            <!--pmd-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-pmd-plugin</artifactId>
                <configuration>
                    <linkXref>true</linkXref>
                    <sourceEncoding>utf-8</sourceEncoding>
                    <minimumTokens>100</minimumTokens>
                    <targetJdk>1.8</targetJdk>
                    <excludes>
                        <exclude>**/*Bean.java</exclude>
                        <exclude>**/generated/*.java</exclude>
                    </excludes>
                    <excludeRoots>
                        <excludeRoot>target/generated-sources/stubs</excludeRoot>
                    </excludeRoots>
                </configuration>
                <version>3.8</version>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jxr-plugin</artifactId>
                <version>2.5</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-report-plugin</artifactId>
                <version>2.14.1</version>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>cobertura-maven-plugin</artifactId>
            </plugin>

        </plugins>
    </reporting>

2 jenkins设置

2.1 安装相关插件

直接搜索安装：

  • Checkstyle Plug-in
  • PMD Plug-in
  • FindBugs Plug-in
  • Static Analysis Collector Plug-in

邮件插件安装：

  • Email Extension Plugin
  • Email Extension Template Plugin

2.2 项目配置

maven构建Goals设置为：
pmd:pmd checkstyle:checkstyle findbugs:findbugs package -DskipTests

在构建设置里，勾上

  • Publish Checkstyle analysis results
  • Publish FindBugs analysis results
  • Publish PMD analysis results

构建后操作，添加Publish combined static analysis results，默认设置即可。

2.3 邮件配置

首先在系统设置里，配置Extended E-mail Notification部分

设置：

  • Default Subject ： 自动构建通知：$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!
  • Default Content： ${JELLY_SCRIPT, template="analysis.jelly"}

剩下的自己配置下SMTP和收件人。

这里邮件内容使用analysis.jelly，使用jelly script，系统没有这个模板，我们需要配置一下：

打开系统管理-Managed files，增加一个Extended Email Publisher Jelly Template

模板文件如下，该模板修改自官方的模板，做了一定的本地化和样式调整：

<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define">
  <html>
    <head>
      <title>${project.name}</title>
      <style>
        body table, td, th, p, h1, h2 {
        margin:0;
        font:normal normal
        100% Georgia, Serif;
        }
        h1, h2 {
        border-bottom:dotted 1px #999999;
        padding:5px;
        margin-bottom:10px;
        color: #000000;
        font: normal bold 130%
        Georgia,Serif;
        background-color:#f0f0f0;
        }
        tr.gray {
        background-color:#f0f0f0;
        }
        h2 {
        padding:5px;
        margin-top:5px;
        margin-bottom:5px;
        font: italic bold 110% Georgia,Serif;
        }
        .bg2 {
        color:black;
        background-color:#E0E0E0;
        font-size:110%
        }
        th {
        font-weight: bold;
        }
        tr, td, th {
        padding:2px;
        }
        td.test_passed {
        color:blue;
        }
        td.test_failed {
        color:red;
        }
        td.center {
          text-align: center;
        }
        td.test_skipped {
        color:grey;
        }
        .console {
        font: normal normal 90% Courier New,
        monotype;
        padding:0px;
        margin:0px;
        }
        div.content, div.header {
        background: #ffffff;
        border: dotted
        1px #666;
        margin: 2px;
        content:
        2px;
        padding: 2px;
        }
        table.border, th.border, td.border {
        border:
        1px solid black;
        border-collapse:collapse;
        }
        .round_border{margin-bottom:5px;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px;margin-top:0;font-size:14px;padding:6px;border:1px solid #ccc}
.status{background-color:<j:choose><j:when test="${build.result=='SUCCESS'}">green</j:when><j:otherwise>red</j:otherwise></j:choose>;font-size:28px;font-weight:bold;color:white;height:52px;margin-bottom:18px;text-align:center;vertical-align:middle;border-collapse:collapse;background-repeat:no-repeat}
.status .info{color:white!important;text-shadow:0 -1px 0 rgba(0,0,0,0.3);font-size:32px;line-height:36px;padding:8px 0}
      </style>
    </head>
    <body>
      <div class="status">
          <p class="info">${project.name}构建<j:choose><j:when test="${build.result=='SUCCESS'}">成功</j:when><j:otherwise>失败</j:otherwise></j:choose></p>
      </div>
      <div class="header round_border">
        <j:set var="spc" value="  " />
        <h1>基本信息</h1>
        <table>
          <tr>
            <td>构建地址</td>
            <td>
              <a href="${rooturl}${build.url}">${rooturl}${build.url}</a>
            </td>
          </tr>
          <tr>
            <td>项目:</td>
            <td>${project.name}</td>
          </tr>
          <tr>
            <td>构建时间:</td>
            <td>${it.timestampString}</td>
          </tr>
          <tr>
            <td>构建耗时:</td>
            <td>${build.durationString}</td>
          </tr>
          <tr>
            <td>构建原因:</td>
            <td>
              <j:forEach var="cause" items="${build.causes}">${cause.shortDescription}
              </j:forEach>
            </td>
          </tr>
          <tr>
            <td>构建描述:</td>
            <td>${build.description}</td>
          </tr>
          <tr>
            <td>构建服务器:</td>
            <td>
              <j:choose>
                <j:when test="${build.builtOnStr!=''}">${build.builtOnStr}</j:when>
                <j:otherwise>master</j:otherwise>
              </j:choose>
            </td>
          </tr>
        </table>
      </div>

      <!-- HEALTH TEMPLATE -->
      <div class="content round_border">
        <j:set var="healthIconSize" value="16x16" />
        <j:set var="healthReports" value="${project.buildHealthReports}" />
        <j:if test="${healthReports!=null}">
          <h1>构建健康报告</h1>
          <table>
            <tr>
              <th>W</th>
              <th>Description</th>
              <th>Score</th>
            </tr>
            <j:forEach var="healthReport" items="${healthReports}">
              <tr>
                <td>
                  <img
                    src="${rooturl}${healthReport.getIconUrl(healthIconSize)}" />
                </td>
                <td>${healthReport.description}</td>
                <td>${healthReport.score}</td>
              </tr>
            </j:forEach>
          </table>
          <br />
        </j:if>
      </div>

      <!-- CHANGE SET -->
      <div class="content round_border">
        <j:set var="changeSet" value="${build.changeSet}" />
        <j:if test="${changeSet!=null}">
          <j:set var="hadChanges" value="false" />
          <a href="${rooturl}${build.url}/changes">
            <h1>代码变更记录</h1>
          </a>
          <j:forEach var="cs" items="${changeSet.logs}"
            varStatus="loop">
            <j:set var="hadChanges" value="true" />
            <h2>${cs.msgAnnotated}</h2>
            <p>
              by <em>${cs.author}</em>
            </p>
            <table>
              <j:forEach var="p" items="${cs.affectedFiles}">
                <tr>
                  <td width="10%">${spc}${p.editType.name}</td>
                  <td>
                    <tt>${p.path}</tt>
                  </td>
                </tr>
              </j:forEach>
            </table>
          </j:forEach>
          <j:if test="${!hadChanges}">
            <p>无变更</p>
          </j:if>
          <br />
        </j:if>
      </div>

      <!-- ARTIFACTS -->
      <j:set var="artifacts" value="${build.artifacts}" />
      <j:if test="${artifacts!=null and artifacts.size()&gt;0}">
        <div class="content round_border">
          <h1>构建产物</h1>
          <ul>
            <j:forEach var="f" items="${artifacts}">
              <li>
                <a href="${rooturl}${build.url}artifact/${f}">${f}</a>
              </li>
            </j:forEach>
          </ul>
        </div>
      </j:if>

      <!-- MAVEN ARTIFACTS -->
      <j:set var="mbuilds" value="${build.moduleBuilds}" />
      <j:if test="${mbuilds!=null}">
        <div class="content round_border">
          <h1>MAVEN 构建产物</h1>
          <j:forEach var="m" items="${mbuilds}">
            <h2>${m.key.displayName}</h2>
            <j:forEach var="mvnbld" items="${m.value}">
              <j:set var="artifacts" value="${mvnbld.artifacts}" />
              <j:if test="${artifacts!=null and artifacts.size()&gt;0}">
                <ul>
                  <j:forEach var="f" items="${artifacts}">
                    <li>
                      <a href="${rooturl}${mvnbld.url}artifact/${f}">${f}</a>
                    </li>
                  </j:forEach>
                </ul>
              </j:if>
            </j:forEach>
          </j:forEach>
          <br />
        </div>
      </j:if>

      <!-- JUnit TEMPLATE -->
      <j:set var="junitResultList" value="${it.JUnitTestResult}" />
      <j:if test="${junitResultList.isEmpty()!=true}">
        <div class="content round_border">
          <a href="${rooturl}${build.url}/testReport">
            <h1>JUnit Tests</h1>
          </a>
          <table class="border">
            <tr>
              <th class="border">Package</th>
              <th class="border">Failed</th>
              <th class="border">Passed</th>
              <th class="border">Skipped</th>
              <th class="border">Total</th>
            </tr>
            <j:forEach var="junitResult" items="${it.JUnitTestResult}">
              <j:forEach var="packageResult" items="${junitResult.getChildren()}">
                <tr>
                  <td class="border">
                    <tt>${packageResult.getName()}</tt>
                  </td>
                  <td class="border test_failed">${packageResult.getFailCount()}</td>
                  <td class="border test_passed">${packageResult.getPassCount()}</td>
                  <td class="border test_skipped">${packageResult.getSkipCount()}</td>
                  <td class="border">
                    <b>${packageResult.getPassCount()+packageResult.getFailCount()+packageResult.getSkipCount()}
                    </b>
                  </td>
                </tr>
                <j:forEach var="failed_test"
                  items="${packageResult.getFailedTests()}">
                  <tr>
                    <td class="test_failed" colspan="5">
                      <tt>${failed_test.getFullName()}</tt>
                    </td>
                  </tr>
                </j:forEach>
              </j:forEach>
            </j:forEach>
          </table>
          <br />
        </div>
      </j:if>


      <!-- Static Analysis -->
      <j:set var="actions" value="${it.staticAnalysisActions}" />
      <j:if test="${!actions.isEmpty()}">
        <div class="content round_border">
          <h1>代码静态检查结果</h1>
          <table>
            <tr>
              <th>名称</th>
              <th>检查结果</th>
              <th>总数</th>
              <th>High</th>
              <th>Normal</th>
              <th>Low</th>
            </tr>
            <j:forEach var="action" items="${actions}">
              <tr>
                <td>
                  <a href="${rooturl}${build.url}/${action.urlName}">${action.displayName}</a> 
                </td>
                <td class="center">
                  <j:choose>
                    <j:when test="${action.result.pluginResult=='SUCCESS'}">
                      <img src="${rooturl}static/e59dfe28/images/16x16/blue.gif" />
                    </j:when>
                    <j:when test="${action.result.pluginResult=='FAILURE'}">
                      <img src="${rooturl}static/e59dfe28/images/16x16/red.gif" />
                    </j:when>
                    <j:otherwise>
                      <img src="${rooturl}static/e59dfe28/images/16x16/yellow.gif" />
                    </j:otherwise>
                  </j:choose>
                </td>
                <td class="center">${action.result.numberOfAnnotations} </td>
                <td class="center">${action.result.getNumberOfAnnotations('HIGH')} </td>
                <td class="center">${action.result.getNumberOfAnnotations('NORMAL')} </td>
                <td class="center">${action.result.getNumberOfAnnotations('LOW')} </td>
              </tr>
            </j:forEach>
          </table>
        </div>
      </j:if>

      <div class="content round_border">
        <!-- CONSOLE OUTPUT -->
        <a href="${rooturl}${build.url}/console">
          <h1>Console 输出结果（后50行）</h1>
        </a>
        <table class="console">
          <j:forEach var="line" items="${build.getLog(50)}">
            <tr>
              <td>
                <tt>${line}</tt>
              </td>
            </tr>
          </j:forEach>
        </table>
        <br />
      </div>
    </body>
  </html>
</j:jelly>

保存。

然后配置系统管理——Editable Email Notification Templates，增加一个默认模板，名称为默认，直接保存。

回到项目配置， 在构建环境里，
勾上Provide Configuration files
选择File为刚新增的jelly文件，target填写/var/jenkins_home/email-templates
Variable填写analysis.jelly

然后，在构建后操作里增加Editable Email Notification Templates，选择默认模板。

这样就完成了配置。

作者：Jadepeng
出处：jqpeng的技术记事本--http://www.cnblogs.com/xiaoqi
您的支持是对博主最大的鼓励，感谢您的认真阅读。
本文版权归作者所有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

weixin_33881050
关注
K8s+Jenkins+GitLab+Harbor+CICD+SonarQube持续集成、持续部署实战
作者的博客园已搬家到CSDN，访问博客园主页将默认跳转至CSDN
05-20 1494
通过`Jenkins`新建项目，以`pipelin`的方式从`GitLab`拉取代码，通过`Maven`编译代码、`docker`构建镜像并推送到`Harbor`仓库，最后以`docker`方式用`docker`命令部署到服务器。 ### Pipeline部署到K8s 通过`Jenkins`新建项目，以`pipelin`的方式从`GitLab`拉取代码，通过`Maven`编译代码、`docker`构建镜像并推送到`Harbor`仓库，最后以`k8s`的`yaml`配置清单方式，用`kubectl`命令部
Docker+Jenkins+Selenium+Pytest+JMeter持续集成交付实战
最新发布
悦分享
12-12 712
Jenkins在每一次的执行构建后，都会对该构建的项目生成一个历史构建记录，测试的项目越来越多，长期的构建，历史版本同样也越来越多。在测试报告XML，进入如下图所示的位置。持续部署的主要部分，是确保其上面所示的整个过程是自动化的，Jenkins实现所有这些是通过各种各样的插件，其中一个是“Deploy to container Plugin”。使用什么系统安装的docker，一般则是用什么方式安装软件，替换源的方式，会有些许区别，如centos用yum安装，ubuntu用apt-get。
findbugs源码包
08-16
findbugs源码包，Google用于查找的bug的不错的工具
持续集成频繁的代码检查怎么办，了解下自动化的静态代码检查！
weixin_42556618的博客
06-16 497
静态代码检查分析是DevOps持续集成环节非常重要的组成部分，每个开发项目团队都会制定相应的编码规范，要求编码实现中遵守相应的编写规则。但仅依靠规则是不够的，在实践中还需依赖静态代码检查工具的能力，以助于持续集成自动化程度。 中国DevOps现状 DevOps已经在互联网、金融行业、运营商和制造业等行业得到了广泛的落地实践，DevOps彻底改变了原有软件开发和运营的模式，使整个IT行业发生了巨大的转变。中国信息通信研究院联合开展了2019年中国DevOps发展现状的调查，受访企业包括科...
jenkins安装pmd对代码进行静态分析
Daniel的专栏
06-13 3924
1、在Jenkins的插件管理中，安装PMD-Plugin插件。 2、在被编译的代码中，增加如下配置： 1）顶级pom中，在dependencyManagement中增加对PMD插件的依赖 org.apache.maven.plugins maven-pmd-plugin 3.8 2）在需要分析的工程的pom中，增加build配置项
jenkins安装插件CheckStyle、FindBugs、PMD 未完待续（Junit、代码覆盖率检查）
ZhangYuan2HH的博客
04-28 1626
一、jenkins安装插件 Jenkins—>系统管理—>插件管理 本次安装与Java项目代码检查相关的一些插件 CheckStyle。FindBugs。PMD。Metrics。Junit。 例如：安装PDM 直接安装跳转到安装页面 其他几个组件和PMD安装方式一样，这里就不重复讲了。 都是在插件管理—>可选组件中过滤（搜索）要安装的组件。点击...
Jenkins集成Java 静态代码分析工具调研和引入
11-27
Java 静态代码分析工具调研和引入，包括maven与findbugs、checkstyle、pmd。gradle与findbugs、checkstyle、pmd，lint。
Jenkins+Docker持续集成
qq_35386002的博客
03-19 1002
本节内容： Jenkins介绍 安装部署Jenkins Jenkins构建maven风格的job Jenkins邮件通知设置 Sonar Jenkins与Docker结合 一、Jenkins介绍 Jenkins是一个开源软件项目，是基于Java开发的一种持续集成工具，用于监控持续重复的工作，旨在提供一个开放易用的软件平台，使软件的持续集成变成可能。 二、安装部署Jenkins 下载地址：https://jenkins.io/download/ 我这里下载war包安装，版本：...
使用Sonar集成Jenkins进行代码静态检查
haihaifeng137的博客
04-29 5376
Sonar简介Sonar是一个用于代码质量管理的开源平台， 用于管理源代码质量。通过插件机制，Sonar 可以集成不同的测试工具，代码分析工具，以及持续集成工具，比如pmd-cpd、checkstyle、findbugs、Jenkins。通过不同的插件对这些结果进行再加工处理，通过量化的方式度量代码质量的变化，从而可以方便地对不同规模和种类的工程进行代码质量管理。Sonar在Jenkins里的安装以
Jenkings_tests:持续集成服务器上的分析工作
05-11
- 使用静态代码分析工具，如Checkstyle，PMD，FindBugs，可检测潜在的编程错误和不一致之处。 - 结合SonarQube，可以进行深度的代码质量管理，包括复杂度分析、重复代码检测、单元测试覆盖率等。 5. **持续集成的...
PMD与CPD使用说明
07-12
PMD与CPD使用说明，检查Java代码的重复度
Jenkins 持续集成综合实战
qq_38542834的博客
03-05 579
【原创】Jenkins 持续集成综合实战  发表于 2017-01-06 文章目录 1 安装 Jenkins 1.1 安装 JDK/Maven1.2 安装 Jenkins 1.2.1 离线安装1.2.2 在线安装1.2.3 基于 Tomcat 安装1.2.4 免安装方式 1.3 调整配置文件1.4 启动1.5 防火墙放行1.6 卸载 2 基本配置 2.1 登录2
Jenkins+maven+pmd对java代码进行静态代码分析
测试蜗牛，一步一个脚印
09-10 9311
By whhuang Maven官方配置说明：http://maven.apache.org/plugins/maven-pmd-plugin/ 一、Pom的配置 1、  在里增加pmd的配置 代码如下：                                                    org.apache.maven.plugins
jenkins checkstyle(一)
shahaizimxm的专栏
09-28 4075
1、在jenkins图形化界面安装checkstyle插件 如果自动安装插件不成功，则选择手工安装： 1.1、先在该url下载jenkins的checkstyle插件： http://updates.jenkins-ci.org/download/plugins/ 插件：checkstyle.hpi、analysis-core.hpi(安装checkstyle插件前需要先安装analysi
Jenkins Maven checkstyle findbugs pmd静态代码检查
JackyZheng
06-20 4258
公司其他java和安卓项目都是用Gradle做配置管理，jenkins集成后使用静态代码检查工具没有问题，现在其他项目组使用Maven作为配置管理，对Maven研究了一哈，窃以为还是Gradle的语法更加简洁。 第一步还是确认环境，需要在jenkins哪里安装maven并进行环境配置，一切都是常规安装，修改profile文件之后执行mvn验证，如果没有问题会看到以下代码 [INFO] Sc
Jenkins+maven+checkstyle对java代码进行静态代码分析
热门推荐
测试蜗牛，一步一个脚印
09-10 1万+
转载注意出处 by  whhuang Maven官方配置说明：http://maven.apache.org/plugins/maven-checkstyle-plugin/ 一、Pom的配置 1、  在里增加checkstyle的配置 代码如下：                                             org.apache.maven.
Maven项目使用Checkstyle检查代码
aouoy的博客
06-23 8987
目录Maven项目使用Checkstyle检查代码idea中配置checkstyle-IDEA插件在Maven项目中配置使用Checkstyle单模块的maven项目多模块的maven项目Jenkins中配置异常参考 Maven项目使用Checkstyle检查代码 Checkstyle可以做到自定义风格的代码检查，这里提供一些使用的例子供参考。 idea中配置checkstyle-IDEA插件 使用checkstyle-IDEA插件，可以直接依靠idea检查代码，优点是有图形界面，操作直观，安装好之后所有项
零基础搭建Docker+Jenkins+Node.js自动化部署教程
本文档详细介绍了如何从零开始搭建一个结合Docker、Jenkins和Node.js的自动化部署环境，旨在帮助具有一定Docker和Linux经验的读者。以下将逐步阐述关键步骤和概念： 1. Docker部分： - Docker简介：Docker是一个...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值