Test Suite 用户指南

上次更新日期 2025年9月9日

Webhooks

Test Manager 提供了 Webhook，允许外部工具订阅 Test Manager 中的事件。

目前，支持以下事件。

创建缺陷：每当用户从测试用例结果中调用“创建缺陷”任务时，都会触发此事件。它允许外部缺陷管理工具从测试结果中接收带有日志信息的缺陷报告。
缺陷 KPI：刷新 Test Manager 仪表板上的缺陷 KPI 时调用此事件。这允许包含来自外部缺陷管理系统的统计信息，以显示在 Test Manager 仪表板上。

合同

在本节中，您可以找到每个事件的请求和响应有效负载详细信息。

创建缺陷。

Test Manager 使用以下有效负载触发已注册的 Webhook：

使用 Test Manager REST API 获取有关失败测试的详细信息，以将信息添加到创建的缺陷中。

Request:
CreateDefectFromTestCaseLogRequest{
testExecutionId    string($uuid)
testCaseId    string($uuid)
variationId    string
nullable: true
linkToTestCaseLog    string
nullable: true
}
Response:
Returns a defect payload to allow Test Manager to add a link to the created defect in the test case log.Request:
CreateDefectFromTestCaseLogRequest{
testExecutionId    string($uuid)
testCaseId    string($uuid)
variationId    string
nullable: true
linkToTestCaseLog    string
nullable: true
}
Response:
Returns a defect payload to allow Test Manager to add a link to the created defect in the test case log.

缺陷 KPI

Test Manager 使用以下有效负载触发已注册的 Webhook：

Request:
api/kpis/project/<projectid>/defectstatus
Response:
KPIConnectorDefectsDto{
totalDefects    integer($int32)
criticalDefects    integer($int32)
moderateDefects    integer($int32)
openDefects    integer($int32)
closedDefects    integer($int32)
status    ConnectorKPIStatusstring
Enum:
Array [ 3 ]
criticalDefectsLink    string
nullable: true
}Request:
api/kpis/project/<projectid>/defectstatus
Response:
KPIConnectorDefectsDto{
totalDefects    integer($int32)
criticalDefects    integer($int32)
moderateDefects    integer($int32)
openDefects    integer($int32)
closedDefects    integer($int32)
status    ConnectorKPIStatusstring
Enum:
Array [ 3 ]
criticalDefectsLink    string
nullable: true
}

配置 Webhook 连接

以管理员身份登录 Test Manager。
打开项目。
导航到 “项目设置” >“ 集成”。
单击“新建连接”，然后从下拉列表中选择“WebHook”。
配置以下连接设置:
- 名称：输入 WebHook 连接的名称。
- 说明（可选）: 添加说明以供参考。
- 负载 URL：添加端点服务器 URL。例如：https://company-name-serverRegion.cloudapp.azure.com。
- 身份验证标头类型：在Client Secret和HMACSHA256之间选择一种散列方法。
- 密码：输入您的客户端密码值。
- 允许不安全的 SSL：选择是否允许具有不安全 SSL 连接的端点。
- 支持缺陷仪表板：选择是否需要在项目仪表板中显示 KPI。
单击“保存”。
单击连接以展开面板并复制 API 密钥以备后用。

管理 WebHook 连接

下表列出了可以用来管理 WebHooks 连接的操作。

操作	描述	程序
编辑	编辑连接设置。	以管理员身份登录 Test Manager。打开项目。转到“ 项目设置”。在“集成”列表中，单击 WebHook 连接以展开面板。单击“ 编辑 ”以配置连接。单击“保存”以确认。
删除	删除选定的连接及其关联的要求。	以管理员身份登录 Test Manager。打开项目。转到“ 项目设置”。在“集成”列表中，单击 WebHook 连接以展开面板。单击“ 删除 ”以删除连接。单击“确定”以确认。