From 2b95999e87aa5305071fca71924a46406174c5fa Mon Sep 17 00:00:00 2001 From: V-LiuShuang Date: Mon, 28 Sep 2026 16:00:25 +0800 Subject: [PATCH] add --- .../example/task_preload_request.json | 0 ...n => task_stress_non_project_request.json} | 0 ...n => task_stress_use_project_request.json} | 0 ...t.json => task_update_driver_request.json} | 0 .../references/exec_task_preload_doc.md | 58 ++++++++++++++++++- .../references/exec_task_stress_doc.md | 11 +++- .../references/exec_task_update_driver_doc.md | 6 +- 7 files changed, 69 insertions(+), 6 deletions(-) create mode 100644 se-task-exec-spec/example/task_preload_request.json rename se-task-exec-spec/example/{stress_task_non_project_request.json => task_stress_non_project_request.json} (100%) rename se-task-exec-spec/example/{stress_task_use_project_request.json => task_stress_use_project_request.json} (100%) rename se-task-exec-spec/example/{update_driver_request.json => task_update_driver_request.json} (100%) diff --git a/se-task-exec-spec/example/task_preload_request.json b/se-task-exec-spec/example/task_preload_request.json new file mode 100644 index 0000000..e69de29 diff --git a/se-task-exec-spec/example/stress_task_non_project_request.json b/se-task-exec-spec/example/task_stress_non_project_request.json similarity index 100% rename from se-task-exec-spec/example/stress_task_non_project_request.json rename to se-task-exec-spec/example/task_stress_non_project_request.json diff --git a/se-task-exec-spec/example/stress_task_use_project_request.json b/se-task-exec-spec/example/task_stress_use_project_request.json similarity index 100% rename from se-task-exec-spec/example/stress_task_use_project_request.json rename to se-task-exec-spec/example/task_stress_use_project_request.json diff --git a/se-task-exec-spec/example/update_driver_request.json b/se-task-exec-spec/example/task_update_driver_request.json similarity index 100% rename from se-task-exec-spec/example/update_driver_request.json rename to se-task-exec-spec/example/task_update_driver_request.json diff --git a/se-task-exec-spec/references/exec_task_preload_doc.md b/se-task-exec-spec/references/exec_task_preload_doc.md index 2c3846e..e8b5c7c 100644 --- a/se-task-exec-spec/references/exec_task_preload_doc.md +++ b/se-task-exec-spec/references/exec_task_preload_doc.md @@ -1 +1,57 @@ -# 执行Preload测试文档 \ No newline at end of file +# 执行Preload测试文档 + +按照步骤一步一步的执行： + +1. 如果用户没有提供项目信息，询问用户项目名称，不支持五码或者别名，建议输入项目完整名称。 + +2. 将用户提供的项目名称，作为`generatePreloadUpdateLink`工具的`project`参数发起调用，若遇到失败，则告诉用户失败原因并终止流程。 + +成功示例： + +```json +{ + "downloadUrl": "string", + "project": "string", + "osVer": "string", + "os": "string", + "preloadVersion": "string", + "locationName": "string" +} +``` + +失败示例： + +```json +{ + "success": false, + "msg": "string" +} +``` + +参数说明： + +| 参数名称 | 含义 | +| --- | --- | +| `downloadUrl` | 生成的 preload 更新下载链接 | +| `project` | 项目名称 | +| `osVer` | OS版本 | +| `os` | OS目录名 | +| `preloadVersion` | 实际使用的 Preload VER | +| `locationName` | 实际使用的 Location | +| `success` | 当值为false的时候，意味着失败，成功时不返回`success`字段 | +| `msg` | 当`success`字段值为fasle时，该字段作为失败原因 | + +3. 阅读[查测试机的文档](./query_test_device_doc.md)获取`testUnitUuid`和`testUnitName`。 + +4. 使用[请求模板文件](../example/task_preload_request.json)，**一字不改地生成**1个JSON字符串，再根据[变量表](#变量表)执行变量替换。 + +## 变量表 + +JSON字符串中变量的格式示例：{id}，根据取值规则查找并替换。 + +|变量名称|取值规则| +|---|---| +|id|随机生成1个由小写字母、数字组成的7位长度字符串（示例：2b43cb39）| +|date|从**上下文变量**取今天的日期| +|testUnitUuid|调用工具获得的测试机ID| +|testUnitName|调用工具获得的测试机名称| \ No newline at end of file diff --git a/se-task-exec-spec/references/exec_task_stress_doc.md b/se-task-exec-spec/references/exec_task_stress_doc.md index 77b1a2c..09977dd 100644 --- a/se-task-exec-spec/references/exec_task_stress_doc.md +++ b/se-task-exec-spec/references/exec_task_stress_doc.md @@ -1,14 +1,19 @@ # 执行Stress任务文档 -1. 如果用户提供了项目信息，先阅读[查项目信息文档](./query_project_info_doc.md)，一步一步地获取`projectName`和`projectUuid`，如果没有的话就跳过。 +按照步骤一步一步的执行： + +1. 如果用户没有提供项目信息，从第2步开始执行。如果用户提供了项目信息，阅读[查项目信息文档](./query_project_info_doc.md)，一步一步地获取`projectName`和`projectUuid`。 + 2. 阅读[查测试机的文档](./query_test_device_doc.md)获取`testUnitUuid`和`testUnitName`。 + 3. 根据相应的[请求模板文件](#请求模板文件)，**一字不改地生成**1个JSON字符串，再根据[变量表](#变量表)执行变量替换。 + 4. 阅读[下发任务文档](./create_task_doc.md)，上一步生成的JSON字符串就是`requestBodyJson`参数。 ## 请求模板文件 -- [无项目下发](../example/stress_task_non_project_request.json) -- [根据项目下发](../example/stress_task_use_project_request.json) +- [无项目下发](../example/task_stress_non_project_request.json) +- [根据项目下发](../example/task_stress_use_project_request.json) ## 变量表 diff --git a/se-task-exec-spec/references/exec_task_update_driver_doc.md b/se-task-exec-spec/references/exec_task_update_driver_doc.md index 1fabf3f..afa5922 100644 --- a/se-task-exec-spec/references/exec_task_update_driver_doc.md +++ b/se-task-exec-spec/references/exec_task_update_driver_doc.md @@ -1,6 +1,8 @@ # 更新驱动文档 -1. 如果用户**没有提供项目信息**，先阅读[查项目信息文档](./query_project_info_doc.md)，一步一步地获取`projectName`和`projectUuid`。 +按照步骤一步一步的执行： + +1. 阅读[查项目信息文档](./query_project_info_doc.md)，一步一步地获取`projectName`和`projectUuid`。 2. 根据上一步获取到的`projectUuid`，调用`queryDriverListNamesByProject`工具查询项目下的驱动列表。 @@ -50,7 +52,7 @@ 5. 阅读[查测试机的文档](./query_test_device_doc.md)获取`testUnitUuid`和`testUnitName`。 -6. 使用[请求模板文件](../example/update_driver_request.json)，**一字不改地生成**1个JSON字符串，再根据[变量表](#变量表)执行变量替换。 +6. 使用[请求模板文件](../example/task_update_driver_request.json)，**一字不改地生成**1个JSON字符串，再根据[变量表](#变量表)执行变量替换。 7. 阅读[下发任务文档](./create_task_doc.md)，上一步生成的JSON字符串就是`requestBodyJson`参数。