本教程详细指导如何使用TestRail API筛选出具有特定自定义字段（如’can_be_automated = true’）的测试用例，并将其动态添加到现有的测试运行中。文章涵盖了通过get_cases端点获取并过滤用例ID，以及利用update_run端点更新测试运行的整个流程，并提供了API调用示例和注意事项，帮助实现TestRail与自动化脚本的集成。
在自动化测试与测试管理工具TestRail集成时，一个常见的需求是根据特定的属性筛选测试用例，并将其添加到指定的测试运行中。本教程将详细介绍如何利用TestRail API实现这一目标，特别是针对具有自定义字段（例如“可自动化”）的测试用例进行筛选。整个过程分为两个主要步骤：首先，从测试套件中检索并过滤出符合条件的测试用例；其次，将这些筛选出的用例添加到目标测试运行。
1. 筛选自动化测试用例
要从TestRail测试套件中识别并提取标记为“可自动化”（例如，自定义字段custom_can_be_automated为true）的测试用例，我们需要使用TestRail的get_cases API端点。
1.1 获取测试用例
get_cases端点允许您根据项目ID和套件ID获取特定测试套件中的所有测试用例。
API 端点格式：
GET index.php?/api/v2/get_cases/{project_id}&suite_id={suite_id}
执行此查询后，TestRail将返回一个JSON格式的响应，其中包含指定套件内的所有测试用例的详细信息。在这些详细信息中，您会找到所有标准字段以及您在TestRail中定义的任何自定义字段。例如，如果您的自定义字段在TestRail UI中是can_be_automated，那么在API响应中它将以custom_can_be_automated的形式出现。
JSON 响应示例（部分）：
"cases":[ { "id":22478, "title":"Test Case Steps (Text)", "section_id":2347, "template_id":1, "type_id":5, "priority_id":4, "milestone_id":null, "refs":null, "created_by":36, "created_on":1691415817, "updated_by":36, "updated_on":1692281184, "estimate":null, "estimate_forecast":null, "suite_id":196, "display_order":4, "is_deleted":0, "case_assignedto_id":null, "custom_automation_type":6, "custom_can_be_automated":true, // 目标自定义字段 "custom_preconds":"Test Case Step *TEXT* Precondition", "custom_steps":"%Var3 rn%Var4rn", "custom_testrail_bdd_scenario":"", "custom_expected":"  ", "custom_steps_separated":null, "custom_mission":null, "custom_goals":null, "comments":[] }, { "id":22494, "title":"Automated Checkout", "section_id":2347, "template_id":9, "type_id":3, "priority_id":3, "milestone_id":null, "refs":null, "created_by":36, "created_on":1691679382, "updated_by":32, "updated_on":1694640912, "estimate":null, "estimate_forecast":null, "suite_id":196, "display_order":5, "is_deleted":0, "case_assignedto_id":null, "custom_automation_type":0, "custom_can_be_automated":false, // 目标自定义字段 "custom_preconds":null, "custom_steps":null, "custom_testrail_bdd_scenario":"", "custom_expected":null, "custom_steps_separated":null, "custom_mission":null, "custom_goals":null, "comments":[] }]
1.2 根据自定义字段过滤用例
获取到JSON响应后，您需要解析该响应并根据custom_can_be_automated属性进行过滤，以提取所有符合条件的测试用例的ID。
在命令行环境中，您可以使用curl结合jq工具来快速实现这一过滤。
使用 curl 和 jq 过滤示例：
curl -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 '[.[] | select(.custom_can_be_automated == true) | .id]'
此命令将：
向TestRail API发送GET请求，获取指定项目和套件的所有测试用例。通过管道将JSON响应传递给jq。jq ‘[.[] | select(.custom_can_be_automated == true) | .id]’ 会遍历JSON数组中的每个用例，选择custom_can_be_automated为true的用例，并仅提取其id字段，最终输出一个包含所有符合条件用例ID的JSON数组。
2. 将筛选出的用例添加到测试运行
获取到需要添加到测试运行的用例ID列表后，下一步是使用update_run API端点来更新现有的测试运行。
2.1 更新测试运行
update_run端点允许您修改指定测试运行的属性，包括其包含的测试用例。
API 端点格式：
POST index.php?/api/v2/update_run/{run_id}
请求体需要包含一个case_ids数组，其中列出所有您希望包含在测试运行中的用例ID。为了确保只包含指定的用例，通常会配合”include_all”: false。
请求体结构示例：
{ "include_all": false, // 如果为 false，则只包含 case_ids 中的用例。 "case_ids": [1, 2, 3, 5, 8] // 替换为您通过筛选获得的用例ID列表}
使用 curl 发送 POST 请求示例：
curl -X POST "https://$TESTRAIL_URL/index.php?/api/v2/update_run/{run_id}" -H "Content-Type: application/json" -u "$TESTRAIL_EMAIL:$TESTRAIL_PASS" -d '{"include_all": false, "case_ids": [22478, 22501, 22505]}' # 替换为实际的用例ID
当请求成功执行后，TestRail会返回一个HTTP 200状态码，表示测试运行已成功更新。
3. 在JavaScript中实现
如果您正在使用JavaScript（例如，在TestComplete脚本或其他Node.js环境中），您可以将上述curl命令的逻辑转换为HTTP请求库（如fetch或axios）的调用。
JavaScript 实现逻辑概述：
配置API凭证： 存储TestRail的URL、电子邮件和API密钥。获取用例：使用fetch或axios向get_cases端点发送GET请求。在请求头中包含Base64编码的认证信息（Authorization: Basic word>）。解析返回的JSON数据。遍历cases数组，检查每个用例的custom_can_be_automated属性。收集所有符合条件的用例的id到一个数组中。更新测试运行：使用fetch或axios向update_run端点发送POST请求。在请求头中包含认证信息和Content-Type: application/json。在请求体中，将收集到的用例ID数组作为case_ids的值，并设置include_all: false（如果只想添加这些特定用例）。处理API响应，检查是否成功（例如，HTTP状态码200）。
4. 注意事项
API 认证： 确保您的TestRail用户拥有足够的权限来读取用例和更新测试运行。API密钥是推荐的认证方式。自定义字段名称： TestRail API在处理自定义字段时，通常会在字段名前加上custom_前缀。例如，如果您的自定义字段在UI中是can_be_automated，那么在API响应中它将是custom_can_be_automated。请务必核对正确的API字段名。占位符替换： 在实际使用中，务必将{project_id}、{suite_id}、{run_id}、$TESTRAIL_EMAIL、$TESTRAIL_PASS和$TESTRAIL_URL替换为您的实际值。include_all 参数： 在update_run请求中，”include_all”: true会将套件中的所有用例添加到测试运行中，然后case_ids会筛选出要 包含 的用例。如果”include_all”: false，则只包含case_ids中指定的用例。根据您的需求选择合适的值。通常，为了精确控制，在筛选后添加特定用例时，建议使用`”include_all”:
以上就是TestRail API：动态筛选自动化测试用例并添加到测试运行的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1521765.html
微信扫一扫 
支付宝扫一扫 
