Jenkins-持续集成秘籍-四-

布客飞龙
177 阅读59分钟

Jenkins 持续集成秘籍（四）

原文：zh.annas-archive.org/md5/B61AA47DB2DCCD9DEF9EF3E145A763A7

译者：飞龙

协议：CC BY-NC-SA 4.0

第七章 探索插件

在本章中，我们将涵盖以下内容：

  • 个性化 Jenkins

  • 测试然后推广构建

  • 享受固定 JSGames

  • 查看 GUI 样本插件

  • 更改 FileSystem SCM 插件的帮助信息

  • 向作业描述添加横幅

  • 创建一个 RootAction 插件

  • 导出数据

  • 在启动时触发事件

  • 使用 Groovy 钩子脚本并在启动时触发事件

  • 当 Web 内容发生变化时触发事件

  • 回顾三个 ListView 插件

  • 创建我的第一个 ListView 插件

介绍

本章有两个目的：第一个是展示一些有趣的插件，第二个是简要回顾插件的工作原理。如果你不是程序员，可以跳过关于"插件工作原理"讨论。

当我开始撰写这本书时，有超过 300 个 Jenkins 插件可用，撰写本页时已超过 1,000 个。很可能已经有插件满足你的需求。Jenkins 不仅是一个持续集成服务器，也是一个创建额外功能的平台。一旦掌握了一些概念，程序员可以调整现有插件以适应组织的需求。

如果你发现缺少某个功能，通常更容易修改现有的功能，而不是从头开始编写一个。如果你想要适应的话，插件教程（wiki.jenkins-ci.org/display/JENKINS/Plugin+tutorial）是一个很好的起点。该教程提供了你日常使用的基础架构相关背景信息。

插件中有大量信息可供了解。以下是一些关键点：

  • 已有许多插件，还会有更多的开发。为跟上这些变化，你需要定期审查 Jenkins 插件管理器中可用的部分。

  • 与社区合作：如果你将改进集中提交，那么它们将对更广泛的观众可见。在社区的仔细关注下，代码更有可能被审查和进一步改进。

  • 不要重复造轮子：有了这么多插件，在大多数情况下，修改已存在的插件比从头开始编写要容易。

  • 固定插件是指当无法通过 Jenkins 插件管理器更新插件到新版本时发生。固定有助于维护稳定的 Jenkins 环境。

  • 大多数插件工作流程易于理解。然而，随着你使用的插件数量增多，无意中配置错误的可能性也增加。

  • Jenkins Maven 插件允许你在 Maven 构建中运行一个测试 Jenkins 服务器，而无需风险。

  • 规范节约精力：插件中文件的位置很重要。例如，你可以在 Jenkins 中找到插件的描述显示在文件位置/src/main/resources/index.jelly中。遵循 Jenkins 的约定，你编写的源代码量将被最小化，可读性将提高。

  • 在 Jenkins 中常用的三个框架是：

    • Jelly用于创建 GUI

    • Stapler将 Java 类绑定到 URL 空间

    • XStream用于将配置持久化为 XML

    注意

    本章中提到的一些插件的源代码在 Subversion 中。在撰写本文时，如果有代码被移动，很可能已经转移到 Jenkins 的 GitHub 存储库（github.com/jenkinsci）。插件开发者的约定是在旧的 Subversion 存储库中留下一个README文件，列出新的 Git 位置。

个性化 Jenkins

本教程重点介绍了两个改善用户体验的插件：Green Balls 插件和 Favorite 插件。

Jenkins 拥有广泛的国际受众。有时，在 Jenkins 外观表达方式上可能会有微妙的文化差异。一个例子是，当一个构建成功时，蓝色的圆球被显示为图标。然而，许多人自然地将交通灯中的绿色与继续前进的信号联系在一起。

Favorite 插件允许你选择你喜欢的项目并在视图中显示一个图标以突出显示你的选择。

准备好了

安装 Green Balls 和 Favorite 插件（wiki.jenkins-ci.org/display/JENKINS/Green+Balls, wiki.jenkins-ci.org/display/JENKINS/Favorite+Plugin）。

如何做...

  1. 创建一个空的新自由风格作业，命名为ch7.plugin.favourite。

  2. 多次构建该作业，查看构建历史。现在你会看到绿色的球而不是通常的蓝色，如下面的屏幕截图所示:如何做...

  3. 返回到主页。

  4. 要创建一个新的视图，请单击**+**图标。

  5. 填写FAV作为名称。

  6. 检查列表视图。

  7. 在作业过滤器部分，选择使用正则表达式将作业包含到视图中。为正则表达式添加.*。

  8. 在列部分，请确保您有三列名称、状态和收藏夹，如下面的屏幕截图所示:如何做...

  9. 点击确定。

  10. 你将会进入FAV视图。通过点击星形图标，你可以选择/取消选择你喜欢的项目，如下面的屏幕截图所示:如何做...

它如何运作...

Green Balls 插件表现如宣传的那样。Favorite 插件允许你选择最感兴趣的项目并将其显示为收藏夹图标。这提醒你项目需要一些即时行动。

注意

如果你对与社区合作感兴趣，那么这些插件是你可以增加额外功能的示例。你可以在这里找到官方的参与指南：wiki.jenkins-ci.org/display/JENKINS/Beginners+Guide+to+Contributing

还有更多...

最喜欢的项目的反义词，至少暂时是一个构建失败的项目。Claim 插件（wiki.jenkins-ci.org/display/JENKINS/Claim+plugin）允许个别开发人员声明失败的构建。这使得将工作流程映射到个人责任成为可能。

一旦安装了 Claims 插件，您就能在作业的后构建操作部分找到一个名为允许声明破损构建的复选框。一旦启用，如果构建失败，您可以声明特定的构建，并添加有关您动机的注释。

还有更多...

现在，在 Jenkins 主页上，有一个指向保留所有声明构建摘要的日志的链接。项目经理现在可以阅读有关问题的快速概述。该日志是直接链接到正在处理当前问题的团队成员，如下截图所示：

还有更多...

Favorite 插件在其简单性中非常优雅。在下一个配方中，测试然后推广将表示允许进一步将复杂工作流程纳入的信号。

另请参阅

  • 测试然后推广构建配方

  • 与标记 JSGames 有趣配方

测试然后推广构建

在自动测试之前，您不希望 QA 团队审查应用程序。为实现此目的，您可以使用推广插件。

在 Jenkins 中，推广是一种视觉信号。在特定构建旁边设置一个图标，以提醒团队执行操作。

促进和前面配方中提到的 Favorite 插件之间的区别在于，促进可以根据各种自动操作自动触发。这些操作包括运行脚本或验证其他上游或下游作业的状态。

在这个配方中，您将编写两个简单的作业。第一个作业将触发第二个作业；如果第二个作业成功，则将提升第一个作业。这是一个现实的质量保证流程的核心，即测试作业推动打包作业。

准备就绪

安装推广构建插件（wiki.jenkins-ci.org/display/JENKINS/Promoted+Builds+Plugin）。

如何操作...

  1. 创建一个名为ch7.plugin.promote_action的自由风格作业。

  2. 运行此作业并验证其成功。

  3. 创建一个名为ch7.plugin.to_be_promoted的自由风格作业。

  4. 在配置页面的顶部附近，勾选当...促进构建。

  5. 填写以下细节：

    • 名称：由自动功能测试验证

    • 为图标选择绿色星号

    • 检查在以下下游项目成功构建时

    • 作业名称：ch7.plugin.promote_action

    如何操作...

  6. 在后构建操作部分检查构建其他项目。

  7. 为要构建的项目填写ch7.plugin.promote_action。

  8. 勾选仅在构建稳定时触发。

  9. 点击保存。

  10. 构建作业。

  11. 单击推广状态链接，如下图所示：如何实现...

  12. 查看构建报告。如何实现...

工作原理...

推广构建类似于 Favorite 插件，但具有工作流自动化。您可以根据由构件创建触发的作业来推广。这是典型的工作流程，当您希望作业在被拾起和审查之前经过基线质量测试时。

该插件具有足够的配置选项，使其适应大多数工作流程。另一个示例是，对于典型的开发、验收和生产基础设施，您不希望在开发和验收被推广之前将构件部署到生产环境。配置此方法是具有一系列作业，最后一个推广到生产取决于上游开发和验收作业的推广。

注

如果您想要添加人工干预，那么在作业配置中检查仅在手动批准时并添加批准者名单。

还有更多...

如果您依赖于人工干预且没有自动测试，请考虑使用简化的推广构建插件(wiki.jenkins-ci.org/display/JENKINS/Promoted+Builds+Simple+Plugin)。正如其名称所示，该插件简化了配置，并且可以很好地与大多数 QA 工作流配合使用。简化配置使得更容易解释，使更广泛的受众可以使用。

您可以在主 Jenkins 配置页面中配置不同类型的推广，如下图所示：

还有更多...

注

明智地使用自动保存功能。此选项告诉 Jenkins 保留构建的所有构件。如果作为增量构建过程的一部分使用，将最终占用大量磁盘空间。

该插件允许您提升推广。通过左侧构建上的链接可提供一个简单的选择。此功能允许您将一系列玩家添加到推广过程中。

注

当最终推广发生时，例如到GA（一般可用），推广将被锁定，不再能够被降级。

还有更多...

用户推广的能力取决于其权限。例如，如果您使用基于矩阵的安全性，则需要在作业的配置页面中看到额外选项之前更新其表格，如下图所示：

还有更多...

另请参阅

  • 个性化 Jenkins 教程

与固定 JSGames 玩耍

本教程向您展示如何固定 Jenkins 插件。固定插件将阻止您能够在 Jenkins 插件管理器内更新其版本。

现在老板走了，生活并不总是关于代码质量。为了减轻压力，考虑让你的团队通过 JSGames 插件放松。

准备工作

安装 JSGames 插件 (wiki.jenkins-ci.org/display/JENKINS/JSGames+Plugin)。

如何操作...

  1. 检查并回顾你选择的目录下的标签 jsgames-0.2，命令如下：

    git clone https://github.com/jenkinsci/jsgames-plugin
git tag
git checkout jsgames-0.2

  2. 查看 Jenkins 的首页；你会看到一个指向 JS Games 的链接，如下所示：如何操作...

  3. 点击链接，你将可以选择两个游戏，马里奥卡丁车和俄罗斯方块：如何操作...

  4. 作为 Jenkins 管理员，访问管理插件部分，然后点击已安装选项卡 (http://localhost:8080/pluginManager/installed)。注意 JSGames 插件没有被固定。

  5. 从命令行，列出插件目录 (JENKINS_HOME/plugin) 的内容，例如：

    ls /var/lib/jenkins/plugins

    输出将类似于：

    ant                             ant.jpi
jsgames                     jsgames.jpi
maven-plugin             maven-plugin.jpi

  6. 在插件目录中，创建一个名为 jsgames.jpi.pinned 的文件，例如：

    sudo touch /var/lib/jenkins/plugins/jsgames.jpi.pinned
sudo chown jenkins /var/lib/jenkins/plugins/jsgames.jpi.pinned

  7. 在你的网络浏览器中，刷新已安装插件页面。现在你会看到 jsgames 插件被固定了：如何操作...

它是如何工作的...

固定一个插件会阻止 Jenkins 管理员更新插件的新版本。要固定一个插件，你需要在插件目录中创建一个与插件同名的文件，以 pinned 为扩展名结尾。参见 wiki.jenkins-ci.org/display/JENKINS/Pinned+Plugins。

Jenkins 的新版本大约每周发布一次，包含 bug 修复和功能更新。这导致改进快速地进入市场，但有时也会导致失败。将插件固定可以防止插件在你评估新版本的稳定性和价值之前被意外更新。固定是保持生产服务器稳定的工具。

还有更多...

源代码包括一个顶级 pom.xml 文件来控制 Maven 构建过程。按照惯例，四个主要的源代码区域是：

  • src/test：这包含构建过程中的测试代码。对于 JSGames，有一堆 JUnit 测试。

  • src/main/java：这是 Java 代码的位置。Jenkins 使用 Stapler (wiki.jenkins-ci.org/display/JENKINS/Architecture) 将此目录中的 Java 对象与 Jenkins 在 src/main/resources 下找到的视图相映射。

  • src/main/resources：这是插件的视图位置。当你在 Jenkins 中进行交互时，例如 JS Games 的链接，你会使用与插件相关联的 GUI。视图是使用 Jelly 标记定义的。

  • src/main/webapp：这是资源的位置，如图像、样式表和 JavaScript。该位置映射到 URL 空间。/src/main/webapp映射到 URL /plugin/name_of_plugin。例如，位置/src/main/webapp/tetris/resources/tetris.js映射到 URL /plugin/jsgames/tetris/resources/tetris.js。

参见

  • 创建 RootAction 插件的步骤

查看 GUI 示例插件

本篇描述如何通过 Maven 运行 Jenkins 测试服务器。在测试服务器中，你将看到示例 GUI 插件。GUI 插件展示了许多标签元素，稍后你可以在自己的插件中使用。

准备工作

创建一个目录来保存本篇的结果。

如何操作...

  1. 在 recipe 目录中，在pom.xml文件中添加以下内容：

    <?xml version="1.0"?>
<project   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 <modelVersion>4.0.0</modelVersion>
<parent>
  <groupId>org.jenkins-ci.plugins</groupId>
  <artifactId>plugin</artifactId>   
  <version>1.584</version>
</parent>
  <artifactId>Startup</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>hpi</packaging>
  <name>Startup</name>
  <repositories>
    <repository>
    <id>repo.jenkins-ci.org</id>
    <url>http://repo.jenkins-ci.org/public/</url>
    </repository>
    </repositories>
    <pluginRepositories>
    <pluginRepository>
    <id>repo.jenkins-ci.org</id>
    <url>http://repo.jenkins-ci.org/public/</url>
  </pluginRepository>
  </pluginRepositories>
  <properties>
    <project.build.sourceEncoding>UTF-8   
    </project.build.sourceEncoding>
  </properties>
</project>

  2. 从命令行运行mvn hpi:run。如果你在端口8080上有一个默认的 Jenkins 运行，那么你将看到类似于以下的错误消息：

    2012-02-05 09:56:57.827::WARN:  failed SelectChannelConnector @ 0.0.0.0:8080
java.net.BindException: Address already in use
at sun.nio.ch.Net.bind0(Native Method)

  3. 如果服务器仍在运行，按下Ctrl + C。

  4. 要在端口8090上运行，请输入以下命令：

    mvn hpi:run -Djetty.port=8090

  5. 服务器现在正在运行，并从控制台生成一个SEVERE错误：

    SEVERE: Failed Inspecting plugin  /DRAFT/Exploring_plugins/hpi_run/./work/plugins/Startup.hpl
java.io.IOException: No such file: /DRAFT/Exploring_plugins/hpi_run/target/classes

  6. 访问localhost:8090/jenkins。在页面底部，查看 Jenkins 的版本号，如下截图所示：如何操作...

  7. 通过插件管理器（http://localhost:8090/pluginManager/available）安装 UI 示例插件。

  8. 在首页上，点击UI 示例链接：如何操作...

  9. 查看所提及的各种示例类型，例如 AutoCompleteTextBox（http://localhost:8090/ui-samples/AutoCompleteTextBox/）。

工作原理...

对于开发目的，从 Maven 运行测试服务器的能力非常棒。你可以修改代码，编译，打包，然后在本地 Jenkins 实例上查看，而无需担心配置或破坏真实服务器。你不必太担心安全性，因为测试服务器只在测试期间运行。

目标hpi:run尝试打包并部署一个名为 Startup 的插件。但是，由于包不可用，它会记录一个投诉，并忠实地运行一个 Jenkins 服务器。Jenkins 服务器的版本号与pom.xml中定义的<parent>标签内的<version>标签相同。

为了避免与本地 Jenkins 实例使用相同的端口，你设置了jetty.port选项。

一旦运行，访问 GUI 示例插件会展示如何在 Jelly 中创建各种 GUI 元素的示例。这些元素稍后在编程自己的插件时会派上用场。插件中使用的 Jelly 文件位于/src/main/resources目录下。Jenkins 使用 Stapler 将在src/main/java中找到的任何相关类绑定起来。

你可以在work文件夹中找到 Jenkins 的工作空间。你在测试服务器上所做的任何配置更改都将保留在这里。为了重新开始，你需要手动删除该目录。

对于本章中的所有配方，我们将固定 Jenkins 版本为 1.584。原因有两个：

  • 依赖项占用了大量空间。Jenkins war 文件和测试 war 文件大约占用本地 Maven 存储库的 120 MB。将此数字乘以使用的 Jenkins 版本数量，您很快就会填满几 GB 的存储空间。

  • 将 Jenkins 版本固定在特定版本可以稳定配方。

欢迎更新到最新版本的 Jenkins，因为本章中的示例应该仍然适用。如果遇到困难，您可以随时返回已知的安全版本号。

更多内容...

在幕后，Maven 做了大量的繁重工作。pom.xml 文件定义了 repo.jenkins-ci.org/public/ 存储库以获取依赖项。它调用版本 1.584 的 org.jenkins-ci.plugins.plugin。版本号与 Maven 运行的 Jenkins 版本号同步。

要发现可接受的版本号，请访问 repo.jenkins-ci.org/public/org/jenkins-ci/plugins/plugin/。

Jenkins 服务器的详细信息以及包含的任何额外插件可以在 1.584/plugin-1.584.pom 相对于前述 URL 找到。UI Samples 插件版本也固定在版本 1.584。

官方页面和插件构建的最新信息可以在 wiki.jenkins-ci.org/display/JENKINS/Plugin+tutorial 找到。

参见

  • 更改 FileSystem SCM 插件的帮助 配方

更改 FileSystem SCM 插件的帮助

本配方审查了 FileSystem SCM 插件的内部工作原理。该插件允许您将代码放在本地目录中，并在构建中被检索到。例如，您将更改插件帮助文件中的文本。

准备工作

创建一个准备接受本配方代码的目录。在新创建的目录中，下载插件的源码：

git clone https://github.com/jenkinsci/filesystem_scm-plugin cd filesystem_scm-plugin/

操作方法...

  1. 查看标签信息，然后检出最新的稳定标签：

    git tag –l
filesystem_scm-0.1
filesystem_scm-1.10
filesystem_scm-1.20
filesystem_scm-1.5
filesystem_scm-1.6
filesystem_scm-1.7
filesystem_scm-1.8
filesystem_scm-1.9
git checkout –b filesystem_scm-1.20

  2. 在顶级目录中，编辑 pom.xml 文件，在 <parent> 下更改版本为 1.584：

      <parent>
    <groupId>org.jenkins-ci.plugins</groupId>
    <artifactId>plugin</artifactId> 
    <version>1.584</version>
  </parent>

  3. 用以下代码替换存储库和 pluginRepositories 部分：

      <repositories>
    <repository>
      <id>repo.jenkins-ci.org</id>
      <url>http://repo.jenkins-ci.org/public/</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>repo.jenkins-ci.org</id>
      <url>http://repo.jenkins-ci.org/public/</url>
    </pluginRepository>
  </pluginRepositories>

  4. 将 src/main/webapp/help-clearWorkspace.html 的内容替换为以下代码：

    <div>
  <p>
<h3>HELLO WORLD</h3>
  </p>
</div>

  5. 运行 mvn clean install。单元测试失败，输出为：

    Failed tests:   test1(hudson.plugins.filesystem_scm.SimpleAntWildcardFilterTest): expected:<2> but was:<0>
Tests run: 27, Failures: 1, Errors: 0, Skipped: 0

  6. 运行 mvn clean package -Dmaven.test.skip=true 来跳过失败的测试。插件现在已经打包完毕。

    将插件上传到插件管理器的 高级 部分 (http://localhost:8080/pluginManager/advanced) 的 ./target/filesystem_scm.hpi 中：

    操作方法...

  7. 重新启动 Jenkins 服务器。

  8. 登录 Jenkins 并访问已安装插件的列表 (http://localhost:8080/pluginManager/installed)。

  9. 创建一个名为 ch7.plugins.filesystem_scm 的 Maven 作业。

  10. 在源码管理部分下，您现在有一个名为文件系统的部分。

  11. 点击帮助图标获取清理工作区的相关信息。如下截图所示：操作步骤...

  12. 要删除插件，请删除 jpi 文件和位于 JENKINS_HOME/plugins 下的扩展目录。

  13. 重启 Jenkins。

工作原理...

恭喜，你已经更新了 SCM 插件。

首先，您修改了插件的 pom.xml 文件，更新了测试 Jenkins 服务器的版本，并指向了 Maven 下载工件的正确存储库。接下来，您修改了其帮助文件。

对于每个 Java 类，您都可以通过关联的 config.jelly 文件配置其 GUI 表示。映射来自 src/main/java/package_path/classname.java。

到 src/main/resources/package_path/classname/config.jelly。

例如，src/main/resources/hudson/plugins/filestem_scm/FSSCM/config.jelly 配置了 src/main/java/hudson/plugins/filesystem_s_c_m/FSSCM.java 的 Jenkins GUI。

帮助文件的位置在 config.jelly 中的 entry Jelly 标记的 help 属性中定义：

  <f:entry title="Clear Workspace" help="/plugin/filesystem_scm/help-clearWorkspace.html">
    <f:checkbox name="fs_scm.clearWorkspace" checked="${scm.clearWorkspace}"/>
  </f:entry>

src/main/webapps 目录为静态内容（如图像、样式表和 JavaScript 文件）提供了一个稳定的 Jenkins URL /plugin/name_of_plugin。这就是为什么帮助文件存储在这里。修改 help-clearWorkspace.html 会更新 entry 标签指向的帮助。

变量 ${scm.clearworkspace} 是对 FSSCM 实例中 clearWorkspace 成员的引用。

还有更多...

插件通常包含两种类型的 Jelly 文件，即 global.jelly 和 config.jelly。config.jelly 文件生成配置作业时看到的配置元素。global.jelly 文件在主 Jenkins 配置页面中呈现。

使用 XStream 框架将数据持久化为 XML 文件。您可以在 Jenkins 工作区的 /jobs/job_name/plugin_name.xml 下找到作业配置的数据，以及在 ./work/name_of_plugin.xml 下找到全局插件配置的数据。

另请参阅

  • 查看 GUI 示例插件的配方

向作业描述添加横幅

想象一个场景。您的公司有一个面向公众的 Jenkins 实例。所有者不希望项目所有者在项目描述中写入未转义的标记。这会带来太多安全问题。但是，所有者确实希望在每个描述的底部放置公司横幅。在管理层开始购买不必要的建议之前，您有 15 分钟来解决这个问题。在前五分钟内，您确定转义标记插件（请参阅第二章中的查找 Jenkins 中的 500 错误和 XSS 攻击配方，增强安全性）执行了描述的转义。

此配方向您展示如何修改 Markup 插件以向所有描述添加横幅。

准备就绪

假设你正在本地进行测试，请为你的项目创建一个目录。在你新创建的目录中，检出转义标记插件的escape-markup-plugin-0.1标签：

git clone https://github.com/jenkinsci/escaped-markup-plugin

操作步骤...

  1. 访问插件源代码的本地副本，列出可能的标签，并检出插件的稳定版本：

    cd escaped-markup-plugin
git tag -l
git –b checkout escaped-markup-plugin-0.1

  2. 在项目的顶级目录中，尝试使用命令mvn install创建插件。构建失败。

  3. 将pom.xml文件中的 Jenkins 插件版本从1.408更改为1.58：

    <parent>
  <groupId>org.jenkins-ci.plugins</groupId>
  <artifactId>plugin</artifactId>
  <version>1.584</version>
</parent>

  4. 用以下代码替换repositories和pluginRepositories部分：

      <repositories>
    <repository>
      <id>repo.jenkins-ci.org</id>
      <url>http://repo.jenkins-ci.org/public/</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>repo.jenkins-ci.org</id>
      <url>http://repo.jenkins-ci.org/public/</url>
    </pluginRepository>
  </pluginRepositories>

  5. 使用mvn install构建插件。构建将成功。你现在可以在target/escaped-markup-plugin.hpi找到该插件。

  6. 通过访问插件管理器（http://localhost:8080/pluginManager/advanced）下的高级选项卡安装插件。

  7. 在上传插件部分，上传escaped-markup-plugin.hpi文件。

  8. 重新启动服务器，例如：

    sudo /etc/init.d/jenkins restart

  9. 访问 Jenkins 安全配置页面（http://localhost:8080/configureSecurity）并查看标记格式化器。

  10. 用以下代码替换src/main/resources/index.jelly：

    <div>
  This plugin escapes the description of project, use, view, and build  to prevent from XSS.
  Revision: Unescaped banner added at the end.
</div>

  11. 用以下代码替换src/main/java/org/jenkinsci/plugins/escapedmarkup/EscapedMarkupFormatter.java的类定义：

    public class EscapedMarkupFormatter extends MarkupFormatter

{
  private final String BANNER= "\n<hr><h2>THINK BIG WITH xyz dot blah</h2><hr>\n";

  @DataBoundConstructor
  public EscapedMarkupFormatter() {
}
@Override
public void translate(String markup, Writer output) throws IOException {
    output.write(Util.escape(markup)+BANNER);
  }
    @Extension
    public static class DescriptorImpl extends MarkupFormatterDescriptor {
    @Override
    public String getDisplayName() {
      return "Escaped HTML with BANNER";
    }
  }
}

  12. 使用mvn install进行构建。构建失败是由于测试未通过（这是件好事）。

  13. 再次使用以下命令构建，这次跳过测试：

    mvn -Dmaven.test.skip=true -DskipTests=true clean install

  14. 关闭 Jenkins，如下所示：

    sudo /etc/init.d/jenkins stop

  15. 从 Jenkins 插件目录和相同目录中的扩展版本中删除转义标记插件，例如：

    sudo rm /var/lib/jenkins/plugins/escaped-markup-plugin.jpi
sudo rm -rf /var/lib/jenkins/plugins/escaped-markup-plugin

  16. 将插件target/escaped-markup-plugin.hpi复制到 Jenkins 插件目录。

  17. 重启 Jenkins。

  18. 访问已安装的插件页面：http://localhost:8080/pluginManager/installed。你现在将看到插件的更新描述，如下图所示：操作步骤...

  19. 在 Jenkins 中，作为管理员，访问配置页面：http://localhost:8080/configureSecurity。

  20. 对于标记格式化器选择带 BANNER 的转义 HTML，如以下截图所示：操作步骤...

  21. 点击保存。

  22. 创建一个名为ch7.plugin.escape的新作业。

  23. 在作业的主页面内，你现在将看到横幅：操作步骤...

工作原理...

标记插件会转义描述中的标签，以防注入任意脚本操作。插件的使用方法在第二章增强安全性中的 通过模糊测试在 Jenkins 中查找 500 错误和 XSS 攻击配方中已经解释过了。

在这个配方中，我们修改了插件以转义项目描述，然后添加了一个横幅。横幅包含任意 HTML。

首先，您编译并上传了 Markup 插件。然后修改源代码以在作业描述末尾包含横幅。该插件重新部署到一个用于审查的牺牲测试实例上。您也可以使用mvn hpi:run目标通过 Maven 运行 Jenkins。有多种部署方法，包括直接将插件转储到 Jenkins 插件目录中。决定使用哪种部署方法取决于个人喜好。

插件渲染的描述在src/main/resources/index.jelly中定义。您更新了文件以准确描述新的横幅功能。

在 Jenkins 中，扩展点是模拟 Jenkins 功能的 Java 接口或抽象类。Jenkins 拥有丰富的扩展点（wiki.jenkins-ci.org/display/JENKINS/Extension+points）。您甚至可以制作自己的（wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point）。

Markdown 插件进行了最小的更改以满足我们的需求。我们扩展了MarkupFormatter扩展点。

Jenkins 使用注解。@Override注解告诉编译器重写该方法。在这种情况下，我们重写了translate方法，并使用一个实用类来使用 Jenkins 实用方法过滤markup字符串。最终，结果字符串加上横幅字符串被添加并传递给 Java 写入器。然后将写入器传递回调用方法。

插件的selectbox中的文本（见第 19 步）是在DescriptorImpl类的getDisplayName()方法中定义的。

注意

编写新的插件并理解 Jenkins 的对象模型需要比复制一个可以工作的插件然后进行微调要付出更多的努力。向已经存在的插件添加横幅功能所需的代码更改量很小。

还有更多……

Jenkins 有大量的文档可用。然而，对于技术宅程序员来说，最详细的信息源是审阅代码、在 IDE（如 Eclipse）中查找的 JavaDoc 以及代码补全功能。如果将 Jenkins 插件项目作为 Maven 项目导入 Eclipse，则最新版本的 Eclipse 会为您解决依赖关系，从而在编辑文件时启用代码补全功能。在 Jenkins 这样一个快速发展的项目中，有时会出现添加功能和文档之间存在的滞后情况。在这种情况下，代码需要是自说明的。代码补全结合良好编写的 JavaDoc 可以减轻开发人员的学习曲线。

下一张屏幕截图展示了在 Eclipse IDE 中运行 Jenkins 时代码补全的工作：

还有更多……

另请参阅

  • *在 第二章，增强安全性 中查找在 Jenkins 中发现 500 错误和 XSS 攻击的方法

  • 更改 FileSystem SCM 插件的帮助 方法

  • 创建 RootAction 插件 方法

创建一个 RootAction 插件

在构建自己的插件之前，值得看看是否可以改编另一个插件。在 Fun with pinning JSGames 方法中，插件在首页创建了一个链接，如下截图所示：

创建 RootAction 插件

在这个方法中，我们将使用插件的元素在 Jenkins 主页上创建一个链接。

准备工作

在本地创建一个目录以存储你的源代码。

如何操作...

  1. 复制 Looking at the GUI samples plugin 方法中的pom.xml文件，替换：

      <artifactId>Startup</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>hpi</packaging>
   <name>Startup</name>

    使用以下内容：

      <artifactId>rootaction</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>hpi</packaging>
   <name>Jenkins Root Action Plugin</name>

  2. 创建目录src/main/java/jenkins/plugins/rootaction、src/main/resources和src/main/webapp。

  3. 在src/main/java/jenkins/plugins/rootaction中添加文件MyRootAction.java，内容如下：

    package jenkins.plugins.rootaction;
import hudson.Extension;
import hudson.model.RootAction;

@Extension
public class MyRootAction implements RootAction {

  public final String getDisplayName() {
    return "Root Action Example";
  }

  public final String getIconFileName() {
    return "/plugin/rootaction/myicon.png";
  }

  //Feel free to modify the URL
  public final String getUrlName() {
    return "http://www.uva.nl";
  }
}

  4. 在src/main/webapp目录中，添加一个名为myicon.png的png文件。例如图片请见：www.iconfinder.com/icondetails/46509/32/youtube_icon。

  5. 添加文件src/main/resources/index.jelly，内容如下：

    <div>
  This plugin adds a root link.
</div>

  6. 在顶级目录中运行命令：

    mvn -Dmaven.test.skip=true -DskipTests=true clean install hpi:run -Djetty.port=8090

  7. 访问主页：http://localhost:8090/jenkins：如何操作...

  8. 点击Root Action Example链接。现在你的浏览器被发送到阿姆斯特丹大学的主网站(www.uva.nl)。

  9. 查看 Jenkins 安装的插件页面(http://localhost:8090/pluginManager/installed)。

工作原理...

你实现了RootAction扩展点。它用于在 Jenkins 的主菜单中添加链接。

扩展点易于扩展。链接名称在getDisplayName方法中定义，图标的位置在getIconFileName方法中，链接到的 URL 在getUrlName中定义。

还有更多...

惯例节省了编程工作。按照惯例，插件的描述定义在src/main/resources/index.jelly中，链接名称在pom.xml文件中的<name>标签旁边的<packaging>标签下，例如：

  <artifactId>rootaction</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>hpi</packaging>
   <name>Jenkins Root Action Plugin</name>

Jenkins wiki 中的详细信息位置计算为一个固定的 URL (wiki.jenkins-ci.org/display/JENKINS/)，该 URL 后跟插件名称，并且名称中的空格被**+**符号替换。对于这个插件也是如此，生成的链接为http://wiki.jenkins-ci.org/display/JENKINS/Jenkins+Root+Action+Plugin。

还有更多...

另请参阅

  • Fun with pinning JSGames 方法

导出数据

Job Exporter 插件创建一个包含项目相关属性列表的属性文件。当你想让 Jenkins 将信息从一个作业传递到另一个作业时，这非常方便。

准备工作

安装 Job Exporter 插件（wiki.jenkins-ci.org/display/JENKINS/Job+Exporter+Plugin）。

如何做…

  1. 下载已知版本号的源代码：

    svn export -r 40275 https://svn.jenkins-ci.org/trunk/hudson/plugins/job-exporter

  2. 创建一个名为ch7.plugins.job_export的自由风格作业。

  3. 在构建部分，添加一个构建步骤导出运行时参数。

  4. 点击保存。

  5. 运行作业。

  6. 在控制台输出中，您将看到作业构建历史中类似的输出：

    (Replace with email)
Started by user Alan Mark Berg 
Building remotely on unix-node01 (dumb functional unix) in workspace
 /home/jenkins-unix-nodex/workspace/c7.plugins.job_export ################################################################### job-exporter plugin started
 hudson.version: 1.584
 host: home.local
 id: 2014-10-13_16-58-18
 duration: 2.5 sec
 slave: unix-node01
 started: 2014-10-13T16:58:18
 result: SUCCESS
 summary: Executor #1 for unix-node01 : executing c7.plugins.job_export #1
 executor: 1
 elapsedTime: 2602
 number: 1
 jobName: c7.plugins.job_export
 we have 1 build cause:       Cause.UserIdCause  Started by user Alan Mark Berg
 user.id: aaaaaaa
 user.name: Alan Mark Berg
 user.fullName: Alan Mark Berg
 user.emailAddress: xxxxx@yyyy.zzz
 new file written: /home/jenkins-unix-nodex/workspace/c7.plugins.job_export/hudsonBuild.properties
 job-exporter plugin  finished.  That's All Folks! ################################################################### Finished: SUCCESS

  7. 审查新创建的属性文件，您将看到类似的文本：

    #created by com.meyling.hudson.plugin.job_exporter.ExporterBuilder
#Thu Feb 02 15:58:51 CET 2012
build.user.id=Alan
build.result=SUCCESS

工作原理…

Job Exporter 插件使 Jenkins 能够将与作业相关的信息导出到一个属性文件中，后续可以通过其他作业重新使用。

审查src/main/java/com/meyling/hudson/plugin/job_exporter/ExporterBuilder.java中的代码，该代码扩展了hudson.tasks.Builder，当运行构建时会调用其perform方法。 当调用perform方法时，Build实例会接收hudson.model.Build对象。 Build实例包含有关构建本身的信息。 调用build.getBuiltOnStr()方法会返回一个包含构建运行在哪个节点上的节点名称的字符串。 该插件使用一些这些方法来发现稍后输出到属性文件的信息。

还有更多…

在审查插件代码时，您可以找到一些有趣的技巧，可以在您自己的插件中重复使用。该插件通过以下方法发现环境变量：

final EnvVars env = build.getEnvironment(new LogTaskListener(Logger.getLogger(
  this.getClass().getName()), Level.INFO));

在此方法中，EnvVars是hudson.EnvVars类（javadoc.jenkins-ci.org/hudson/EnvVars.html）。 EnvVars甚至有一个方法可以从远程 Jenkins 节点获取环境变量。

您还可以在Jenkins 管理区域的系统信息下找到为 Jenkins 定义的所有环境变量列表（http://localhost:8080/systemInfo）。

另请参阅

  • 我的第一个 ListView 插件 配方

在启动时触发事件

经常在服务器启动时，您会希望执行清理操作，例如运行发送电子邮件给所有 Jenkins 管理员警告他们启动事件的作业。 您可以使用 Startup Trigger 插件实现这一点。

准备工作

安装 Startup Trigger 插件（wiki.jenkins-ci.org/display/JENKINS/Startup+Trigger）。

如何做…

  1. 下载源代码：

    svn export -r 40275 https://svn.jenkins-ci.org/trunk/hudson/plugins/startup-trigger-plugin

  2. 创建一个名为ch7.plugin.startup的自由风格作业。

  3. 在构建触发器部分，勾选当作业节点启动时构建。

  4. 点击保存。

  5. 重新启动 Jenkins。

  6. 返回项目页面，您会注意到已触发一个作业。

  7. 审查构建历史控制台输出。您将看到类似的输出：

    Started due to the start of a node.
Building on master in workspace /var/lib/jenkins/workspace/ch7.plugins.startup
Finished: SUCCESS

工作原理…

Startup Trigger 插件在启动时运行作业。 这在执行管理任务（例如，审查文件系统）时非常有用。它的设计也很简洁。

Startup Trigger 插件在 Java 类/src/main/java/org/jvnet/hudson/plugins/triggers/startup/HudsonStartupTrigger中扩展了hudson.triggers.Trigger，并覆盖了方法start，该方法在 Jenkins 启动时调用。

start方法调用父类的 start 方法，如果它不是一个新实例，则调用方法project.scheduleBuild，然后启动构建。

@Override
  public void start( BuildableItem project, boolean newInstance )
  {
    super.start( project, newInstance );

    // do not schedule build when trigger was just added to the job
    if ( !newInstance )
    {
      project.scheduleBuild( new HudsonStartupCause() );
    }
  }

启动的原因在HudsonStartupCause中定义，它本身扩展了hudson.model.Cause。该插件覆盖了getShortDescription()方法，返回字符串Started due to Hudson startup。该字符串作为日志的一部分输出到控制台中：

@Override
   public String  getShortDescription()
  {
    return "Started due to Hudson startup.";
  }

参见

  • 当网页内容更改时触发事件的方法

  • 在启动时的 Groovy 钩子脚本和触发事件

在启动时的 Groovy 钩子脚本和触发事件

在前述的方法中，您看到您可以使用插件来运行任意的启动代码。另一种方法是将 Groovy 脚本init.groovy放在 Jenkins 主目录中。然后，您的 Jenkins 实例将在启动时运行 Groovy 脚本。

准备就绪

访问Scriptler网站scriptlerweb.appspot.com/catalog/list并查看当前可用的 Groovy 脚本。

操作步骤...

  1. 访问scriptlerweb.appspot.com/script/show/256001并查看安装的插件列表脚本。

  2. 在 Jenkins 主目录中创建以下init.groovy脚本，如下面的代码所示：

    import jenkins.model.Jenkins
import java.util.logging.LogManager
def logger = LogManager.getLogManager().getLogger("")logger.info("RUNNING init.groovy from ${Jenkins.instance.getRootDir().absolutePath}")logger.info("Here are the Jenkins environment variables on startup")
def env = System.getenv()
env.each{
 logger.info("${it}")
}
logger.info("<PLUGINS>")
count=0
for(plugin in hudson.model.Hudson.instance.pluginManager.plugins.sort())
{
 logger.info( plugin.shortName)
 count = count+1
}
logger.info("<PLUGINS>\nFound " + count + " plugins")
logger.info("End of init.groovy \n... Goodbye Cruel world")

  3. 重新启动 Jenkins 实例：

    sudo /etc/init.d/jenkins restart

  4. 查看位于/var/log/jenkins/jenkins.log的日志文件。输出结果类似于以下内容（注意为了简洁起见，已删除了每秒钟的时间戳的每一行）：

    INFO: RUNNING init.groovy from /var/lib/jenkins
INFO: Here are the Jenkins environment variables on startup
INFO: TERM=xterm
INFO: JENKINS_HOME=/var/lib/jenkins
INFO: SHLVL=1
INFO: XFILESEARCHPATH=/usr/dt/app-defaults/%L/Dt
INFO: COLORTERM=gnome-terminal
INFO: MAIL=/var/mail/jenkins
INFO: XDG_SESSION_COOKIE=3e4cca1158bd9704ef8146c500000008-1413227204.360563-1079526024
INFO: QT_QPA_PLATFORMTHEME=appmenu-qt5
INFO: PWD=/var/lib/jenkins
INFO: LOGNAME=jenkins
INFO: _=/usr/bin/daemon
INFO: NLSPATH=/usr/dt/lib/nls/msg/%L/%N.cat
INFO: SHELL=/bin/bash
INFO: PATH=/usr/local/bin:/usr/bin:/bin:/usr/local/games:/usr/games
INFO: DISPLAY=:0.0
INFO: USER=jenkins
INFO: HOME=/var/lib/jenkins
INFO: XAUTHORITY=/home/alan/.Xauthority
INFO: XDG_SEAT=seat0
INFO: XDG_SESSION_ID=c3
INFO: XDG_VTNR=7
INFO: LANG=en_US.UTF-8
INFO: <PLUGINS>
INFO: ant
INFO: antisamy-markup-formatter
INFO: buildresult-trigger
INFO: claim
INFO: credentials
INFO: cvs
INFO: 
Found 46 plugins
INFO: End of init.groovy
... Goodbye Cruel world

  5. 访问http://localhost:8080/systemInfo并将日志文件与 Jenkins 中显示的系统信息进行比较，如下面的截图所示：操作步骤...

工作原理...

Jenkins 在启动时会寻找 Groovy 脚本来运行。可接受的位置在这里提到(wiki.jenkins-ci.org/display/JENKINS/Groovy+Hook+Script)，包括：

  • $JENKINS_HOME/init.groovy

  • $JENKINS_HOME/init.groovy.d/*.groovy（文件按其词法顺序运行）

Jenkins 从init.groovy中运行代码。它使用了我们初始化的标准java.util.logging框架，该框架的初始化代码如下：def logger = LogManager.getLogManager().getLogger("")。

建议使用日志记录框架而不是老式的println语句。在日志记录框架中，配置与报告分开。通过一点努力，这使您可以更改输出位置（文件系统、syslog 服务器等），格式、过滤器、旋转等。有关日志记录器框架的更多详细信息，请参阅docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html。

记录器可以以各种级别报告；然后您可以过滤结果。在此示例中，我们使用了info级别，因为我们没有在大声报告问题。

首先，脚本遍历环境变量：

def env = System.getenv()
env.each{
  logger.info("${it}")
}

接下来，您使用了 Scriptler 示例的稍微修改版本来列出 Jenkins 中的所有活动插件，如以下代码所示：

for(plugin in hudson.model.Hudson.instance.pluginManager.plugins.sort()) {
  logger.info( plugin.shortName)

最后，我们与系统信息页面进行了视觉比较，该页面也显示了相同的环境细节。

还有更多...

如果您希望分析系统信息以支持调试，请安装 Support Core 插件(wiki.jenkins-ci.org/display/JENKINS/Support+Core+Plugin)。安装完成后，您可以在 URL http://localhost:8080/support/处进行配置。

单击生成捆绑包按钮将支持数据归档下载到您的浏览器中。 Jenkins 还将每小时生成类似的归档，并将 ZIP 文件放置在目录$JENKINS_HOME/support下。信息存储在多个文本文件中。例如，文件support/plugins/active列出了所有活动插件的当前版本：

ant:1.2
antisamy-markup-formatter:1.2
backup:1.6.1
cas1:1.0.1
credentials:1.16.1

以下截图显示了支持页面：

还有更多...

另请参阅

  • 启动时触发事件示例

  • 当网页内容更改时触发事件示例

当网页内容更改时触发事件

在这个示例中，URL 触发器插件将在网页更改其内容时触发构建。

Jenkins 部署到各种基础设施。在您的选择系统上，标准插件有时无法触发。Web 服务器是众所周知的技术。在大多数情况下，您要连接的系统具有其自己的 Web 界面。如果应用程序没有，则仍然可以设置一个网页，在需要 Jenkins 反应时更改该网页。

准备工作

安装 XTrigger 插件(wiki.jenkins-ci.org/display/JENKINS/XTrigger+Plugin)。这将自动安装 URL 触发器插件和一些其他插件，这些插件监视两次检查之间的更改，例如运行本地脚本、Groovy 代码或监视文件或文件夹更改。

如何做

  1. 创建一个名为ch7.plugin.url的新自由样式作业。

  2. 在构建触发器部分，选中**[URL 触发器] - 使用 URL 轮询**复选框。

  3. 点击添加要监视的 URL。

  4. 对于URL，添加http://localhost:8080。

  5. 检查检查 URL 内容。

  6. 从添加内容性质中选择值监视内容变化，如下面的截图所示：操作步骤...

  7. 添加一分钟的时间表。

  8. 点击保存。

  9. 在右侧，点击链接URLTrigger Log：操作步骤...

    现在，您将每分钟看到日志信息更新，内容类似于以下电子邮件：

    Inspecting Monitor a change of the content for URL http://localhost:8080
Polling started on Oct 13, 2014 5:49:00 PM
Polling for the job ch7.plugin.url
Looking nodes where the poll can be run.
Looking for a candidate node to run the poll.
Looking for a node with no predefined label.
Trying to poll with the last built on node.
Trying to poll on master node.

Polling on master.
Invoking the url:   http://localhost:8080
Inspecting the content
The content of the URL has changed.

Polling complete. Took 0.13 sec.
Changes found. Scheduling a build.

  10. 删除作业，因为我们不想每分钟轮询http://localhost:8080。

它是如何工作的...

您已经配置插件每分钟访问我们的本地 Jenkins http://localhost:8080，下载并比较更改。一分钟的时间表是积极主动的；考虑使用与您的 SCM 存储库类似的时间间隔，例如每 5 分钟一次。

由于返回的每个页面存在细微差异，触发器被激活。这一点通过查看URLTrigger Log得到了验证。

URLTrigger 插件也可用于 JSON 和文本或 XML 响应。

还有更多...

URI 模式的一部分指向您的本地文件系统（en.wikipedia.org/wiki/File_URI_scheme）。当您将本地文件加载到 Web 浏览器中时，您会看到这些示例，如下图所示：

更多内容...

本地文件系统的更改无法通过此插件监视。如果重新配置作业指向位置file:///，您将收到以下错误消息：

java.lang.ClassCastException: sun.net.www.protocol.file.FileURLConnection cannot be cast to java.net.HttpURLConnection

您将不得不使用文件系统 SCM 插件。

另请参阅

  • 启动时触发事件的方法

回顾三个 ListView 插件

Jenkins 首页放射出的信息很重要。您对项目质量的最初感知可能会通过这次初次接触来评判。

在这个示例中，我们将回顾可以添加到列表视图中的最后成功、最后失败和最后持续时间列，如下面的截图所示：

回顾三个 ListView 插件

在下一个示例中，您将学习如何为列表视图编写自己的列插件。

准备就绪

安装 List View Columns 插件；最后失败版本列插件（wiki.jenkins-ci.org/display/JENKINS/Last+Failure+Version+Column+Plugin）；最后成功描述列插件（wiki.jenkins-ci.org/display/JENKINS/Last+Success+Description+Column+Plugin）；以及最后成功版本列插件（wiki.jenkins-ci.org/display/JENKINS/Last+Success+Version+Column+Plugin）。

如何操作...

  1. 在选择的目录中将源代码安装到本地：

    git clone https://github.com/jenkinsci/lastfailureversioncolumn-plugin
git clone https://github.com/jenkinsci/lastsuccessversioncolumn-plugin
git clone https://github.com/jenkinsci/lastsuccessdescriptioncolumn-plugin

  2. 在 Jenkins 中，创建一个名为 ch7.plugin.lastview 的新的自由样式作业。不需要进一步的配置。

  3. 在主页面上，点击 All 选项卡旁边的 + 选项卡，如下图所示：操作步骤...

  4. 创建一个名为 LAST 的 列表视图。

  5. 在 作业过滤器 | 作业 下勾选 ch7.plugin.lastview 复选框：操作步骤...

  6. 点击 确定。您将返回到显示 LAST 列表视图的主页面：操作步骤...

  7. 按下 构建 图标以运行 ch7.plugin.lastview 作业：操作步骤...

  8. 刷新页面。最后成功版本 列现在有了数据，并附带构建历史的链接。

  9. 在 最后成功说明 列中，点击 N/A 链接。

  10. 在右侧，点击 添加描述。

  11. 为构建添加描述：这是我的精彩描述。

  12. 点击 提交。

  13. 通过点击页面顶部显示的面包屑中的 LAST 返回到 LAST 列表视图，如下图所示：操作步骤...

  14. 最后成功说明 列现在已经填充：操作步骤...

工作原理...

这三个插件执行类似的功能；唯一的区别是列的细节稍有不同。细节对于快速决策项目非常有用，例如，当构建成功时，向构建添加描述（例如将核心库更新为与现代浏览器兼容）可以让普通查看者了解项目中的最后一个重要操作的概况，而无需深入了解源代码。这样可以节省大量的点击：

工作原理...

更多内容...

这里有大量的 ListView 插件，其中包括：

  • 额外列插件：添加了计算成功和失败构建数量的选项，一个快捷方式到项目的配置页面，一个启用/禁用项目按钮，以及一个项目描述按钮。每个新列都允许您更好地了解项目的状态或更有效地执行操作。

  • Cron 列插件：显示项目中计划的触发器以及它们是否启用或禁用。如果您想要比较来自 Melody 插件的系统监视信息，这将非常有用。

  • Emma Coverage 插件：显示由 Emma 插件报告的代码覆盖率结果。如果您的组织有内部样式指南，并且代码需要达到特定的代码覆盖率水平，这将特别有用。

  • 进度条插件：显示正在运行的作业的进度条。这为前台页面增加了一种活动感。

另请参阅

  • 创建我的第一个 ListView 插件 配方

  • 第四章, 通过 Jenkins 进行通信 中的高效使用视图配方

  • 第四章, 通过 Jenkins 进行通信 中的使用 Dashboard View 插件节省屏幕空间配方

  • 第一章, 维护 Jenkins 中的通过 JavaMelody 进行监控配方

创建我的第一个 ListView 插件

在最后一个配方中，您将创建您的第一个自定义 ListView 插件。这允许您向标准列表视图添加一个额外的列，其中包含注释。列的内容代码是一个占位符，只等着您用自己的精彩实验替换它。

准备就绪

创建一个准备好的代码目录。

操作方法...

  1. 创建一个顶级pom.xml文件，内容如下：

    <artifactId> rootaction</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>hpi</packaging>
   <name>Jenkins Root Action Plugin</name>
<?xml version="1.0"?>
<project 

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
     <version>1.548</version>
</parent>
  <artifactId>rootaction</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>hpi</packaging>
   <name>Jenkins Root Action Plugin</name>
  <repositories>
    <repository>
      <id>repo.jenkins-ci.org</id>
      <url>http://repo.jenkins-ci.org/public/</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>repo.jenkins-ci.org</id>
      <url>http://repo.jenkins-ci.org/public/</url>
    </pluginRepository>
  </pluginRepositories>
 <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
</project>

  2. 创建目录src/main/java/jenkins/plugins/comments。

  3. 在 comments 目录中，添加CommentsColumn.java，其内容如下：

    package jenkins.plugins.comments;
import org.kohsuke.stapler.StaplerRequest;
import hudson.views.ListViewColumn;
import net.sf.json.JSONObject;
import hudson.Extension;
import hudson.model.Descriptor;
import hudson.model.Job;

  public class CommentsColumn extends ListViewColumn {
    public String getFakeComment(Job job) {
      return "Comments for <em>"+job.getName()+"</em>"+
      "Short URL: <em>"+job.getShortUrl()+"</em>";
    }

    @Extension
    public static final Descriptor<ListViewColumn> DESCRIPTOR = new DescriptorImpl();
    public Descriptor<ListViewColumn> getDescriptor(){
      return DESCRIPTOR;
    }

    private static class DescriptorImpl extends Descriptor<ListViewColumn> {
      @Override
      public ListViewColumn newInstance(StaplerRequest req,
      JSONObject formData) throws FormException {
      return new CommentsColumn();
    }
    @Override
    public String getDisplayName() {
      return "FakeCommentsColumn";
    }
  }
}

  4. 创建目录src/main/resources/jenkins/plugins/comments/CommentsColumn。

  5. 在CommentsColumn目录中，添加column.jelly，其内容如下：

    <j:jelly >
  <j:set var="comment" value="${it.getFakeComment(job)}"/>
  <td data="${comment}">${comment}</td>
</j:jelly>

  6. 在CommentsColumn目录中，添加columnHeader.jelly，其内容如下：

    <j:jelly >
  <th>${%Fake Comment}</th>
</j:jelly>

  7. 在CommentsColumn目录中，添加columnHeader.properties，其内容如下：

    Fake\ Comment=My Fake Column [Default]

  8. 在CommentsColumn目录中，添加columnHeader_an.properties，其内容如下：

    Fake\ Comment=My Fake Column [an]

  9. 在src/main/resources目录中，添加插件描述文件index.jelly，其内容如下：

    <div>
  This plugin adds a comment to the sections mentioned in list view.
</div>

  10. 在顶级目录中，运行以下命令：

    mvn -Dmaven.test.skip=true clean install hpi:run -Djetty.port=8090

  11. 访问 Jenkins 作业创建页面：http://localhost:8090/jenkins/view/All/newJob。创建一个名为ch7.plugin.l的新自由样式作业。

  12. 在 Jenkins 的主页面，http://localhost:8090/jenkins，现在将有一个名为我的假栏 [默认]的列视图。如果您将 web 浏览器的首选语言更改为阿拉贡语 [an]，那么该列现在将被称为我的假栏 [an]，如下面的屏幕截图所示：操作方法...

在 Ubuntu 的默认 Firefox 浏览器中，您可以在编辑/首选项内容选项卡下的语言部分更改首选语言，如下面的屏幕截图所示：

操作方法...

工作原理...

在这个配方中，创建了一个基本的 ListView 插件，具有以下结构：

├── pom.xml
└── src
 └── main
 ├── java
 │   └── jenkins
 │       └── plugins
 │           └── comments
 │               └── CommentsColumn.java
 └── resources
 ├── index.jelly
 └── jenkins
 └── plugins
 └── comments
 └── CommentsColumn
 ├── columnHeader_an.properties
 ├── columnHeader.jelly
 ├── columnHeader.properties
 └── column.jelly

插件中包含的一个 Java 文件是CommentsColumn.java，位于/src/main/java/jenkins/plugins/comments下。该类扩展了ListViewColumn扩展点。

方法getFakeComment期望输入类型为Job并返回一个字符串。此方法用于填充列中的条目。

在 ListView 中 GUI 是在 /src/main/resources/packagename/Classname/ 下定义的。你可以找到 /src/main/java/jenkins/plugins/comments/CommentsColumn.java 对应到 /src/main/resources/Jenkins/plugins/comments/CommentsColumn 目录的 GUI。在这个目录中，有两个 Jelly 文件 columnHeader.jelly 和 column.jelly。

正如其名称所示，columnHeader.jelly 渲染了 ListView 中列的标题。其内容如下：

<j:jelly >
  <th>${%Fake Comment}</th>
</j:jelly>

FAKE Comment 在 columnHeader.properties 中定义。% 符号告诉 Jelly 根据 web 浏览器返回的语言设置值查找不同的属性文件。在这个示例中，我们将 web 浏览器的语言值设置为 an，这会首先查找 columnHeader_an.properties 文件。如果 web 浏览器返回的语言没有自己的属性文件，那么 Jelly 将默认使用 columnHeader.properties。

columns.jelly 的内容如下：

<j:jelly >
  <j:set var="comment" value="${it.getFakeComment(job)}"/>
  <td data="${comment}">${comment}</td>
</j:jelly>

it.getFakeComment 调用了 CommentsColumn 类的 getFakeComment 方法。这是对象实例的默认名称。返回的对象类型是按约定定义的，文件结构/src/main/resources/Jenkins/plugins/comments/CommentsColumn。

返回的字符串被放置在变量 comment 中，然后显示在 <td> 标签中。

注意

如果你对 Jenkins 中可用的 Jelly 标签感兴趣，请参阅 wiki.jenkins-ci.org/display/JENKINS/Understanding+Jelly+Tags。

还有更多...

如果你想参与社区活动，那么治理页面是必读的（wiki.jenkins-ci.org/display/JENKINS/Governance+Document）。关于许可证的问题，该页面说明了：

核心完全采用 MIT 许可证，因此大多数基础设施代码（运行项目本身的代码）和许多插件也是如此。我们鼓励托管的插件使用相同的 MIT 许可证，以简化用户的操作，但插件可以自行选择许可证，只要它是 OSI 批准的开源许可证即可。

你可以在 opensource.org/licenses/alphabetical 找到已批准的 OSI 许可证列表。

大多数插件的顶级目录中都有一个 LICENSE.txt 文件，采用 MIT 许可证（en.wikipedia.org/wiki/MIT_License）。例如，请查看 github.com/jenkinsci/lastfailureversioncolumn-plugin/blob/master/LICENSE.txt。其结构类似于以下内容：

The MIT License

Copyright (c) 20xx, Name x, Name y…

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

另见

  • 审查三个 ListView 插件 配方

附录 A. 提高质量的流程

质量保证要求专家关注各种细节。这些细节与人类行为相关，而不仅仅是技术性的。本章提到了运行成功项目所需的软技能以及本书配方中所规范化的配置技能。以下是一些通过实践获得的观察。

早期失败

在软件生命周期的后期纠正问题，成本会更高。尽早失败比之后失败要便宜得多。持续集成允许您自动早期失败。通过插件或连接的云服务添加额外的测试会更有机会早期发现问题，从而提高质量并降低成本。接受问题是一种拥抱，因为这样可以节省时间和金钱。

以下是一些相关资源：

  • 在第一章 Maintaining Jenkins 中的通过日志解析有意失败的构建配方

  • 在第六章 Testing Remotely 中的使用 Selenium Webdriver 触发故障安全集成测试 配方

  • 通过项目生命周期的错误成本递增在ntrs.nasa.gov/search.jsp?R=20100036670

数据驱动的测试

如果您使用数据驱动的测试方法，您可以有效地覆盖您的测试范围。例如，在编写 JMeter 测试计划时，您可以使用 CSV 配置元素从文本文件中读取变量。这允许 JMeter 从 CSV 文件中读取参数，例如主机名，并横跨您的基础设施。这使得一个测试计划可以攻击许多服务器。对于 SoapUI 也是如此；通过添加 Excel 数据源并循环遍历行，您可以测试具有许多不同测试用户的应用程序，每个用户都具有一系列角色。数据驱动的测试有一种易于维护的倾向。在重构期间，不需要像应用程序中的 URL 一样更改测试计划，可以将 URL 因素化为 CSV 文件。

以下是一些相关资源：

  • 在第六章 Testing Remotely 中的创建 JMeter 测试计划 配方

  • 在第六章 Testing Remotely 中的使用 SoapUI 编写测试计划 配方

  • 在第六章 Testing Remotely 中的用于从属节点的自定义设置脚本 配方

  • 在第六章 Testing Remotely 中的使用 Apache JMeter 测试云应用程序 配方

  • 使用 SoapUI 进行数据驱动方法的测试，www.soapui.org/Data-Driven-Testing/functional-tests.html

历史教训

团队往往有自己的编码习惯。如果项目因代码质量而失败，请尝试弄清楚哪些代码指标会阻止代码达到生产环境。哪些错误经常出现？看看以下例子：

  • 周五下午的代码失效：我们都是人，都有次要议程。到了一周的末尾，程序员可能把注意力放在代码之外的地方。一小部分程序员会受到影响，他们的代码质量会受到影响，而在排班的最后阶段会不断注入更多的缺陷。考虑安排一个每周执行的 Jenkins 作业，在注意力最不集中的时间附近设置更严格的质量指标阈值。

  • 代码变动: 在将产品从验收环境移至产品环境之前，代码提交突然激增表明存在最后一刻的匆忙。对于一些有着较强代码质量意识的团队来说，这也是额外警惕的迹象。对于其他纪律性较差的团队来说，这可能是朝着毁灭的天真推进。如果项目失败，QA 因代码变动激增而不堪重负，请考虑根据提交速度设置一个警告 Jenkins 作业。如有必要，您可以展示您自己的定制指标。有关更多信息，请参阅 第三章 中的 构建软件 中的 在 Jenkins 中绘制替代代码指标 配方。

  • 一个流氓程序员：并非所有开发者都能创造出统一高质量的代码。在一个项目中可能存在持续的表现不佳情况。流氓程序员会被人工代码审查发现。然而，作为第二道防线，考虑在 FindBugs 和 PMD 的静态代码审查报告中设置阈值。如果某个开发者没有遵循接受的做法，构建将会以极高的频率失败。有关更多信息，请参阅 第五章 中的 使用指标提高质量 中的 使用 FindBugs 查找错误 配方。

  • GUI 没有意义: 当您构建一个 Web 应用程序，最后时刻却被告知 GUI 与产品所有者预期的交互方式不太一样时，这不是很痛苦吗？一个解决方案是在 FitNesse 中编写一个模型，并用夹具将其包围起来进行自动功能测试。当 GUI 与计划的工作流程不符时，那么 Jenkins 将开始大声喊叫。有关更多信息，请参阅 第六章 中的 远程测试 中的 激活 FitNesse HtmlUnit 夹具 配方。

  • 跟踪责任：错误总会发生，需要吸取教训。然而，如果没有清晰的责任链条记录，很难确定谁需要学习机会。一种方法是通过一系列连接的任务来构建 Jenkins 中的工作流程，并使用推广构建插件确保正确的团队在正确的时点进行验证。这种方法也适用于提醒团队完成短期任务。有关更多信息，请参阅第七章中的测试然后推广构建配方，探索插件。

将测试自动化视为一个软件项目

如果您将自动化测试视为一个软件项目，并应用已知原则，那么您将节省维护成本并提高测试的可靠性。

不要重复自己（DRY）原则是一个很好的例子。在时间压力下，从代码库的一个区域复制并粘贴类似的测试是诱人的：不要这样做。项目发展会扭曲代码库的形状；测试需要可重用以适应这种变化。脆弱的测试会增加维护成本。一个具体的例子是在第六章中简要讨论的，远程测试，就是使用 Selenium WebDriver 的页面对象。如果将代码分开成页面，那么当页面之间的工作流程发生变化时，大部分测试代码仍然保持不变。

有关更多信息，请参阅第五章中的激活更多 PMD 规则集配方，使用指标提高质量。

保持简单愚蠢（KISS）原则意味着尽可能地保持项目的每个方面简单。例如，可以使用真实的浏览器进行自动化功能测试，也可以使用 HtmlUnit 框架模拟浏览器。第二种选择避免了设置内存中的 X 服务器或 VNC（en.wikipedia.org/wiki/Virtual_Network_Computing）的需要，并且还会跟踪浏览器版本。这些额外的琐事会降低运行 Jenkins 作业的可靠性，但会增加测试的价值。因此，对于小型项目，考虑从 HtmlUnit 开始。对于较大的项目，额外的努力是值得的。有关更详细信息，请参阅第三章中的使用 Selenium WebDriver 触发 failsafe 集成测试配方，构建软件。

考虑是否需要一个独立的集成服务器，或者是否可以使用 Maven 中的集成目标调用 Jetty 服务器。有关更详细信息，请参阅第三章中的为集成测试配置 Jetty配方，构建软件。

可视化，可视化，可视化

当您拥有由不同团队和个人开发的许多项目散布在多个服务器上时，要理解关键指标和出现的问题是困难的。

80% 的信息通过您的大脑进行视觉处理，并且您的大脑是一个出色的模式识别器，理解底层复杂性的技巧之一是可视化您的 Jenkins 作业结果。

SonarQube 是可视化和获取项目整体质量概览的绝佳起点，并且用于深入研究代码不同领域之间的关系和耦合。有关更多信息，请参阅第五章中的 将 Jenkins 与 SonarQube 集成 配方，使用指标改善质量。

但是，如果您有专门的需求，您将需要构建图形生成。测试结果通常以 XML 或 CSV 格式存储。一旦积累了结果，您可以使用您选择的语言轻松地转换它们。

R 是专为统计学家和科学家设计的语言。数据收集后，会尝试探索哪些变量是相关的。为此，R 社区创建了许多辅助图形包。有关详细信息，请参阅第五章中的 使用 R 插件分析项目数据 配方，使用指标改善质量。

以下图形是总结本书内容的词云。在 10 行代码内，R 语言生成了它。R 使用 tm 和 wordcloud 包的组合。您可以从本书的网站下载代码。

可视化，可视化，可视化

R 中的图形库展示了令人瞩目的成果示例。将example()命令置于您选择的函数周围，基于该函数运行示例代码。以下代码显示了plot和hist图形函数的图形。代码包含在图形中：

example(plot)
example(hist)

x <- rchisq(100, df = 4)
hist(x, freq = FALSE, ylim = c(0, 0.2))
curve(dchisq(x, df = 4), col = 2, lty = 2, lwd = 2, add = TRUE)

一旦您发现了一个新的有趣函数，您可以通过搜索文档进一步探索其帮助。例如，键入 ?rchisq 将输出以下信息：

密度、分布函数、卡方分布（chi²）的分位函数和随机生成具有 df 自由度和可选非中心参数 ncp 的卡方分布。

有关更多信息，请参阅第四章中简化 使用 R 插件进行强大的可视化 配方，通过 Jenkins 进行通信。

下图显示了hist函数生成的图形：

可视化，可视化，可视化

rgl 包具有生成引人注目图形的广泛功能。

要从 Ubuntu 命令行安装 rgl 包及其依赖项，请键入以下命令：

sudo apt-get install r-cran-rgl

要查看一些示例，请从 R 控制台运行以下命令：

library(rgl)
example(plot3d)
example(ellipse3d)
example(surface3d)
example(persp3d)

你会看到类似以下截图的输出：

可视化，可视化，可视化

以下是一些相关资源：

约定是好的

遵循约定，你会减少维护量并降低代码中隐藏的缺陷数量。当有多个开发人员参与编写代码时，编码约定尤为重要。约定有助于可读性。一致缩进的代码会让人注意到编写不好的部分。良好结构化的变量名有助于避免组织不同部分编写的代码之间的命名冲突。命名中的结构突出了以后可以移动到配置文件中的数据，并增加了使用正则表达式进行半自动重构的机会，例如，你可以编写一小段 R 代码来可视化每个模块的全局变量数量。全局变量越多，多个用途使用相同变量的风险就越大。因此，图表是代码质量的一个粗略指标。

以下是一些相关资源：

测试框架和商业选择不断增加

在过去几年中，测试自动化方面取得了很多进展。一个例子是静态代码审查被更全面地用于安全检查。SonarQube 是一个全面报告项目质量的工具，新框架正在出现以改进旧框架。以下是一些含义：

  • SonarQube: 这可以衡量项目质量。其社区活跃。SonarQube 将比 Jenkins 的全部质量度量插件更快地发展。考虑使用 Jenkins 插件来提前警告负面质量变化，使用 SonarQube 进行深度报告。有关更多信息，请参阅 第五章 使用指标改进质量 中的 将 Jenkins 与 SonarQube 集成 配方。

  • 静态代码审查工具: 这些正在改进。FindBugs 已将评论功能移到云中。正在开发更多的错误模式检测器。静态代码审查工具在查找安全性缺陷方面变得更加出色。随着时间的推移，您可能会期望显着改进的工具，可能只需更新当前工具的版本即可。有关更多详细信息，请参阅 第五章 使用指标改进质量 中的 使用 FindBugs 查找安全性缺陷 配方

  • 代码搜索: 如果代码搜索引擎根据缺陷密度或编码实践在其搜索结果中对特定代码片段的位置进行排名，那不是很好吗？然后，您可以搜索广泛的开源产品以找到最佳实践。您可以搜索缺陷以删除，然后将补丁发送回代码的社区。

  • 云: CloudBees 允许您在云中创建按需的从节点。预计在 Jenkins 周围会有更多类似云的集成。

有关 SonarQube 功能和 CloudBees 云服务的更多信息，请访问 www.sonarqube.org/features/ 和 www.CloudBees.com/products/dev。

将工作分配到 Jenkins 节点

由于其丰富的插件，Jenkins 可以轻松连接到许多类型的系统。因此，在组织中，Jenkins 的使用可能会像病毒一样扩散。测试和 JavaDoc 生成会占用系统资源。最好使用主 Jenkins 快速报告分布在一系列 Jenkins 节点上的作业。这种方法使得更容易分析失败在基础架构中的位置。

如果您在规模上使用 JMeter 进行性能测试，请考虑将其从 Jenkins 转移到诸如 BlazeMeter (blazemeter.com/) 等云服务。

对于使用 Selenium 进行功能测试，也有许多云服务可供选择。考虑使用它们不仅仅是因为负载，还因为它们提供了广泛的浏览器类型和版本。一个商业服务的例子是 Sauce Labs (saucelabs.com/)。定期审查市场以了解新的云服务是值得的。

以下是一些相关资源：

  • 在第一章 维护 Jenkins 中的 通过 JavaMelody 进行监控 配方

  • 创建多个 Jenkins 节点 在第六章中的Testing Remotely食谱中

  • 自定义从属节点的设置脚本 在第六章中的Testing Remotely食谱中

使 QA/集成服务器处于饥饿状态

几百年前，煤矿工人会因矿井中甲烷和一氧化碳的积聚而死亡。为了提前警告这种情况，人们在矿井中引入了金丝雀。由于它们更加敏感，鸟类会首先晕倒，给矿工足够的时间逃脱。考虑在您的验收环境中为集成服务器采取同样的做法：故意使它们资源匮乏。如果它们崩溃了，您将有足够的时间进行审查，然后看着生产中的爆炸。

要了解更多信息，请参考第一章中的通过 JavaMelody 进行监控食谱，Maintaining Jenkins。

阅读 Jenkins 的变更日志

Jenkins 践行其所宣扬的。次要版本号发布大约每周一次。新功能出现，错误被解决，新错误被引入。一般来说，绝大多数的变更都会带来改进，但也有少数不会。然而，一旦引入，错误通常会很早被发现并迅速被修复。

在更新 Jenkins 以获取新功能和潜在稳定性故障之前，值得阅读变更日志（jenkins-ci.org/changelog）。偶尔，您可能希望因安全问题而加快部署到生产环境的速度，或者由于稳定性失误而错过某个版本。

注意

如果您专注于稳定性而不是功能丰富性，请考虑使用更老但更稳定的长期支持版本。更多详细信息请访问：wiki.jenkins-ci.org/display/JENKINS/LTS+Release+Line。

避免人为瓶颈

您的测试环境越简单，维护所需的技能就越少。随着您学习使用插件并探索新工具和脚本语言的潜力，组织需要维护稳定系统的知识越多。如果您希望在没有随机短信请求建议的情况下度假，请确保您的知识已传递至少给第二人。这听起来很明显，但在您日常工作的忙碌中，这个原则经常被遗忘或搁置一边。

共享知识的最简单方法之一是让几名开发人员一起参加同一场会议和活动（www.CloudBees.com/company/events/juc）。

这就是经理在知识传播中发挥重要作用的地方。他们需要及时计划和活动，以便分享知识，而不是期望它会以魔术般的方式发生。

避免群体思维

在纸上变得完美很容易，定义了一套完整的 JavaDocs 和单元测试的重要性。然而，现实世界在最好的日子里也是混乱的。由于需要交付而产生的项目动力是一股难以抵御的力量。

与项目动力相关的是项目团队或资源所有者可能发生的群体思维现象。如果团队有错误的集体态度，作为质量保证专业人员，注入已经学到的现实主义会更加困难。质量保证不仅仅是尽早发现和捕获缺陷，还要在项目周期的不同阶段注入客观的成功或失败标准。

考虑将可衡量的标准添加到 Jenkins 构建中。显然，如果代码无法编译，则产品不应提交给验收和生产。不太明显的是，关于单元测试代码覆盖率的规则是否值得在发布管理会议上辩护？

在项目开始之前让整个团队参与，并在任何编码之前就达成一致，同意构建失败的度量标准。一种方法是将一个小成功项目与一个小失败项目进行比较。如果后来发生争议，那么争论的焦点就是流程和数字，而不是个性。

更多信息，请参阅 第五章 使用指标提高质量 中的 通过代码覆盖寻找“有味道的代码” 配方。

培训和社区

参与 Jenkins 和更广泛的测试人员社区的培训对于通向优化环境的长期学习路径至关重要。以下是一些相关资源：

对成功开发者进行可见的奖励

这是一个对资源经理的呼吁。开发人员和测试人员专门从事有时很难向不了解他们问题领域的人解释的技术问题。要达到最高水平的专业知识，并跟踪趋势需要时间（有时是他们自己的很多时间）、精力和动力。削弱他们的动力或低估建立技能所需的时间最终将降低产品的质量，并且最终会花费更多。考虑一下你可以做些什么来支持他们，从工资水平的跳跃、学习路径、为开发人员保留时间阅读和实践新想法，到会议和小工具。例如，在加薪之后，Kickstarter（www.kickstarter.com/）是一个很好的地方，可以寻找激励性的奖励，并激发开发人员的创造力。

最后，不要让开发人员做非开发性的工作。一般来说，他们需要高度专注于理解详细的需求，并将其转化为牢固的代码的复杂任务。

稳定性和代码维护

本书提到了许多插件和一些语言和测试工具。在开发中进行实验然后推向验收是可以的，但是在生产中拥有更多的多样性，需要更多的技能来维护，尤其是编写流畅的工作流。微妙的选择，比如将 Jenkins 插件固定在已知版本，并且将 Jenkins 服务器的生产版本稳定在固定时间段内，有助于提高上线时间。同样重要的是，监控负载并将大部分工作远离主 Jenkins，确保工作的时序性。

限制工作维护意味着保持配置的简单和相似。在一个具有高度多样性的复杂组织中，这是不现实的。采用测试驱动的方法是有帮助的；惯例也简化了配置。随着多样性的增加，沟通和达成惯例变得重要。简单的策略——比如一份文档智慧的源头（例如，一个共同的维基），定期的经验总结会议，以及每周的回顾——变得至关重要。

质量保证资源

认为测试是测试人员的唯一责任是错误的。程序员应该对他们的代码质量负责，架构师应该对他们的设计质量负责，管理人员应该对项目的精神和项目规划负责，等等。以下是一些实用的资源范例，涵盖了可行的质量保证领域——这不仅仅是为了测试人员：

  • 关于避免经过多年的艰辛和挫折的经典错误的许多明智的话语。其中一组深思熟虑的评论可以在www.exampler.com/testing-com/writings/classic/mistakes.html找到。

  • 如果单元测试充分覆盖了你的代码，那么如果你在更新过程中破坏了一段代码，你将在下一次构建过程中迅速发现这一点。JUnit 可以说是这个领域中最著名的框架。你可以在junit.org/找到该框架的主页。

  • Jenkins 主页（jenkins-ci.org/）涵盖了大量关于配置、插件、社区、提示和技巧的实用信息。

  • 开放式网络应用安全项目（OWASP）是一个关于安全测试的信息和工具的重要来源。OWASP 致力于提高软件的安全性。其使命是使软件安全可见，以便全球个人和组织能够就真实的软件安全风险做出知情决策。你可以在www.owasp.org/index.php/Main_Page找到 OWASP 的主页。

  • 如果你想要 OWASP 材料的实体书或电子书，你可以从 Lulu（www.lulu.com/spotlight/owasp）下载或购买。

  • 你可以在www.owasp.org/index.php/OWASP_Testing_Guide_v4_Table_of_Contents找到 OWASP 的安全测试指南。

  • 一个流行的商业公司销售云端 Jenkins 基础设施的例子是 Sauce Labs（docs.saucelabs.com/ci-integrations/jenkins/）。

  • 有许多优秀的免费软件测试杂志可供下载。专业测试员就是其中之一，可以在www.professionaltester.com/找到。

  • uTest 是世界上最大的致力于专业测试员和软件测试的开放社区。它的唯一目的是促进和推进测试专业及从事这项重要工作的人。更多信息，请访问www.utest.com/about-us。

  • 越来越多的免费 MOOC 课程，其中一些支持软件测试员的学习路径。你可以在www.mooc-list.com/找到当前正在运行的 MOOC 课程的完整列表。

  • 有数以百计的优秀博客聚焦于测试。马丁·福勒的博客（martinfowler.com/）是一个很好的资源，而 Jenkins 的创始人小冈晃佑还有另一个博客（kohsuke.org/）。

  • 静态代码审查允许作业在不需要人工干预的情况下找到各种问题。我在 Free Software Magazine 上撰写的一系列关于静态代码审查的文章可以在www.freesoftwaremagazine.com/articles/destroy_annoying_bugs_part_1找到。

还有更多

总是有更多要考虑的地方。以下是一些精选的内容：

  • 模糊团队边界：诸如 FitNesse 和 Selenium IDE 等工具使非 Java 程序员编写测试更加容易。编写测试越容易，相关测试捕获用户期望的本质细节的可能性就越大。寻找支持降低学习曲线的工具的新 Jenkins 插件。有关更多信息，请参阅第六章中的 运行 Selenium IDE 测试 配方，远程测试。

  • 故意添加缺陷：通过轮流使用 Jenkins 构建，然后故意添加失败的代码，可以测试团队的警觉性和响应时间。

    提示

    警告

    在添加缺陷之前，请确保团队已经同意了这个过程，否则你可能会在深夜收到愤怒的电子邮件。

  • 使用链接爬虫和安全扫描器增加代码覆盖率：模糊器发现正在攻击的应用程序的输入，然后发射意外输入。这不仅对安全测试有好处，而且对边界测试也有好处。如果您的服务器返回意外错误，则使用模糊器触发更彻底的审核。模糊器和链接爬虫是增加测试代码覆盖率的廉价方法。有关更多信息，请参阅第二章中的 在 Jenkins 中通过模糊测试查找 500 错误和 XSS 攻击 配方，增强安全性。

  • 在您的开发环境中，定期查看新的 Jenkin 插件。插件数量正在迅速增加，可能会有新的方式将 Jenkins 连接到组织基础设施的不同部分以进行持续集成。

最后评论

Jenkins 与积极的自动化测试的结合构成了对编码项目的坚实安全网络。本书中的配方支持最佳实践。

生成高质量的作品需要高度关注细节。Jenkins 可以关注许多细节，然后在发生违规行为时大声呼喊。

每个项目都是不同的，有许多方法来构建工作流程。幸运的是，有超过 1000 个插件，并且数量迅速增长，Jenkins 足够灵活，可以适应甚至最隐蔽的基础设施。

如果您没有您想要的确切插件，那么对于 Java 程序员来说，自行适应或创建自己的插件是很简单的。

注意

没有蓬勃发展的开源 Jenkins 社区，这一切都不可能实现。Jenkins 是开源精神在实践中的又一个积极例证。如果您同意，请考虑参与。

avatar
文章
阅读
粉丝