@autotest/plugin 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,399 +1,237 @@
1
- # @autotest/plugin
1
+ # DevecoCode Test模式
2
2
 
3
- > DevEco Code 插件 —— 把 AutoTest 的测试任务执行与报告读取能力接入 DevEco Code 的 AI Agent。
3
+ DevEco Code(devco)Test 模式插件。通过自然语言描述测试用例,在已连接的 HarmonyOS 设备上执行 UI 自动化测试,生成可回看的测试报告,并在用例失败时进行根因分析与受限自愈。
4
4
 
5
- 本包是 devco 插件的**独立发包形态,也是唯一推荐接入通道**:插件入口、构建链与产物(`dist/index.js` + `dist/skills`)都在本包内;任务执行内核由本包 `dependencies` 声明的 `@autotest/agent`(CLI)提供。
6
-
7
- 两个工具**只在 Test 模式可用**(插件自动注入,见 §Test 模式),其他模式(build/plan 等)默认不可见:
8
-
9
- | 工具 | 作用 |
5
+ | 项 | 值 |
10
6
  |---|---|
11
- | `autotest_run_task` | 异步启动一个 AutoTest 测试任务,立即返回任务句柄(`taskId` / `reportDir` / `pid`) |
12
- | `autotest_get_report` | 纯文件读查询任务进度与结果(PASS / FAIL / RUNNING / …),离线可用 |
13
-
14
- 任务由插件 spawn 的 `node` 子进程调用 `@autotest/agent` 的 CLI 执行(`dist/autotest-cli.js`),插件自身不直连设备或模型。交互模型为「异步启动 + 轮询查询」,分钟级长任务不阻塞 devco 会话。
15
-
16
- ---
17
-
18
- ## 安装
7
+ | 包名 | `@autotest/plugin` |
8
+ | 运行环境 | Node.js ≥ 18 |
19
9
 
20
- ### 前提
10
+ ## 目录
21
11
 
22
- - DevEco Code(devco)≥ 0.1.2
23
- - Node.js ≥ 18
24
- - `@autotest/agent` 由本包 `dependencies` 自动安装(版本区间 `>=0.0.25 <0.2.0`),**无需单独安装 CLI**
12
+ - [1. 功能范围](#1-功能范围)
13
+ - [2. 环境要求](#2-环境要求)
14
+ - [3. 安装](#3-安装)
15
+ - [4. 快速开始](#4-快速开始)
16
+ - [5. 执行流程与输出](#5-执行流程与输出)
17
+ - [6. Loop 闭环](#6-loop-闭环)
18
+ - [7. 报告](#7-报告)
19
+ - [8. 配置](#8-配置)
20
+ - [9. 故障排查](#9-故障排查)
25
21
 
26
- ### 安装本包(唯一推荐通道:装进 devco 包缓存)
27
-
28
- devco 对**包名** spec 的解析只看它自己的包缓存(`%USERPROFILE%\.cache\deveco\packages\@autotest\plugin@latest`),**不读工程的 `node_modules`**。因此唯一可靠的安装动作是交给 devco 自己装——它会连同本包 `dependencies` 声明的 `@autotest/agent` 一起装进该缓存,并把包名写入工程配置:
29
-
30
- ```bash
31
- deveco plugin @autotest/plugin
32
- ```
33
-
34
- 本地镜像 / 内网场景**必须用环境变量**指定 registry(工程 `.npmrc` 的 `registry=` 会被 devco 忽略):
35
-
36
- ```bash
37
- NPM_CONFIG_REGISTRY=http://127.0.0.1:4873 deveco plugin @autotest/plugin
38
- ```
39
-
40
- 确认工程 `.deveco/deveco.jsonc` 的 `plugin` 数组已写入包名(`deveco plugin` 通常已自动写入,手写等价):
41
-
42
- ```jsonc
43
- {
44
- "plugin": ["@autotest/plugin"]
45
- }
46
- ```
47
-
48
- 保存后重启 devco,插件即被加载,注册 `autotest_run_task` / `autotest_get_report` 两工具并**自动注入 Test 模式**(见 §Test 模式),同时把包内 skill 目录注入 `skills.paths`(`<包根>/dist/skills`,宿主递归扫描 `**/SKILL.md`)。
49
-
50
- > **不要用工程级 `npm install` 代替。** `cd <devco 工程> && npm install @autotest/plugin` 只会把包放进工程的 `node_modules`,devco 不会从那里解析包名 spec:实测 `plugin_origins` 仍列出该 spec,但 `permission` / `agent.test` / `skills.paths` **三项全缺**,退出码 0、stderr 为空——两个工具静默消失(与 §升级须知「旧配置的症状」同一类失败)。工程级安装只用于本地联调(下节),不改变 devco 的插件解析。
22
+ ---
51
23
 
52
- > **`plugin` 里的本地路径 spec(`file:`)不是受支持通道。** 实测(devco 0.2.4):`file:<包根>` → 宿主日志 `failed to load plugin … error="Plugin export is not a function"`、三项注入全缺、退出码 0;`file:///<包根>/dist/index.js` → 静默无注入;两种形态宿主都会建 `~/.cache/deveco/packages/file_<盘符>_…` 缓存条目(走 npm install + link),所以「指向本地目录即可绕过缓存」并不成立,且同一产物换目录后结果不稳定。本地联调请走 §本地联调。
24
+ ## 1. 功能范围
53
25
 
54
- ### CLI 解析(零配置)
26
+ **支持**
55
27
 
56
- `cliPath` 默认**无需配置**——四源的最后一条是包内解析:插件从自身产物目录(`node_modules/@autotest/plugin/dist/runner/`)沿目录逐级上行,找到 `node_modules/@autotest/agent/dist/autotest-cli.js` 后还要校验该包的 `package.json`——`name` 必须逐字等于 `@autotest/agent`,`version` 必须满足 `>=0.0.25 <0.2.0`(严格 `x.y.z`;`v0.1.0` / `0.1.0-rc.1` / `0.1.0+build` 一律不接受)。名字不符、版本越界或读取失败都**继续上行**,不中断、不误用祖先目录里的同名包。
28
+ - 单条用例:自然语言描述操作步骤与预期结果,自动完成点击、输入、滑动、返回等操作并验证结果
29
+ - 批量执行:一次提供多条用例,按顺序串行执行并汇总结果
30
+ - 需求生成用例:提供需求描述,先设计可执行的 UI 用例,再逐条执行
31
+ - 报告输出:JSON / HTML / Markdown,包含步骤、截图、耗时与 Token 用量
57
32
 
58
- 命中时插件日志记录一行 `cli resolved: <绝对路径> @<版本>`——这是**诊断线索**(区分命中的是哪一棵安装树里的哪个版本),不是验证通过的证据(验证方法见 §验证)。
33
+ **不支持**
59
34
 
60
- 四源顺序:工厂 options > sidecar `cliPath` > 环境变量 `AUTOTEST_BIN` > 包内解析(见 §配置)。前三源是用户显式配置,存在即用、不做身份校验。
35
+ - 纯后端逻辑、接口层校验
36
+ - 性能压测、网络抓包
37
+ - 无界面的功能验证
61
38
 
62
- ### 本地联调(在本仓库内开发)
39
+ ---
63
40
 
64
- 改完本包要在 devco 里验证,走与发布相同的通道:本地镜像 → devco 包缓存 → `deveco plugin`(`plugin` 里的本地路径 spec 不可用,见 §安装)。
41
+ ## 2. 环境要求
65
42
 
66
- ```bash
67
- cd AutoTest-nodejs/integrations/deveco
68
- npm install # 只在本包内装 devDependencies(tsc / vitest / esbuild / copyfiles …)
69
- npm test # pretest 先 build;含包元数据 / 产物 / 入口契约断言
70
- ```
43
+ | 项 | 要求 |
44
+ |---|---|
45
+ | DevEco Code | 已安装并可正常启动 |
46
+ | Node.js | ≥ 18 |
47
+ | 设备 | 已通过 HDC 连接、已解锁的 HarmonyOS 设备 |
48
+ | 模型 | 支持图片输入的多模态模型 |
71
49
 
72
- 随后按 §本地 npm 镜像发布与安装 发两包(先主包、后本包),删缓存重装让它用上新构建:
50
+ 检查设备连接:
73
51
 
74
52
  ```bash
75
- rmdir /s /q "%USERPROFILE%\.cache\deveco\packages\@autotest\plugin@latest"
76
- NPM_CONFIG_REGISTRY=http://127.0.0.1:4873 deveco plugin @autotest/plugin
53
+ hdc list targets
77
54
  ```
78
55
 
79
- 缓存目录名固定 `<name>@latest`、命中即复用——**不删缓存,重装也还是旧包**。
56
+ ---
80
57
 
81
- 联调期若还要让插件用**仓库内未发布的 CLI**(例如改的是主包代码),在 `.deveco/autotest-plugin.json` 显式固定,二选一:
58
+ ## 3. 安装
82
59
 
83
- ```jsonc
84
- // .deveco/autotest-plugin.json
85
- { "cliPath": "<仓库绝对路径>/AutoTest-nodejs/dist/autotest-cli.js" }
86
- ```
60
+ 在工程根目录执行:
87
61
 
88
62
  ```bash
89
- # 或环境变量
90
- AUTOTEST_BIN=<仓库绝对路径>/AutoTest-nodejs/dist/autotest-cli.js
63
+ # 安装最新版本
64
+ deveco plugin @autotest/plugin
91
65
  ```
92
66
 
93
- ### 本地 npm 镜像发布与安装
67
+ 插件安装在 devco 自己的包缓存中。
94
68
 
95
- 未发布 / 内网环境下用仓库自带的本地 verdaccio 托管 `@autotest/*`(脚本与模板见 `AutoTest-nodejs/scripts-dev/local-registry/`):
69
+ ---
96
70
 
97
- ```bash
98
- cd AutoTest-nodejs
99
- node scripts-dev/local-registry/local-registry.mjs start
100
- node scripts-dev/local-registry/local-registry.mjs publish # 1. @autotest/agent(本包的依赖)
101
- node scripts-dev/local-registry/local-registry.mjs publish --pkg integrations/deveco # 2. @autotest/plugin
102
- ```
71
+ ## 4. 快速开始
103
72
 
104
- 安装时**必须用环境变量**指定 registry(工程 `.npmrc` 的 `registry=` 会被 devco 忽略):
73
+ 1. 在 devco 的 agent 列表中选择 **Test** 模式。
74
+ 2. 直接输入用例描述:
105
75
 
106
- ```bash
107
- NPM_CONFIG_REGISTRY=http://127.0.0.1:4873 deveco plugin @autotest/plugin
76
+ ```text
77
+ 打开设置,进入“WLAN”页面,验证可用网络列表正常显示
108
78
  ```
109
79
 
110
- 验证完成后 unset(bash `unset NPM_CONFIG_REGISTRY`、PowerShell `Remove-Item Env:NPM_CONFIG_REGISTRY`、cmd `set NPM_CONFIG_REGISTRY=`)——该变量作用于同一终端内的所有 npm 命令。
80
+ 插件将依次执行:设备检查 → 启动任务 → 按约 30 秒间隔查询进度 → 输出终态结果与报告路径。
111
81
 
112
82
  ---
113
83
 
114
- ## 配置
84
+ ## 5. 执行流程与输出
115
85
 
116
- ### 优先级链
86
+ 插件按「设备检查 → 启动任务 → 轮询进度 → 输出结果」执行,轮询间隔约 30 秒。
117
87
 
118
- ```
119
- 工具参数 > 工厂 options > sidecar > 环境变量 > 默认值
120
- ```
88
+ 执行过程中会转述当前操作步骤(每轮只列本轮新增行):
121
89
 
122
- - 工具参数为 `task` / `task_name` / `max_loops` / `config_path` / `report_dir` / `device_sn`(调用时覆盖);`max_loops` 取 0–3,缺省 2(默认闭环、最多两轮;0 禁用闭环、1 单次执行);其中 `device_sn` 只覆盖目标设备序列号(`config.device.deviceSn`)——缺省跟随 config(该值为空则自动选首台在线设备),**不改** `device.ip` / `device.port`(远程设备地址仍取 config);
123
- - 工厂 options(插件工厂第二参数)与 sidecar 同 schema,优先级高于 sidecar;
124
- - 环境变量只提供 `AUTOTEST_BIN`(→ cliPath)与 `AUTOTEST_CONFIG`(→ configPath);
125
- - 报告根 / 解释器 / 超时走默认值;`cliPath` 四源全失败(含包内解析)→ 错误码 T3。
126
-
127
- ### sidecar:`.deveco/autotest-plugin.json`
128
-
129
- 放在 devco 工程目录的 `.deveco/` 下(固定路径 `.deveco/autotest-plugin.json`):
130
-
131
- | 字段 | 类型 | 默认值 | 说明 |
132
- |---|---|---|---|
133
- | `cliPath` | string | 无 | `dist/autotest-cli.js` 绝对路径(四源之一;**通常无需配置**,包内解析自动命中依赖树里的同版本 CLI;仅四源全失败才报 T3) |
134
- | `configPath` | string | 无 | AutoTest `config.yaml` 绝对路径(**可选**:模型段由 devco 凭据注入,见 §模型配置;该文件只承载非模型配置) |
135
- | `reportsRoot` | string | `<devco 工程目录>/autotest-reports` | 报告根目录;非绝对路径按工程目录解析 |
136
- | `nodePath` | string | `"node"` | 子进程解释器;受限环境兜底 |
137
- | `timeoutMinutes` | number | `30` | 超时 kill 阈值(分钟);**默认闭环两轮,建议调大**(见 §生命周期) |
138
- | `env` | object | `{}` | 透传给子进程的附加环境变量(合并进宿主环境,同名覆盖) |
139
-
140
- 示例(`cliPath` 通常无需填写;仅当使用自定义 CLI 路径时才加入该字段):
141
-
142
- ```json
143
- {
144
- "configPath": "<AUTOTEST_CONFIG_ABS>",
145
- "reportsRoot": "<AUTOTEST_REPORTS_ABS>",
146
- "timeoutMinutes": 30,
147
- "env": {}
148
- }
90
+ ```text
91
+ 第 1 条用例执行中(RUNNING,已完成 4 步)
92
+ 3. 打开设置应用
93
+ 4. 点击“WLAN”入口
149
94
  ```
150
95
 
151
- > **sidecar 由你的工程创建**:请在你自己的工程 `.deveco/` 目录创建
152
- > `autotest-plugin.json`。`configPath` / `reportsRoot` 若填写须为本机实际绝对路径
153
- > (示例中的 `<AUTOTEST_CONFIG_ABS>` / `<AUTOTEST_REPORTS_ABS>` 是占位符,机器专属路径不进版本库);
154
- > 不填 `configPath` 时插件走 devco 凭据注入模型配置。
155
-
156
- ### 模型配置(由 devco 注入)
157
-
158
- 插件的 CLI 子进程需要一个可用的 `model.unified` 段,解析顺序:
159
-
160
- 1. **用户已配置**——`configPath` 指向的文件、工程目录的 `config.local.yaml`、工程目录的 `config.yaml` 任一含有效 `api_key`(非空且非 `YOUR_API_KEY*` 占位符)→ 以用户配置为准,**不做任何注入**;
161
- 2. **用户未配置,devco 凭据可用**——从 devco 登录态(OAuth)或 `UI_VERIFY_BASE_URL` / `UI_VERIFY_API_KEY` / `UI_VERIFY_MODEL_NAME` 取凭据,合成一份临时 config(`model.unified` 三键齐全)写到系统临时目录,任务终态自动删除;用户 `configPath` 的非模型内容会深合并进去,不会丢;
162
- 3. **用户未配置且凭据不可用**——返回确定性错误(含三条修复指引),**不 spawn** 子进程。
163
-
164
- 第 1 条命中但只有非模型配置时,插件会以该文件为基底、把模型段合成进临时 config(用户显式配置不因模型 key 缺失被丢弃)。
96
+ 到达终态后输出执行结果、结论摘要与 JSON / HTML / Markdown 报告路径。
165
97
 
166
98
  ---
167
99
 
168
- ## Test 模式(自动注入)
169
-
170
- 安装插件后,`autotest_run_task` / `autotest_get_report` 两个工具**只在 Test 模式可用**——插件在配置期通过 devco 的 `config` 钩子自动注入,**零手动配置**:
100
+ ## 6. Loop 闭环
171
101
 
172
- - **新增 Test agent**:`agent.test = { mode: "primary", tools: { 两工具: true, 三 UI 验证工具: false }, permission: { 两工具: "allow" } }`。若你的工程已自定义 `agent.test`,插件**合并**而非覆盖——保留你的 `description` / `model` / 其他 tools 与 permission 条目,仅确保两个 autotest 工具 `tools: true` 且 agent 级 `permission: "allow"`(`mode` 已有显式值也保留,缺省时补 `primary`)。
173
- - **全局默认隐藏**:顶层 `permission` 对两个 autotest 工具与 devco 内置 UI 验证工具族默认写 `deny`,使其在 build / plan / general 等所有 agent 的 tools map 中为 `false`(对模型不可见);只有 Test 模式通过 agent 级 `permission: "allow"` 覆盖全局 deny 而打开两个 autotest 工具(UI 验证工具族在 Test 模式保持隐藏)。
174
- - **禁用 devco 内置 UI 验证工具(双保险)**:Test 模式禁用 devco 内置的 `verify_ui` / `save_ui_screenshot` / `get_ui_verification_log`——测试验证统一走 AutoTest 自身视觉链路(报告内判定),不让模型使用 devco 的内置 UI 验证能力。**机理**:① 顶层 `permission` 对三工具默认写 `deny`(全局对模型隐藏的关键——config 钩子注入的 tools 对内置工具不派生为 deny);② test agent 的 tools map 中显式置 `false`(显式声明兜底)。用户对三工具显式 `allow` 时插件保留该覆盖(尊重用户显式配置)。
175
- - **skill 注册**:`config` 钩子把包内 `<包根>/dist/skills` 追加进 `config.skills.paths`(与你已有路径去重合并),`subagent`/批次执行类 skill 随插件分发——装插件即注册、卸载即消失,不落盘到工程。
102
+ Loop 在用例失败后执行「归因 → 改写 → 重执行」,默认最多 2 轮。
176
103
 
177
- 使用方式:在 devco 中切换到 **Test** 模式(agent 列表出现 `test (primary)`)后,模型即可调用这两个工具执行 AutoTest 任务并查询报告。
178
-
179
- **改回全局可用**:若想让工具在所有模式都可见,在工程 `.deveco/deveco.jsonc` 顶层 `permission` 显式写 `allow`(用户显式覆盖优先于插件默认的 deny):
104
+ | `max_loops` | 行为 |
105
+ |---|---|
106
+ | `0` | 只执行一次,不做归因与改写 |
107
+ | `1` | 只执行一次 |
108
+ | `2`(默认) | 最多两轮闭环 |
109
+ | `3` | 最多三轮闭环 |
180
110
 
181
- ```jsonc
182
- {
183
- "permission": {
184
- "autotest_run_task": "allow",
185
- "autotest_get_report": "allow"
186
- }
187
- }
188
- ```
111
+ 开启 Loop 后,每轮报告隔离在 `iter_N/` 目录,根目录生成 `loop_result.json` 与 `loop_summary.html`。
189
112
 
190
113
  ---
191
114
 
192
- ## 验证(离线四断言)
193
-
194
- 无需模型、无需设备——一次性命令即可验证插件加载链路。全部命令在配置了 `plugin: ["@autotest/plugin"]` 的工程目录执行(前提是包已按 §安装 进入 devco 包缓存;工程级 `npm install` 给出的包名 spec 与本地路径 spec 都不生效),**四项同时成立才算验证通过**:
195
-
196
- | 断言 | 命令 | 期望 |
197
- |---|---|---|
198
- | 1. 插件被发现 | `deveco debug config` | `plugin_origins` 命中 `@autotest/plugin` |
199
- | 2. permission 注入 | `deveco debug config` | `permission` 段出现 `autotest_run_task`(与 `autotest_get_report`)条目 |
200
- | 3. Test 模式注入 | `deveco debug agent test` | tools map 中 `autotest_run_task` / `autotest_get_report` 为 `true`,`verify_ui` / `save_ui_screenshot` / `get_ui_verification_log` 为 `false`(`deveco debug agent build` 中五个均为 `false`) |
201
- | 4. skill 注册 | `deveco debug config` | `skills.paths` 含 `@autotest/plugin/dist/skills` |
115
+ ## 7. 报告
202
116
 
203
- > **`cli resolved: <path> @<version>` 只是诊断线索,不是验证证据**——它只说明四源里哪一条命中,不能证明插件已被宿主加载、工具已注入。验证只看上表四项注入结果。
117
+ 默认报告根目录:
204
118
 
205
- **直连 CLI 探针**(不经 devco,验证子进程契约):
206
-
207
- ```bash
208
- node <AutoTest-nodejs>/dist/autotest-cli.js run \
209
- --task "Open calculator and verify 2+4=6" \
210
- --report-dir <绝对临时目录> \
211
- --config <AutoTest-nodejs>/config.yaml \
212
- --stream-log
119
+ ```text
120
+ <工程目录>/autotest-reports/
213
121
  ```
214
122
 
215
- 预期:进程正常退出(退出码 ∈ 预期集合);stdout 逐行为 `{"ts","level","message"}` JSON 行;报告 JSON 落于 `<report-dir>/<basename(report-dir)>.json`,事件字段为 snake_case。
123
+ 单次任务:
216
124
 
217
- ---
218
-
219
- ## 日志与可观测性
220
-
221
- ### 插件日志通道:宿主 server logs(TUI 静默)
222
-
223
- 插件自身的诊断日志——版本日志 `loaded, version=<semver>`、CLI 解析结果、模型来源诊断(来源 / 模型名 / baseUrl / 合成配置路径)、配置与凭据链的降级告警等——统一经**宿主日志通道**输出:
224
-
225
- ```
226
- pluginLog(shared/logger.ts)→ 工厂注册的 sink(index.ts)→ client.app.log() → POST /log → 宿主 server logs
125
+ ```text
126
+ autotest-reports/
127
+ └── <task_name>/
128
+ ├── *.json
129
+ ├── *.html
130
+ ├── *.md
131
+ ├── agent_*.log
132
+ └── screenPath/
227
133
  ```
228
134
 
229
- - **查看位置 = 宿主 server logs**(devco 服务端日志),按 `service=autotest-plugin` 过滤即可定位本插件输出(该 service 标识是稳定的日志锚点,不随版本改名)。
230
- - **TUI 静默**:插件不向 devco 前台 TUI 输出日志——前台界面不被插件的诊断文本污染。需要查看插件日志时,请从宿主 server logs 观察。
231
- - **实现锚点**:`shared/logger.ts` 提供 `pluginLog(msg)` 与模块级 sink 注册 API(`setHostLogSink` / `resetHostLogSink`);`index.ts` 插件工厂在装配首行以 `client.app.log()` 注册 sink。请求体固定 `service: "autotest-plugin"`、`level: "info"`,`message` 为诊断文本,`extra.ts` 为发送时刻的 ISO 时间戳,`query.directory` 为工程目录。
232
- - **失败不阻塞**:日志发送为 fire-and-forget——发送失败静默丢弃、不重试,也**不回退**到 stdout / 前台 TUI;未注册 sink 时 `pluginLog` 直接丢弃(fail-closed)。
233
- - **与任务子进程日志区分**:被 spawn 的 AutoTest 子进程诊断仍走 `<reportDir>/plugin_stream.log`(任务自身的事实记录),与上述插件宿主日志通道相互独立。
135
+ Loop 任务:
234
136
 
235
- ### 工厂期早期日志的丢失窗口
137
+ ```text
138
+ autotest-reports/
139
+ └── <task_name>/
140
+ ├── loop_result.json
141
+ ├── loop_summary.html
142
+ ├── plugin_stream.log
143
+ └── iter_1/
144
+ ├── *.json / *.html / *.md
145
+ ├── log/
146
+ └── screenPath/
147
+ ```
236
148
 
237
- 插件工厂加载**早期**(宿主 server 尚未就绪的窗口,或 sink 注册之前的极早期窗口)产生的日志可能丢失。日志是**尽力而为的辅助工件**,从不阻塞插件装配或任务主流程——错过极早期窗口不影响工具与任务功能。
149
+ 报告内容包含:每步操作与截图、模型判定、耗时与 Token 用量。`plugin_stream.log` 为插件转述数据源,排查执行问题时优先查看。
238
150
 
239
151
  ---
240
152
 
241
- ## 生命周期
242
-
243
- ### devco 退出后的子进程(孤儿语义)
244
-
245
- 测试任务由插件 spawn 的子进程执行。devco 退出**不会**杀死运行中的子进程——Windows 没有 POSIX 进程组收割机制,子进程会继续运行直到完成并落盘报告。这是**特性而非缺陷**:任务执行对宿主生命周期不敏感;下次启动 devco 后用 `autotest_get_report` 以 `task_id` 或 `report_dir` 查询,纯文件读照常命中。
246
-
247
- ### 取消语义(abort 与超时兜底)
248
-
249
- devco 宿主在工具 `execute` 返回后立即触发该次工具调用的 `AbortSignal`(真实调用实测语义)。任务已转入后台后,该信号是工具调用生命周期的**收尾信号**而非用户取消意图——`autotest_run_task` 已忽略该信号(返回前移除 abort 监听),**不会** kill 刚启动的子进程(否则每次调用都会误杀后台任务)。
153
+ ## 8. 配置
250
154
 
251
- - **execute 返回前**的 abort(用户在工具调用期间的取消)会被尊重:kill 子进程 + 任务表置 `killed`。
252
- - **execute 返回后**的 abort 被忽略:后台任务继续运行,直到自然完成或超时。
253
- - **取消后台任务的兜底 = 超时 kill**:`timeoutMinutes`(默认 30 分钟)到期 → kill + `killed`。超时被杀时,已增量落盘的 stream log / 报告部分仍可读取。
155
+ ### 8.1 AutoTest 配置
254
156
 
255
- 与「devco 退出孤儿语义」同理:后台任务对宿主生命周期(退出 / 取消工具调用)不敏感。
157
+ 未提供时插件可使用内置配置运行,模型由 devco 登录态提供。建议自行配置模型与设备,保证环境稳定性。
256
158
 
257
- ### Loop 任务建议调大 timeoutMinutes
159
+ 配置文件按以下顺序查找,命中即用:
258
160
 
259
- 闭环任务(`max_loops ≥ 2`,**缺省即 2**)总耗时按轮数成倍增长——默认 30 分钟可能不足。若闭环任务被超时 kill(查询返回 KILLED),在 `.deveco/autotest-plugin.json` 调大 `timeoutMinutes` 后重试。
161
+ 1. 显式指定的配置文件
162
+ 2. `<工程>/.deveco/autotest/config.local.yaml`(工程本地覆盖)
163
+ 3. `<工程>/.deveco/autotest/config.yaml`(工程基础配置)
164
+ 4. `~/.deveco/autotest/config.yaml`(全局默认)
260
165
 
261
- ### 并发使用(同一窗口多任务)
166
+ 最小配置示例:
262
167
 
263
- 插件**不限制**同一 devco 实例内的并发任务数:已有任务在跑时再次调用 `autotest_run_task` 会照常创建新子进程并立即返回新的 `taskId` / `reportDir`,不排队、不拒绝。每个任务各自 spawn 子进程,`reportDir`、超时计时、abort 监听与临时 config 清理也都各自独立。
168
+ ```yaml
169
+ model:
170
+ unified:
171
+ name: "your-vision-model"
172
+ base_url: "https://your-gateway/v1"
173
+ api_key: "..."
264
174
 
265
- 并发安全由调用方掌握,插件不做防护:
266
-
267
- - **并发跑不同设备**:每次调用传不同的 `device_sn` 即可,**同一个 `config_path` 可以共用**(设备由该参数决定,config 只提供 `ip` / `port` 等其余字段)。`device_sn` 只覆盖序列号,不改 `device.ip` / `device.port`——远程设备地址仍取 config。
268
- - **同一设备并发 = 多个任务抢同一台设备**:两个任务传同一个 `device_sn`(或都不传而落到同一 config 设备)即共享同一台设备,两个 agent 会互相干扰 UI 状态,插件不做防护。设备解析链为 `device_sn` 参数 > config 的 `device.device_sn`;两者都没有时 hypium 在连接期静默 auto-pick 首台在线设备,没有 guard——需要并行时请显式传 `device_sn`(或为 config 显式指定设备)。
269
- - **`device_sn` 生效的前提是 CLI 为含该修复的构建**:运行环境里的 CLI 必须真正实现 `--device` 对 `config.device.deviceSn` 的覆盖。旧构建会把 `--device` 解析后忽略,任务静默落到 config 设备或 auto-pick 的首台设备——自查方法见 §故障排查(报告目录 stream log 的 banner `sn=`)。
270
- - **并发任务显式传同一 `report_dir` = 报告互相覆盖**:多个任务落到同一目录时,报告文件同名互相覆盖,插件不做防护。不传 `report_dir` 时各任务默认落在 `<reportsRoot>/<taskId>`(`taskId` 含时间戳 + 随机后缀),天然隔离。
271
-
272
- ### 跨 devco 实例的任务表竞态
273
-
274
- 进程内并发任务数**没有上限**,任务表因此允许同时存在多条 `status: "running"` 记录(同进程内落盘为同步整段执行,不会交错)。同一工程若同时运行多个 devco 实例,任务表文件(`<reportsRoot>/.plugin-tasks.json`)存在 last-write-wins 竞态。实际危害低——报告读取不依赖任务表(文件系统是最终事实源),但多实例并发发起任务不作为常态使用。
275
-
276
- ---
277
-
278
- ## 升级须知
279
-
280
- ### 版本与缓存
281
-
282
- 插件版本号硬编码在 `integrations/deveco/shared/version.ts` 的 `PLUGIN_VERSION` 常量(index.ts 的版本日志与 update_checker 的自更新比较共用),与 `integrations/deveco/package.json` 的 `version` 必须一致(契约测试断言)——它同时是版本漂移的诊断锚点(宿主 server logs 的 `loaded, version=<semver>`)。
283
-
284
- devco 的包缓存目录名固定为 `<name>@latest`,**命中即复用,上游发新版不会自动拉取**。本包的缓存目录即 `%USERPROFILE%\.cache\deveco\packages\@autotest\plugin@latest`——升级必须先手删它,否则重装仍在用旧包:
285
-
286
- ```bash
287
- # 1. 删缓存(Windows 路径;目录名即 @autotest/plugin@latest)
288
- rmdir /s /q "%USERPROFILE%\.cache\deveco\packages\@autotest\plugin@latest"
289
- # 2. 重新安装
290
- deveco plugin @autotest/plugin
175
+ device:
176
+ device_sn: "YOUR_DEVICE_SN" # 通过 hdc list targets 获取
291
177
  ```
292
178
 
293
- ### 自更新检测(L1:检测 + 提示)
294
-
295
- 插件在每次装配(devco 启动)时后台检测安装源 registry 是否有新版本,**只检测、只提示,绝不自动安装**(devco 缓存命中即复用,自动安装也装不进去——见上节):
296
-
297
- - **registry 自发现**:从插件产物根上溯到 devco 包缓存根,读 `package-lock.json` 里本包条目的 `resolved` 提取安装源(如本地镜像 `http://127.0.0.1:4873`)——提示里的重装命令带的就是这个源,无需用户记得装包时用的哪个 registry。
298
- - **提示通道**(toast 通道已实测不可用:宿主 `client.tui.showToast` 调用永不返回且不弹窗,正式实现不碰):
299
- 1. 宿主 server logs(`update available: <旧> -> <新>(cache: <缓存目录>;reinstall: …)`);
300
- 2. 工具响应附带 `update_hint` 块(`autotest_run_task` / `autotest_get_report` 的 output 末尾 + metadata)——**仅随每个会话的首个工具响应附带一次**(会话级一次性消费,同会话后续工具响应不重复)。块内自带转述指令行(真实会话实测:提示正文出现三次、模型零转述,纯提示词规则显著性不足),与 Test agent prompt 注入的「升级提示纪律」段互为双保险,agent 向用户转述一次(含精确缓存目录、重装命令与重启步骤)。
301
- - **版本比较**:严格 x.y.z 语义比较,仅 registry `latest` **大于**本地版本才提示(registry 落后本地不误报);非严格格式(预发布等)降级字符串不等比较。
302
- - **提示频率**:检测每次 devco 启动(插件装配)一次;检测到新版后,升级提示**仅随每个会话的首个工具响应出现一次**(同会话后续工具响应不重复);版本差距消除前,每个新会话(含重启 devco)各提示一次。
303
- - **fail-silent**:检测链路任何失败(缓存布局不适用、registry 不可达、超时 5s、dist-tags 形状异常)都静默降级为「无提示」,只留一条 pluginLog 诊断行——绝不影响插件装配与工具执行;仓库内直跑(无缓存布局)自然跳过。
304
-
305
- ### 发布顺序(兼容断点)
179
+ 说明:
306
180
 
307
- 本包只依赖 `@autotest/agent` 的 **CLI**(`dist/autotest-cli.js`),不依赖它的插件入口。因此切换顺序是:
308
-
309
- 1. **先发本包** `@autotest/plugin`(0.1.0)——它可与仍带 `exports["./server"]` 的旧主包共存;
310
- 2. **再发主包**——移除 `exports["./server"]` 与插件构建链的版本。
311
-
312
- 反过来做(先发移除入口的主包)会让尚未迁移的工程在两个工具消失后才发现问题。
313
-
314
- ### 旧配置的症状与下线
315
-
316
- 旧工程把插件入口指向 `@autotest/agent`(`"plugin": ["@autotest/agent"]`),或在 `.deveco/plugins/` 下留有一个 re-export 薄壳。新主包移除 `exports["./server"]` 后:
317
-
318
- - **症状**:Test 模式里两个工具**静默消失**,`deveco` 启动不报错、不提示——宿主无法解析的插件条目会被跳过,没有失败日志指向它。
319
- - **自检**:`deveco debug config` 的 `plugin_origins` 若仍显示 `@autotest/agent` 或干脆没有插件条目,即命中此情况。
320
- - **下线旧配置项**:从 `.deveco/deveco.jsonc` 的 `plugin` 数组删掉 `@autotest/agent` 条目(有旧薄壳文件则一并删除),改成 `"plugin": ["@autotest/plugin"]`;删 devco 缓存目录后重新安装本包,再按 §验证 的四项断言复核。
181
+ - 模型必须支持图片输入;纯文本模型在首次截图后会失败
182
+ - 用户配置了有效模型时优先使用用户配置;未配置时插件从 devco 登录态注入模型三键
183
+ - 任务参数 `device_sn` 仅覆盖设备序列号,不修改 `device.ip` / `device.port`
184
+ - 不传 `device_sn` 时,跟随配置文件的 `device.device_sn`;配置为空时可能自动选择首个在线设备,多设备场景建议显式指定
321
185
 
322
186
  ---
323
187
 
324
- ## 发布(维护者)
188
+ ## 9. 故障排查
325
189
 
326
- 本包自带完整构建与发布链,`npm pack` / `npm publish` 会先跑 `prepack`(= `build:obfuscate`),产物为 `dist/index.js`(单文件混淆 bundle)+ `dist/skills/`:
190
+ ### Test 模式无法执行用例
327
191
 
328
- ```bash
329
- cd AutoTest-nodejs/integrations/deveco
330
- npm test # pretest 先 build,再跑 vitest(含包元数据/产物/入口契约断言)
331
- npm run typecheck
332
- npm pack # 本地检查 tarball 内容(files 只含 dist,README 由 npm 自动收入)
333
- npm publish # scoped 包,publishConfig.access=public
334
- ```
192
+ - 确认当前为 **Test** 模式
193
+ - 确认插件已在 devco 中启用
194
+ - 确认插件安装后已重启 devco
335
195
 
336
- 发布前确认主包已不再是插件分发通道(该检查在主包根执行):
196
+ ### 找不到设备
337
197
 
338
198
  ```bash
339
- cd AutoTest-nodejs
340
- npm run check:pack # 主包产物检查:0 fail 0 skip
341
- npm run release:check # 聚合门:主包 build → check:pack → 本包 npm test
199
+ hdc list targets
342
200
  ```
343
201
 
344
- `check:pack` 会真实触发主包的 `prepack`(clean + 全量构建)后核对 tarball 清单,判定 `dist/integrations` 下不再有插件产物、且主包 `bin` 与库入口齐全;它 fail-closed,无法判定即 FAIL。
202
+ 确认设备在线且已解锁;多设备时显式传入 `device_sn`。
345
203
 
346
- > **入口导出面约束(宿主契约,加任何具名导出都会整包加载失败)**:宿主插件加载器遍历入口模块的**全部导出值**——先按「函数、或带 `server` 函数的对象」校验(不合格直接 `Plugin export is not a function`),再把每个合格值**都当插件工厂调用**(无 per-export 容错)。因此函数型具名导出同样致命:调用期抛错即整包 `failed to load plugin`,**三项注入**——`permission` / `agent.test` / `skills.paths`——静默缺失;`plugin_origins` 仍会列出该 spec,**不构成加载成功证据**。结论:`dist/index.js` 的导出面只放插件工厂(默认导出),**不要具名导出任何值**(常量 / 函数 / 类型别名)——包括为单测方便导出的纯函数;版本一致性改由入口工厂的运行时日志 `loaded, version=<semver>` 断言(`tests/package-contract.test.ts` 用「导出键集恒为 `['default']`」守住这条契约)。
204
+ ### 无法启动应用
347
205
 
348
- ---
206
+ 应用无法按显示名启动(未找到、名称重复或启动了错误应用)时,请在用例中显式给出应用包名:
349
207
 
350
- ## 故障排查
351
-
352
- | 错误码 | 场景 | 处理 |
353
- |---|---|---|
354
- | T1 | 已退役(0.1.1 移除进程内并发互斥) | 无需处理——并发发起任务不再被拒绝,任务表可同时存在多条 `running` |
355
- | T2 | `configPath` 三源全空的状态描述(**不是报错**:`configPath` 可选) | 无需处理——模型段由 devco 凭据注入;仅当还要携带非模型配置(设备 / Agent / 输出)时才三选一提供 `configPath`:① sidecar 写 `{"configPath": "<绝对路径>/config.yaml"}`;② 环境变量 `AUTOTEST_CONFIG=<绝对路径>`;③ 调用工具时传 `config_path` 参数 |
356
- | T3 | 未找到 CLI(四源全失败,含包内解析) | 确认 `@autotest/agent` 安装完整(含 `dist/autotest-cli.js` 且版本落在 `>=0.0.25 <0.2.0`);仍失败时在 `.deveco/autotest-plugin.json` 写 `{"cliPath": "<绝对路径>/dist/autotest-cli.js"}` 显式指定 |
357
- | T4 | 子进程启动失败 | 检查 `node` 是否在 PATH(或 sidecar `nodePath` 指向有效解释器)、CLI 文件是否存在 |
358
- | T5 | `autotest_get_report` 未传参数 | `task_id` 与 `report_dir` 至少提供一个 |
359
- | T6 | 任务启动前已被取消 | abort 预检命中,未创建子进程 |
360
- | T7 | 报告目录发现多个候选 JSON | 传精确的 `report_dir` 重查(单任务报告与目录同名;loop 任务传含 `loop_result.json` 的任务根目录) |
361
- | T8 | 报告 JSON 解析失败 | 文件可能损坏或为非报告 JSON;可重试或人工检查该文件 |
362
- | — | 传了 `device_sn` 但连接的设备没变 | `device_sn` 只覆盖序列号(不改 `device.ip` / `device.port`,远程地址仍取 config);若运行环境里的 CLI 不是含该修复的构建,`--device` 会被解析后忽略——用报告目录 stream log 的 banner 行(`sn=`)自查实际连接的设备:banner 显示 config 值或 `(auto)` 即覆盖未生效,请改用含该修复的 CLI(如 sidecar `cliPath` 指向该构建) |
363
- | — | 模型凭据不可用(未配置 `model.unified` 且 devco 登录态 / `UI_VERIFY_*` 均不可用) | 三选一:① 确认已登录 DevEco Code(OAuth 凭据依赖有效登录态);② 设置 `UI_VERIFY_BASE_URL` / `UI_VERIFY_API_KEY` / `UI_VERIFY_MODEL_NAME`(可只设 `api_key`);③ 在 AutoTest 配置文件中显式配置 `model.unified` 的 `base_url` / `api_key` / `name` |
208
+ ```text
209
+ 打开应用(包名 com.example.app),进入“WLAN”页面,验证可用网络列表正常显示
210
+ ```
364
211
 
365
- ### 回滚(已发布版本出问题时)
212
+ `com.example.app` 替换为实际包名,可通过 `hdc shell bm dump -a` 查看。
366
213
 
367
- 1. **标记问题版本**(安装方会看到弃用提示;已装工程需按 §升级须知 改回配置):
214
+ ### 任务长时间处于 RUNNING
368
215
 
369
- ```bash
370
- npm deprecate @autotest/plugin@0.1.0 "插件入口问题,回滚到 @autotest/agent 的 ./server 通道,详见发布说明"
371
- ```
216
+ - 继续轮询任务状态
217
+ - 查看任务目录下 `plugin_stream.log`,确认是否存在设备断连、模型超时或重试记录
372
218
 
373
- 2. **按上一个良好 tag 检出并重发含 `./server` 的主包补丁版**(可直接复制):
219
+ ### 模型调用失败
374
220
 
375
- ```bash
376
- git worktree add ../autotest-rollback <last-good-tag>
377
- cd ../autotest-rollback/AutoTest-nodejs
378
- npm ci
379
- npm version patch --no-git-tag-version
380
- npm publish --tag next
381
- ```
221
+ 属于模型服务侧问题,可尝试:
382
222
 
383
- 3. **灰度确认后把 `next` 提升为 `latest`**:
223
+ - 稍后重试
224
+ - 更换稳定的多模态模型
225
+ - 在 AutoTest 配置 `model.unified` 中显式指定可用模型
384
226
 
385
- ```bash
386
- # 先让少量工程用 <主包补丁版> 验证:npm i @autotest/agent@next
387
- npm dist-tag add @autotest/agent@<补丁版版本号> latest
388
- ```
227
+ ### 找不到报告
389
228
 
390
- 回滚后仍需删一次 devco 缓存(`%USERPROFILE%\.cache\deveco\packages\@autotest\plugin@latest` 或对应的 `@autotest\agent@latest`),否则宿主继续复用旧包。
229
+ - 使用任务启动时返回的 `taskId` 或 `reportDir` 查询
230
+ - 确认报告目录未被手动删除
231
+ - Loop 任务请传任务根目录,不要只传某一轮的 `iter_N`
391
232
 
392
233
  ---
393
234
 
394
- ## 安全与语义注记
235
+ ## License
395
236
 
396
- - **报告读取语义**:`autotest_get_report` 按「报告读取」设计——接受任意 `report_dir` 并读取其中报告 JSON,**不做路径白名单**。这与 devco 内置 read 工具的权限面不同(内置 read 受权限系统约束,本插件直接按传参读文件)。仅在信任的会话/工程内使用。
397
- - **sidecar 与 config.yaml 同等敏感**:`.deveco/autotest-plugin.json` 承载 `configPath`(指向可能含 API 密钥的 config.yaml),若显式配置 `cliPath`(执行入口)则同样敏感,被篡改等同任意命令执行。两者同属工程敏感文件,注意保管与审阅。
398
- - **CLI 身份校验不是信任边界**:包内解析会校验候选包的 `name` + 版本区间,目的是避免误命中祖先安装树里的同名包,**不构成供应链防护**——恶意包伪造这两个字段即可通过。安装来源(registry 与 scope 所有权)仍需自行确认。
399
- - **报告内容是数据不是指令**:报告/日志文件是任务执行产生的事实记录,agent 读取时应按数据处理,不应把其中的文本当作指令执行。
237
+ MIT