Jenkins 插件安装与用户指南

EOL 通知:将不再对用于 Jenkins 的 CA Agile Central 插件进行增强或修复,而技术支持将在 2018 年 6 月终止。 现有客户可以继续使用该集成,但建议您使用最新的、适用于 Jenkins 的内部版本连接器。新的连接器支持管道作业、具有预览模式、提供日志文件,同时也是我们将继续增强的版本。

概述

适用于 Jenkins 的 CA Agile Central 插件可让团队使用 CA Agile Central 来查看当前所执行项目的内部版本状态、显示有关内部版本运行状况的图表,以及跟踪内部版本的代码提交。此插件可通过将内部版本数据填充到 CA Agile Central 来实现此目的。

与版本控制系统 (VCS) 和 CA Agile Central VC 连接器配合使用时,Jenkins 插件还会将内部版本链接到更改集。CA Agile Central VC 连接器会解析提交消息,且如果提及 CA Agile Central 构件(如 DE27),VCS 连接器则会将此构件链接到提交给 SCM 系统的更改的更改集。当下一 Jenkins 内部版本出现时,Jenkins 插件会将此更改集链接到 CA Agile Central 中的内部版本。结果为来自“情景/缺陷”→“更改集”→“内部版本”的可跟踪性。

此外,还可构建自定义显示板以显示“内部版本运行状况”和“可跟踪性”应用程序来管理整个企业的持续内部版本/测试管道的运行状况。

本安装指南包括:

软件要求

Jenkins 支持

  • 我们当前支持 Jenkins 2.7.1。(由于 Jenkins 版本 1.598 到 1.609 中的缺陷,这些版本无法与此插件在以下任意所列平台上使用。)
  • 已在 Ubuntu、CentOS、Mac OS X 和 Windows Server 2012 上完成测试。建议使用这些操作系统。

SCM 系统支持

  • SCM 系统是将更改集链接到 CA Agile Central 中的内部版本对象以便将情景/缺陷跟踪到内部版本的必要系统。
  • 经认证支持 Git、Subversion 和 Mercurial。
  • SCM 系统的 Jenkins 插件必须安装在 Jenkins 中。Jenkins 具有内置 Subversion 插件,而 Jenkins CI 站点则提供了适用于 Git 和 Mercurial 的可选插件。
  • 相应 SCM 的 CA Agile Central VCS 连接器必须进行安装才能将更改集填充到 CA Agile Central(GitSubversionMercurial)。
  • 注意*** Jenkins 插件当前不支持 SSO

连接器下载

要下载该连接器,请完成此处的步骤。

安装

安装该插件需完成以下基本步骤:

  1. 将 Ruby 运行时插件安装到 Jenkins(一次)
  2. 将 CA Agile Central 内部版本通知程序插件安装到 Jenkins(一次)
  3. 配置插件的全局设置(一次)
  4. 配置 Jenkins 作业以将内部版本结果发布到 CA Agile Central(针对每个作业)

设置 CA Agile Central

确认目标 WorkspaceConfiguration 对象已将 BuildandChangsetEnabled 设为 true。

CA Agile Central 工作区管理员需要为目标工作区启用此设置。如果未启用,连接器将起作用,但您将无法看到与您的 Rally 工作项(情景、缺陷、任务)关联的变更集/变更信息。

工作区管理员必须编辑工作区并执行以下操作:

  1. 选择“设置”图标
  2. 选择“工作区和项目”选项卡。
  3. 在“工作区和项目”摘要页面上,选择工作区。
  4. 在“操作”下拉列表中,选择“编辑”。
  5. 在工作区编辑器中,选中标记为“启用内部版本和更改集”的复选框。
  6. 选择“保存并关闭”。

 

Jenkins 设置

如果您不熟悉 Jenkins 插件,请针对插件参阅 Jenkins 文档以熟悉相关概念以及如何在 Jenkins 中安装插件。

将插件从先前版本升级到 4.0.1 版本

如果您先前在使用适用于 CA Agile Central v4.0.0 或以下版本的 Jenkins 插件,您应在安装 v4.0.1 的 Jenkins 插件之前完成以下步骤:

  1. 记下全局和作业级别的所有 Jenkins 设置。安装新的插件后,您需要重新输入这些设置。
  2. 从 Jenkins 卸载适用于 Jenkins 的 CA Agile Central 插件(或 Rally 插件)
  3. 按照以下说明将插件安装到 Jenkins

在 Linux、Mac OS X 和 Windows Server 2012 上将插件安装到 Jenkins

您也可在插件随附的自述文件中找到此信息。

您可能需要重新启动 Jenkins。

  1. 在 Jenkins 界面上,导航到“管理 Jenkins”→“管理插件”
  2. 选择“Advanced”(高级)选项卡。
  3. 在“Upload Plugin”(上传插件)部分,选择“Choose File”(选择文件),然后选择“ruby-runtime-plugin-0.14.hpi”。
  4. 选择“Upload”(上传)。Jenkins 随即显示插件安装的状态屏幕。
  5. 按以上相同步骤安装 Jenkins CA Agile Central 发布程序插件。
  6. 导航到“Manage Plugins”(管理插件)屏幕,然后选择“Advanced”(高级)选项卡。
  7. 在“Upload Plugin”(上传插件)部分,选择“Choose File”(选择文件),然后选择“agile-central-build-publisher-1.0.1.hpi”。Jenkins 随即显示状态屏幕,其中显示插件安装。

 

注意:步骤的顺序非常重要。如果 agile-central-build-publisher 是在 ruby-runtime-plugin 之前上传,Jenkins 则会自动安装 0.12 版本的 ruby-runtime 插件而非所需的 0.14 版本。我们的插件无法与 CA Technologies 先前打包的公用 0.12 版本 (ruby-runtime-plugin-0.12.hpi) 或 0.13 版本搭配使用。

 

配置

安装此插件后,需要在全局级别对其进行配置,并为每个 Jenkins 作业配置一次。

配置全局设置

  1. 在 Jenkins web 界面上,转到“管理 Jenkins”→“系统配置”。
  2. 在“CA Agile Central 内部版本发布程序”部分,填写以下字段:
    • CA Agile Central 服务器:在文本框中输入 rally1.rallydev.com。如果您正在评估 CA Agile Central,请输入 trial.rallydev.com。如果您正在运行内部部署实例,请输入 CA Agile Central 服务器的名称。
    • CA Agile Central 用户名和 CA Agile Central 密码:可访问要在其中发布 Jenkins 内部版本结果的工作区的 CA Agile Central 用户的用户名和密码。
  3. 如果您通过代理服务器访问 CA Agile Central,请在“ CA Agile Central Build Publisher Proxy Settings”(CA Agile Central 内部版本发布程序代理设置)部分选择“Advanced”(高级)以显示用于指定代理的字段:
    • 代理服务器:代理服务器的名称或 IP 地址
    • 代理端口:在代理服务器上使用的端口号
    • 代理用户名(可选):代理服务器的有效用户名(如果代理服务器要求进行身份验证)
    • 代理服务器密码(可选):代理服务器的有效密码(如果代理服务器要求进行身份验证)

配置 Jenkins 作业以发布内部版本结果

Jenkins 中的任意免费或 maven2 作业均可通过配置以在 CA Agile Central 中发布“内部版本定义和内部版本”。CA Agile Central 中的每个项目均有一个或多个可用于发布内部版本状态指示器的内部版本定义。

在 Jenkins 中:

  1. 转到您要通过配置将构建结果发布到 CA Agile Central 的 Jenkins 作业,然后选择左上角的“Configure”(配置)。
  2. 在页面的“Post-build Actions”(构建后操作)部分,选择“Add post-build action”(添加构建后操作)下拉列表并选择“CA Agile Central Build Publisher”(CA Agile Central 构建发布程序)选项。
  3. 在页面的“CA Agile Central 内部版本发布程序”部分,输入要向其发布内部版本结果的 CA Agile Central 工作区和项目的名称(注意:您在全局配置中输入的用户必须具有您所指定的工作区的操作权限)。已知问题:如果发布到子项目,则会为项目输入顶级项目。如果引用子项目,插件将显示以下错误:ERROR: [Rally Publisher] Unable to post Build info to Rally for Test1 build #35, unable to find default project SubProj1
  4. 在配置页面上选择“Save”(保存)。

作业下次运行时,此插件会搜索 CA Agile Central 中与 Jenkins 作业同名的内部版本定义。如果无法找到,则会创建一个。每当作业运行时,均会在 CA Agile Central 中创建内部版本对象并链接到此内部版本定义。

按需重复执行这些步骤以配置其他 Jenkins 作业,从而将结果发布到其他 CA Agile Central 项目。

在 CA Agile Central 中查看内部版本信息

在报告中查看内部版本运行状况

内部版本运行状况报告将在 Rally 中的“报告”→“报告”页面提供。具体而言,“内部版本运行状况”和“内部版本运行状况 (按迭代)”均可用。

创建自定义内部版本显示板

构建自定义显示板时,您可以从四个不同的内部版本显示板应用程序进行选择,其中包括“内部版本运行状况”、“内部版本运行状况 (按迭代)”、“内部版本可跟踪性”和“内部版本显示板”。

故障排除

使用以下命令以调试模式启动 Jenkins 和查看消息:

java  -Drally.debug="true"  -jar  jenkins.war  --httpPort=9000

控制台输出

如果您在使用插件时出现问题,请查看作业的控制台输出或正在运行 Jenkins 的应用程序服务器日志。要查看作业的控制台输出,请在 Jenkins Web 界面上选择内部版本号,然后在出现的 Jenkins 页面上选择“Console Output”(控制台输出)。

Tomcat 服务器日志

如果您使用的是 Tomcat,请导航到 [TOMCAT_INSTALL_DIR]/logs/catalina.out 以查看应用程序服务器日志。

密码更改

确保您在插件的“全局配置”中输入的 CA Agile Central 用户名和密码均正确且未更改。

对象模型

适用于 CA Agile Central 的 Jenkins 插件运行后,CA Agile Central 中各数据对象之间的关系如下:

历史版本要点

  • 已添加上下文标识参数。
  • 已保留全局设置并可用于重新启动 Hudson。
  • 对 Rally 中的内部版本定义和内部版本对象提供支持。
  • 对直到 1.381 的各 Hudson 版本提供支持。
  • 对 Hudson 中的各 Maven2 项目类型提供支持。
  • 支持将 Git 和 Perforce 用作 SCM 选项。
  • 保持 Rally 的代理设置
  • 用 Jenkins 提供的值来填充内部版本对象中的“持续时间”字段。
  • 已添加调试标志。

支持的版本

版本 终止支持
Jenkins 2.x 及更高版本 不适用
Jenkins 1.642.4 到 1.651.2 2016 年 12 月 1 日
Jenkins 1.42 到 1.642.3 2016 年 12 月 1 日
Jenkins 1.41 及更低版本;任意 Hudson 版本 2013 年 4 月 1 日

修订历史记录

  • 4.0.1 2016 年 5 月 18 日
    • 修复:
      • 因先前的 ruby-runtime-plugin 而导致的针对 Agile Central 的 SSL 连接错误。
  • 4.0.0 2015 年 11 月 16 日
    • 增强功能:
      • 重新设计品牌。
  • 3.0.6 2015 年 2 月 25 日
    • 已知问题:
      • 在内部版本配置中输入子项目时收到以下错误:

        ERROR: [Rally Publisher] Unable to post Build info to Rally for Test1 build #35, unable to find default project SubProj1

      • 插件未正确转换项目名称的中文字符。

版本历史记录

版本 注释 文件 日期
4.0.1
  • 因 SSL 故障导致修复中止
Jenkins 插件 4.0.1 2016 年 5 月 18 日
4.0.0
  • 重新设计品牌
Jenkins 插件 4.0.0 2015 年 11 月 16 日
3.0.6
  • 已使用新的体系结构重新进行构建
  • 修复缺陷:项目名称中的特殊字符和拖尾空格
Jenkins 插件 3.0.6 2015 年 1 月 28 日
1.0 - 2.4.1 不支持  

反馈

需要更多帮助? CA Agile Central 社区为您提供一站式自助和支持。要将反馈或支持请求提交到 CA Agile Central 支持、获取解答并与其他用户协作,请加入我们的 CA Agile Central 社区