From 0b6a08446445c7804224f8ca74fc428eb323b122 Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Thu, 23 Apr 2026 04:58:43 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/help/testing.md | 933 +++++++++++++++++----------------- docs/zh-CN/platforms/linux.md | 67 ++- docs/zh-CN/vps.md | 91 ++-- 3 files changed, 561 insertions(+), 530 deletions(-) diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index 4782a4b77..1bed4c99c 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,115 +1,118 @@ --- read_when: - 在本地或 CI 中运行测试 - - 为模型/提供商缺陷添加回归测试 + - 为模型 / 提供商 bug 添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：unit/e2e/live 测试套件、Docker 运行器，以及每种测试覆盖的内容 +summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及每项测试涵盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-23T04:24:24Z" + generated_at: "2026-04-23T04:54:32Z" model: gpt-5.4 provider: openai - source_hash: 3f965b3d818730c7c58125a29f7cc2508a45aba6c7534b7f13755380dedcef66 + source_hash: d8d80348fd025100a5a57fe26fbc53fa90c04a6248ca8f6b940a79a9471be666 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三套 Vitest 测试套件（unit/integration、e2e、live）以及一小组 Docker 运行器。 +OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 -本文档是一份“我们如何测试”的指南： +本文档是“我们如何测试”的指南： - 每个测试套件覆盖什么内容（以及它刻意 _不_ 覆盖什么） - 常见工作流（本地、推送前、调试）应运行哪些命令 -- live 测试如何发现凭证并选择模型/提供商 -- 如何为真实世界中的模型/提供商问题添加回归测试 +- 实时测试如何发现凭证并选择模型 / 提供商 +- 如何为真实世界中的模型 / 提供商问题添加回归测试 ## 快速开始 大多数情况下： -- 完整门禁（预期在推送前运行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` -- 在配置充裕的机器上更快地运行本地完整测试套件：`pnpm test:max` -- 直接进入 Vitest 监听循环：`pnpm test:watch` -- 现在直接按文件定位也会路由到 extension/channel 路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` -- 当你在迭代处理单个失败用例时，优先使用定向运行。 +- 完整门禁（预期在推送前执行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` +- 在配置充足的机器上更快地运行本地完整测试套件：`pnpm test:max` +- 直接使用 Vitest 观察循环：`pnpm test:watch` +- 现在直接指定文件也会路由到 extension / channel 路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` +- 当你正在迭代处理单个失败用例时，优先使用有针对性的运行。 - 基于 Docker 的 QA 站点：`pnpm qa:lab:up` - 基于 Linux VM 的 QA 通道：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` -当你改动了测试，或希望获得更高信心时： +当你修改了测试，或希望获得更多信心时： - 覆盖率门禁：`pnpm test:coverage` - E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商/模型时（需要真实凭证）： +当你在调试真实提供商 / 模型时（需要真实凭证）： -- live 测试套件（模型 + Gateway 网关 tool/image 探测）：`pnpm test:live` -- 安静地只运行一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -- Moonshot/Kimi 成本冒烟测试：设置 `MOONSHOT_API_KEY` 后，运行 - `openclaw models list --provider moonshot --json`，然后针对 `moonshot/kimi-k2.6` 运行一个独立的 - `openclaw agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json` - 。验证 JSON 报告的是 Moonshot/K2.6，并且 assistant transcript 存储了标准化后的 `usage.cost`。 +- 实时测试套件（模型 + Gateway 网关 工具 / 图像探测）：`pnpm test:live` +- 安静地只运行一个实时测试文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` +- Moonshot / Kimi 成本冒烟测试：设置 `MOONSHOT_API_KEY` 后，运行 + `openclaw models list --provider moonshot --json`，然后针对 `moonshot/kimi-k2.6` 运行隔离的 + `openclaw agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json`。 + 验证 JSON 报告了 Moonshot / K2.6，并且助手转录存储了规范化的 `usage.cost`。 -提示：当你只需要一个失败用例时，优先通过下文描述的 allowlist 环境变量来缩小 live 测试范围。 +提示：当你只需要一个失败用例时，优先使用下文描述的 allowlist 环境变量来缩小实时测试范围。 ## QA 专用运行器 -当你需要更贴近 QA-lab 的真实环境时，这些命令与主测试套件并列使用： +当你需要 QA-lab 的真实环境时，这些命令与主测试套件并列使用： - `pnpm openclaw qa suite` - - 直接在宿主机上运行基于仓库的 QA 场景。 - - 默认并行运行多个已选择的场景，并使用隔离的 Gateway 网关 worker。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整 worker 数量，或使用 `--concurrency 1` 回到旧的串行通道。 - - 当任一场景失败时，以非零状态退出。如果你希望保留产物而不以失败退出，可使用 `--allow-failures`。 + - 直接在主机上运行由仓库支持的 QA 场景。 + - 默认并行运行多个选定场景，并使用隔离的 Gateway 网关 工作进程。`qa-channel` 默认并发度为 4（受所选场景数量限制）。使用 `--concurrency ` 调整工作进程数量，或使用 `--concurrency 1` 以使用旧的串行通道。 + - 当任一场景失败时，以非零状态退出。若你希望生成产物但不以失败退出，可使用 `--allow-failures`。 - 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。 - `aimock` 会启动一个本地 AIMock 支持的提供商服务器，用于实验性的 fixture 和协议 mock 覆盖，而不会替代具备场景感知的 `mock-openai` 通道。 + `aimock` 会启动一个本地的、由 AIMock 支持的提供商服务器，用于实验性的 fixture 和协议 mock 覆盖，但不会替代具备场景感知能力的 `mock-openai` 通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一个临时的 Multipass Linux VM 中运行相同的 QA 测试套件。 - - 保持与宿主机上 `qa suite` 相同的场景选择行为。 - - 复用与 `qa suite` 相同的提供商/模型选择参数。 - - live 运行会转发那些对 guest 来说可行且受支持的 QA 认证输入： - 基于环境变量的提供商密钥、QA live provider 配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保持在仓库根目录下，以便 guest 能通过挂载的工作区回写数据。 - - 会在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要，以及 Multipass 日志。 + - 在一次性 Multipass Linux VM 中运行相同的 QA 测试套件。 + - 保持与主机上 `qa suite` 相同的场景选择行为。 + - 复用与 `qa suite` 相同的提供商 / 模型选择标志。 + - 实时运行会转发适合访客机使用的受支持 QA 认证输入： + 基于环境变量的提供商密钥、QA 实时提供商配置路径，以及存在时的 `CODEX_HOME`。 + - 输出目录必须保持在仓库根目录下，以便访客机可通过挂载的工作区回写内容。 + - 将常规 QA 报告 + 摘要以及 Multipass 日志写入 + `.artifacts/qa-e2e/...`。 - `pnpm qa:lab:up` - - 启动基于 Docker 的 QA 站点，供操作员式 QA 工作使用。 + - 启动基于 Docker 的 QA 站点，用于偏运营风格的 QA 工作。 +- `pnpm test:docker:npm-onboard-channel-agent` + - 从当前检出构建 npm tarball，在 Docker 中全局安装，运行非交互式 OpenAI API 密钥新手引导，默认配置 Telegram，验证启用插件时会按需安装运行时依赖，运行 doctor，并针对一个 mock OpenAI 端点运行一次本地智能体回合。 + - 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 可在相同的打包安装通道中使用 Discord。 - `pnpm test:docker:bundled-channel-deps` - - 在 Docker 中打包并安装当前 OpenClaw 构建，启动已配置 OpenAI 的 Gateway 网关，然后通过修改配置启用内置 channel/plugins。 - - 验证设置发现流程会让尚未配置的插件运行时依赖保持缺失状态；第一次已配置的 Gateway 网关或 doctor 运行会按需安装每个内置插件的运行时依赖；第二次重启不会重复安装已激活的依赖。 - - 还会安装一个已知较旧的 npm 基线，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 能修复内置 channel 运行时依赖，而无需测试框架侧的 postinstall 修复。 + - 在 Docker 中打包并安装当前 OpenClaw 构建，启动已配置 OpenAI 的 Gateway 网关，然后通过编辑配置启用内置渠道 / 插件。 + - 验证设置发现阶段不会安装未配置插件的运行时依赖，首次配置后的 Gateway 网关 或 doctor 运行会按需安装每个内置插件的运行时依赖，而第二次重启不会重新安装已激活的依赖。 + - 还会安装一个已知较旧的 npm 基线，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 会修复内置渠道运行时依赖，而不需要测试工具侧的 postinstall 修复。 - `pnpm openclaw qa aimock` - - 仅启动本地 AIMock 提供商服务器，用于直接的协议冒烟测试。 + - 仅启动本地 AIMock 提供商服务器，用于直接协议冒烟测试。 - `pnpm openclaw qa matrix` - - 针对一个临时的、基于 Docker 的 Tuwunel homeserver 运行 Matrix live QA 通道。 - - 这个 QA 宿主目前仅供仓库/开发使用。打包后的 OpenClaw 安装不包含 `qa-lab`，因此不会暴露 `openclaw qa`。 - - 仓库检出会直接加载内置运行器；不需要单独安装插件。 - - 预配三个临时 Matrix 用户（`driver`、`sut`、`observer`）以及一个私有房间，然后以真实 Matrix 插件作为 SUT 传输层启动一个 QA Gateway 网关子进程。 - - 默认使用固定的稳定版 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。当你需要测试不同镜像时，可使用 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 - - Matrix 不暴露共享凭证源参数，因为该通道会在本地预配临时用户。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Matrix QA 报告、摘要、observed-events 产物，以及合并的 stdout/stderr 输出日志。 + - 针对一次性、基于 Docker 的 Tuwunel homeserver 运行 Matrix 实时 QA 通道。 + - 该 QA 主机目前仅供仓库 / 开发环境使用。打包后的 OpenClaw 安装不附带 + `qa-lab`，因此不会暴露 `openclaw qa`。 + - 仓库检出会直接加载内置运行器；无需单独安装插件。 + - 预配三个临时 Matrix 用户（`driver`、`sut`、`observer`）以及一个私有房间，然后启动一个以真实 Matrix 插件作为 SUT 传输层的 QA Gateway 网关 子进程。 + - 默认使用固定的稳定版 Tuwunel 镜像 `ghcr.io/matrix-construct/tuwunel:v1.5.1`。当你需要测试其他镜像时，可使用 `OPENCLAW_QA_MATRIX_TUWUNEL_IMAGE` 覆盖。 + - Matrix 不暴露共享凭证来源标志，因为该通道会在本地预配一次性用户。 + - 将 Matrix QA 报告、摘要、observed-events 产物以及合并的 stdout / stderr 输出日志写入 `.artifacts/qa-e2e/...`。 - `pnpm openclaw qa telegram` - - 使用环境变量中的 driver 和 SUT bot token，针对一个真实私有群组运行 Telegram live QA 通道。 - - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。group id 必须是 Telegram chat 的数字 id。 - - 支持 `--credential-source convex` 以使用共享的池化凭证。默认使用 env 模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 - - 当任一场景失败时，以非零状态退出。如果你希望保留产物而不以失败退出，可使用 `--allow-failures`。 - - 需要两个不同的 bot 位于同一个私有群组中，并且 SUT bot 需要暴露一个 Telegram 用户名。 - - 为了实现稳定的 bot 间观察，请在 `@BotFather` 中为两个 bot 都启用 Bot-to-Bot Communication Mode，并确保 driver bot 可以观察群组中的 bot 流量。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 产物。 + - 使用环境变量中的 driver 和 SUT 机器人令牌，针对真实私有群组运行 Telegram 实时 QA 通道。 + - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。group id 必须是 Telegram chat id 的数字值。 + - 支持 `--credential-source convex`，用于共享池化凭证。默认使用环境变量模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 + - 当任一场景失败时，以非零状态退出。若你希望生成产物但不以失败退出，可使用 `--allow-failures`。 + - 需要两个不同的机器人位于同一个私有群组中，且 SUT 机器人公开 Telegram 用户名。 + - 为了实现稳定的 bot-to-bot 观察，请在 `@BotFather` 中为两个机器人启用 Bot-to-Bot Communication Mode，并确保 driver 机器人能够观察群组中的机器人流量。 + - 将 Telegram QA 报告、摘要和 observed-messages 产物写入 `.artifacts/qa-e2e/...`。 -live 传输通道共享一套标准契约，以避免新传输方式发生漂移： +实时传输通道共享一份标准契约，因此新传输方式不会发生漂移： -`qa-channel` 仍然是广义的合成 QA 测试套件，不属于 live -传输覆盖矩阵的一部分。 +`qa-channel` 仍然是覆盖范围广泛的合成 QA 测试套件，不属于实时传输覆盖矩阵的一部分。 -| 通道 | Canary | Mention gating | Allowlist block | 顶层回复 | 重启恢复 | 线程后续跟进 | 线程隔离 | Reaction 观察 | 帮助命令 | -| -------- | ------ | -------------- | --------------- | --------------- | -------------- | ---------------- | ---------------- | -------------------- | ------------ | +| 通道 | Canary | 提及门控 | allowlist 阻止 | 顶层回复 | 重启恢复 | 线程后续跟进 | 线程隔离 | reaction 观察 | help 命令 | +| ---- | ------ | -------- | -------------- | -------- | -------- | ------------ | -------- | ------------- | --------- | | Matrix | x | x | x | x | x | x | x | x | | | Telegram | x | | | | | | | | x | ### 通过 Convex 共享 Telegram 凭证（v1） -当为 `openclaw qa telegram` 启用 `--credential-source convex`（或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`）时， -QA lab 会从一个由 Convex 支持的池中获取独占租约，在通道运行期间为该租约发送心跳，并在关闭时释放该租约。 +当为 `openclaw qa telegram` 启用 `--credential-source convex`（或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`）时，QA lab 会从基于 Convex 的池中获取一个独占租约，在通道运行期间为该租约发送心跳，并在关闭时释放该租约。 参考 Convex 项目脚手架： @@ -118,12 +121,12 @@ QA lab 会从一个由 Convex 支持的池中获取独占租约，在通道运 必需的环境变量： - `OPENCLAW_QA_CONVEX_SITE_URL`（例如 `https://your-deployment.convex.site`） -- 针对所选角色的一个密钥： - - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`，用于 `maintainer` - - `OPENCLAW_QA_CONVEX_SECRET_CI`，用于 `ci` +- 为所选角色提供一个 secret： + - `maintainer` 使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` + - `ci` 使用 `OPENCLAW_QA_CONVEX_SECRET_CI` - 凭证角色选择： - CLI：`--credential-role maintainer|ci` - - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认为 `ci`，否则默认为 `maintainer`） + - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认为 `ci`，否则为 `maintainer`） 可选环境变量： @@ -132,15 +135,15 @@ QA lab 会从一个由 Convex 支持的池中获取独占租约，在通道运 - `OPENCLAW_QA_CREDENTIAL_ACQUIRE_TIMEOUT_MS`（默认 `90000`） - `OPENCLAW_QA_CREDENTIAL_HTTP_TIMEOUT_MS`（默认 `15000`） - `OPENCLAW_QA_CONVEX_ENDPOINT_PREFIX`（默认 `/qa-credentials/v1`） -- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`（可选追踪 id） +- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`（可选的追踪 id） - `OPENCLAW_QA_ALLOW_INSECURE_HTTP=1` 允许在仅限本地开发时使用 loopback `http://` Convex URL。 `OPENCLAW_QA_CONVEX_SITE_URL` 在正常运行中应使用 `https://`。 -维护者管理命令（池添加/移除/列出）必须明确使用 +维护者管理命令（池的添加 / 删除 / 列表）必须专门使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 -面向维护者的 CLI 辅助命令： +供维护者使用的 CLI 辅助命令： ```bash pnpm openclaw qa credentials add --kind telegram --payload-file qa/telegram-credential.json @@ -148,14 +151,14 @@ pnpm openclaw qa credentials list --kind telegram pnpm openclaw qa credentials remove --credential-id ``` -在脚本和 CI 工具中使用 `--json` 以获得机器可读输出。 +在脚本和 CI 工具中，使用 `--json` 获取机器可读输出。 默认端点契约（`OPENCLAW_QA_CONVEX_SITE_URL` + `/qa-credentials/v1`）： - `POST /acquire` - 请求：`{ kind, ownerId, actorRole, leaseTtlMs, heartbeatIntervalMs }` - 成功：`{ status: "ok", credentialId, leaseToken, payload, leaseTtlMs?, heartbeatIntervalMs? }` - - 池耗尽/可重试：`{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }` + - 耗尽 / 可重试：`{ status: "error", code: "POOL_EXHAUSTED" | "NO_CREDENTIAL_AVAILABLE", ... }` - `POST /heartbeat` - 请求：`{ kind, ownerId, actorRole, credentialId, leaseToken, leaseTtlMs }` - 成功：`{ status: "ok" }`（或空的 `2xx`） @@ -173,26 +176,26 @@ pnpm openclaw qa credentials remove --credential-id - 请求：`{ kind?, status?, includePayload?, limit? }` - 成功：`{ status: "ok", credentials, count }` -Telegram 类型的 payload 结构： +Telegram 类型的负载结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是 Telegram chat 的数字 id 字符串。 -- 对于 `kind: "telegram"`，`admin/add` 会验证该结构，并拒绝格式错误的 payload。 +- `groupId` 必须是 Telegram chat id 的数字字符串。 +- 对于 `kind: "telegram"`，`admin/add` 会验证此结构，并拒绝格式错误的负载。 ### 向 QA 添加一个渠道 -将一个渠道添加到 Markdown QA 系统中，严格来说只需要两样东西： +将一个渠道添加到 Markdown QA 系统中，恰好需要两样东西： 1. 该渠道的传输适配器。 2. 一个用于验证该渠道契约的场景包。 -不要为了这个流程新增顶层 QA 命令根；共享的 `qa-lab` 宿主应负责整个流程。 +当共享的 `qa-lab` 主机可以承载流程时，不要新增新的顶层 QA 命令根。 -`qa-lab` 负责共享宿主机制： +`qa-lab` 负责共享主机机制： - `openclaw qa` 命令根 - 测试套件启动与清理 -- worker 并发 +- 工作进程并发 - 产物写入 - 报告生成 - 场景执行 @@ -200,35 +203,35 @@ Telegram 类型的 payload 结构： 运行器插件负责传输契约： -- `openclaw qa ` 如何挂载到共享的 `qa` 根命令下 +- `openclaw qa ` 如何挂载在共享的 `qa` 根命令下 - 如何为该传输方式配置 Gateway 网关 - 如何检查就绪状态 - 如何注入入站事件 - 如何观察出站消息 -- 如何暴露 transcript 和标准化后的传输状态 +- 如何暴露转录和规范化的传输状态 - 如何执行由传输支持的操作 -- 如何处理传输特有的重置或清理 +- 如何处理传输特定的重置或清理 新渠道的最低接入门槛是： -1. 保持由 `qa-lab` 作为共享 `qa` 根命令的所有者。 -2. 在共享的 `qa-lab` 宿主接缝上实现传输运行器。 -3. 将传输特有机制保留在运行器插件或渠道 harness 内部。 -4. 将运行器挂载为 `openclaw qa `，而不是注册一个彼此竞争的根命令。 +1. 保持 `qa-lab` 作为共享 `qa` 根命令的所有者。 +2. 在共享的 `qa-lab` 主机接缝上实现传输运行器。 +3. 将传输特定的机制保留在运行器插件或渠道 harness 内部。 +4. 将运行器挂载为 `openclaw qa `，而不是注册一个相互竞争的根命令。 运行器插件应在 `openclaw.plugin.json` 中声明 `qaRunners`，并从 `runtime-api.ts` 导出匹配的 `qaRunnerCliRegistrations` 数组。 - 保持 `runtime-api.ts` 轻量；延迟 CLI 和运行器执行应放在单独的入口点之后。 -5. 在带主题的 `qa/scenarios/` 目录下编写或改造 Markdown 场景。 -6. 对新场景使用通用场景辅助工具。 -7. 除非仓库正在进行有意迁移，否则要保持现有兼容性别名继续可用。 + 保持 `runtime-api.ts` 足够轻量；延迟 CLI 和运行器执行应保留在独立的入口点之后。 +5. 在按主题组织的 `qa/scenarios/` 目录下编写或调整 Markdown 场景。 +6. 为新场景使用通用场景辅助函数。 +7. 除非仓库正在进行有意的迁移，否则保持现有兼容别名继续可用。 决策规则是严格的： -- 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放进 `qa-lab`。 -- 如果某个行为依赖于单一渠道传输，就把它保留在对应的运行器插件或插件 harness 中。 -- 如果某个场景需要新增一种可供多个渠道使用的能力，就添加一个通用辅助工具，而不是在 `suite.ts` 中加入渠道专用分支。 -- 如果某个行为只对一种传输有意义，就让该场景保持传输专用，并在场景契约中明确说明。 +- 如果某项行为可以在 `qa-lab` 中统一表达一次，就将它放在 `qa-lab` 中。 +- 如果某项行为依赖于某一个渠道传输方式，就将它保留在该运行器插件或插件 harness 中。 +- 如果某个场景需要超过一个渠道都能使用的新能力，请添加通用辅助函数，而不是在 `suite.ts` 中添加渠道特定分支。 +- 如果某项行为只对某一种传输方式有意义，请保持该场景为传输特定，并在场景契约中明确这一点。 -新场景推荐使用的通用辅助工具名称是： +新场景推荐使用的通用辅助函数名称是： - `waitForTransportReady` - `waitForChannelReady` @@ -243,7 +246,7 @@ Telegram 类型的 payload 结构： - `formatTransportTranscript` - `resetTransport` -现有场景仍可使用兼容性别名，包括： +现有场景仍可使用兼容别名，包括： - `waitForQaChannelReady` - `waitForOutboundMessage` @@ -251,84 +254,82 @@ Telegram 类型的 payload 结构： - `formatConversationTranscript` - `resetBus` -新的渠道工作应使用这些通用辅助工具名称。 -兼容性别名的存在是为了避免一次性强制迁移，而不是作为 -新场景编写的模板。 +新的渠道工作应使用通用辅助函数名称。 +兼容别名的存在是为了避免“一刀切”的迁移日，而不是作为 +新场景编写的范式。 -## 测试套件（各自运行的位置） +## 测试套件（各自运行位置） -可以将这些测试套件理解为“真实性逐步增加”（同时不稳定性/成本也逐步增加）： +可以将这些测试套件理解为“真实度逐步提升”（同时不稳定性 / 成本也逐步增加）： -### Unit / integration（默认） +### 单元 / 集成（默认） - 命令：`pnpm test` -- 配置：通过现有分域 Vitest projects 运行十个顺序分片（`vitest.full-*.config.ts`） -- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core/unit 清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 +- 配置：对现有按范围划分的 Vitest projects 运行十个顺序分片（`vitest.full-*.config.ts`） +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core / 单元测试清单，以及由 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 - 范围： - 纯单元测试 - - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） - - 针对已知缺陷的确定性回归测试 + - 进程内集成测试（Gateway 网关 认证、路由、工具、解析、配置） + - 已知 bug 的确定性回归测试 - 预期： - - 会在 CI 中运行 + - 在 CI 中运行 - 不需要真实密钥 - - 应当快速且稳定 + - 应该快速且稳定 - Projects 说明： - - 未定向的 `pnpm test` 现在会运行十一个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个巨大的原生 root-project 进程。这能降低高负载机器上的峰值 RSS，并避免 auto-reply/extension 工作拖慢无关测试套件。 - - `pnpm test --watch` 仍然使用原生 root `vitest.config.ts` project graph，因为多分片 watch 循环并不现实。 - - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 会优先将显式文件/目录目标路由到分域通道，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整 root project 启动成本。 - - 当变更 diff 只涉及可路由的源码/测试文件时，`pnpm test:changed` 会将变更的 git 路径扩展到相同的分域通道；配置/设置类修改仍会回退到更广泛的 root-project 重跑。 - - `pnpm check:changed` 是狭窄工作范围下常用的智能本地门禁。它会将 diff 归类为 core、core tests、extensions、extension tests、apps、docs、发布元数据和工具，然后运行匹配的 typecheck/lint/test 通道。公共 Plugin SDK 和插件契约的变更会包含 extension 验证，因为 extensions 依赖这些 core 契约。仅发布元数据的版本升级会运行定向的版本/配置/root-dependency 检查，而不是完整测试套件，并有一个守卫来拒绝顶层 version 字段之外的 package 变更。 - - 来自 agents、commands、plugins、auto-reply helpers、`plugin-sdk` 以及类似纯工具区域的轻导入 unit 测试会通过 `unit-fast` 通道路由，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态/运行时较重的文件仍保留在现有通道中。 - - 选定的 `plugin-sdk` 和 `commands` helper 源文件也会在 changed 模式运行中映射到这些轻量通道中的显式同级测试，因此 helper 修改无需为该目录重跑完整重型测试套件。 - - `auto-reply` 现在分为三个专用桶：顶层 core helpers、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样最重的 reply harness 工作就不会挤占廉价的 status/chunk/token 测试。 + - 无目标的 `pnpm test` 现在会运行 11 个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个庞大的原生 root-project 进程。这可以降低高负载机器上的峰值 RSS，并避免 auto-reply / extension 工作拖累无关测试套件。 + - `pnpm test --watch` 仍然使用原生根级 `vitest.config.ts` project graph，因为多分片 watch 循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会优先将显式文件 / 目录目标路由到按范围划分的通道，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 无需承担完整 root project 启动成本。 + - `pnpm test:changed` 会在 diff 只涉及可路由的源码 / 测试文件时，将变更的 git 路径扩展到相同的按范围划分通道；配置 / setup 修改仍会回退到范围更广的 root-project 重新运行。 + - `pnpm check:changed` 是窄范围工作时的常规智能本地门禁。它会将 diff 分类为 core、core tests、extensions、extension tests、apps、docs、release metadata 和 tooling，然后运行匹配的 typecheck / lint / test 通道。公共插件 SDK 和插件契约变更会包含 extension 验证，因为 extensions 依赖这些 core 契约。仅包含发布元数据版本提升的变更会运行有针对性的版本 / 配置 / 根依赖检查，而不是完整测试套件，并带有一个保护措施，拒绝顶层 version 字段之外的 package 变更。 + - 来自 agents、commands、plugins、auto-reply helpers、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试会路由到 `unit-fast` 通道，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件仍保留在现有通道上。 + - 某些选定的 `plugin-sdk` 和 `commands` helper 源文件也会将 changed 模式运行映射到这些轻量通道中的显式同级测试，因此 helper 修改无需为该目录重新运行完整的重型测试套件。 + - `auto-reply` 现在有三个专用分桶：顶层 core helpers、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这使得最重的 reply harness 工作不会影响廉价的 status / chunk / token 测试。 - Embedded runner 说明： - - 当你更改 message-tool 发现输入或压缩运行时上下文时， - 要同时保持两个层级的覆盖。 - - 为纯路由/标准化边界添加聚焦的 helper 回归测试。 - - 同时也要保持 embedded runner 集成测试套件健康： + - 当你修改消息工具发现输入或压缩运行时上下文时， + 请同时保持两层覆盖。 + - 为纯路由 / 规范化边界添加聚焦的 helper 回归测试。 + - 同时保持 embedded runner 集成测试套件健康： `src/agents/pi-embedded-runner/compact.hooks.test.ts`、 - `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts`，以及 + `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 和 `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`。 - - 这些测试套件会验证作用域 id 和压缩行为仍会沿着真实的 - `run.ts` / `compact.ts` 路径流动；仅有 helper 测试 - 不能充分替代这些集成路径。 + - 这些测试套件验证带作用域的 id 和压缩行为仍会沿着真实的 `run.ts` / `compact.ts` 路径流动；仅有 helper 测试并不能充分替代这些集成路径。 - Pool 说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置也固定使用 `isolate: false`，并在 root projects、e2e 和 live 配置中使用非隔离运行器。 - - root UI 通道保留其 `jsdom` 设置和优化器，但现在也运行在共享的非隔离运行器上。 + - 共享 Vitest 配置还固定了 `isolate: false`，并在 root projects、e2e 和实时配置中使用非隔离运行器。 + - 根级 UI 通道保留其 `jsdom` setup 和 optimizer，但现在也运行在共享的非隔离运行器上。 - 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 - - 共享的 `scripts/run-vitest.mjs` 启动器现在还会默认为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要对比原生 V8 行为，请设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 -- Fast-local iteration 说明： - - `pnpm changed:lanes` 会显示某个 diff 会触发哪些架构通道。 - - pre-commit hook 会在 staged formatting/linting 之后运行 `pnpm check:changed --staged`，因此纯 core 提交不会承担 extension 测试成本，除非它们触及面向 extension 的公共契约。仅发布元数据的提交会保留在定向的版本/配置/root-dependency 通道。 - - 当变更路径可以清晰映射到较小测试套件时，`pnpm test:changed` 会通过分域通道进行路由。 - - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是提高了 worker 上限。 - - 本地 worker 自动扩缩现在有意保持保守，当宿主负载平均值已经较高时也会回退，因此默认情况下多个并发 Vitest 运行造成的影响会更小。 - - 基础 Vitest 配置会将 projects/config 文件标记为 `forceRerunTriggers`，这样在测试接线发生变化时，changed 模式重跑仍然正确。 - - 配置会在受支持宿主上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你想为直接性能分析指定一个显式缓存位置，请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 -- Perf-debug 说明： - - `pnpm test:perf:imports` 会启用 Vitest 导入时长报告以及导入拆分输出。 - - `pnpm test:perf:imports:changed` 会将相同的性能分析视图限定到自 `origin/main` 以来变更的文件。 -- `pnpm test:perf:changed:bench -- --ref ` 会将当前提交 diff 的路由版 `test:changed` 与原生 root-project 路径进行比较，并输出 wall time 和 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会通过将变更文件列表路由到 `scripts/test-projects.mjs` 和 root Vitest 配置，对当前脏工作树进行基准测试。 - - `pnpm test:perf:profile:main` 会为 Vitest/Vite 启动和 transform 开销写入主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为 unit 测试套件写入 runner CPU + heap profiles。 + - 共享的 `scripts/run-vitest.mjs` 启动器现在还会默认向 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原生 V8 行为进行比较，请设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 +- 快速本地迭代说明： + - `pnpm changed:lanes` 会显示一个 diff 触发了哪些架构通道。 + - pre-commit hook 会在对已暂存内容执行格式化 / lint 后运行 `pnpm check:changed --staged`，因此仅 core 的提交不会承担 extension 测试成本，除非它们触及面向 extension 的公共契约。仅发布元数据提交会保留在有针对性的版本 / 配置 / 根依赖通道上。 + - 当变更路径可以清晰映射到更小的测试套件时，`pnpm test:changed` 会通过按范围划分的通道进行路由。 + - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是使用更高的 worker 上限。 + - 本地 worker 自动扩缩容现在刻意更保守，并且当主机负载平均值已经较高时也会回退，因此默认情况下多个并发 Vitest 运行的破坏性会更小。 + - 基础 Vitest 配置将 projects / 配置文件标记为 `forceRerunTriggers`，因此当测试接线发生变化时，changed 模式重新运行仍然正确。 + - 在受支持的主机上，配置会保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你希望为直接分析指定一个显式缓存位置，请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 +- 性能调试说明： + - `pnpm test:perf:imports` 会启用 Vitest 导入时长报告以及导入分解输出。 + - `pnpm test:perf:imports:changed` 会将相同的分析视图限定到自 `origin/main` 以来发生变更的文件。 +- `pnpm test:perf:changed:bench -- --ref ` 会将已提交 diff 的路由式 `test:changed` 与原生 root-project 路径进行比较，并输出墙钟时间以及 macOS 最大 RSS。 +- `pnpm test:perf:changed:bench -- --worktree` 会通过将变更文件列表路由到 `scripts/test-projects.mjs` 和根 Vitest 配置，对当前脏工作树进行基准测试。 + - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动与 transform 开销写入主线程 CPU profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件并行时，为单元测试套件写入 runner CPU + heap profiles。 ### 稳定性（Gateway 网关） - 命令：`pnpm test:stability:gateway` - 配置：`vitest.gateway.config.ts`，强制单 worker - 范围： - - 启动一个真实的 loopback Gateway 网关，默认启用诊断 - - 通过诊断事件路径驱动合成的 gateway message、memory 和 large-payload 抖动 + - 启动一个默认启用诊断功能的真实 loopback Gateway 网关 + - 通过诊断事件路径驱动合成的 Gateway 网关 消息、内存和大负载 churn - 通过 Gateway 网关 WS RPC 查询 `diagnostics.stability` - - 覆盖诊断稳定性 bundle 持久化辅助工具 - - 断言 recorder 保持有界、合成 RSS 样本保持在压力预算之下、每个会话的队列深度会回落到零 + - 覆盖诊断稳定性 bundle 持久化 helper + - 断言 recorder 保持有界、合成 RSS 样本保持在压力预算之下，并且每个会话的队列深度会回落到零 - 预期： - 对 CI 安全且无需密钥 - - 这是一个用于稳定性回归跟进的狭窄通道，不是完整 Gateway 网关测试套件的替代 + - 这是用于稳定性回归跟进的窄范围通道，不是完整 Gateway 网关 测试套件的替代品 -### E2E（Gateway 网关冒烟） +### E2E（Gateway 网关 冒烟测试） - 命令：`pnpm test:e2e` - 配置：`vitest.e2e.config.ts` @@ -337,176 +338,176 @@ Telegram 类型的 payload 结构： - 使用 Vitest `threads` 且 `isolate: false`，与仓库其余部分保持一致。 - 使用自适应 workers（CI：最多 2 个，本地：默认 1 个）。 - 默认以 silent 模式运行，以减少控制台 I/O 开销。 -- 有用的覆盖项： - - `OPENCLAW_E2E_WORKERS=` 可强制指定 worker 数量（上限为 16）。 - - `OPENCLAW_E2E_VERBOSE=1` 可重新启用详细控制台输出。 +- 有用的覆盖选项： + - `OPENCLAW_E2E_WORKERS=` 强制设置 worker 数量（上限为 16）。 + - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - - 多实例 Gateway 网关端到端行为 - - WebSocket/HTTP 表面、节点配对和更重的网络行为 + - 多实例 Gateway 网关 端到端行为 + - WebSocket / HTTP 表面、节点配对以及更重的网络场景 - 预期： - - 会在 CI 中运行（当通道在流水线中启用时） + - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比 unit 测试涉及更多活动部件（可能更慢） + - 比单元测试包含更多活动部件（可能更慢） -### E2E：OpenShell backend 冒烟 +### E2E：OpenShell 后端冒烟测试 - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 - - 从一个临时本地 Dockerfile 创建一个沙箱 - - 通过真实的 `sandbox ssh-config` + SSH exec 练习 OpenClaw 的 OpenShell backend - - 通过 sandbox fs bridge 验证远端规范文件系统行为 + - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 + - 从临时本地 Dockerfile 创建一个沙箱 + - 通过真实的 `sandbox ssh-config` + SSH exec 演练 OpenClaw 的 OpenShell 后端 + - 通过沙箱 fs bridge 验证远端规范文件系统行为 - 预期： - - 仅按需启用；不属于默认的 `pnpm test:e2e` 运行 + - 仅限选择加入；不属于默认 `pnpm test:e2e` 运行的一部分 - 需要本地 `openshell` CLI 和可用的 Docker daemon - - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，随后销毁测试 Gateway 网关和沙箱 -- 有用的覆盖项： - - `OPENCLAW_E2E_OPENSHELL=1` 可在手动运行更广泛 e2e 测试套件时启用该测试 - - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell` 可指向非默认 CLI 二进制或包装脚本 + - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 Gateway 网关 和沙箱 +- 有用的覆盖选项： + - `OPENCLAW_E2E_OPENSHELL=1` 在手动运行更广泛的 e2e 测试套件时启用该测试 + - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell` 指向非默认 CLI 二进制或包装脚本 -### Live（真实提供商 + 真实模型） +### 实时（真实提供商 + 真实模型） - 命令：`pnpm test:live` - 配置：`vitest.live.config.ts` - 文件：`src/**/*.live.test.ts` - 默认：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商/模型在 _今天_ 搭配真实凭证时是否真的可用？” - - 捕获提供商格式变更、tool-calling 怪癖、认证问题以及速率限制行为 + - “这个提供商 / 模型 _今天_ 是否真的能在真实凭证下工作？” + - 捕获提供商格式变更、工具调用怪癖、认证问题和限流行为 - 预期： - - 按设计并不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - - 会花钱 / 占用速率限制额度 - - 优先运行缩小范围的子集，而不是“全部都跑” -- live 运行会读取 `~/.profile`，以获取缺失的 API 密钥。 -- 默认情况下，live 运行仍会隔离 `HOME`，并将配置/认证材料复制到一个临时测试 home 中，这样 unit fixture 就无法修改你真实的 `~/.openclaw`。 -- 仅在你明确需要让 live 测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 -- `pnpm test:live` 现在默认采用更安静的模式：会保留 `[live] ...` 进度输出，但会隐藏额外的 `~/.profile` 提示，并静默 gateway 启动日志/Bonjour 杂讯。如果你想恢复完整启动日志，请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 -- API 密钥轮换（提供商专用）：设置逗号/分号格式的 `*_API_KEYS`，或设置 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），也可以通过 `OPENCLAW_LIVE_*_KEY` 为单次 live 运行覆盖；测试会在收到速率限制响应时重试。 -- 进度/心跳输出： - - live 测试套件现在会将进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用仍能显示为正在运行。 - - `vitest.live.config.ts` 禁用了 Vitest 控制台拦截，因此在 live 运行期间，提供商/Gateway 网关进度行会立即流式输出。 - - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型的心跳间隔。 - - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关/探针的心跳间隔。 + - 按设计并不具备 CI 稳定性（真实网络、真实提供商策略、配额、服务中断） + - 会花钱 / 消耗限流额度 + - 优先运行缩小范围的子集，而不是“一次跑全部” +- 实时运行会读取 `~/.profile` 以获取缺失的 API 密钥。 +- 默认情况下，实时运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，这样单元测试 fixture 就不会修改你真实的 `~/.openclaw`。 +- 仅当你明确需要让实时测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 +- `pnpm test:live` 现在默认使用更安静的模式：它会保留 `[live] ...` 进度输出，但会抑制额外的 `~/.profile` 提示，并静音 Gateway 网关 引导日志 / Bonjour 杂讯。如果你想恢复完整启动日志，请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 +- API 密钥轮换（按提供商区分）：设置逗号 / 分号格式的 `*_API_KEYS` 或 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），或者通过 `OPENCLAW_LIVE_*_KEY` 进行单次实时覆盖；测试会在收到限流响应时重试。 +- 进度 / 心跳输出： + - 实时测试套件现在会将进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用也能明显显示仍在运行。 + - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，因此在实时运行期间，提供商 / Gateway 网关 进度行会立即流式输出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探针心跳。 -## 我应该运行哪套测试？ +## 我应该运行哪个测试套件？ -使用这个决策表： +使用下面这个决策表： -- 编辑逻辑/测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） -- 涉及 Gateway 网关网络 / WS 协议 / 配对：再加上 `pnpm test:e2e` -- 调试“我的 bot 挂了” / 提供商专用故障 / tool calling：运行一个缩小范围的 `pnpm test:live` +- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动较多，也运行 `pnpm test:coverage`） +- 修改 Gateway 网关 网络 / WS 协议 / 配对：额外运行 `pnpm test:e2e` +- 调试“我的 bot 挂了” / 提供商特定失败 / 工具调用：运行缩小范围的 `pnpm test:live` -## Live：Android 节点能力扫描 +## 实时：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前**公布的每一个命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前**公开的每一个命令**，并断言命令契约行为。 - 范围： - - 有前置条件/手动设置（该测试套件不会安装/运行/配对应用）。 - - 针对所选 Android 节点逐条验证 gateway `node.invoke`。 -- 必需的预先设置： - - Android 应用已连接并已与 gateway 配对。 + - 预置 / 手动 setup（该测试套件不会安装 / 运行 / 配对应用）。 + - 对所选 Android 节点逐命令执行 Gateway 网关 `node.invoke` 验证。 +- 必需的前置 setup： + - Android 应用已连接并与 Gateway 网关 配对。 - 应用保持在前台。 - - 已授予你预期会通过的能力所需的权限/捕获同意。 -- 可选目标覆盖项： + - 已为你期望通过的能力授予权限 / 捕获同意。 +- 可选目标覆盖： - `OPENCLAW_ANDROID_NODE_ID` 或 `OPENCLAW_ANDROID_NODE_NAME`。 - `OPENCLAW_ANDROID_GATEWAY_URL` / `OPENCLAW_ANDROID_GATEWAY_TOKEN` / `OPENCLAW_ANDROID_GATEWAY_PASSWORD`。 -- 完整 Android 设置详情：[Android App](/zh-CN/platforms/android) +- 完整 Android setup 详情： [Android App](/zh-CN/platforms/android) -## Live：模型冒烟测试（profile keys） +## 实时：模型冒烟测试（profile 键） -live 测试分为两层，以便隔离故障： +实时测试分为两层，以便我们隔离失败原因： -- “Direct model” 告诉我们，提供商/模型在给定密钥下是否至少能够响应。 -- “Gateway smoke” 告诉我们，针对该模型，完整的 gateway + 智能体 流水线是否正常工作（会话、历史、工具、沙箱策略等）。 +- “直接模型”告诉我们，在给定密钥下该提供商 / 模型是否至少能响应。 +- “Gateway 网关 冒烟测试”告诉我们，该模型的完整 Gateway 网关 + 智能体流水线是否正常工作（会话、历史、工具、沙箱策略等）。 -### 第 1 层：直接模型补全（无 gateway） +### 第 1 层：直接模型补全（无 Gateway 网关） - 测试：`src/agents/models.profiles.live.test.ts` - 目标： - 枚举已发现的模型 - 使用 `getApiKeyForModel` 选择你有凭证的模型 - - 对每个模型运行一个小型补全（并在需要时运行定向回归） + - 为每个模型运行一个小型补全（并在需要时运行有针对性的回归测试） - 如何启用： - - `pnpm test:live`（或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） -- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，即 modern 的别名）才会真正运行此测试套件；否则会跳过，以便让 `pnpm test:live` 聚焦于 gateway 冒烟测试 + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） +- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，它是 modern 的别名）才能真正运行此测试套件；否则它会跳过，以便让 `pnpm test:live` 聚焦于 Gateway 网关 冒烟测试 - 如何选择模型： - - `OPENCLAW_LIVE_MODELS=modern` 以运行 modern allowlist（Opus/Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_MODELS=all` 是 modern allowlist 的别名 - - 或 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） - - modern/all 全量扫描默认带有一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置为正数以使用更小上限。 + - `OPENCLAW_LIVE_MODELS=modern` 运行现代 allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - `OPENCLAW_LIVE_MODELS=all` 是现代 allowlist 的别名 + - 或者 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） + - modern / all 扫描默认使用一组精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行穷尽式现代扫描，或设置为正数以使用更小的上限。 - 如何选择提供商： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔的 allowlist） - 密钥来源： - 默认：profile store 和环境变量回退 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅使用 profile store** -- 存在这个测试的原因： - - 将“提供商 API 出故障 / 密钥无效”与“gateway 智能体 流水线出故障”区分开来 - - 容纳小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 推理回放 + tool-call 流程） + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 以强制**仅**使用 profile store +- 为什么需要它： + - 将“提供商 API 坏了 / 密钥无效”与“Gateway 网关 智能体流水线坏了”区分开来 + - 容纳小而隔离的回归测试（示例：OpenAI Responses / Codex Responses 推理重放 + 工具调用流程） -### 第 2 层：Gateway 网关 + dev 智能体 冒烟测试（也就是 “@openclaw” 实际做的事） +### 第 2 层：Gateway 网关 + dev 智能体冒烟测试（也就是 “@openclaw” 实际做的事） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - - 启动一个进程内 gateway - - 创建/修补一个 `agent:dev:*` 会话（每次运行按需覆盖模型） - - 迭代那些带密钥的模型，并断言： - - “有意义的”回复（无工具） - - 一次真实工具调用可正常工作（read probe） - - 可选的额外工具探针（exec+read probe） - - OpenAI 回归路径（仅 tool-call → 后续跟进）持续可用 -- 探针细节（这样你就能快速解释故障）： - - `read` probe：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 该文件并回显 nonce。 - - `exec+read` probe：测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件，然后再 `read` 回来。 - - image probe：测试会附加一个生成的 PNG（cat + 随机代码），并期望模型返回 `cat `。 + - 启动一个进程内 Gateway 网关 + - 创建 / patch 一个 `agent:dev:*` 会话（每次运行覆盖模型） + - 遍历带密钥的模型并断言： + - “有意义的”回复（不使用工具） + - 真实工具调用可用（read 探针） + - 可选的额外工具探针（exec+read 探针） + - OpenAI 回归路径（仅工具调用 → 后续跟进）持续可用 +- 探针细节（这样你可以快速解释失败）： + - `read` 探针：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 它并回显 nonce。 + - `exec+read` 探针：测试会要求智能体通过 `exec` 将 nonce 写入临时文件，然后再 `read` 回来。 + - 图像探针：测试会附加一个生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 - 实现参考：`src/gateway/gateway-models.profiles.live.test.ts` 和 `src/gateway/live-image-probe.ts`。 - 如何启用： - - `pnpm test:live`（或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） - 如何选择模型： - - 默认：modern allowlist（Opus/Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是 modern allowlist 的别名 + - 默认：现代 allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是现代 allowlist 的别名 - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号分隔列表）以缩小范围 - - modern/all gateway 扫描默认带有一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置为正数以使用更小上限。 -- 如何选择提供商（避免“OpenRouter 全都跑”）： + - modern / all Gateway 网关 扫描默认使用一组精心挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行穷尽式现代扫描，或设置为正数以使用更小的上限。 +- 如何选择提供商（避免“OpenRouter 全家桶”）： - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） -- tool + image 探针在这个 live 测试中始终开启： - - `read` probe + `exec+read` probe（工具压力测试） - - 当模型声明支持图像输入时，会运行 image probe +- 工具 + 图像探针在此实时测试中始终启用： + - `read` 探针 + `exec+read` 探针（工具压力测试） + - 当模型宣称支持图像输入时，运行图像探针 - 流程（高层级）： - - 测试生成一个带有 “CAT” + 随机代码的小 PNG（`src/gateway/live-image-probe.ts`） - - 通过 `agent` `attachments: [{ mimeType: "image/png", content: "" }]` 发送它 - - Gateway 网关将附件解析为 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） - - embedded 智能体向模型转发一条多模态用户消息 + - 测试会生成一个带有 “CAT” + 随机代码的小型 PNG（`src/gateway/live-image-probe.ts`） + - 通过 `agent` `attachments: [{ mimeType: "image/png", content: "" }]` 发送 + - Gateway 网关 将附件解析到 `images[]` 中（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） + - 内嵌智能体将一条多模态用户消息转发给模型 - 断言：回复包含 `cat` + 该代码（OCR 容错：允许轻微错误） -提示：要查看你机器上可以测试什么（以及精确的 `provider/model` id），请运行： +提示：若想查看你机器上可以测试什么（以及精确的 `provider/model` id），请运行： ```bash openclaw models list openclaw models list --json ``` -## Live：CLI backend 冒烟测试（Claude、Codex、Gemini 或其他本地 CLI） +## 实时：CLI 后端冒烟测试（Claude、Codex、Gemini 或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：在不触碰你的默认配置的情况下，使用本地 CLI backend 验证 Gateway 网关 + 智能体 流水线。 -- backend 专用的冒烟测试默认值位于所属 extension 的 `cli-backend.ts` 定义中。 +- 目标：在不触碰默认配置的前提下，使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线。 +- 后端特定的默认冒烟测试位于所属 extension 的 `cli-backend.ts` 定义中。 - 启用方式： - - `pnpm test:live`（或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） - `OPENCLAW_LIVE_CLI_BACKEND=1` - 默认值： - - 默认提供商/模型：`claude-cli/claude-sonnet-4-6` - - 命令/参数/图像行为来自所属 CLI backend 插件元数据。 + - 默认提供商 / 模型：`claude-cli/claude-sonnet-4-6` + - 命令 / 参数 / 图像行为来自所属 CLI 后端插件元数据。 - 覆盖项（可选）： - `OPENCLAW_LIVE_CLI_BACKEND_MODEL="codex-cli/gpt-5.4"` - `OPENCLAW_LIVE_CLI_BACKEND_COMMAND="/full/path/to/codex"` - `OPENCLAW_LIVE_CLI_BACKEND_ARGS='["exec","--json","--color","never","--sandbox","read-only","--skip-git-repo-check"]'` - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 可发送真实图像附件（路径会被注入到 prompt 中）。 - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 可将图像文件路径作为 CLI 参数传递，而不是注入到 prompt。 - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）用于在设置了 `IMAGE_ARG` 时控制图像参数的传递方式。 - - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 可发送第二轮消息并验证恢复流程。 - - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 可禁用默认的 Claude Sonnet -> Opus 同会话连续性探针（当所选模型支持切换目标时，设置为 `1` 可强制启用）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 发送真实图像附件（路径会注入到提示词中）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 将图像文件路径作为 CLI 参数传递，而不是注入到提示词中。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）控制在设置 `IMAGE_ARG` 时如何传递图像参数。 + - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 发送第二轮并验证恢复流程。 + - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 禁用默认的 Claude Sonnet -> Opus 同会话连续性探针（当所选模型支持切换目标时，设为 `1` 可强制开启）。 示例： @@ -534,28 +535,28 @@ pnpm test:docker:live-cli-backend:gemini 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会在仓库 Docker 镜像内，以非 root 的 `node` 用户身份运行 live CLI-backend 冒烟测试。 -- 它会从所属 extension 解析 CLI 冒烟测试元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到 `OPENCLAW_DOCKER_CLI_TOOLS_DIR` 指向的可写缓存前缀中（默认：`~/.cache/openclaw/docker-cli-tools`）。 -- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过 `~/.claude/.credentials.json` 中的 `claudeAiOauth.subscriptionType`，或通过 `claude setup-token` 生成的 `CLAUDE_CODE_OAUTH_TOKEN` 提供。它会先验证 Docker 中直接 `claude -p` 可用，然后在不保留 Anthropic API key 环境变量的情况下运行两轮 Gateway 网关 CLI-backend 交互。这个订阅通道默认禁用 Claude MCP/tool 和 image 探针，因为 Claude 当前会将第三方应用使用量计入额外用量计费，而不是普通订阅计划额度。 -- live CLI-backend 冒烟测试现在会对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后通过 gateway CLI 验证 MCP `cron` 工具调用。 -- Claude 的默认冒烟测试还会将会话从 Sonnet 修补为 Opus，并验证恢复后的会话仍然记得更早之前的一条备注。 +- 它会在仓库 Docker 镜像中，以非 root 的 `node` 用户身份运行实时 CLI 后端冒烟测试。 +- 它会从所属 extension 中解析 CLI 冒烟测试元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到可缓存、可写的前缀目录 `OPENCLAW_DOCKER_CLI_TOOLS_DIR`（默认：`~/.cache/openclaw/docker-cli-tools`）。 +- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过 `~/.claude/.credentials.json` 中的 `claudeAiOauth.subscriptionType`，或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN` 提供。它会先在 Docker 中验证直接 `claude -p` 可用，然后在不保留 Anthropic API 密钥环境变量的情况下运行两轮 Gateway 网关 CLI 后端测试。该订阅通道默认禁用 Claude MCP / 工具和图像探针，因为 Claude 当前会将第三方应用使用量路由到额外使用计费，而不是普通订阅计划限额。 +- 现在，实时 CLI 后端冒烟测试会对 Claude、Codex 和 Gemini 运行相同的端到端流程：文本轮次、图像分类轮次，然后通过 Gateway 网关 CLI 验证 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet patch 到 Opus，并验证恢复后的会话仍然记得之前的备注。 -## Live：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） +## 实时：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用一个 live ACP 智能体验证真实的 ACP conversation-bind 流程： +- 目标：使用实时 ACP 智能体验证真实的 ACP 会话绑定流程： - 发送 `/acp spawn --bind here` - - 原地绑定一个合成的 message-channel 会话 - - 在同一个会话上发送一条普通后续消息 - - 验证该后续消息会落入已绑定的 ACP 会话 transcript 中 + - 就地绑定一个合成的消息渠道会话 + - 在同一会话中发送一条普通后续消息 + - 验证该后续消息落入已绑定的 ACP 会话转录中 - 启用方式： - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` - 默认值： - Docker 中的 ACP 智能体：`claude,codex,gemini` - - 直接通过 `pnpm test:live ...` 使用的 ACP 智能体：`claude` - - 合成渠道：类似 Slack 私信的会话上下文 - - ACP backend：`acpx` + - 直接 `pnpm test:live ...` 使用的 ACP 智能体：`claude` + - 合成渠道：Slack 私信风格的会话上下文 + - ACP 后端：`acpx` - 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` - `OPENCLAW_LIVE_ACP_BIND_AGENT=codex` @@ -564,7 +565,7 @@ pnpm test:docker:live-cli-backend:gemini - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - `OPENCLAW_LIVE_ACP_BIND_CODEX_MODEL=gpt-5.4` - 说明： - - 这个通道使用 gateway `chat.send` 表面，并附带仅管理员可用的合成 originating-route 字段，这样测试就能附加 message-channel 上下文，而无需假装进行外部投递。 + - 该通道使用 Gateway 网关 `chat.send` 表面，并带有仅管理员可用的合成 originating-route 字段，因此测试可以附加消息渠道上下文，而无需假装进行外部投递。 - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件的内建智能体注册表来获取所选 ACP harness 智能体。 示例： @@ -592,33 +593,34 @@ pnpm test:docker:live-acp-bind:gemini Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会按顺序针对所有受支持的 live CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后是 `gemini`。 +- 默认情况下，它会按顺序对所有受支持的实时 CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后是 `gemini`。 - 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可缩小矩阵范围。 -- 它会读取 `~/.profile`，将匹配的 CLI 认证材料暂存到容器中，把 `acpx` 安装到一个可写的 npm 前缀，然后在缺失时安装所请求的 live CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 -- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 acpx 就能让从 profile 中读取到的 provider 环境变量继续对其子 harness CLI 可用。 +- 它会读取 `~/.profile`，将匹配的 CLI 认证材料暂存到容器中，把 `acpx` 安装到可写 npm 前缀，然后在缺失时安装所请求的实时 CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 +- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 acpx 就能让从 profile 中读取到的提供商环境变量继续可用于子 harness CLI。 -## Live：Codex app-server harness 冒烟测试 +## 实时：Codex app-server harness 冒烟测试 -- 目标：通过常规 gateway +- 目标：通过常规 Gateway 网关 `agent` 方法验证由插件拥有的 Codex harness： - 加载内置 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - - 向 `codex/gpt-5.4` 发送第一条 gateway agent 消息 - - 向同一个 OpenClaw 会话发送第二条消息，并验证 app-server + - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关 智能体消息 + - 向同一个 OpenClaw 会话发送第二轮消息，并验证 app-server 线程能够恢复 - - 通过相同的 gateway 命令 + - 通过相同的 Gateway 网关 命令 路径运行 `/codex status` 和 `/codex models` - - 可选运行两个经过 Guardian 审核的提权 shell 探针：一个应被批准的良性 - 命令，以及一个应被拒绝、从而让智能体发起回问的假秘密上传 + - 可选运行两个经过 Guardian 审核的提权 shell 探针：一个应被批准的无害 + 命令，以及一个应被拒绝的伪造密钥上传命令， + 以便智能体回问用户 - 测试：`src/gateway/gateway-codex-harness.live.test.ts` - 启用：`OPENCLAW_LIVE_CODEX_HARNESS=1` - 默认模型：`codex/gpt-5.4` -- 可选 image 探针：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` -- 可选 MCP/tool 探针：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` +- 可选图像探针：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` +- 可选 MCP / 工具探针：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` - 可选 Guardian 探针：`OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=1` - 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，因此损坏的 Codex - harness 不能通过静默回退到 PI 来“假装通过”。 -- 认证：来自 shell/profile 的 `OPENAI_API_KEY`，以及可选复制的 + harness 不能通过悄悄回退到 PI 而蒙混过关。 +- 认证：来自 shell / profile 的 `OPENAI_API_KEY`，以及可选复制的 `~/.codex/auth.json` 和 `~/.codex/config.toml` 本地配方： @@ -644,49 +646,50 @@ Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 - 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI - 认证文件，将 `@openai/codex` 安装到一个可写、已挂载的 npm - 前缀中，暂存源代码树，然后仅运行 Codex-harness live 测试。 -- Docker 默认启用 image、MCP/tool 和 Guardian 探针。当你需要更窄范围的调试 - 运行时，可设置 `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 + 认证文件，将 `@openai/codex` 安装到可写的挂载 npm + 前缀，暂存源码树，然后只运行 Codex harness 实时测试。 +- Docker 默认启用图像、MCP / 工具和 Guardian 探针。需要更窄范围的调试 + 运行时，可设置 + `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0` 或 `OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0`。 -- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与 live +- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与实时 测试配置保持一致，因此 `openai-codex/*` 或 PI 回退都无法掩盖 Codex harness 回归问题。 -### 推荐的 live 配方 +### 推荐的实时测试配方 -范围窄、明确的 allowlist 最快，也最不容易抖动： +范围窄、显式的 allowlist 最快且最不容易出问题： -- 单模型，direct（无 gateway）： +- 单模型，直接测试（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` -- 单模型，gateway 冒烟： +- 单模型，Gateway 网关 冒烟测试： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 跨多个提供商的 tool calling： +- 跨多个提供商测试工具调用： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 聚焦 Google（Gemini API key + Antigravity）： - - Gemini（API key）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` +- 聚焦 Google（Gemini API 密钥 + Antigravity）： + - Gemini（API 密钥）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - Antigravity（OAuth）：`OPENCLAW_LIVE_GATEWAY_MODELS="google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-pro-high" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` 说明： -- `google/...` 使用 Gemini API（API key）。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立的认证 + 工具行为差异）。 +- `google/...` 使用 Gemini API（API 密钥）。 +- `google-antigravity/...` 使用 Antigravity OAuth bridge（类似 Cloud Code Assist 风格的智能体端点）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立认证 + 独特工具行为）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API key / profile 认证）；这通常是大多数用户所说的 “Gemini”。 - - CLI：OpenClaw 调用本地 `gemini` 二进制；它有自己的认证方式，且行为可能不同（流式传输/工具支持/版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 调用本地 `gemini` 二进制；它有自己的认证，并且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 -## Live：模型矩阵（我们覆盖什么） +## 实时：模型矩阵（我们的覆盖范围） -这里没有固定的“CI 模型列表”（live 是按需启用的），但以下是**建议**在有密钥的开发机器上定期覆盖的模型。 +没有固定的“CI 模型列表”（实时测试是选择加入），但以下是**推荐**在带有密钥的开发机上定期覆盖的模型。 -### Modern 冒烟集（tool calling + image） +### 现代冒烟测试集（工具调用 + 图像） -这是我们期望持续保持可用的“常用模型”运行集合： +这是我们期望持续可用的“常用模型”运行集合： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -696,10 +699,10 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -使用 tools + image 运行 gateway 冒烟测试： +运行带工具 + 图像的 Gateway 网关 冒烟测试： `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,openai-codex/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3.1-pro-preview,google/gemini-3-flash-preview,google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-flash,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -### 基线：tool calling（Read + 可选 Exec） +### 基线：工具调用（Read + 可选 Exec） 每个提供商家族至少选一个： @@ -712,78 +715,78 @@ Docker 说明： 可选的额外覆盖（有更好，没有也行）： - xAI：`xai/grok-4`（或最新可用版本） -- Mistral：`mistral/`…（选择一个你已启用、支持 tools 的模型） +- Mistral：`mistral/`…（选择一个你已启用、支持工具的模型） - Cerebras：`cerebras/`…（如果你有访问权限） -- LM Studio：`lmstudio/`…（本地；tool calling 取决于 API 模式） +- LM Studio：`lmstudio/`…（本地；工具调用取决于 API 模式） -### Vision：发送图像（附件 → 多模态消息） +### 视觉：图像发送（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个具备图像能力的模型（Claude/Gemini/OpenAI 的支持视觉的变体等），以覆盖 image probe。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的支持视觉的变体等），以覆盖图像探针。 -### 聚合器 / 替代 Gateway 网关 +### 聚合器 / 备用 Gateway 网关 -如果你已启用对应密钥，也支持通过以下方式进行测试： +如果你已启用相关密钥，我们也支持通过以下方式测试： -- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持 tool + image 的候选项） -- OpenCode：`opencode/...` 对应 Zen，`opencode-go/...` 对应 Go（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） +- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选项） +- OpenCode：Zen 使用 `opencode/...`，Go 使用 `opencode-go/...`（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） -如果你有凭证/配置，还可以将更多提供商纳入 live 矩阵： +你还可以将更多提供商纳入实时矩阵（如果你有凭证 / 配置）： - 内置：`openai`、`openai-codex`、`anthropic`、`google`、`google-vertex`、`google-antigravity`、`google-gemini-cli`、`zai`、`openrouter`、`opencode`、`opencode-go`、`xai`、`groq`、`cerebras`、`mistral`、`github-copilot` -- 通过 `models.providers`（自定义端点）：`minimax`（云/API），以及任何兼容 OpenAI/Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） +- 通过 `models.providers`（自定义端点）：`minimax`（云端 / API），以及任何兼容 OpenAI / Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） -提示：不要试图在文档里硬编码“所有模型”。权威列表始终是你机器上 `discoverModels(...)` 返回的内容，再加上当前可用的密钥。 +提示：不要试图在文档里硬编码“所有模型”。权威列表是你机器上 `discoverModels(...)` 返回的结果，加上可用密钥所支持的内容。 -## 凭证（绝不要提交） +## 凭证（切勿提交） -live 测试发现凭证的方式与 CLI 完全相同。实际含义如下： +实时测试发现凭证的方式与 CLI 相同。实际含义是： -- 如果 CLI 能工作，live 测试应当能找到同样的密钥。 -- 如果某个 live 测试提示 “no creds”，就像调试 `openclaw models list` / 模型选择一样去调试它。 +- 如果 CLI 可用，实时测试应能找到相同的密钥。 +- 如果实时测试提示 “no creds”，请像调试 `openclaw models list` / 模型选择那样调试。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile keys” 的含义） +- 每个智能体的 auth profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试中 “profile keys” 的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到暂存的 live home 中，但这不是主 profile-key 存储） -- 本地 live 运行默认会将活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；暂存的 live home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探针就不会落到你真实宿主的工作区中。 +- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到暂存的实时测试 home 中，但它不是主要的 profile-key 存储） +- 默认情况下，本地实时运行会将活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；暂存的实时测试 home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探针就不会触碰你真实主机的工作区。 -如果你想依赖环境变量密钥（例如已在 `~/.profile` 中导出），请在本地测试前运行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 +如果你想依赖环境变量密钥（例如导出在你的 `~/.profile` 中），请在本地测试前运行 `source ~/.profile`，或使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 -## Deepgram live（音频转写） +## Deepgram 实时测试（音频转录） - 测试：`src/media-understanding/providers/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts` -## BytePlus 编码计划 live +## BytePlus coding plan 实时测试 - 测试：`src/agents/byteplus.live.test.ts` - 启用：`BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` - 可选模型覆盖：`BYTEPLUS_CODING_MODEL=ark-code-latest` -## ComfyUI workflow 媒体 live +## ComfyUI workflow media 实时测试 - 测试：`extensions/comfy/comfy.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts` - 范围： - - 覆盖内置 comfy 的图像、视频和 `music_generate` 路径 - - 除非已配置 `models.providers.comfy.`，否则会跳过每项能力 - - 在改动 comfy workflow 提交、轮询、下载或插件注册之后非常有用 + - 演练内置 comfy 图像、视频和 `music_generate` 路径 + - 除非配置了 `models.providers.comfy.`，否则会跳过每项能力 + - 在修改 comfy workflow 提交、轮询、下载或插件注册后很有用 -## 图像生成 live +## 图像生成实时测试 - 测试：`src/image-generation/runtime.live.test.ts` - 命令：`pnpm test:live src/image-generation/runtime.live.test.ts` - Harness：`pnpm test:live:media image` - 范围： - - 枚举每一个已注册的图像生成提供商插件 - - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用 live/env API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实 shell 凭证 - - 跳过没有可用认证/profile/model 的提供商 + - 枚举每个已注册的图像生成提供商插件 + - 在探测前，从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是存储的 auth profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` - `google:pro-edit` - `openai:default-generate` -- 当前覆盖的内置提供商： +- 当前已覆盖的内置提供商： - `openai` - `google` - `xai` @@ -792,74 +795,74 @@ live 测试发现凭证的方式与 CLI 完全相同。实际含义如下： - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-2,google/gemini-3.1-flash-image-preview,xai/grok-imagine-image"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit,xai:default-generate,xai:default-edit"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile-store 认证并忽略仅 env 的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅来自环境变量的覆盖 -## 音乐生成 live +## 音乐生成实时测试 - 测试：`extensions/music-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` - Harness：`pnpm test:live:media music` - 范围： - - 覆盖共享的内置音乐生成提供商路径 + - 演练共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live/env API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实 shell 凭证 - - 跳过没有可用认证/profile/model 的提供商 - - 在可用时同时运行两种已声明的运行时模式： - - 使用纯 prompt 输入的 `generate` + - 在探测前，从你的登录 shell（`~/.profile`）加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是存储的 auth profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 在可用时运行两种已声明的运行时模式： + - 使用仅提示词输入的 `generate` - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` - 当前共享通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：使用单独的 Comfy live 文件，不在此共享扫描中 + - `comfy`：使用单独的 Comfy 实时文件，不在此共享扫描中 - 可选缩小范围： - `OPENCLAW_LIVE_MUSIC_GENERATION_PROVIDERS="google,minimax"` - `OPENCLAW_LIVE_MUSIC_GENERATION_MODELS="google/lyria-3-clip-preview,minimax/music-2.5+"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile-store 认证并忽略仅 env 的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅来自环境变量的覆盖 -## 视频生成 live +## 视频生成实时测试 - 测试：`extensions/video-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` - Harness：`pnpm test:live:media video` - 范围： - - 覆盖共享的内置视频生成提供商路径 - - 默认走对发布安全的冒烟路径：非 FAL 提供商、每个提供商一次文本转视频请求、一秒钟的龙虾 prompt，并且每个提供商的操作上限由 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 控制（默认 `180000`） - - 默认跳过 FAL，因为提供商侧队列延迟可能主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 可显式运行它 - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用 live/env API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实 shell 凭证 - - 跳过没有可用认证/profile/model 的提供商 - - 默认只运行 `generate` + - 演练共享的内置视频生成提供商路径 + - 默认使用对发布安全的冒烟测试路径：非 FAL 提供商、每个提供商一个文本生成视频请求、1 秒龙虾提示词，以及来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的每提供商操作上限（默认 `180000`） + - 默认跳过 FAL，因为提供商侧队列延迟可能主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 可显式运行 + - 在探测前，从你的登录 shell（`~/.profile`）加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是存储的 auth profile，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 默认仅运行 `generate` - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1`，在可用时也运行已声明的转换模式： - - 当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商/模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - - 当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商/模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` + - 当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` + - 当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` - 当前在共享扫描中已声明但被跳过的 `imageToVideo` 提供商： - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL - - 提供商专用的 Vydra 覆盖： + - 提供商特定的 Vydra 覆盖： - `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - - 该文件会运行 `veo3` 文本转视频，以及一个默认使用远程图像 URL fixture 的 `kling` 通道 - - 当前 `videoToVideo` live 覆盖： - - 仅 `runway`，且所选模型是 `runway/gen4_aleph` 时 + - 该文件会运行 `veo3` 文本生成视频，以及一个默认使用远程图像 URL fixture 的 `kling` 通道 + - 当前 `videoToVideo` 实时覆盖： + - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini/Veo 通道使用本地基于 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享通道缺乏特定组织的视频 inpaint/remix 访问保证 + - `alibaba`、`qwen`、`xai`，因为这些路径目前需要远程 `http(s)` / MP4 参考 URL + - `google`，因为当前共享 Gemini / Veo 通道使用本地基于 buffer 的输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享通道缺少组织特定的视频修补 / remix 访问保证 - 可选缩小范围： - `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="google,openai,runway"` - `OPENCLAW_LIVE_VIDEO_GENERATION_MODELS="google/veo-3.1-fast-generate-preview,openai/sora-2,runway/gen4_aleph"` - - `OPENCLAW_LIVE_VIDEO_GENERATION_SKIP_PROVIDERS=""` 以在默认扫描中包含每一个提供商，包括 FAL - - `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS=60000` 可降低每个提供商的操作上限，用于更激进的冒烟运行 + - `OPENCLAW_LIVE_VIDEO_GENERATION_SKIP_PROVIDERS=""` 可在默认扫描中包含所有提供商，包括 FAL + - `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS=60000` 可在激进的冒烟测试中缩短每个提供商的操作上限 - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile-store 认证并忽略仅 env 的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile store 认证，并忽略仅来自环境变量的覆盖 -## 媒体 live harness +## 媒体实时 harness - 命令：`pnpm test:live:media` - 目的： - - 通过一个仓库原生入口运行共享的图像、音乐和视频 live 测试套件 + - 通过一个仓库原生入口点运行共享的图像、音乐和视频实时测试套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个测试套件缩小到当前具备可用认证的提供商 + - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 - 示例： - `pnpm test:live:media` @@ -869,198 +872,200 @@ live 测试发现凭证的方式与 CLI 完全相同。实际含义如下： ## Docker 运行器（可选的“在 Linux 中可用”检查） -这些 Docker 运行器分成两类： +这些 Docker 运行器分为两类： -- live-model 运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像中运行各自匹配的 profile-key live 文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，也会读取 `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 -- Docker live 运行器默认采用更小的冒烟上限，以便完整 Docker 扫描保持可操作： - `test:docker:live-models` 默认设置 `OPENCLAW_LIVE_MAX_MODELS=12`，并且 +- 实时模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像中运行各自对应的 profile-key 实时测试文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，也会读取 `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 +- Docker 实时运行器默认使用较小的冒烟测试上限，以便完整 Docker 扫描仍然可行： + `test:docker:live-models` 默认设置 `OPENCLAW_LIVE_MAX_MODELS=12`，而 `test:docker:live-gateway` 默认设置 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=8`、 - `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000`，以及 + `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000` 和 `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你 - 明确想执行更大的完整扫描时，可覆盖这些环境变量。 -- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后将其复用于两个 live Docker 通道。 -- 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools` 和 `test:docker:plugins` 会启动一个或多个真实容器，并验证更高层的集成路径。 + 明确需要更大的穷尽式扫描时，可覆盖这些环境变量。 +- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次实时 Docker 镜像，然后将其复用于两个实时 Docker 通道。 +- 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools` 和 `test:docker:plugins` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -live-model Docker 运行器还会只 bind-mount 所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持的），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新 token，而不会修改宿主认证存储： +实时模型 Docker 运行器还会仅 bind-mount 所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持的认证 home），然后在运行前将它们复制到容器 home 中，以便外部 CLI OAuth 可以刷新令牌而不修改主机认证存储： -- Direct models：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） +- 直接模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） - ACP 绑定冒烟测试：`pnpm test:docker:live-acp-bind`（脚本：`scripts/test-live-acp-bind-docker.sh`） -- CLI backend 冒烟测试：`pnpm test:docker:live-cli-backend`（脚本：`scripts/test-live-cli-backend-docker.sh`） +- CLI 后端冒烟测试：`pnpm test:docker:live-cli-backend`（脚本：`scripts/test-live-cli-backend-docker.sh`） - Codex app-server harness 冒烟测试：`pnpm test:docker:live-codex-harness`（脚本：`scripts/test-live-codex-harness-docker.sh`） - Gateway 网关 + dev 智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） -- Open WebUI live 冒烟测试：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） +- Open WebUI 实时冒烟测试：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） - 新手引导向导（TTY，完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） -- Gateway 网关网络（两个容器，WS 认证 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） -- MCP 渠道桥接（已种子化的 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） -- Pi bundle MCP 工具（真实 stdio MCP server + 内置 Pi profile allow/deny 冒烟测试）：`pnpm test:docker:pi-bundle-mcp-tools`（脚本：`scripts/e2e/pi-bundle-mcp-tools-docker.sh`） -- Cron/subagent MCP 清理（真实 Gateway 网关 + 在隔离 cron 和一次性 subagent 运行后拆除 stdio MCP 子进程）：`pnpm test:docker:cron-mcp-cleanup`（脚本：`scripts/e2e/cron-mcp-cleanup-docker.sh`） +- Gateway 网关 网络（两个容器，WS 认证 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） +- MCP 渠道桥接（带种子的 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） +- Pi bundle MCP 工具（真实 stdio MCP server + 内嵌 Pi profile allow / deny 冒烟测试）：`pnpm test:docker:pi-bundle-mcp-tools`（脚本：`scripts/e2e/pi-bundle-mcp-tools-docker.sh`） +- Cron / subagent MCP 清理（真实 Gateway 网关 + 在隔离 cron 和一次性 subagent 运行后清理 stdio MCP 子进程）：`pnpm test:docker:cron-mcp-cleanup`（脚本：`scripts/e2e/cron-mcp-cleanup-docker.sh`） - Plugins（安装冒烟测试 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -- 内置插件运行时依赖：`pnpm test:docker:bundled-channel-deps` 默认会构建一个小型 Docker 运行器镜像，在宿主机上构建并打包一次 OpenClaw，然后将该 tarball 挂载到每个 Linux 安装场景中。使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 可复用镜像；在本地刚完成一次全新构建后，可使用 `OPENCLAW_BUNDLED_CHANNEL_HOST_BUILD=0` 跳过宿主重建；也可以通过 `OPENCLAW_BUNDLED_CHANNEL_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 指向一个现有 tarball。 +- Npm tarball 新手引导 / 渠道 / 智能体冒烟测试：`pnpm test:docker:npm-onboard-channel-agent` 会在 Docker 中全局安装已打包的 OpenClaw tarball，通过 env-ref 新手引导配置 OpenAI，并默认配置 Telegram，验证启用插件会按需安装其运行时依赖，运行 doctor，并执行一次 mock OpenAI 智能体回合。可通过 `OPENCLAW_NPM_ONBOARD_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball，通过 `OPENCLAW_NPM_ONBOARD_HOST_BUILD=0` 跳过主机构建，或通过 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 切换渠道。 +- 内置插件运行时依赖：`pnpm test:docker:bundled-channel-deps` 默认会构建一个小型 Docker 运行器镜像，在主机上构建并打包一次 OpenClaw，然后将该 tarball 挂载到每个 Linux 安装场景中。可通过 `OPENCLAW_SKIP_DOCKER_BUILD=1` 复用镜像，通过 `OPENCLAW_BUNDLED_CHANNEL_HOST_BUILD=0` 在完成一次新的本地构建后跳过主机构建，或通过 `OPENCLAW_BUNDLED_CHANNEL_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 指向现有 tarball。 - 在迭代时，可通过禁用无关场景来缩小内置插件运行时依赖测试范围，例如： - `OPENCLAW_BUNDLED_CHANNEL_SCENARIOS=0 OPENCLAW_BUNDLED_CHANNEL_UPDATE_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_ROOT_OWNED_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_SETUP_ENTRY_SCENARIO=0 pnpm test:docker:bundled-channel-deps`。 + `OPENCLAW_BUNDLED_CHANNEL_SCENARIOS=0 OPENCLAW_BUNDLED_CHANNEL_UPDATE_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_ROOT_OWNED_SCENARIO=0 OPENCLAW_BUNDLED_CHANNEL_SETUP_ENTRY_SCENARIO=0 pnpm test:docker:bundled-channel-deps` -live-model Docker 运行器还会将当前 checkout 以只读方式 bind-mount 进去， -并在容器内暂存到一个临时 workdir 中。这样既能保持运行时 -镜像精简，又仍然可以针对你精确的本地 source/config 运行 Vitest。 +实时模型 Docker 运行器还会以只读方式 bind-mount 当前检出内容， +并将其暂存到容器内的临时工作目录中。这样可以保持运行时 +镜像精简，同时仍然针对你本地精确的源码 / 配置运行 Vitest。 暂存步骤会跳过大型仅本地缓存和应用构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地的 `.build` 或 -Gradle 输出目录，因此 Docker live 运行不会花上数分钟去复制 -与机器相关的产物。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 gateway live 探针就不会在 -容器内启动真实的 Telegram/Discord 等渠道 worker。 -`test:docker:live-models` 仍然会运行 `pnpm test:live`，因此当你需要缩小范围 -或从该 Docker 通道中排除 gateway live 覆盖时，也请一并传入 +`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地 `.build` 或 +Gradle 输出目录，这样 Docker 实时运行就不会花上几分钟去复制 +特定于机器的产物。 +它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关 实时探针就不会在 +容器中启动真实的 Telegram / Discord / 等渠道工作进程。 +`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要缩小范围或排除该 Docker 通道中的 Gateway 网关 +实时覆盖时，也要一并传入 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个 -已启用 OpenAI 兼容 HTTP 端点的 OpenClaw gateway 容器， -再针对该 gateway 启动一个固定版本的 Open WebUI 容器，通过 -Open WebUI 登录，验证 `/api/models` 暴露了 `openclaw/default`，然后通过 -Open WebUI 的 `/api/chat/completions` 代理发送一次真实聊天请求。 +`test:docker:openwebui` 是更高层级的兼容性冒烟测试：它会启动一个 +启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关 容器， +再针对该 Gateway 网关 启动一个固定版本的 Open WebUI 容器，通过 +Open WebUI 完成登录，验证 `/api/models` 暴露 `openclaw/default`，然后通过 +Open WebUI 的 `/api/chat/completions` 代理发送一个真实聊天请求。 第一次运行可能明显更慢，因为 Docker 可能需要拉取 -Open WebUI 镜像，而 Open WebUI 也可能需要完成自己的冷启动设置。 -这个通道需要一个可用的 live 模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认是 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 -成功运行会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": +Open WebUI 镜像，而且 Open WebUI 可能需要完成其自身的冷启动 setup。 +该通道需要可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` +（默认 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 +成功运行时会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是有意设计为确定性的，不需要真实的 +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要真实的 Telegram、Discord 或 iMessage 账号。它会启动一个已预置的 Gateway 网关 -容器，再启动第二个容器来拉起 `openclaw mcp serve`，然后 -验证路由后的会话发现、transcript 读取、附件元数据、 -live 事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 传递的 Claude 风格渠道 + -权限通知。通知检查会直接检查原始 stdio MCP frame， -因此该冒烟测试验证的是 bridge 实际发出的内容， -而不仅仅是某个特定客户端 SDK 恰好暴露出的内容。 -`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要 live +容器，启动第二个容器来运行 `openclaw mcp serve`，然后 +验证路由后的会话发现、转录读取、附件元数据、 +实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + +权限通知，这些都通过真实的 stdio MCP bridge 完成。通知检查 +会直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 bridge 实际发出了什么， +而不仅仅是某个特定客户端 SDK 恰好暴露了什么。 +`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要实时 模型密钥。它会构建仓库 Docker 镜像，在容器中启动一个真实 stdio MCP probe server， -通过内置的 Pi bundle MCP 运行时实例化该 server， +通过内嵌 Pi bundle MCP 运行时实例化该 server， 执行该工具，然后验证 `coding` 和 `messaging` 会保留 -`bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会将它们过滤掉。 -`test:docker:cron-mcp-cleanup` 是确定性的，不需要 live 模型 -密钥。它会启动一个带真实 stdio MCP probe server 的已预置 Gateway 网关， -运行一次隔离的 cron 轮次和一次 `/subagents spawn` 一次性子智能体轮次， -然后验证 MCP 子进程会在每次运行后退出。 +`bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会将其过滤掉。 +`test:docker:cron-mcp-cleanup` 是确定性的，不需要实时模型 +密钥。它会启动一个带有真实 stdio MCP probe server 的预置 Gateway 网关，运行一次 +隔离的 cron 回合和一次 `/subagents spawn` 单次子智能体回合，然后验证 +每次运行后 MCP 子进程都会退出。 手动 ACP 自然语言线程冒烟测试（非 CI）： - `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel ...` -- 为回归/调试工作流保留这个脚本。它未来可能还会再次用于 ACP 线程路由验证，因此不要删除它。 +- 保留此脚本用于回归 / 调试工作流。它未来可能还会再次用于 ACP 线程路由验证，因此不要删除它。 有用的环境变量： - `OPENCLAW_CONFIG_DIR=...`（默认：`~/.openclaw`）挂载到 `/home/node/.openclaw` - `OPENCLAW_WORKSPACE_DIR=...`（默认：`~/.openclaw/workspace`）挂载到 `/home/node/.openclaw/workspace` -- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile`，并在运行测试前读取 -- `OPENCLAW_DOCKER_PROFILE_ENV_ONLY=1` 用于只验证从 `OPENCLAW_PROFILE_FILE` 读取的环境变量，使用临时配置/workspace 目录且不挂载外部 CLI 认证 -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于在 Docker 内缓存 CLI 安装 -- `$HOME` 下的外部 CLI 认证目录/文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` +- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile` 并在运行测试前读取 +- `OPENCLAW_DOCKER_PROFILE_ENV_ONLY=1` 验证仅使用从 `OPENCLAW_PROFILE_FILE` 读取的环境变量，使用临时配置 / 工作区目录，且不挂载外部 CLI 认证 +- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于在 Docker 中缓存 CLI 安装 +- `$HOME` 下的外部 CLI 认证目录 / 文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` - 默认目录：`.minimax` - 默认文件：`~/.codex/auth.json`、`~/.codex/config.toml`、`.claude.json`、`~/.claude/.credentials.json`、`~/.claude/settings.json`、`~/.claude/settings.local.json` - - 缩小提供商范围的运行只会挂载从 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录/文件 - - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none` 或逗号列表手动覆盖，例如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex` + - 缩小范围后的提供商运行只会挂载从 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录 / 文件 + - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none` 或逗号列表（如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex`）手动覆盖 - `OPENCLAW_LIVE_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...` 用于缩小运行范围 - `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于在容器内过滤提供商 -- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用现有的 `openclaw:local-live` 镜像，以便进行无需重建的重跑 -- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自 profile store（而不是 env） -- `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择由 gateway 为 Open WebUI 冒烟测试暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试中使用的 nonce 检查 prompt -- `OPENWEBUI_IMAGE=...` 用于覆盖固定的 Open WebUI 镜像标签 +- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用现有 `openclaw:local-live` 镜像，适合无需重建的重跑 +- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile store（而非环境变量） +- `OPENCLAW_OPENWEBUI_MODEL=...` 选择 Gateway 网关 为 Open WebUI 冒烟测试暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词 +- `OPENWEBUI_IMAGE=...` 覆盖固定的 Open WebUI 镜像标签 ## 文档完整性检查 -文档编辑后运行文档检查：`pnpm check:docs`。 -当你还需要检查页内标题时，运行完整的 Mintlify anchor 验证：`pnpm docs:check-links:anchors`。 +修改文档后运行文档检查：`pnpm check:docs`。 +当你还需要检查页内标题锚点时，运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 ## 离线回归测试（CI 安全） -这些是不依赖真实提供商的“真实流水线”回归测试： +这些是无需真实提供商的“真实流水线”回归测试： -- Gateway 网关 tool calling（mock OpenAI，真实 gateway + 智能体 循环）：`src/gateway/gateway.test.ts`（用例："runs a mock OpenAI tool call end-to-end via gateway agent loop"） -- Gateway 网关向导（WS `wizard.start`/`wizard.next`，写入配置 + 强制认证）：`src/gateway/gateway.test.ts`（用例："runs wizard over ws and writes auth token config"） +- Gateway 网关 工具调用（mock OpenAI，真实 Gateway 网关 + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） +- Gateway 网关 向导（WS `wizard.start` / `wizard.next`，强制写入配置 + 认证）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） ## 智能体可靠性评估（Skills） -我们已经有一些具备 CI 安全性的测试，它们的行为类似“智能体可靠性评估”： +我们已经有一些 CI 安全的测试，它们的行为类似“智能体可靠性评估”： -- 通过真实 gateway + 智能体 循环执行 mock tool-calling（`src/gateway/gateway.test.ts`）。 +- 通过真实 Gateway 网关 + 智能体循环进行 mock 工具调用（`src/gateway/gateway.test.ts`）。 - 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 -对于 Skills 仍然缺失的内容（参见 [Skills](/zh-CN/tools/skills)）： +对于 Skills，仍然缺失的内容是（见 [Skills](/zh-CN/tools/skills)）： -- **决策**：当 prompt 中列出 Skills 时，智能体是否会选择正确的 Skills（或避免选择无关的 Skills）？ -- **合规性**：智能体是否会在使用前读取 `SKILL.md`，并遵循所需步骤/参数？ -- **工作流契约**：断言工具顺序、会话历史继承以及沙箱边界的多轮场景。 +- **决策能力：** 当提示词中列出 Skills 时，智能体是否会选择正确的 skill（或避免无关 skill）？ +- **合规性：** 智能体在使用前是否会读取 `SKILL.md`，并遵循所需步骤 / 参数？ +- **工作流契约：** 断言工具顺序、会话历史延续和沙箱边界的多轮场景。 未来的评估应首先保持确定性： -- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取以及会话接线。 -- 一小组以 skill 为中心的场景（使用 vs 避免、门控、prompt injection）。 -- 仅在具备 CI 安全测试套件之后，再加入可选的 live 评估（按需启用、受环境变量门控）。 +- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 +- 一小组聚焦 skill 的场景（使用与避免、门控、提示词注入）。 +- 只有在 CI 安全测试套件就位后，才添加可选的实时评估（选择加入、环境变量门控）。 -## 契约测试（plugin 和 channel 形状） +## 契约测试（插件和渠道形状） -契约测试用于验证每个已注册的 plugin 和 channel 都符合其 -接口契约。它们会遍历所有已发现的插件，并运行一组关于形状和行为的断言。默认的 `pnpm test` unit 通道会有意 -跳过这些共享接缝和冒烟文件；当你修改共享 channel 或 provider 表面时， -请显式运行这些契约命令。 +契约测试用于验证每个已注册的插件和渠道都符合其 +接口契约。它们会遍历所有已发现的插件，并运行一组 +关于形状和行为的断言。默认的 `pnpm test` 单元测试通道会有意 +跳过这些共享接缝和冒烟测试文件；当你修改共享渠道或提供商表面时， +请显式运行契约命令。 ### 命令 - 所有契约测试：`pnpm test:contracts` -- 仅渠道契约测试：`pnpm test:contracts:channels` -- 仅提供商契约测试：`pnpm test:contracts:plugins` +- 仅渠道契约：`pnpm test:contracts:channels` +- 仅提供商契约：`pnpm test:contracts:plugins` -### 渠道契约测试 +### 渠道契约 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基本插件形状（id、名称、能力） -- **setup** - 向导设置契约 +- **plugin** - 基本插件形状（id、name、capabilities） +- **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 - **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 -- **actions** - 渠道 action handler +- **actions** - 渠道操作处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录/成员清单 API +- **directory** - 目录 / roster API - **group-policy** - 群组策略执行 -### 提供商状态契约测试 +### 提供商状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探针 - **registry** - 插件注册表形状 -### 提供商契约测试 +### 提供商契约 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选项/选择 +- **auth-choice** - 认证选择 / 选取 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 - **runtime** - 提供商运行时 -- **shape** - 插件形状/接口 +- **shape** - 插件形状 / 接口 - **wizard** - 设置向导 ### 何时运行 -- 修改 plugin-sdk 导出或子路径之后 -- 添加或修改 channel 或 provider 插件之后 -- 重构插件注册或发现逻辑之后 +- 修改插件 SDK 导出或子路径后 +- 添加或修改渠道或提供商插件后 +- 重构插件注册或发现逻辑后 契约测试会在 CI 中运行，不需要真实 API 密钥。 -## 添加回归测试（指南） +## 添加回归测试（指导） -当你修复一个在 live 中发现的 provider/model 问题时： +当你修复一个在实时测试中发现的提供商 / 模型问题时： -- 如果可能，添加一个具备 CI 安全性的回归测试（mock/stub provider，或捕获精确的请求形状转换） -- 如果它天然只能在 live 中复现（速率限制、认证策略），就让 live 测试保持狭窄范围，并通过环境变量按需启用 -- 优先定位到能捕获该缺陷的最小层级： - - provider 请求转换/回放缺陷 → direct models 测试 - - gateway 会话/历史/工具流水线缺陷 → gateway live 冒烟测试或具备 CI 安全性的 gateway mock 测试 -- SecretRef 遍历防护： +- 如果可能，添加一个 CI 安全的回归测试（mock / stub 提供商，或捕获精确的请求形状转换） +- 如果它天生只能在实时环境中复现（限流、认证策略），请保持实时测试范围狭窄，并通过环境变量选择加入 +- 优先针对能捕获该 bug 的最小层级： + - 提供商请求转换 / 重放 bug → 直接模型测试 + - Gateway 网关 会话 / 历史 / 工具流水线 bug → Gateway 网关 实时冒烟测试或 CI 安全的 Gateway 网关 mock 测试 +- SecretRef 遍历护栏： - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历段 exec id 会被拒绝。 - - 如果你在 `src/secrets/target-registry-data.ts` 中添加了一个新的 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会在未分类的目标 id 上有意失败，这样新类别就无法被悄悄跳过。 + - 如果你在 `src/secrets/target-registry-data.ts` 中新增一个 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会在目标 id 未分类时故意失败，因此新类别不能被悄悄跳过。 diff --git a/docs/zh-CN/platforms/linux.md b/docs/zh-CN/platforms/linux.md index 3f129391c..406d76b88 100644 --- a/docs/zh-CN/platforms/linux.md +++ b/docs/zh-CN/platforms/linux.md @@ -1,47 +1,48 @@ --- read_when: - - 查找 Linux 配套应用状态时 - - 规划平台覆盖范围或贡献时 + - 寻找 Linux 配套应用状态 + - 规划平台覆盖范围或贡献 + - 在 VPS 或容器上调试 Linux OOM 被杀或退出码 137 summary: Linux 支持 + 配套应用状态 title: Linux 应用 x-i18n: - generated_at: "2026-04-05T08:37:25Z" + generated_at: "2026-04-23T04:54:32Z" model: gpt-5.4 provider: openai - source_hash: 5dbfc89eb65e04347479fc6c9a025edec902fb0c544fb8d5bd09c24558ea03b1 + source_hash: c56151406517a1259e66626b8f4b48c16917b10580e7626463afd8a68dc286f7 source_path: platforms/linux.md workflow: 15 --- # Linux 应用 -Gateway 网关 在 Linux 上已获得完整支持。**Node 是推荐的运行时**。 -不建议对 Gateway 网关 使用 Bun（存在 WhatsApp/Telegram 相关问题）。 +Gateway 网关在 Linux 上得到完全支持。**推荐使用 Node 作为运行时**。 +不建议 Gateway 网关使用 Bun（存在 WhatsApp/Telegram 相关 bug）。 -原生 Linux 配套应用已在计划中。如果你想帮助构建一个，欢迎贡献。 +原生 Linux 配套应用已在规划中。如果你想帮助构建一个，欢迎贡献。 -## 面向新手的快速路径（VPS） +## 面向初学者的快速路径（VPS） -1. 安装 Node 24（推荐；Node 22 LTS，目前为 `22.14+`，出于兼容性考虑仍然可用） +1. 安装 Node 24（推荐；Node 22 LTS，目前 `22.14+`，出于兼容性仍然可用） 2. `npm i -g openclaw@latest` 3. `openclaw onboard --install-daemon` 4. 在你的笔记本电脑上运行：`ssh -N -L 18789:127.0.0.1:18789 @` -5. 打开 `http://127.0.0.1:18789/`，并使用已配置的共享密钥进行认证（默认是 token；如果你设置了 `gateway.auth.mode: "password"`，则使用密码） +5. 打开 `http://127.0.0.1:18789/`，并使用已配置的共享密钥进行认证（默认是 token；如果你设置了 `gateway.auth.mode: "password"`，则使用 password） -完整的 Linux 服务器指南：[Linux Server](/vps)。分步 VPS 示例：[exe.dev](/install/exe-dev) +完整的 Linux 服务器指南：[Linux 服务器](/zh-CN/vps)。VPS 分步示例：[exe.dev](/zh-CN/install/exe-dev) ## 安装 -- [入门指南](/start/getting-started) -- [安装与更新](/install/updating) -- 可选流程：[Bun（实验性）](/install/bun)、[Nix](/install/nix)、[Docker](/install/docker) +- [入门指南](/zh-CN/start/getting-started) +- [安装与更新](/zh-CN/install/updating) +- 可选流程：[Bun（实验性）](/zh-CN/install/bun)、[Nix](/zh-CN/install/nix)、[Docker](/zh-CN/install/docker) ## Gateway 网关 -- [Gateway 网关 运行手册](/gateway) -- [Configuration](/gateway/configuration) +- [Gateway 网关运行手册](/zh-CN/gateway) +- [配置](/zh-CN/gateway/configuration) -## Gateway 网关 服务安装（CLI） +## Gateway 网关服务安装（CLI） 使用以下任一方式： @@ -61,7 +62,7 @@ openclaw gateway install openclaw configure ``` -在提示时选择 **Gateway service**。 +在提示时选择 **Gateway 网关服务**。 修复/迁移： @@ -71,9 +72,7 @@ openclaw doctor ## 系统控制（systemd 用户单元） -默认情况下，OpenClaw 会安装 systemd **用户**服务。对于共享或始终开启的服务器，请使用 **系统**服务。`openclaw gateway install` 和 -`openclaw onboard --install-daemon` 已经会为你渲染当前的规范单元文件；只有在你需要自定义 system/service-manager -设置时，才需要手动编写。完整的服务说明位于 [Gateway 网关 运行手册](/gateway)。 +默认情况下，OpenClaw 会安装一个 systemd **用户**服务。对于共享服务器或始终在线的服务器，请使用 **系统**服务。`openclaw gateway install` 和 `openclaw onboard --install-daemon` 已经会为你生成当前规范的单元文件；只有在你需要自定义系统/服务管理器设置时，才需要手动编写。完整的服务说明见 [Gateway 网关运行手册](/zh-CN/gateway)。 最小配置： @@ -103,3 +102,29 @@ WantedBy=default.target ``` systemctl --user enable --now openclaw-gateway[-].service ``` + +## 内存压力与 OOM 被杀 + +在 Linux 上，当主机、虚拟机或容器的 cgroup 内存耗尽时，内核会选择一个 OOM 受害者。Gateway 网关可能是一个不理想的受害者，因为它持有长期存在的会话和渠道连接。因此，OpenClaw 会尽可能优先让短暂的子进程在 Gateway 网关之前被杀死。 + +对于符合条件的 Linux 子进程创建，OpenClaw 会通过一个简短的 `/bin/sh` 包装器启动子进程，该包装器会将子进程自身的 `oom_score_adj` 提高到 `1000`，然后通过 `exec` 执行真实命令。这是一个无需特权的操作，因为子进程只是在提高其自身被 OOM 杀死的概率。 + +覆盖的子进程入口包括： + +- 由 supervisor 管理的命令子进程， +- PTY shell 子进程， +- MCP stdio 服务器子进程， +- 由 OpenClaw 启动的浏览器/Chrome 进程。 + +该包装器仅适用于 Linux；如果 `/bin/sh` 不可用，则会跳过。 +如果子进程环境变量设置了 `OPENCLAW_CHILD_OOM_SCORE_ADJ=0`、`false`、`no` 或 `off`，也会跳过。 + +要验证某个子进程： + +```bash +cat /proc//oom_score_adj +``` + +对于受覆盖的子进程，预期值为 `1000`。Gateway 网关进程应保持其正常分值，通常为 `0`。 + +这不能替代常规的内存调优。如果 VPS 或容器反复杀死子进程，请提高内存限制、降低并发，或增加更强的资源控制，例如 systemd 的 `MemoryMax=` 或容器级内存限制。 diff --git a/docs/zh-CN/vps.md b/docs/zh-CN/vps.md index 044364043..ecc8c358a 100644 --- a/docs/zh-CN/vps.md +++ b/docs/zh-CN/vps.md @@ -1,78 +1,76 @@ --- read_when: - 你想在 Linux 服务器或云 VPS 上运行 Gateway 网关 - - 你需要一份托管指南的快速导航图 - - 你想了解适用于 OpenClaw 的通用 Linux 服务器调优】【。 + - 你需要一份托管指南的快速导览 + - 你想要适用于 OpenClaw 的通用 Linux 服务器调优指南 sidebarTitle: Linux Server -summary: 在 Linux 服务器或云 VPS 上运行 OpenClaw —— 提供商选择器、架构与调优 +summary: 在 Linux 服务器或云 VPS 上运行 OpenClaw —— 提供商选择器、架构和调优 title: Linux 服务器 x-i18n: - generated_at: "2026-04-13T13:14:20Z" + generated_at: "2026-04-23T04:54:32Z" model: gpt-5.4 provider: openai - source_hash: e623f4c770132e01628d66bfb8cd273bbef6dad633b812496c90da5e3e0f1383 + source_hash: 759428cf20204207a5505a73c880aa776ddd0eabf969fc0dcf444fc8ce6991b2 source_path: vps.md workflow: 15 --- # Linux 服务器 -在任何 Linux 服务器或云 VPS 上运行 OpenClaw Gateway 网关。本页可帮助你 -选择提供商，说明云部署如何工作，并介绍适用于各种环境的通用 Linux -调优方法。 +在任何 Linux 服务器或云 VPS 上运行 OpenClaw Gateway 网关。本页可帮助你选择提供商，解释云部署的工作方式，并介绍适用于各类环境的通用 Linux 调优方法。 ## 选择提供商 - 一键式浏览器安装 - 一键式浏览器安装 + 一键式浏览器设置 + 一键式浏览器设置 简单的付费 VPS - 永久免费 ARM 套餐 + 永久免费 ARM 层级 Fly Machines - 在 Hetzner VPS 上使用 Docker - 支持一键安装的 VPS + 在 Hetzner VPS 上运行 Docker + 带一键设置的 VPS Compute Engine - Linux 虚拟机 - 带 HTTPS 代理的虚拟机 + Linux VM + 带 HTTPS 代理的 VM ARM 自托管 -**AWS（EC2 / Lightsail / 免费套餐）** 也非常适合。 -社区视频演示可见 +**AWS（EC2 / Lightsail / 免费层级）** 也运行良好。 +社区视频演示可在 [x.com/techfrenAJ/status/2014934471095812547](https://x.com/techfrenAJ/status/2014934471095812547) -（社区资源——未来可能失效）。 +查看（社区资源——可能会失效）。 -## 云端部署的工作方式 +## 云部署如何工作 - **Gateway 网关运行在 VPS 上**，并负责状态和工作区。 -- 你可通过 **Control UI** 或 **Tailscale/SSH** 从笔记本电脑或手机连接。 -- 将 VPS 视为唯一真实来源，并定期**备份**状态和工作区。 -- 默认安全做法：将 Gateway 网关绑定在 loopback 上，并通过 SSH 隧道或 Tailscale Serve 访问。 - 如果你绑定到 `lan` 或 `tailnet`，请务必启用 `gateway.auth.token` 或 `gateway.auth.password`。 +- 你可以通过 **Control UI** 或 **Tailscale/SSH** 从笔记本电脑或手机连接。 +- 将 VPS 视为事实来源，并定期**备份**状态和工作区。 +- 安全默认做法：将 Gateway 网关保持在 loopback 上，并通过 SSH 隧道或 Tailscale Serve 访问它。 + 如果你绑定到 `lan` 或 `tailnet`，请启用 `gateway.auth.token` 或 `gateway.auth.password`。 -相关页面：[Gateway 远程访问](/zh-CN/gateway/remote)、[平台总览](/zh-CN/platforms)。 +相关页面：[Gateway 网关远程访问](/zh-CN/gateway/remote)、[平台中心](/zh-CN/platforms)。 -## 在 VPS 上为公司团队共享一个智能体 +## VPS 上的共享公司智能体 -当所有用户都处于同一信任边界内，且该智能体仅用于业务场景时，为团队运行单个智能体是一种可行的方案。 +当所有用户都处于同一信任边界内，且该智能体仅用于业务场景时，在团队中运行单个智能体是一种可行的设置。 -- 将它放在专用运行环境中（VPS/VM/容器 + 专用 OS 用户/账号）。 -- 不要让该运行环境登录个人 Apple/Google 账号，或个人浏览器/密码管理器配置。 -- 如果用户彼此之间存在对抗风险，请按 Gateway 网关/主机/OS 用户进行隔离。 +- 将其放在专用运行环境中（VPS/VM/容器 + 专用 OS 用户/账户）。 +- 不要让该运行环境登录个人 Apple/Google 账户，或个人浏览器/密码管理器配置。 +- 如果用户彼此之间存在对抗风险，请按 gateway/主机/OS 用户进行拆分。 -安全模型详情请参阅：[安全](/zh-CN/gateway/security)。 +安全模型详情参见：[Security](/zh-CN/gateway/security)。 -## 在 VPS 中配合节点使用 +## 在 VPS 中使用节点 你可以将 Gateway 网关保留在云端，并在本地设备上配对**节点** -（Mac/iOS/Android/无头设备）。节点可提供本地屏幕/摄像头/canvas 和 `system.run` -能力，而 Gateway 网关仍保留在云端。 +（Mac/iOS/Android/无头环境）。节点提供本地屏幕/摄像头/canvas 和 `system.run` +能力，而 Gateway 网关则保留在云端。 -文档：[节点](/zh-CN/nodes)、[节点 CLI](/cli/nodes)。 +文档：[节点](/zh-CN/nodes)、[Nodes CLI](/cli/nodes)。 -## 面向小型 VM 和 ARM 主机的启动调优 +## 小型 VM 和 ARM 主机的启动调优 -如果在低性能 VM（或 ARM 主机）上 CLI 命令感觉较慢，可启用 Node 的模块编译缓存： +如果在低性能 VM（或 ARM 主机）上 CLI 命令感觉较慢，可以启用 Node 的模块编译缓存： ```bash grep -q 'NODE_COMPILE_CACHE=/var/tmp/openclaw-compile-cache' ~/.bashrc || cat >> ~/.bashrc <<'EOF' @@ -85,21 +83,21 @@ source ~/.bashrc - `NODE_COMPILE_CACHE` 可提升重复执行命令时的启动速度。 - `OPENCLAW_NO_RESPAWN=1` 可避免自重启路径带来的额外启动开销。 -- 首次执行命令会预热缓存；后续执行会更快。 -- 关于 Raspberry Pi 的具体说明，请参阅 [Raspberry Pi](/zh-CN/install/raspberry-pi)。 +- 第一次运行命令会预热缓存；后续运行会更快。 +- 有关 Raspberry Pi 的具体说明，请参见 [Raspberry Pi](/zh-CN/install/raspberry-pi)。 ### `systemd` 调优清单（可选） -对于使用 `systemd` 的 VM 主机，可考虑： +对于使用 `systemd` 的 VM 主机，可以考虑： -- 为服务添加环境变量，以获得更稳定的启动路径： +- 为服务添加环境变量，以获得稳定的启动路径： - `OPENCLAW_NO_RESPAWN=1` - `NODE_COMPILE_CACHE=/var/tmp/openclaw-compile-cache` -- 明确设置重启行为： +- 保持重启行为明确： - `Restart=always` - `RestartSec=2` - `TimeoutStartSec=90` -- 状态/缓存路径尽量使用 SSD 支持的磁盘，以减少随机 I/O 冷启动带来的性能损失。 +- 优先使用基于 SSD 的磁盘来存放状态/缓存路径，以减少随机 I/O 冷启动带来的性能损失。 对于标准的 `openclaw onboard --install-daemon` 路径，请编辑用户单元： @@ -116,9 +114,12 @@ RestartSec=2 TimeoutStartSec=90 ``` -如果你是有意安装为系统单元，请改为通过 +如果你是有意安装了系统单元，请改用 `sudo systemctl edit openclaw-gateway.service` 编辑 `openclaw-gateway.service`。 -关于 `Restart=` 策略如何帮助自动恢复，请参阅： -[systemd 可自动执行服务恢复](https://www.redhat.com/en/blog/systemd-automate-recovery)。 +关于 `Restart=` 策略如何帮助自动恢复： +[systemd 可以自动执行服务恢复](https://www.redhat.com/en/blog/systemd-automate-recovery)。 + +关于 Linux OOM 行为、子进程受害者选择以及 `exit 137` +诊断，请参见 [Linux 内存压力和 OOM 终止](/zh-CN/platforms/linux#memory-pressure-and-oom-kills)。