本教程详细介绍了如何使用TestRail API，根据自定义字段（如“custom_can_be_automated”）筛选特定测试用例，并将其动态添加到现有的测试运行中。通过get_cases接口获取用例数据并进行过滤，然后利用update_run接口将筛选出的用例ID批量更新到指定的测试运行，实现自动化测试流程的精确管理。
1. 理解核心需求
在TestRail与自动化测试框架（如TestComplete）集成时，一个常见需求是仅将标记为“可自动化”的测试用例纳入到测试运行中。这通常涉及两个主要步骤：
从测试套件中筛选出符合特定条件的测试用例：例如，根据自定义字段 custom_can_be_automated 的值来识别可自动化的用例。将筛选出的用例添加到现有的测试运行中：使用TestRail API 更新测试运行，包含这些特定的用例ID。
接下来，我们将详细介绍如何通过TestRail API实现这两个步骤。
2. 步骤一：筛选可自动化测试用例
要从TestRail测试套件中获取并筛选测试用例，您可以使用 get_cases API 端点。
2.1 API 端点与请求
使用 GET 请求访问 get_cases 端点，并提供项目ID和套件ID：
GET index.php?/api/v2/get_cases/{project_id}&suite_id={suite_id}
{project_id}：您要操作的项目ID。{suite_id}：包含目标测试用例的测试套件ID。
2.2 API 响应与数据过滤
执行此查询后，您将收到一个JSON格式的响应，其中包含测试套件中的所有测试用例信息。在这些用例对象中，您会找到自定义字段，例如 custom_can_be_automated。
以下是响应中测试用例对象的示例结构：
{ "cases": [ { "id": 22478, "title": "Test Case Steps (Text)", "section_id": 2347, // ... 其他字段 ... "custom_can_be_automated": true, // 目标自定义字段 // ... 更多自定义字段 ... }, { "id": 22494, "title": "Automated Checkout", "section_id": 2347, // ... 其他字段 ... "custom_can_be_automated": false, // 目标自定义字段 // ... 更多自定义字段 ... } ]}
基于此响应，您可以编写脚本来解析JSON数据，并筛选出 custom_can_be_automated 属性为 true 的用例ID。
2.3 示例：使用 curl 和 jq 筛选用例ID
以下示例展示了如何使用 curl 发送API请求，并结合 jq 工具来解析和筛选出所有可自动化测试用例的ID。
# 替换 $TESTRAIL_EMAIL, $TESTRAIL_PASS, $TESTRAIL_URL# 替换 {project_id} 和 {suite_id} 为您的实际值# 获取所有用例并筛选出 custom_can_be_automated 为 true 的用例IDAUTOMATED_CASE_IDS=$(curl -s -H "Content-Type: application/json" -u "$TESTRAIL_EMAIL:$TESTRAIL_PASS" "$TESTRAIL_URL/index.php?/api/v2/get_cases/{project_id}&suite_id={suite_id}" | jq -r '.cases[] | select(.custom_can_be_automated == true) | .id')echo "筛选出的可自动化用例ID: $AUTOMATED_CASE_IDS"
在JavaScript环境中，您可以使用 fetch 或 axios 等库发送HTTP请求，然后利用数组的 filter 和 map 方法来处理JSON响应并提取所需的用例ID。
3. 步骤二：将筛选出的用例添加到测试运行
获取到可自动化测试用例的ID列表后，您可以将它们添加到已创建的测试运行中。这通过 update_run API 端点实现。
3.1 API 端点与请求
使用 POST 请求访问 update_run 端点，并提供测试运行ID：
POST index.php?/api/v2/update_run/{run_id}
{run_id}：您要更新的测试运行ID。
3.2 请求体结构
请求体应包含一个JSON对象，指定要包含的用例ID。请注意，为了只添加特定用例，include_all 字段应设置为 false。
{ "include_all": false, "case_ids": [1, 2, 3, 5, 8] // 替换为您的筛选出的用例ID数组}
3.3 示例：使用 curl 更新测试运行
以下 curl 命令演示了如何将筛选出的用例ID列表更新到指定的测试运行中：
# 替换 $TESTRAIL_EMAIL, $TESTRAIL_PASS, $TESTRAIL_URL# 替换 {run_id} 为您的实际测试运行ID# 替换 [1, 2, 3, 5, 8] 为您在步骤一中筛选出的用例ID数组curl -X POST -H "Content-Type: application/json" -u "$TESTRAIL_EMAIL:$TESTRAIL_PASS" "$TESTRAIL_URL/index.php?/api/v2/update_run/{run_id}" -d '{"include_all": false, "case_ids": [1, 2, 3, 5, 8]}'
如果操作成功，您将收到一个状态码为 200 的响应，确认测试用例已成功添加到测试运行中。
4. 完整流程示例（概念性伪代码）
以下是一个概念性的JavaScript伪代码示例，展示了如何将上述两个步骤整合到一个自动化脚本中：
// 假设您已配置好TestRail API客户端，例如一个封装了认证和请求的类或函数// testrailClient.sendGet(endpoint) 和 testrailClient.sendPost(endpoint, data)async function filterAndAddAutomatedTestCases(projectId, suiteId, runId) { try { // 1. 获取所有用例 console.log(`正在从项目 ${projectId} 的套件 ${suiteId} 获取测试用例...`); const casesResponse = await testrailClient.sendGet(`get_cases/${projectId}&suite_id=${suiteId}`); const allCases = casesResponse.data.cases; // 假设响应数据结构为 { "cases": [...] } if (!allCases || allCases.length === 0) { console.log("未找到任何测试用例。"); return; } // 2. 筛选出 custom_can_be_automated 为 true 的用例ID const automatedCaseIds = allCases .filter(c => c.custom_can_be_automated === true) .map(c => c.id); if (automatedCaseIds.length === 0) { console.log("未找到任何可自动化的测试用例。"); return; } console.log(`筛选出 ${automatedCaseIds.length} 个可自动化用例:`, automatedCaseIds); // 3. 更新测试运行，添加筛选出的用例 console.log(`正在将用例添加到测试运行 ${runId}...`); const updateRunPayload = { "include_all": false, // 明确指示只添加 case_ids 中指定的用例 "case_ids": automatedCaseIds }; await testrailClient.sendPost(`update_run/${runId}`, updateRunPayload); console.log(`成功将 ${automatedCaseIds.length} 个可自动化用例添加到测试运行 ${runId}。`); } catch (error) { console.error("处理TestRail API请求时发生错误:", error.message || error); // 进一步处理错误，例如根据错误类型进行重试或通知 }}// 调用示例 (请替换为您的实际项目ID、套件ID和测试运行ID)// filterAndAddAutomatedTestCases(1, 196, 50);
5. 注意事项
API 认证： 确保您的API请求使用了正确的TestRail账户邮箱/用户名和API密钥进行认证。通常通过HTTP基本认证（Basic Auth）实现。自定义字段名称： 本教程中使用的 custom_can_be_automated 是一个示例。您在TestRail中创建的自定义字段名称会以 custom_ 为前缀出现在API响应中。请务必检查您的TestRail实例中该字段的实际API名称。include_all 参数： 在 update_run 请求中，此参数至关重要。如果您想添加特定的用例，必须将其设置为 false 或不包含此参数，并提供 case_ids 数组。如果设置为 true，则 case_ids 将被忽略，测试运行将包含测试套件中的所有用例。错误处理： 在实际生产代码中，务必
以上就是TestRail API：筛选可自动化测试用例并动态更新测试运行的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/56435.html
微信扫一扫 
支付宝扫一扫 
