Rational Build Forge 和 Rational ClearQuest

BuildForge 能够与 Rational ClearQuest 协作以更新构建记录。

Build Forge 与 ClearQuest 具有两种集成方式:

这些功能是完全相互独立的。特别是,适配器与为其创建的环境相关联。该环境中的变量独立于为激活自动构建记录而设置的变量。

设置自动生成构建记录

系统可以在您的 IBM Rational® ClearQuest® 数据库中自动创建构建记录,并附带指向日志数据的链接。再则,当作业通过时,系统可以更新 ClearQuest 数据库,标注作业已完成、记录结束时间以及完成的步骤汇总。该功能需要 Rational ClearQuest V7.0 或更高版本。

当您将项目配置为更新 ClearQuest 数据库时,系统执行创建或更新构建记录操作,如下所述:
作业启动
当系统启动一个作业时,系统将创建一个 ClearQuest 构建记录。构建记录处于“已提交”状态,其中包含作业日志 URL、开始时间、发行版名称、标识以及表明“Build XYZ started.”的日志条目。如果源控制适配器取消了作业(例如,由于找不到任何源更改),那么不会创建任何 ClearQuest 构建记录。
注: 如果某项目链向其他项目,那么新项目将获取其自己的唯一 ClearQuest 构建标识。
作业通过/失败
当作业通过或失败时,系统会将 ClearQuest 中的构建状态更改为“已完成”或“失败”,设置构建结束时间,并在 ClearQuest 构建日志中存储作业步骤的摘要。该摘要包含每个步骤的名称、结果状态和服务器。
作业重新启动
当作业重新启动时,系统会将 ClearQuest 中的构建状态更改为“已提交”,并创建一个 ClearQuest 构建日志条目指出“已重新启动构建 XYZ”。

您可以通过特殊环境变量来配置自动更新构建记录。要将项目链接到 ClearQuest 数据库,请确保在项目的环境中包含下表中的变量。

注: 项目环境中必须有这些变量。将它们添加至某个步骤还不够。但可以使用设置为“包含”类型的变量,这一类型通过另一个环境来包含这些变量。此外,由于 CQ_RELEASE_NAME 值是唯一可能随项目而变化的值,因此您可能希望创建一个环境来包括其他变量,并使用“包含”类型的变量将该环境包括在项目环境中,您还可在其中将 CQ_RELEASE_NAME 指定为特定于项目的环境变量。

要通过 Build Forge 作业来激活自动更新构建记录,必须为项目设置以下环境变量。它们在步骤级别不起作用。

变量

描述

CQ_DBNAME

必需。要更新的 ClearQuest 数据库的名称。

CQ_DBSET

ClearQuest 数据库设置值。不是必需的。缺省为空。

CQ_INTERACTION

如果您的项目环境已定义用于启用 ClearQuest 构建记录创建的相应环境变量,而您不希望创建构建记录,请将此变量设置为 OFF 来禁用构建记录创建。

要启用创建构建记录,将此环境变量设置为 ON。

注: 如果要使用 ClearQuest 的任一适配器,将此环境变量设置为 OFF。适配器直接与构建记录交互。

CQ_PASSWORD

必需。登录到 ClearQuest 数据库时使用的密码。不是必需的;缺省为空。

CQ_RELEASE_NAME

必需。ClearQuest 数据库中要更新的发行版的名称。

CQ_USER

必需。用于登录到 ClearQuest 数据库的用户名。

ClearQuest 适配器的其他设置需求

ClearQuest 适配器模板样本提供了几种方法来扫描 ClearCase 和更新 ClearQuest 中的构建记录。这通常与 Build Forge 中运行的构建的成功或失败有关。请参阅适配器需求以了解一般需求。另外,需要执行以下配置。

执行以下操作:

  1. 在可与 ClearCase 服务器连接的主机上安装 Build Forge 代理程序。
  2. 在代理程序主机上安装 ClearCase 完整客户机。
  3. 设置代理程序的环境以便能够通过 ClearCase 客户机来运行命令。
  4. 在 Build Forge 控制台主机上安装 ClearQuest 完整客户机。
  5. 将 cqperl (ClearQuest Perl API) 目录添加到系统路径。
  6. 定义 Build Forge 主机上 ClearQuest 客户机可用于访问 ClearQuest 数据库的连接。在 ClearQuest 客户机主机上执行这些操作。
    1. 使用 cqreg 命令来添加数据库集 (cqreg add_dbset)。
    2. 使用 CQ 维护工具来设置与 ClearQuest 数据库的连接。
  7. 确定如何实施以及如何、何时启动所需的 ClearCase 视图。
显示 Build Forge、ClearCase 和 ClearQuest 安装的关系的图形。

您无需安装代理程序。ClearQuest 适配器使用 ClearQuest Perl API,通过客户机直接与 ClearQuest 进行通信。

要点: 仅通过步骤中的点命令便可调用 ClearQuest 适配器。它不是源适配器,因此无法使用适配器链接。

ClearQuest 适配器模板样本

提供了以下适配器模板样本。

ClearQuestBaseClearCaseByDate
  1. 查询 ClearCase 视图以查找两个日期之间的更改。缺省日期是当前时间戳记和上次执行适配器的时间戳记。
  2. 为每个已更改文件查找识别 ClearQuest 更改标识的 ClearQuest 超链接属性。通过添加作业信息解析 ClearQuest 中的缺陷记录来尝试解析更改标识,前提是 ClearQuest 状态允许解析这些缺陷记录。
  3. 为每个已更改文件将以下信息写入 BOM 报告:文件名、缺陷标识、缺陷状态和任何 ClearQuest 错误。

适配器模板中定义的变量:

  • CurDate
  • LAST_RUN
  • VIEW
  • VOB_PATH
  • CQ_USER
  • CQ_PASSWORD
  • BFSERVER
  • UNIXCLIENT
  • _CHAR_NATIVE
ClearQuestClearCaseByActivity
  1. 查找与 ClearCase 活动列表关联的 ClearQuest 缺陷记录。
  2. 它为发现的每个缺陷记录添加作业信息以解析 ClearQuest 内的缺陷记录,前提是 ClearQuest 状态允许解析这些缺陷记录。
  3. 将以下信息写入 BOM 报告:与 ClearCase 活动标识和 ClearQuest 缺陷状态关联的文件。

适配器模板中定义的变量:

  • CurDate
  • VIEW
  • VOB_PATH
  • ACTIVITIES
  • CQ_USER
  • CQ_PASSWORD
  • PROJECT_VOB
  • BFSERVER
  • UNIXCLIENT
  • _CHAR_NATIVE
ClearQuestUCMClearCaseByDate
  1. 查询 ClearCase 视图以查找两个日期之间的更改。缺省日期是当前时间戳记和上次执行适配器的时间戳记。它使用 Rational 统一变更管理 (UCM) 来生成结果。
  2. 为每个已更改文件将以下信息写入 BOM 报告:文件名、缺陷标识、缺陷状态和任何 ClearQuest 错误。

适配器模板中定义的变量:

  • CurDate
  • LAST_RUN
  • VIEW
  • VOB_PATH
  • CQ_USER
  • CQ_PASSWORD
  • BFSERVER
  • UNIXCLIENT
  • _CHAR_NATIVE

ClearQuest 适配器变量

此表引用了适配器模板的变量列表。

表 1. Rational ClearQuest 集成所需的环境变量

变量

描述

ACTIVITIES 对于 ClearQuestClearCaseByActivity 适配器,这是一组用空格定界的活动标识。示例:SAMPL0001@\ProjectVob
BFSERVER 将此变量设置为 Build Forge 控制台的主机名。

CQ_PASSWORD

必需。登录到 ClearQuest 数据库时使用的密码。不是必需的;缺省为空。

CQ_USER

必需。用于登录到 ClearQuest 数据库的用户名。

CurDate 通过使用 .date 命令生成当前日期,以提供给适配器。请不要更改此值。
LAST_RUN 对于 ByDate 适配器,系统使用该值来确定是否发生了任何更改;该值是上一次成功运行的日期。可在测试适配器时操作此值,通过选择在某些更改之前的某个已知日期可强制适配器运行。如果适配器允许运行继续,它将自动把此值更新为当前日期。缺省值为 1-Jan-05.00:00:00。
UNIXCLIENT 用于设置特定于平台的信息。如果客户机运行在 Windows 平台上,请设置为 0。如果客户机运行在 UNIX 或 Linux 平台上,请设置为 1。
VIEW 将此变量设置为要用于适配器的 ClearCase 视图的名称。
VOB_PATH 将此值设置为组件 VOB 的名称及其子目录(子目录可选)。对于多个名称,请使用以逗号分隔的列表。
_CHAR_NATIVE 内部使用并且始终设置为 1。

重新启动由 ClearQuest 集成的作业

完成由 ClearQuest 集成的作业后,通常无法在 Rational Build Forge 中重新启动。作为简单的变通方法,您可以将此作业作为新作业启动。

要能够重新启动,您必须使用 ClearQuest 设计器工具编辑 ClearQuest 模式。必须修改 Build 记录的工作流,以允许状态从“已完成”转变为“提交”。


反馈