From b3edea4d908c5eba2c3e1a653affcc787def5bce Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Fri, 24 Apr 2026 01:54:59 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/concepts/qa-e2e-automation.md | 147 ++-- docs/zh-CN/help/testing.md | 868 +++++++++++------------ 2 files changed, 503 insertions(+), 512 deletions(-) diff --git a/docs/zh-CN/concepts/qa-e2e-automation.md b/docs/zh-CN/concepts/qa-e2e-automation.md index 33252fa4f..74e1ddf24 100644 --- a/docs/zh-CN/concepts/qa-e2e-automation.md +++ b/docs/zh-CN/concepts/qa-e2e-automation.md @@ -1,31 +1,31 @@ --- read_when: - 扩展 qa-lab 或 qa-channel - - 添加基于仓库的 QA 场景 + - 添加仓库支持的 QA 场景 - 围绕 Gateway 网关仪表板构建更高真实性的 QA 自动化 -summary: 用于 qa-lab、qa-channel、种子场景和协议报告的私有 QA 自动化形态 -title: QA E2E 自动化 +summary: qa-lab、qa-channel、种子场景和协议报告的私有 QA 自动化形态 +title: QA 端到端自动化 x-i18n: - generated_at: "2026-04-23T22:57:06Z" + generated_at: "2026-04-24T01:50:42Z" model: gpt-5.4 provider: openai - source_hash: 8cf607af9e85c1f6908049da2b31a1c6c9eaa1fc95bc3af2136babb1a3b9b48f + source_hash: f6924a05faebdd22ac5222db6b9579b57d9c7f3dfac71df6c5f2ee7d2bf0a5f8 source_path: concepts/qa-e2e-automation.md workflow: 15 --- -私有 QA 堆栈旨在以比单个单元测试更贴近真实渠道形态的方式演练 OpenClaw。 +私有 QA 栈的目标，是以比单个单元测试更贴近真实、更加符合渠道形态的方式来演练 OpenClaw。 当前组成部分： -- `extensions/qa-channel`：合成消息渠道，具有私信、渠道、线程、reaction、编辑和删除界面。 -- `extensions/qa-lab`：调试器 UI 和 QA 总线，用于观察记录、注入入站消息以及导出 Markdown 报告。 -- `qa/`：用于启动任务和基线 QA 场景的仓库支撑种子资源。 +- `extensions/qa-channel`：合成消息渠道，具备私信、渠道、线程、表情反应、编辑和删除等交互面。 +- `extensions/qa-lab`：调试器 UI 和 QA 总线，用于观察对话记录、注入入站消息，并导出 Markdown 报告。 +- `qa/`：由仓库支持的种子资源，用于启动任务和基线 QA 场景。 -当前 QA 操作流是一个双窗格 QA 站点： +当前 QA 操作流程是一个双栏 QA 站点： - 左侧：带有智能体的 Gateway 网关仪表板（Control UI）。 -- 右侧：QA Lab，显示类 Slack 的记录和场景计划。 +- 右侧：QA Lab，显示类似 Slack 的对话记录和场景计划。 使用以下命令运行： @@ -33,9 +33,9 @@ x-i18n: pnpm qa:lab:up ``` -该命令会构建 QA 站点，启动基于 Docker 的 Gateway 网关通道，并暴露 QA Lab 页面。在该页面中，操作员或自动化循环可以向智能体下达 QA 任务、观察真实渠道行为，并记录哪些内容成功、失败或仍被阻塞。 +该命令会构建 QA 站点、启动基于 Docker 的 Gateway 网关通道，并暴露 QA Lab 页面，供操作员或自动化循环向智能体下达 QA 任务、观察真实渠道行为，并记录哪些有效、哪些失败、哪些仍然受阻。 -如果希望更快地迭代 QA Lab UI，而不必每次都重建 Docker 镜像，请使用带有绑定挂载 QA Lab bundle 的方式启动堆栈： +如果你想更快地迭代 QA Lab UI，而不必每次都重建 Docker 镜像，请使用绑定挂载的 QA Lab bundle 启动该栈： ```bash pnpm openclaw qa docker-build-image @@ -44,78 +44,78 @@ pnpm qa:lab:up:fast pnpm qa:lab:watch ``` -`qa:lab:up:fast` 会让 Docker 服务继续使用预构建镜像，并将 `extensions/qa-lab/web/dist` 绑定挂载到 `qa-lab` 容器中。`qa:lab:watch` 会在变更时重建该 bundle，当 QA Lab 资源哈希发生变化时，浏览器会自动重新加载。 +`qa:lab:up:fast` 会让 Docker 服务继续使用预构建镜像，并将 `extensions/qa-lab/web/dist` 绑定挂载到 `qa-lab` 容器中。`qa:lab:watch` 会在变更时重建该 bundle，并在 QA Lab 资源哈希发生变化时让浏览器自动重新加载。 -如果要运行一个基于真实传输的 Matrix 冒烟通道，请执行： +如果要运行一个使用真实传输的 Matrix 冒烟通道，请执行： ```bash pnpm openclaw qa matrix ``` -该通道会在 Docker 中配置一个一次性的 Tuwunel homeserver，注册临时的 driver、SUT 和 observer 用户，创建一个私有房间，然后在 QA Gateway 网关子进程内运行真实的 Matrix 插件。该实时传输通道会将子配置限定在正在测试的传输范围内，因此 Matrix 运行时子配置中不会包含 `qa-channel`。它会将结构化报告工件和合并后的 stdout/stderr 日志写入所选的 Matrix QA 输出目录。若还要捕获外层 `scripts/run-node.mjs` 的构建/启动器输出，请将 `OPENCLAW_RUN_NODE_OUTPUT_LOG=` 设置为仓库内本地日志文件路径。 +该通道会在 Docker 中预配一个一次性的 Tuwunel homeserver，注册临时的驱动、SUT 和观察者用户，创建一个私有房间，然后在 QA Gateway 网关子进程中运行真实的 Matrix 插件。这个实时传输通道会将子配置限定在被测传输范围内，因此 Matrix 会在子配置中不带 `qa-channel` 运行。它会把结构化报告产物和合并后的 stdout/stderr 日志写入所选的 Matrix QA 输出目录。若要同时捕获外层 `scripts/run-node.mjs` 的构建/启动器输出，请将 `OPENCLAW_RUN_NODE_OUTPUT_LOG=` 设置为仓库内本地日志文件路径。 -如果要运行一个基于真实传输的 Telegram 冒烟通道，请执行： +如果要运行一个使用真实传输的 Telegram 冒烟通道，请执行： ```bash pnpm openclaw qa telegram ``` -该通道会针对一个真实的私有 Telegram 群组，而不是配置一次性服务器。它需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`，并且要求两个不同的机器人位于同一个私有群组中。SUT 机器人必须具有 Telegram 用户名，并且当两个机器人都在 `@BotFather` 中启用了 Bot-to-Bot Communication Mode 时，机器人到机器人的观测效果最佳。 -当任一场景失败时，该命令会以非零状态退出。如果你希望在不以失败退出码结束的情况下获取工件，请使用 `--allow-failures`。 -Telegram 报告和摘要会包含每条回复的 RTT，时间范围从 driver 消息发送请求开始，到观察到 SUT 回复为止，包含 canary。 +该通道会针对一个真实的私有 Telegram 群组，而不是预配一次性服务器。它要求设置 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`，并要求两个不同的机器人位于同一个私有群组中。SUT 机器人必须有 Telegram 用户名，并且当两个机器人都在 `@BotFather` 中启用 Bot-to-Bot Communication Mode 时，机器人之间的观察效果最佳。 +当任一场景失败时，该命令会以非零状态退出。如果你想保留产物但不希望退出码失败，请使用 `--allow-failures`。 +Telegram 报告和摘要包含每次回复的 RTT，从驱动消息发送请求开始，到观察到 SUT 回复结束，金丝雀场景也包含在内。 实时传输通道现在共享一个更小的契约，而不是各自发明自己的场景列表结构： -`qa-channel` 仍然是覆盖面更广的合成产品行为套件，不属于实时传输覆盖矩阵的一部分。 +`qa-channel` 仍然是覆盖范围广泛的合成产品行为测试套件，不属于实时传输覆盖矩阵的一部分。 -| 通道 | Canary | 提及门控 | 允许列表拦截 | 顶层回复 | 重启恢复 | 线程跟进 | 线程隔离 | Reaction 观测 | 帮助命令 | -| -------- | ------ | -------------- | --------------- | --------------- | -------------- | ---------------- | ---------------- | -------------------- | ------------ | -| Matrix | x | x | x | x | x | x | x | x | | -| Telegram | x | | | | | | | | x | +| 通道 | 金丝雀 | 提及门控 | Allowlist 拦截 | 顶层回复 | 重启恢复 | 线程跟进 | 线程隔离 | 表情反应观察 | 帮助命令 | +| ---- | ------ | -------- | -------------- | -------- | -------- | -------- | -------- | ------------ | -------- | +| Matrix | x | x | x | x | x | x | x | x | | +| Telegram | x | | | | | | | | x | -这样可以让 `qa-channel` 保持为广覆盖的产品行为套件，同时让 Matrix、Telegram 和未来的实时传输共享一个明确的传输契约检查清单。 +这使 `qa-channel` 保持为覆盖广泛产品行为的测试套件，而 Matrix、Telegram 以及未来的实时传输则共享一份明确的传输契约检查清单。 -如果你想在不将 Docker 引入 QA 路径的情况下运行一个一次性 Linux VM 通道，请执行： +如果要运行一个一次性的 Linux VM 通道，而不把 Docker 引入 QA 路径，请执行： ```bash pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline ``` -这会启动一个全新的 Multipass 来宾机，在来宾机中安装依赖、构建 OpenClaw、运行 `qa suite`，然后将常规 QA 报告和摘要复制回宿主机上的 `.artifacts/qa-e2e/...`。 -它会复用与宿主机上 `qa suite` 相同的场景选择行为。 -宿主机和 Multipass 套件运行默认都会通过隔离的 Gateway 网关 worker 并行执行多个已选场景。`qa-channel` 默认并发数为 4，并受所选场景数量上限约束。使用 `--concurrency ` 可调整 worker 数量，或使用 `--concurrency 1` 进行串行执行。 -当任一场景失败时，该命令会以非零状态退出。如果你希望在不以失败退出码结束的情况下获取工件，请使用 `--allow-failures`。 -实时运行会转发适合来宾机使用的受支持 QA auth 输入：基于环境变量的 provider 密钥、QA 实时 provider 配置路径，以及存在时的 `CODEX_HOME`。请将 `--output-dir` 保持在仓库根目录下，这样来宾机才能通过挂载的工作区写回结果。 +该命令会启动一个全新的 Multipass 来宾系统、安装依赖、在来宾系统内构建 OpenClaw、运行 `qa suite`，然后把标准 QA 报告和摘要复制回主机上的 `.artifacts/qa-e2e/...`。 +它复用了与主机上 `qa suite` 相同的场景选择行为。 +主机和 Multipass 套件运行默认都会并行执行多个已选场景，并使用隔离的 Gateway 网关工作进程。`qa-channel` 默认并发数为 4，但不会超过所选场景数量。使用 `--concurrency ` 可调节工作进程数量，或使用 `--concurrency 1` 进行串行执行。 +当任一场景失败时，该命令会以非零状态退出。如果你想保留产物但不希望退出码失败，请使用 `--allow-failures`。 +实时运行会转发那些对来宾系统来说可行的受支持 QA 凭证输入：基于环境变量的提供商密钥、QA 实时提供商配置路径，以及存在时的 `CODEX_HOME`。请将 `--output-dir` 保持在仓库根目录下，以便来宾系统能通过挂载的工作区回写内容。 -## 基于仓库的种子资源 +## 由仓库支持的种子 -种子资源位于 `qa/` 中： +种子资源位于 `qa/`： - `qa/scenarios/index.md` - `qa/scenarios//*.md` 这些内容有意保存在 git 中，以便 QA 计划对人类和智能体都可见。 -`qa-lab` 应保持为通用的 Markdown 运行器。每个场景 Markdown 文件都是一次测试运行的事实来源，并应定义： +`qa-lab` 应保持为一个通用的 Markdown 运行器。每个场景 Markdown 文件都是一次测试运行的事实来源，并应定义： - 场景元数据 -- 可选的 category、capability、lane 和 risk 元数据 +- 可选的类别、能力、通道和风险元数据 - 文档和代码引用 - 可选的插件要求 - 可选的 Gateway 网关配置补丁 - 可执行的 `qa-flow` -支撑 `qa-flow` 的可复用运行时界面可以保持通用和跨领域。例如，Markdown 场景可以将传输侧辅助工具与浏览器侧辅助工具组合起来，通过 Gateway 网关 `browser.request` 接缝驱动嵌入式 Control UI，而无需增加特殊用途运行器。 +支撑 `qa-flow` 的可复用运行时能力面可以保持通用且跨领域。例如，Markdown 场景可以将传输侧辅助工具与浏览器侧辅助工具结合起来，通过 Gateway 网关 `browser.request` 接缝驱动嵌入式 Control UI，而无需添加特例运行器。 -场景文件应按产品能力而不是源代码树目录进行分组。文件移动时请保持场景 ID 稳定；使用 `docsRefs` 和 `codeRefs` 实现实现层面的可追溯性。 +场景文件应按产品能力而非源码树目录来分组。即使文件移动，也要保持场景 ID 稳定；使用 `docsRefs` 和 `codeRefs` 来提供实现可追踪性。 -基线列表应保持足够宽广，以覆盖： +基线列表应保持足够广泛，以覆盖： - 私信和渠道聊天 - 线程行为 -- 消息操作生命周期 +- 消息动作生命周期 - cron 回调 -- 记忆回溯 +- 记忆召回 - 模型切换 - 子智能体交接 - 读取仓库和读取文档 @@ -123,42 +123,42 @@ pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline ## 提供商 mock 通道 -`qa suite` 有两个本地 provider mock 通道： +`qa suite` 有两个本地提供商 mock 通道： -- `mock-openai` 是面向场景的 OpenClaw mock。它仍然是基于仓库 QA 和一致性关卡的默认确定性 mock 通道。 -- `aimock` 会启动一个由 AIMock 支撑的 provider 服务器，用于实验性协议、夹具、录制/回放和混沌测试覆盖。它是增量补充，不替代 `mock-openai` 场景分发器。 +- `mock-openai` 是具备场景感知能力的 OpenClaw mock。它仍然是用于仓库支持 QA 和一致性门禁的默认确定性 mock 通道。 +- `aimock` 会启动一个基于 AIMock 的提供商服务器，用于实验性的协议、夹具、录制/回放和混沌覆盖。它是补充性的，不会替代 `mock-openai` 场景分发器。 -provider 通道实现位于 `extensions/qa-lab/src/providers/` 下。每个 provider 自行管理其默认值、本地服务器启动、Gateway 网关模型配置、auth-profile 暂存需求以及 live/mock 能力标志。共享套件和 Gateway 网关代码应通过 provider 注册表进行路由，而不是基于 provider 名称分支。 +提供商通道实现位于 `extensions/qa-lab/src/providers/` 下。每个提供商都负责其默认值、本地服务器启动、Gateway 网关模型配置、auth-profile 暂存需求，以及实时/mock 能力标志。共享的套件和 Gateway 网关代码应通过提供商注册表进行路由，而不是根据提供商名称做分支。 ## 传输适配器 -`qa-lab` 拥有一个用于 Markdown QA 场景的通用传输接缝。 -`qa-channel` 是该接缝上的第一个适配器，但设计目标更广：未来的真实或合成渠道应接入同一个套件运行器，而不是新增一个传输专用 QA 运行器。 +`qa-lab` 拥有一个用于 Markdown QA 场景的通用传输接缝。 +`qa-channel` 是该接缝上的第一个适配器，但设计目标更广：未来的真实或合成渠道应接入同一个 suite 运行器，而不是增加一个特定于传输的 QA 运行器。 -在架构层面，拆分如下： +在架构层面，划分如下： -- `qa-lab` 负责通用场景执行、worker 并发、工件写入和报告。 -- 传输适配器负责 Gateway 网关配置、就绪状态、入站和出站观测、传输操作以及标准化传输状态。 -- `qa/scenarios/` 下的 Markdown 场景文件定义测试运行；`qa-lab` 提供执行这些场景的可复用运行时界面。 +- `qa-lab` 负责通用场景执行、工作进程并发、产物写入和报告。 +- 传输适配器负责 Gateway 网关配置、就绪检测、入站和出站观察、传输动作以及标准化的传输状态。 +- `qa/scenarios/` 下的 Markdown 场景文件定义测试运行；`qa-lab` 提供执行它们的可复用运行时能力面。 -面向维护者的新渠道适配器接入指南位于 -[Testing](/zh-CN/help/testing#adding-a-channel-to-qa)。 +面向维护者的新渠道适配器采用指南位于 +[测试](/zh-CN/help/testing#adding-a-channel-to-qa)。 ## 报告 -`qa-lab` 会根据观察到的总线时间线导出 Markdown 协议报告。 +`qa-lab` 会根据观察到的总线时间线导出 Markdown 协议报告。 报告应回答： -- 哪些内容成功了 -- 哪些内容失败了 -- 哪些内容仍被阻塞 +- 哪些有效 +- 哪些失败 +- 哪些仍然受阻 - 值得补充哪些后续场景 -对于角色与风格检查，可以让同一场景在多个实时模型引用上运行，并写出一份经过评判的 Markdown 报告： +对于角色和风格检查，请在多个实时模型引用上运行同一场景，并写出一份经评审的 Markdown 报告： ```bash pnpm openclaw qa character-eval \ - --model openai-codex/gpt-5.5,thinking=xhigh \ + --model openai/gpt-5.4,thinking=medium,fast \ --model openai/gpt-5.2,thinking=xhigh \ --model openai/gpt-5,thinking=xhigh \ --model anthropic/claude-opus-4-6,thinking=high \ @@ -166,30 +166,25 @@ pnpm openclaw qa character-eval \ --model zai/glm-5.1,thinking=high \ --model moonshot/kimi-k2.5,thinking=high \ --model google/gemini-3.1-pro-preview,thinking=high \ - --judge-model openai-codex/gpt-5.5,thinking=xhigh,fast \ + --judge-model openai/gpt-5.4,thinking=xhigh,fast \ --judge-model anthropic/claude-opus-4-6,thinking=high \ --blind-judge-models \ --concurrency 16 \ --judge-concurrency 16 ``` -该命令运行的是本地 QA Gateway 网关子进程，而不是 Docker。角色评测场景应通过 `SOUL.md` 设置人格，然后运行普通用户轮次，例如聊天、工作区帮助和小型文件任务。不应告知候选模型自己正在被评估。该命令会保留每份完整记录，记录基本运行统计信息，然后以 fast 模式和 `xhigh` 推理要求评审模型根据自然度、氛围和幽默感对运行结果进行排序。 -在比较不同 provider 时，请使用 `--blind-judge-models`：评审提示仍会获得每份记录和运行状态，但候选引用会被替换为类似 `candidate-01` 的中性标签；报告会在解析后将排名映射回真实引用。 -候选运行默认使用 `high` thinking，而支持该能力的 OpenAI 模型默认使用 `xhigh`。可通过 `--model provider/model,thinking=` 内联覆盖某个特定候选。`--thinking ` 仍可设置全局后备值，而旧版 `--model-thinking ` 形式也会保留以保持兼容性。 -OpenAI 候选引用默认使用 fast 模式，以便在 provider 支持时使用优先处理。若单个候选或评审需要覆盖，可内联添加 `,fast`、`,no-fast` 或 `,fast=false`。仅当你希望对每个候选模型都强制启用 fast 模式时，才传入 `--fast`。 -候选和评审的持续时间都会记录在报告中用于基准分析，但评审提示会明确说明不要按速度进行排名。 -候选模型运行和评审模型运行的默认并发数均为 16。当 provider 限制或本地 Gateway 网关压力导致运行噪声过大时，可降低 `--concurrency` 或 `--judge-concurrency`。 -如果未传入候选 `--model`，角色评测默认会使用 -`openai-codex/gpt-5.5`、`openai/gpt-5.4`、`openai/gpt-5.2`、`anthropic/claude-opus-4-6`、 -`anthropic/claude-sonnet-4-6`、`zai/glm-5.1`、 -`moonshot/kimi-k2.5` 和 -`google/gemini-3.1-pro-preview`。 -如果未传入 `--judge-model`，评审默认使用 -`openai-codex/gpt-5.5,thinking=xhigh,fast` 和 -`anthropic/claude-opus-4-6,thinking=high`。 +该命令运行的是本地 QA Gateway 网关子进程，而不是 Docker。角色评估场景应通过 `SOUL.md` 设置人格，然后运行普通用户轮次，例如聊天、工作区帮助和小型文件任务。候选模型不应被告知自己正在被评估。 +该命令会保留每一份完整对话记录、记录基本运行统计信息，然后要求评审模型在快速模式下、在支持时使用 `xhigh` 推理，按自然度、氛围和幽默感对运行结果进行排序。 +在比较不同提供商时，请使用 `--blind-judge-models`：评审提示词仍会拿到每份对话记录和运行状态，但候选引用会被替换为诸如 `candidate-01` 这样的中性标签；报告会在解析后将排名映射回真实引用。 +候选运行默认使用 `high` thinking，而 GPT-5.4 使用 `medium`，支持该能力的旧版 OpenAI 评估引用使用 `xhigh`。可通过 `--model provider/model,thinking=` 为特定候选单独覆盖。`--thinking ` 仍然设置全局回退值，旧的 `--model-thinking ` 形式也会保留以兼容。 +OpenAI 候选引用默认启用 fast 模式，因此在提供商支持时会使用优先处理。若某个单独候选或评审需要覆盖，可内联添加 `,fast`、`,no-fast` 或 `,fast=false`。只有当你希望为每个候选模型都强制启用 fast 模式时，才使用 `--fast`。 +候选和评审运行时长都会记录在报告中，用于基准分析，但评审提示词会明确说明不要按速度排名。 +候选模型运行和评审模型运行默认并发数均为 16。当提供商限制或本地 Gateway 网关压力导致运行噪声过大时，请降低 `--concurrency` 或 `--judge-concurrency`。 +当未传入候选 `--model` 时，角色评估默认使用 `openai/gpt-5.4`、`openai/gpt-5.2`、`openai/gpt-5`、`anthropic/claude-opus-4-6`、`anthropic/claude-sonnet-4-6`、`zai/glm-5.1`、`moonshot/kimi-k2.5` 和 `google/gemini-3.1-pro-preview`。 +当未传入 `--judge-model` 时，评审默认使用 `openai/gpt-5.4,thinking=xhigh,fast` 和 `anthropic/claude-opus-4-6,thinking=high`。 ## 相关文档 -- [Testing](/zh-CN/help/testing) -- [QA 渠道](/zh-CN/channels/qa-channel) +- [测试](/zh-CN/help/testing) +- [QA Channel](/zh-CN/channels/qa-channel) - [仪表板](/zh-CN/web/dashboard) diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index ee0dff775..5124e3b6e 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -3,124 +3,123 @@ read_when: - 在本地或 CI 中运行测试 - 为模型 / 提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及每类测试覆盖的内容 +summary: 测试工具包：单元 / e2e / live 测试套件、Docker 运行器，以及每类测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-24T00:42:35Z" + generated_at: "2026-04-24T01:50:44Z" model: gpt-5.4 provider: openai - source_hash: bf98cc453740fefbd85fd453ec0fc2f08b3546f99aa62a4fd50c01f303314c94 + source_hash: 2598e4f03b2133dcbe6dac0a51f1d75e075e8961b00f6519003d41311936fd1d source_path: help/testing.md workflow: 15 --- -OpenClaw 有三套 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。本文档是一份“我们的测试方式”指南： +OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、live）以及一小组 Docker 运行器。本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么（以及它刻意 _不_ 覆盖什么）。 +- 每个测试套件覆盖什么内容（以及它刻意**不**覆盖什么内容）。 - 常见工作流应运行哪些命令（本地、推送前、调试）。 -- 实时测试如何发现凭证并选择模型 / 提供商。 +- live 测试如何发现凭证并选择模型 / 提供商。 - 如何为真实世界中的模型 / 提供商问题添加回归测试。 ## 快速开始 大多数情况下： -- 完整门禁（预期在推送前执行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` -- 在配置充足的机器上更快地运行本地全套测试：`pnpm test:max` -- 直接进入 Vitest 监听循环：`pnpm test:watch` -- 现在直接按文件定位也会路由扩展 / 渠道路径：`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` +- 现在直接指定文件路径也会路由扩展 / 渠道路径：`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` +- E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商 / 模型时（需要真实凭证）： +当你在调试真实的提供商 / 模型时（需要真实凭证）： -- 实时套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` -- 安静地只跑一个实时文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -- Docker 实时模型扫描：`pnpm test:docker:live-models` - - 现在每个选定模型都会运行一次文本轮次加一个小型类文件读取探针。元数据声明支持 `image` 输入的模型还会运行一次极小图像轮次。排查提供商故障时，可用 `OPENCLAW_LIVE_MODEL_FILE_PROBE=0` 或 `OPENCLAW_LIVE_MODEL_IMAGE_PROBE=0` 禁用额外探针。 - - CI 覆盖：每日的 `OpenClaw Scheduled Live And E2E Checks` 和手动触发的 `OpenClaw Release Checks` 都会调用可复用的实时 / E2E 工作流，并设置 `include_live_suites: true`，其中包含按提供商分片的独立 Docker 实时模型矩阵作业。 - - 若要在 CI 中做聚焦重跑，可触发 `OpenClaw Live And E2E Checks (Reusable)` 并设置 `include_live_suites: true` 和 `live_models_only: true`。 - - 将新的高信号提供商密钥添加到 `scripts/ci-hydrate-live-auth.sh`、`.github/workflows/openclaw-live-and-e2e-checks-reusable.yml` 以及其计划 / 发布调用方中。 -- 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`。 +- live 测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` +- 安静地只跑一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` +- Docker live 模型扫描：`pnpm test:docker:live-models` + - 现在，每个选中的模型都会运行一次文本轮次加一次小型类文件读取探测。元数据声明支持 `image` 输入的模型还会运行一个微型图像轮次。隔离提供商故障时，可用 `OPENCLAW_LIVE_MODEL_FILE_PROBE=0` 或 `OPENCLAW_LIVE_MODEL_IMAGE_PROBE=0` 禁用额外探测。 + - CI 覆盖范围：每日的 `OpenClaw Scheduled Live And E2E Checks` 和手动触发的 `OpenClaw Release Checks` 都会调用可复用的 live/E2E 工作流，并设置 `include_live_suites: true`，其中包含按提供商分片的独立 Docker live 模型矩阵作业。 + - 如需有针对性的 CI 重跑，请派发 `OpenClaw Live And E2E Checks (Reusable)`，并设置 `include_live_suites: true` 和 `live_models_only: true`。 + - 将新的高信号提供商密钥添加到 `scripts/ci-hydrate-live-auth.sh`，以及 `.github/workflows/openclaw-live-and-e2e-checks-reusable.yml` 和其 scheduled/release 调用方中。 +- 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 测试范围。 ## QA 专用运行器 当你需要 QA-lab 的真实环境时，这些命令与主测试套件并列存在： -CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上以及通过手动触发使用模拟提供商运行。`QA-Lab - All Lanes` 会在 `main` 上每晚运行，也可通过手动触发运行，其中包括模拟 parity gate、实时 Matrix 通道以及由 Convex 管理的实时 Telegram 通道，作为并行作业。`OpenClaw Release Checks` 会在发布审批前运行相同通道。 +CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上运行，也可通过手动派发以 mock 提供商运行。`QA-Lab - All Lanes` 会在 `main` 上每晚运行，也可通过手动派发运行，其中 mock parity gate、live Matrix 通道和 Convex 管理的 live Telegram 通道会作为并行作业执行。`OpenClaw Release Checks` 会在发布批准前运行同样的通道。 - `pnpm openclaw qa suite` - - 直接在主机上运行基于仓库的 QA 场景。 - - 默认会以隔离的 Gateway 网关工作进程并行运行多个选定场景。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整工作进程数量，或使用 `--concurrency 1` 采用旧的串行通道。 - - 任一场景失败时以非零状态退出。若你希望保留制品但退出码不报错，可使用 `--allow-failures`。 - - 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。 - `aimock` 会启动一个本地的 AIMock 支持的提供商服务器，用于实验性夹具和协议模拟覆盖，但不会替代具备场景感知能力的 `mock-openai` 通道。 + - 直接在宿主机上运行基于仓库的 QA 场景。 + - 默认会使用隔离的 Gateway 网关 worker 并行运行多个选中的场景。`qa-channel` 默认并发数为 4（受选中场景数量限制）。使用 `--concurrency ` 调整 worker 数量，或者使用 `--concurrency 1` 切换为旧的串行通道。 + - 任一场景失败时，以非零状态退出。如果你想保留产物但不希望退出码失败，请使用 `--allow-failures`。 + - 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。`aimock` 会启动一个本地的 AIMock 支持的提供商服务器，用于实验性的夹具和协议 mock 覆盖，而不会替代具备场景感知能力的 `mock-openai` 通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一次性 Multipass Linux VM 中运行同一套 QA 套件。 - - 保持与主机上 `qa suite` 相同的场景选择行为。 + - 在一次性的 Multipass Linux VM 内运行同样的 QA 套件。 + - 与宿主机上的 `qa suite` 保持相同的场景选择行为。 - 复用与 `qa suite` 相同的提供商 / 模型选择标志。 - - 实时运行会转发对来宾系统切实可用的受支持 QA 认证输入：基于环境变量的提供商密钥、QA 实时提供商配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保持在仓库根目录下，以便来宾通过挂载的工作区写回内容。 + - live 运行会转发适合来宾环境的受支持 QA 认证输入：基于环境变量的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 + - 输出目录必须保持在仓库根目录下，这样来宾才能通过挂载的工作区回写。 - 会将常规 QA 报告 + 摘要以及 Multipass 日志写入 `.artifacts/qa-e2e/...`。 - `pnpm qa:lab:up` - 启动基于 Docker 的 QA 站点，用于偏操作员风格的 QA 工作。 - `pnpm test:docker:npm-onboard-channel-agent` - - 从当前检出构建 npm tarball，在 Docker 中全局安装，以非交互方式完成 OpenAI API 密钥新手引导，默认配置 Telegram，验证启用插件时会按需安装运行时依赖，运行 doctor，并针对模拟的 OpenAI 端点执行一次本地智能体轮次。 + - 从当前检出构建 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 网关，然后通过编辑配置启用内置渠道 / 插件。 - - 验证设置发现流程会使未配置的插件运行时依赖保持缺失状态，首次配置好的 Gateway 网关或 doctor 运行会按需安装每个内置插件的运行时依赖，而第二次重启不会重新安装已经激活过的依赖。 - - 还会安装一个已知的较旧 npm 基线，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 会修复内置渠道运行时依赖，而无需测试框架侧的 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 实时 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/...`。 + - 针对一次性的、基于 Docker 的 Tuwunel homeserver 运行 Matrix live QA 通道。 + - 这个 QA 宿主目前仅用于仓库 / 开发环境。打包后的 OpenClaw 安装不包含 `qa-lab`，因此也不会暴露 `openclaw qa`。 + - 仓库检出会直接加载内置运行器；无需单独安装插件。 + - 预配三个临时 Matrix 用户（`driver`、`sut`、`observer`）以及一个私有房间，然后启动一个 QA gateway 子进程，使用真实 Matrix 插件作为 SUT 传输层。 + - 默认使用固定的稳定版 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 机器人令牌，针对真实私有群组运行 Telegram 实时 QA 通道。 - - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。群组 id 必须是数字型 Telegram chat id。 - - 支持 `--credential-source convex` 以使用共享凭证池。默认使用 env 模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用共享租约。 - - 任一场景失败时以非零状态退出。若你希望保留制品但退出码不报错，可使用 `--allow-failures`。 - - 需要同一私有群组中的两个不同机器人，且 SUT 机器人暴露 Telegram 用户名。 - - 为了稳定观察机器人之间的交互，请在 `@BotFather` 中为两个机器人启用 Bot-to-Bot Communication Mode，并确保 driver 机器人可以观察群组中的机器人流量。 - - 会将 Telegram QA 报告、摘要和 observed-messages 制品写入 `.artifacts/qa-e2e/...`。回复场景包含从 driver 发送请求到观察到 SUT 回复的 RTT。 + - 使用环境变量中的 driver 和 SUT bot token，针对真实私有群组运行 Telegram live QA 通道。 + - 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。群组 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 流量。 + - 会将 Telegram QA 报告、摘要和 observed-messages 产物写入 `.artifacts/qa-e2e/...`。回复场景包含从 driver 发送请求到观察到 SUT 回复之间的 RTT。 -实时传输通道共享同一份标准契约，以避免新传输方式发生漂移： +live 传输通道共享一套标准契约，因此新传输不会发生漂移： -`qa-channel` 仍然是范围广泛的合成 QA 套件，不属于实时传输覆盖矩阵的一部分。 +`qa-channel` 仍然是广泛的合成 QA 套件，不属于 live 传输覆盖矩阵的一部分。 -| 通道 | Canary | 提及门控 | 允许列表拦截 | 顶层回复 | 重启恢复 | 线程后续跟进 | 线程隔离 | 反应观察 | 帮助命令 | -| ---- | ------ | -------- | ------------ | -------- | -------- | ------------ | -------- | -------- | -------- | -| Matrix | x | x | x | x | x | x | x | x | | -| Telegram | x | | | | | | | | x | +| 通道 | 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 支持的池中获取一个独占租约，在通道运行期间为该租约发送心跳，并在关闭时释放该租约。 -参考用的 Convex 项目脚手架： +参考 Convex 项目脚手架： - `qa/convex-credential-broker/` -必需的环境变量： +必需环境变量： - `OPENCLAW_QA_CONVEX_SITE_URL`（例如 `https://your-deployment.convex.site`） -- 为所选角色提供的一个密钥： - - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` 用于 `maintainer` - - `OPENCLAW_QA_CONVEX_SECRET_CI` 用于 `ci` +- 所选角色对应的一个密钥： + - `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` 对应 `maintainer` + - `OPENCLAW_QA_CONVEX_SECRET_CI` 对应 `ci` - 凭证角色选择： - CLI：`--credential-role maintainer|ci` - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认是 `ci`，否则默认是 `maintainer`） @@ -132,13 +131,12 @@ CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上 - `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_ALLOW_INSECURE_HTTP=1` 允许在仅本地开发中使用 loopback `http://` Convex URL。 +- `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`。 +维护者管理命令（池添加 / 移除 / 列表）必须明确使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 面向维护者的 CLI 辅助命令： @@ -148,14 +146,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,62 +171,62 @@ pnpm openclaw qa credentials remove --credential-id - 请求：`{ kind?, status?, includePayload?, limit? }` - 成功：`{ status: "ok", credentials, count }` -Telegram 类型的负载结构： +Telegram 类型的 payload 结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是数字形式的 Telegram chat id 字符串。 -- `admin/add` 会为 `kind: "telegram"` 验证此结构，并拒绝格式错误的负载。 +- `groupId` 必须是 Telegram chat id 的数字字符串。 +- `admin/add` 会对 `kind: "telegram"` 的此结构进行校验，并拒绝格式不正确的 payload。 ### 向 QA 添加一个渠道 -向 markdown QA 系统添加一个渠道只需要且必须满足两件事： +将一个渠道添加到 markdown QA 系统中，**只需要且必须**做两件事： -1. 一个适用于该渠道的传输适配器。 -2. 一个用于验证该渠道契约的场景包。 +1. 为该渠道实现一个传输适配器。 +2. 编写一个用于验证该渠道契约的场景包。 -当共享的 `qa-lab` 主机可以承载该流程时，不要新增一个顶层 QA 命令根。 +当共享的 `qa-lab` 宿主能够承载整个流程时，不要添加新的顶层 QA 命令根。 -`qa-lab` 负责共享主机机制： +`qa-lab` 负责共享宿主机制： - `openclaw qa` 命令根 -- 套件启动与拆除 -- 工作进程并发 -- 制品写入 +- 套件启动与清理 +- worker 并发 +- 产物写入 - 报告生成 - 场景执行 - 对旧版 `qa-channel` 场景的兼容别名 运行器插件负责传输契约： -- `openclaw qa ` 如何挂载到共享 `qa` 根下 -- 如何为该传输配置 gateway +- `openclaw qa ` 如何挂载在共享的 `qa` 根之下 +- 如何为该传输配置 Gateway 网关 - 如何检查就绪状态 - 如何注入入站事件 - 如何观察出站消息 -- 如何暴露转录和规范化后的传输状态 +- 如何暴露转录和标准化后的传输状态 - 如何执行由传输支持的操作 - 如何处理传输特定的重置或清理 -新渠道的最低采用标准是： +新渠道的最低接入门槛是： -1. 继续让 `qa-lab` 作为共享 `qa` 根的所有者。 -2. 在共享的 `qa-lab` 主机接缝上实现该传输运行器。 +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 场景。 + 保持 `runtime-api.ts` 轻量；惰性 CLI 和运行器执行应放在独立入口点之后。 +5. 在按主题划分的 `qa/scenarios/` 目录下编写或改造 markdown 场景。 6. 为新场景使用通用场景辅助函数。 -7. 保持现有兼容别名继续可用，除非仓库正在进行有意的迁移。 +7. 除非仓库正在进行有意迁移，否则保持现有兼容别名继续可用。 决策规则是严格的： -- 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放进 `qa-lab`。 -- 如果某个行为依赖单一渠道传输，就把它保留在对应运行器插件或插件 harness 中。 -- 如果某个场景需要一个可被多个渠道使用的新能力，就添加一个通用辅助函数，而不是在 `suite.ts` 中加入渠道特定分支。 -- 如果某个行为只对一种传输有意义，就保持该场景为传输特定场景，并在场景契约中明确说明。 +- 如果某个行为能在 `qa-lab` 中统一表达一次，就把它放进 `qa-lab`。 +- 如果某个行为依赖某一个渠道传输，就把它保留在该运行器插件或插件 harness 中。 +- 如果某个场景需要超过一个渠道都能使用的新能力，请添加通用辅助函数，而不是在 `suite.ts` 中添加渠道特定分支。 +- 如果某个行为只对一种传输有意义，就让该场景保持传输特定，并在场景契约中明确说明。 -新场景优先使用的通用辅助函数名称是： +新场景推荐使用的通用辅助函数名称是： - `waitForTransportReady` - `waitForChannelReady` @@ -251,250 +249,250 @@ Telegram 类型的负载结构： - `formatConversationTranscript` - `resetBus` -新的渠道工作应使用通用辅助函数名称。 -兼容别名存在的目的是避免一次性强制迁移，而不是作为新场景编写的范式。 +新的渠道开发应使用这些通用辅助函数名称。 +兼容别名的存在是为了避免一次性迁移日，而不是作为新场景编写的范式。 -## 测试套件（各自在哪里运行） +## 测试套件（各自运行位置） 可以把这些套件理解为“真实度逐步增加”（同时不稳定性 / 成本也逐步增加）： -### 单元 / 集成（默认） +### Unit / integration（默认） - 命令：`pnpm test` -- 配置：未指定目标的运行使用 `vitest.full-*.config.ts` 分片集，并且可能会将多项目分片展开为按项目划分的配置，以便并行调度 -- 文件：位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的已列入白名单的 `ui` Node 测试 +- 配置：未指定目标的运行使用 `vitest.full-*.config.ts` 分片集合，并且可能会将多项目分片展开为按项目划分的配置，以进行并行调度 +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 - 范围： - 纯单元测试 - - 进程内集成测试（gateway 认证、路由、工具、解析、配置） - - 已知缺陷的确定性回归测试 + - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） + - 针对已知缺陷的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 - - 未指定目标的 `pnpm test` 运行的是 12 个更小的分片配置（`core-unit-fast`、`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`），而不是一个巨大的原生根项目进程。这样可以降低繁忙机器上的峰值 RSS，并避免 auto-reply / 扩展工作拖累无关套件。 - `pnpm test --watch` 仍使用原生根 `vitest.config.ts` 项目图，因为多分片 watch 循环并不现实。 - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 会优先通过按范围通道来路由显式文件 / 目录目标，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根项目启动成本。 - 当变更仅涉及可路由的源文件 / 测试文件时，`pnpm test:changed` 会将变更的 git 路径展开到相同的按范围通道；配置 / 设置编辑仍会回退到更宽泛的根项目重跑。 - `pnpm check:changed` 是窄范围工作时常规的智能本地门禁。它会将差异分类为 core、core tests、extensions、extension tests、apps、docs、发布元数据和工具，然后运行对应的 typecheck / lint / test 通道。公共 Plugin SDK 和插件契约变更会附带一次扩展验证，因为扩展依赖这些核心契约。仅发布元数据版本号变更会运行有针对性的版本 / 配置 / 根依赖检查，而不是完整套件，并带有一个保护机制，拒绝顶层版本字段之外的 package 改动。 - 来自 agents、commands、plugins、auto-reply helpers、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试会路由到 `unit-fast` 通道，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件仍保留在现有通道中。 - 部分选定的 `plugin-sdk` 和 `commands` 辅助源文件也会将 changed 模式运行映射到这些轻量通道中的显式同级测试，因此对辅助函数的编辑可以避免为该目录重跑完整的重型套件。 - `auto-reply` 有三个专用桶：顶层核心辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply harness 工作远离那些便宜的状态 / 分块 / token 测试。 + - 未指定目标的 `pnpm test` 会运行 12 个较小的分片配置（`core-unit-fast`、`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`），而不是运行一个巨大的原生根项目进程。这能降低高负载机器上的峰值 RSS，并避免 auto-reply / extension 工作拖累无关套件。 - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` 项目图，因为多分片 watch 循环并不现实。 - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 会优先通过作用域通道来路由显式文件 / 目录目标，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根项目启动的代价。 - 当差异仅触及可路由的源文件 / 测试文件时，`pnpm test:changed` 会将变更的 git 路径展开到同样的作用域通道；配置 / setup 编辑仍会回退到更宽泛的根项目重跑。 - `pnpm check:changed` 是常规的智能本地门禁，适用于小范围工作。它会将 diff 分类为 core、core tests、extensions、extension tests、apps、docs、release metadata 和 tooling，然后运行匹配的类型检查 / lint / 测试通道。公共 Plugin SDK 和插件契约变更会额外包含一次 extension 验证，因为 extensions 依赖这些 core 契约。仅涉及发布元数据的版本提升会运行有针对性的版本 / 配置 / 根依赖检查，而不是全量套件，并带有一个守卫，拒绝顶层版本字段之外的 `package` 变更。 - 来自 agents、commands、plugins、auto-reply 辅助函数、`plugin-sdk` 及类似纯工具区域的轻导入单元测试会路由到 `unit-fast` 通道，该通道会跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件仍保留在现有通道中。 - 选定的 `plugin-sdk` 和 `commands` 辅助源文件也会在 changed 模式运行时映射到这些轻量通道中的显式同级测试，因此辅助函数编辑无需为该目录重跑完整重型套件。 - `auto-reply` 有三个专用分桶：顶层 core 辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这使最重的 reply harness 工作不会落到廉价的状态 / chunk / token 测试上。 - - 当你修改消息工具发现输入或压缩运行时上下文时，保持两个层级的覆盖。 - - 为纯路由和规范化边界添加聚焦的辅助函数回归测试。 + - 当你修改消息工具发现输入或压缩运行时上下文时，要同时保留两个层级的覆盖。 + - 为纯路由和标准化边界添加聚焦的辅助函数回归测试。 - 保持嵌入式运行器集成套件健康： `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.loop.test.ts`。 - - 这些套件会验证作用域 id 和压缩行为仍会流经真实的 `run.ts` / `compact.ts` 路径；仅有辅助函数级别测试并不足以替代这些集成路径。 + - 这些套件会验证作用域 id 和压缩行为仍然经过真实的 `run.ts` / `compact.ts` 路径；仅有辅助函数测试并不足以替代这些集成路径。 - 基础 Vitest 配置默认使用 `threads`。 - - 共享 Vitest 配置固定 `isolate: false`，并在根项目、e2e 和实时配置中使用非隔离运行器。 - - 根 UI 通道保留其 `jsdom` 设置和优化器，但也在共享的非隔离运行器上运行。 + - 共享的 Vitest 配置固定为 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 + - 根 UI 通道保留其 `jsdom` setup 和 optimizer，但同样运行在共享的非隔离运行器上。 - 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 - - `scripts/run-vitest.mjs` 默认会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1` 可与默认 V8 行为做对比。 + - `scripts/run-vitest.mjs` 默认会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1` 可与 stock V8 行为进行对比。 - - `pnpm changed:lanes` 会显示某个差异触发了哪些架构通道。 - - pre-commit hook 仅负责格式化。它会重新暂存格式化后的文件，不会运行 lint、typecheck 或测试。 - - 当你需要智能本地门禁时，请在交接或推送前显式运行 `pnpm check:changed`。公共 Plugin SDK 和插件契约变更会附带一次扩展验证。 - - 当变更路径可以清晰映射到更小套件时，`pnpm test:changed` 会通过按范围通道进行路由。 - - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是提高了 worker 上限。 - - 本地 worker 自动扩缩容刻意保守，当主机负载平均值已经较高时会主动回退，因此默认情况下多个并发 Vitest 运行造成的影响会更小。 - - 基础 Vitest 配置会把项目 / 配置文件标记为 `forceRerunTriggers`，以便在测试接线发生变化时，changed 模式重跑仍保持正确。 - - 配置会在受支持主机上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你想为直接性能分析指定一个明确的缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - `pnpm changed:lanes` 会显示某个 diff 触发了哪些架构通道。 + - pre-commit hook 只负责格式化。它会重新暂存已格式化文件，但不会运行 lint、类型检查或测试。 + - 当你需要智能本地门禁时，在交接或推送前显式运行 `pnpm check:changed`。公共 Plugin SDK 和插件契约变更会包含一次 extension 验证。 + - 当变更路径能明确映射到较小套件时，`pnpm test:changed` 会通过作用域通道进行路由。 + - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是使用更高的 worker 上限。 + - 本地 worker 自动伸缩有意采取保守策略；当宿主负载平均值已经较高时会自动退让，因此默认情况下，多个并发 Vitest 运行造成的影响会更小。 + - 基础 Vitest 配置将项目 / 配置文件标记为 `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` 以来发生变更的文件。 - - 当某个热点测试仍然把大部分时间花在启动导入上时，应将重依赖隐藏在一个狭窄的本地 `*.runtime.ts` 接缝之后，并直接模拟这个接缝，而不是为了传给 `vi.mock(...)` 就深度导入运行时辅助函数。 - - `pnpm test:perf:changed:bench -- --ref ` 会针对该已提交差异，将经路由的 `test:changed` 与原生根项目路径进行比较，并输出墙钟时间以及 macOS 最大 RSS。 - - `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和根 Vitest 配置对当前脏工作树进行基准测试。 - - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动和转换开销写出主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为单元测试套件写出运行器 CPU + 堆 profile。 + - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告，以及导入拆解输出。 + - `pnpm test:perf:imports:changed` 会将同样的分析视图收窄到自 `origin/main` 以来变更的文件。 + - 当某个热点测试仍然将大部分时间花在启动导入上时，应将重型依赖放在狭窄的本地 `*.runtime.ts` 接缝之后，并直接 mock 该接缝，而不是为了传给 `vi.mock(...)` 而深度导入运行时辅助函数。 + - `pnpm test:perf:changed:bench -- --ref ` 会将路由后的 `test:changed` 与该已提交 diff 的原生根项目路径进行对比，并打印 wall time 以及 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 profile。 -### 稳定性（gateway） +### Stability（Gateway 网关） - 命令：`pnpm test:stability:gateway` -- 配置：`vitest.gateway.config.ts`，强制单 worker +- 配置：`vitest.gateway.config.ts`，强制使用一个 worker - 范围： - - 启动一个真实的 loopback Gateway 网关，并默认启用诊断 - - 通过诊断事件路径驱动合成的 gateway 消息、内存和大负载 churn + - 启动一个真实的 loopback Gateway 网关，并默认启用 diagnostics + - 通过诊断事件路径驱动合成的 gateway 消息、memory 和大 payload 抖动 - 通过 Gateway 网关 WS RPC 查询 `diagnostics.stability` - 覆盖诊断稳定性 bundle 持久化辅助函数 - - 断言记录器保持有界、合成 RSS 样本保持在压力预算之下，以及每个会话的队列深度能回落到零 + - 断言记录器保持有界、合成 RSS 样本保持在压力预算之下，并且每个会话的队列深度最终回落为零 - 预期： - - 对 CI 安全且不需要密钥 - - 是用于稳定性回归跟进的窄范围通道，不可替代完整 Gateway 网关套件 + - 对 CI 安全且无需密钥 + - 这是用于稳定性回归跟进的窄通道，而不是完整 Gateway 网关套件的替代品 -### E2E（gateway 冒烟） +### E2E（Gateway 网关冒烟） - 命令：`pnpm test:e2e` - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts`，以及 `extensions/` 下的内置插件 E2E 测试 - 运行时默认值： - - 使用 Vitest `threads` 并设置 `isolate: false`，与仓库其余部分保持一致。 + - 使用带 `isolate: false` 的 Vitest `threads`，与仓库其余部分保持一致。 - 使用自适应 worker（CI：最多 2 个，本地：默认 1 个）。 - 默认以静默模式运行，以减少控制台 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 中运行（当流水线启用时） - 不需要真实密钥 - - 比单元测试涉及更多活动部件（可能更慢） + - 比单元测试涉及更多可变因素（可能更慢） -### E2E：OpenShell 后端冒烟 +### E2E：OpenShell 后端冒烟测试 - 命令：`pnpm test:e2e:openshell` - 文件：`extensions/openshell/src/backend.e2e.test.ts` - 范围： - - 通过 Docker 在主机上启动一个隔离的 OpenShell gateway - - 从一个临时本地 Dockerfile 创建沙箱 + - 通过 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 和沙箱 + - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 Gateway 网关和沙箱 - 常用覆盖项： - - `OPENCLAW_E2E_OPENSHELL=1`，在手动运行更宽泛的 e2e 套件时启用该测试 - - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`，指向非默认 CLI 二进制文件或包装脚本 + - `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`、`test/**/*.live.test.ts`，以及 `extensions/` 下的内置插件实时测试 +- 文件：`src/**/*.live.test.ts`、`test/**/*.live.test.ts`，以及 `extensions/` 下的内置插件 live 测试 - 默认：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型 _今天_ 是否真的能用真实凭证工作？” - - 捕捉提供商格式变化、工具调用怪癖、认证问题和限流行为 + - “这个提供商 / 模型在 _今天_ 使用真实凭证时，是否真的可用？” + - 捕获提供商格式变化、工具调用怪癖、认证问题和速率限制行为 - 预期： - - 设计上不保证 CI 稳定性（真实网络、真实提供商策略、配额、故障） - - 会花钱 / 消耗限流额度 - - 优先运行缩小范围的子集，而不是“全部” -- 实时运行会读取 `~/.profile`，以获取缺失的 API 密钥。 -- 默认情况下，实时运行仍会隔离 `HOME`，并把配置 / 认证材料复制到临时测试 home 中，这样单元测试夹具就无法改动你真实的 `~/.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` 进行按实时测试的覆盖；测试在收到限流响应时会重试。 + - 按设计不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） + - 会花钱 / 消耗速率限制 + - 优先运行收窄后的子集，而不是“全部” +- live 运行会读取 `~/.profile`，以补充缺失的 API 密钥。 +- 默认情况下，live 运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，以避免单元测试夹具修改你真实的 `~/.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 运行覆盖；测试在收到速率限制响应时会重试。 - 进度 / 心跳输出： - - 实时套件现在会把进度行输出到 stderr，因此即使 Vitest 控制台捕获较安静，长时间的提供商调用也能看出仍在活跃执行。 - - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，因此在实时运行时，提供商 / gateway 进度行会立即流式输出。 - - 用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳。 - - 用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 gateway / 探针心跳。 + - live 套件现在会将进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用也能显示为正在活动。 + - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截，这样提供商 / Gateway 网关的进度行能在 live 运行期间立即流出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整 direct-model 心跳。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / probe 心跳。 -## 我应该运行哪套测试？ +## 我应该运行哪个套件？ -使用这个决策表： +使用下表决策： - 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） -- 触及 gateway 网络 / WS 协议 / 配对：增加 `pnpm test:e2e` -- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行一个缩小范围的 `pnpm test:live` +- 触及 Gateway 网关网络 / WS 协议 / 配对：额外运行 `pnpm test:e2e` +- 调试“我的 bot 挂了” / 提供商特定故障 / 工具调用：运行收窄后的 `pnpm test:live` -## 实时：Android 节点能力扫描 +## Live：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前**通告的每一个命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前声明的**每一个命令**，并断言命令契约行为。 - 范围： - - 带前提条件的手动设置（该套件不会安装 / 运行 / 配对 app）。 - - 针对所选 Android 节点逐条验证 gateway `node.invoke`。 + - 依赖预先手动设置（该套件不会安装 / 运行 / 配对应用）。 + - 针对所选 Android 节点逐命令验证 gateway `node.invoke`。 - 必需的预先设置： - - Android app 已连接并与 gateway 配对。 - - app 保持在前台。 - - 已为你期望通过的能力授予权限 / 捕获同意。 -- 可选目标覆盖： + - 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) -## 实时：模型冒烟（配置档案密钥） +## Live：模型冒烟测试（profile keys） -实时测试分为两层，以便我们隔离故障： +live 测试分为两层，以便我们隔离故障： -- “直接模型”告诉我们提供商 / 模型在给定密钥下是否至少能响应。 -- “Gateway 网关冒烟”告诉我们针对该模型，完整的 gateway + 智能体管线是否工作正常（会话、历史、工具、沙箱策略等）。 +- “Direct model” 告诉我们：使用给定密钥时，该提供商 / 模型是否至少能响应。 +- “Gateway smoke” 告诉我们：该模型的完整 gateway + 智能体流水线是否正常工作（会话、历史、工具、沙箱策略等）。 -### 第 1 层：直接模型补全（无 gateway） +### 第 1 层：Direct model completion（无 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 网关冒烟上 + - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 + - 为每个模型运行一个小型 completion（并在需要时运行有针对性的回归测试） +- 启用方式： + - `pnpm test:live`（或直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） +- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，即 modern 的别名）才会实际运行此套件；否则它会跳过，以便让 `pnpm test:live` 聚焦于 gateway 冒烟测试 - 如何选择模型： - - `OPENCLAW_LIVE_MODELS=modern` 运行现代允许列表（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_MODELS=all` 是现代允许列表的别名 - - 或者 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,openai-codex/gpt-5.5,anthropic/claude-opus-4-6,..."`（逗号分隔允许列表） - - modern / all 扫描默认有一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可进行穷尽式 modern 扫描，或设置正整数以采用更小上限。 + - `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,openai-codex/gpt-5.5,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） + - modern/all 扫描默认有一个经过策划的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可进行穷尽式 modern 扫描，或设置为正数以缩小上限。 - 如何选择提供商： - - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔允许列表） + - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔的 allowlist） - 密钥来源： - - 默认：配置档案存储和环境变量回退 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 以强制**仅使用配置档案存储** -- 这个套件存在的原因： - - 将“提供商 API 坏了 / 密钥无效”与“gateway 智能体管线坏了”分离开来 - - 容纳小而隔离的回归测试（示例：OpenAI Responses / Codex Responses 推理回放 + 工具调用流程） + - 默认：profile 存储和环境变量回退 + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**仅**使用 profile 存储 +- 为什么需要它： + - 将“提供商 API 坏了 / 密钥无效”与“gateway 智能体流水线坏了”区分开来 + - 容纳小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 推理重放 + 工具调用流程） -### 第 2 层：Gateway 网关 + 开发智能体冒烟（也就是 “@openclaw” 实际在做什么） +### 第 2 层：Gateway 网关 + dev 智能体冒烟测试（即 “@openclaw” 实际在做的事） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - 启动一个进程内 gateway - 创建 / 修补一个 `agent:dev:*` 会话（每次运行按模型覆盖） - - 遍历带密钥的模型并断言： + - 遍历有密钥的模型并断言： - “有意义的”响应（无工具） - - 一次真实工具调用成功（read 探针） - - 可选的额外工具探针（exec+read 探针） + - 真实工具调用可用（读取探测） + - 可选的额外工具探测（exec+read 探测） - OpenAI 回归路径（仅工具调用 → 后续跟进）持续可用 -- 探针细节（这样你就能快速解释故障）： - - `read` 探针：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 它并把 nonce 回显回来。 - - `exec+read` 探针：测试会要求智能体通过 `exec` 把 nonce 写入一个临时文件，然后再 `read` 回来。 - - 图像探针：测试会附加一张生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 +- 探测详情（这样你可以快速解释故障）： + - `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`） - 如何选择模型： - - 默认：现代允许列表（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） - - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是现代允许列表的别名 - - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）来缩小范围 - - modern / all gateway 扫描默认有一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可进行穷尽式 modern 扫描，或设置正整数以采用更小上限。 + - 默认：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 的别名 + - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）以收窄范围 + - modern/all gateway 扫描默认有一个经过策划的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可进行穷尽式 modern 扫描，或设置为正数以缩小上限。 - 如何选择提供商（避免“OpenRouter 全家桶”）： - - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔允许列表） -- 在这个实时测试中，工具 + 图像探针始终开启： - - `read` 探针 + `exec+read` 探针（工具压力测试） - - 当模型声明支持图像输入时，会运行图像探针 - - 流程（高层）： - - 测试生成一张带有 “CAT” + 随机代码的极小 PNG（`src/gateway/live-image-probe.ts`） + - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） +- 工具 + 图像探测在此 live 测试中始终启用： + - `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`） - - 嵌入式智能体把多模态用户消息转发给模型 - - 断言：回复包含 `cat` + 该代码（OCR 容错：允许轻微错误） + - 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 ``` -## 实时：CLI 后端冒烟（Claude、Codex、Gemini 或其他本地 CLI） +## Live：CLI 后端冒烟测试（Claude、Codex、Gemini 或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：在不触碰默认配置的情况下，使用本地 CLI 后端验证 Gateway 网关 + 智能体管线。 -- 后端特定的默认冒烟行为定义在所属扩展的 `cli-backend.ts` 中。 +- 目标：使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线，而不触碰你的默认配置。 +- 后端特定的冒烟测试默认值位于所属扩展的 `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` @@ -503,11 +501,11 @@ openclaw models list --json - `OPENCLAW_LIVE_CLI_BACKEND_MODEL="codex-cli/gpt-5.5"` - `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` 发送一个真实图像附件（路径会被注入到提示中）。 - - `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` 可强制启用）。 + - `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` 可强制启用）。 示例： @@ -532,30 +530,30 @@ pnpm test:docker:live-cli-backend:codex pnpm test:docker:live-cli-backend:gemini ``` -注意： +注意事项： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会在仓库 Docker 镜像内，以非 root 的 `node` 用户身份运行实时 CLI 后端冒烟测试。 -- 它会从所属扩展解析 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 当前会将第三方 app 使用计入额外用量计费，而不是普通订阅计划额度。 -- 实时 CLI 后端冒烟现在会为 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后是通过 gateway CLI 验证的 MCP `cron` 工具调用。 -- Claude 的默认冒烟还会把会话从 Sonnet 切换到 Opus，并验证恢复后的会话仍然记得更早的一条备注。 +- 它会以非 root 的 `node` 用户身份，在仓库 Docker 镜像内运行 live CLI 后端冒烟测试。 +- 它会从所属扩展解析 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，可通过带有 `claudeAiOauth.subscriptionType` 的 `~/.claude/.credentials.json` 或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN` 提供。它会先在 Docker 中验证直接执行 `claude -p`，然后在不保留 Anthropic API 密钥环境变量的情况下运行两次 Gateway 网关 CLI 后端轮次。由于 Claude 目前会将第三方应用使用量路由到额外用量计费，而不是普通订阅计划额度，因此这个订阅通道默认会禁用 Claude MCP / 工具和图像探测。 +- live CLI 后端冒烟测试现在对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后是通过 gateway CLI 验证的 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet 修补到 Opus，并验证恢复后的会话仍记得之前的一条备注。 -## 实时：ACP 绑定冒烟（`/acp spawn ... --bind here`） +## Live：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用实时 ACP 智能体验证真实的 ACP 会话绑定流程： +- 目标：使用 live ACP 智能体验证真实 ACP 会话绑定流程： - 发送 `/acp spawn --bind here` - 就地绑定一个合成的消息渠道会话 - - 在同一个会话上发送一次普通后续消息 - - 验证该后续消息落入已绑定 ACP 会话的转录中 + - 在同一个会话上发送一次普通的后续消息 + - 验证后续消息确实落入已绑定的 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 私信风格的会话上下文 + - 直接使用 `pnpm test:live ...` 时的 ACP 智能体：`claude` + - 合成渠道：类似 Slack 私信 的会话上下文 - ACP 后端：`acpx` - 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` @@ -565,9 +563,9 @@ 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.5` - `OPENCLAW_LIVE_ACP_BIND_PARENT_MODEL=openai/gpt-5.4` -- 注意： - - 该通道使用 gateway `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，这样测试可以附加消息渠道上下文，而无需假装进行外部投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中针对所选 ACP harness 智能体的内建智能体注册表。 +- 注意事项： + - 该通道使用 gateway `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，以便测试能够附加消息渠道上下文，而无需伪装成外部投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会对所选 ACP harness 智能体使用内置 `acpx` 插件自带的智能体注册表。 示例： @@ -591,34 +589,37 @@ pnpm test:docker:live-acp-bind:codex pnpm test:docker:live-acp-bind:gemini ``` -Docker 注意事项： +Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会按顺序针对所有受支持的实时 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 前缀，然后在缺失时安装所请求的实时 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 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 认证材料放入容器，在可写 npm 前缀中安装 `acpx`，然后在缺失时安装请求的 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 的提供商环境变量对子 harness CLI 子进程保持可见。 -## 实时：Codex app-server harness 冒烟 +## Live：Codex app-server harness 冒烟测试 - 目标：通过常规 gateway - `agent` 方法验证由插件持有的 Codex harness： - - 加载内置 `codex` 插件 + `agent` 方法验证由插件拥有的 Codex harness： + - 加载内置的 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - - 使用强制启用的 Codex harness，向 `openai/gpt-5.5` 发送第一轮 gateway 智能体请求 - - 向同一个 OpenClaw 会话发送第二轮请求，并验证 app-server 线程可以恢复 - - 通过同一条 gateway 命令路径运行 `/codex status` 和 `/codex models` - - 可选运行两个经 Guardian 审核的提权 shell 探针：一个应被批准的无害命令，以及一个应被拒绝并促使智能体回问的伪秘密上传命令 + - 在强制使用 Codex harness 的情况下，向 `openai/gpt-5.4` 发送第一个 gateway 智能体轮次 + - 向同一个 OpenClaw 会话发送第二个轮次，并验证 app-server 线程可以恢复 + - 通过同一路径运行 `/codex status` 和 `/codex models` + gateway 命令路径 + - 可选地运行两个经 Guardian 审核的升级 shell 探测：一个应被批准的无害 + 命令，以及一个应被拒绝的伪造密钥上传命令，从而让智能体回问 - 测试：`src/gateway/gateway-codex-harness.live.test.ts` - 启用：`OPENCLAW_LIVE_CODEX_HARNESS=1` -- 默认模型：`openai/gpt-5.5` -- 可选图像探针：`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 而“蒙混过关”。 +- 默认模型：`openai/gpt-5.4` +- 可选图像探测：`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 来蒙混过关。 - 认证：Codex app-server 认证来自本地 Codex 订阅登录。Docker - 冒烟在适用时也可提供 `OPENAI_API_KEY` 以支持非 Codex 探针，并可选复制 `~/.codex/auth.json` 和 `~/.codex/config.toml`。 + 冒烟测试在适用时也可以提供 `OPENAI_API_KEY` 用于非 Codex 探测， + 以及可选复制的 `~/.codex/auth.json` 和 `~/.codex/config.toml`。 本地配方： @@ -628,7 +629,7 @@ OPENCLAW_LIVE_CODEX_HARNESS=1 \ OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1 \ OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1 \ OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=1 \ - OPENCLAW_LIVE_CODEX_HARNESS_MODEL=openai/gpt-5.5 \ + OPENCLAW_LIVE_CODEX_HARNESS_MODEL=openai/gpt-5.4 \ pnpm test:live -- src/gateway/gateway-codex-harness.live.test.ts ``` @@ -639,27 +640,28 @@ source ~/.profile pnpm test:docker:live-codex-harness ``` -Docker 注意事项： +Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 -- 它会读取已挂载的 `~/.profile`，传入 `OPENAI_API_KEY`，在存在时复制 Codex CLI - 认证文件，把 `@openai/codex` 安装到可写、已挂载的 npm 前缀中，暂存源代码树，然后仅运行 Codex harness 实时测试。 -- Docker 默认启用图像、MCP / 工具和 Guardian 探针。当你需要更窄范围的调试运行时，可设置 - `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 +- 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI + 认证文件，将 `@openai/codex` 安装到可写的挂载 npm + 前缀中，准备源码树，然后仅运行 Codex harness live 测试。 +- 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`，与实时 - 测试配置一致，因此旧别名或回退到 PI 都无法掩盖 Codex harness - 回归问题。 +- Docker 还会导出 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，与 live + 测试配置保持一致，因此旧版别名或回退到 PI 都无法掩盖 Codex harness + 回归。 -### 推荐的实时配方 +### 推荐的 live 配方 -缩小范围且显式的允许列表最快、最不容易抖动： +范围窄且明确的 allowlist 最快，也最不容易出问题： -- 单模型，直接模式（无 gateway）： +- 单模型，direct（无 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` - 跨多个提供商的工具调用： @@ -669,32 +671,32 @@ Docker 注意事项： - 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 密钥）。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立认证 + 独特工具行为）。 +- `google-antigravity/...` 使用 Antigravity OAuth bridge（类似 Cloud Code Assist 的智能体端点）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的认证 + 工具行为差异）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / 配置档案认证）；这也是大多数用户提到 “Gemini” 时的含义。 - - CLI：OpenClaw 调用本地 `gemini` 二进制；它有自己的认证，并且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这也是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 调用本地 `gemini` 二进制；它有自己的认证方式，行为也可能不同（流式传输 / 工具支持 / 版本偏差）。 -## 实时：模型矩阵（我们覆盖什么） +## Live：模型矩阵（我们覆盖什么） -没有固定的“CI 模型列表”（实时测试是选择性启用的），但以下是推荐在有密钥的开发机器上定期覆盖的模型。 +没有固定的“CI 模型列表”（live 是按需启用的），但以下是在有密钥的开发机上建议定期覆盖的模型。 -### 现代冒烟集（工具调用 + 图像） +### 现代冒烟测试集（工具调用 + 图像） -这是我们期望持续保持可用的“常见模型”运行集： +这是我们期望持续可用的“常见模型”运行集： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex OAuth：`openai-codex/gpt-5.5` - Anthropic：`anthropic/claude-opus-4-6`（或 `anthropic/claude-sonnet-4-6`） -- Google（Gemini API）：`google/gemini-3.1-pro-preview` 和 `google/gemini-3-flash-preview`（避免较旧的 Gemini 2.x 模型） +- Google（Gemini API）：`google/gemini-3.1-pro-preview` 和 `google/gemini-3-flash-preview`（避免使用较旧的 Gemini 2.x 模型） - Google（Antigravity）：`google-antigravity/claude-opus-4-6-thinking` 和 `google-antigravity/gemini-3-flash` - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -运行带工具 + 图像的 Gateway 网关冒烟： +运行带工具 + 图像的 Gateway 网关冒烟测试： `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,openai-codex/gpt-5.5,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` ### 基线：工具调用（Read + 可选 Exec） @@ -707,66 +709,66 @@ Docker 注意事项： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的附加覆盖（有更好，没有也行）： +可选附加覆盖（有更好，没有也行）： - xAI：`xai/grok-4`（或最新可用版本） -- Mistral：`mistral/`…（选择一个你已启用的支持 `tools` 的模型） +- Mistral：`mistral/`…（选一个你已启用的支持工具的模型） - Cerebras：`cerebras/`…（如果你有访问权限） - LM Studio：`lmstudio/`…（本地；工具调用取决于 API 模式） -### 视觉：发送图像（附件 → 多模态消息） +### Vision：图像发送（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的视觉变体等），以覆盖图像探针。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的支持视觉的变体等），以覆盖图像探测。 ### 聚合器 / 替代 Gateway 网关 -如果你启用了相应密钥，我们也支持通过以下方式测试： +如果你启用了相应密钥，我们还支持通过以下方式进行测试： -- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选项） +- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选） - OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 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(...)` 返回的结果 + 当前可用的密钥。 -## 凭证（切勿提交） +## 凭证（绝不要提交） -实时测试发现凭证的方式与 CLI 相同。实际含义如下： +live 测试发现凭证的方式与 CLI 完全相同。实际含义是： -- 如果 CLI 可用，实时测试通常也应能找到相同密钥。 -- 如果实时测试提示“没有凭证”，就像排查 `openclaw models list` / 模型选择那样去调试。 +- 如果 CLI 可用，live 测试也应该能发现相同的密钥。 +- 如果 live 测试提示“没有凭证”，就用你调试 `openclaw models list` / 模型选择的同样方式来调试。 -- 按智能体划分的认证配置档案：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试中“profile keys”的含义） +- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中“profile keys”的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（存在时会被复制到暂存的实时 home 中，但它不是主配置档案密钥存储） -- 本地实时运行默认会把当前生效的配置、按智能体划分的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；暂存的实时 home 会跳过 `workspace/` 和 `sandboxes/`，并去除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探针就不会落到你真实主机的工作区上。 +- 旧版状态目录：`~/.openclaw/credentials/`（存在时会被复制到已准备好的 live home 中，但它不是主 profile-key 存储） +- 本地 live 运行默认会将当前活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home；已准备好的 live home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，以确保探测不会落到你真实宿主的工作区中。 -如果你想依赖环境变量密钥（例如导出在你的 `~/.profile` 中），请在运行本地测试前执行 `source ~/.profile`，或者使用下方的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 +如果你想依赖环境变量密钥（例如在你的 `~/.profile` 中导出的密钥），请在运行本地测试前执行 `source ~/.profile`，或者使用下方的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 -## Deepgram 实时测试（音频转录） +## Deepgram live（音频转录） - 测试：`extensions/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live extensions/deepgram/audio.live.test.ts` -## BytePlus（国际版） 编码计划实时测试 +## BytePlus（国际版）编码计划 live - 测试：`extensions/byteplus/live.test.ts` - 启用：`BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live extensions/byteplus/live.test.ts` - 可选模型覆盖：`BYTEPLUS_CODING_MODEL=ark-code-latest` -## ComfyUI 工作流媒体实时测试 +## ComfyUI 工作流媒体 live - 测试：`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 工作流提交、轮询、下载或插件注册后非常有用 + - 除非已配置 `models.providers.comfy.`，否则会跳过各项能力 + - 在修改 comfy 工作流提交、轮询、下载或插件注册后很有用 -## 图像生成实时测试 +## 图像生成 live - 测试：`test/image-generation.runtime.live.test.ts` - 命令：`pnpm test:live test/image-generation.runtime.live.test.ts` @@ -774,8 +776,8 @@ Docker 注意事项： - 范围： - 枚举每一个已注册的图像生成提供商插件 - 在探测前从你的登录 shell（`~/.profile`）中加载缺失的提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证配置档案，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / 配置档案 / 模型的提供商 + - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` @@ -789,14 +791,14 @@ Docker 注意事项： - `openrouter` - `vydra` - `xai` -- 可选缩小范围： +- 可选收窄： - `OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS="openai,google,openrouter,xai"` - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-2,google/gemini-3.1-flash-image-preview,openrouter/google/gemini-3.1-flash-image-preview,xai/grok-imagine-image"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit,openrouter:generate,xai:default-generate,xai:default-edit"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用配置档案存储认证，并忽略仅环境变量覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile 存储认证，并忽略仅环境变量的覆盖 -## 音乐生成实时测试 +## 音乐生成 live - 测试：`extensions/music-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` @@ -805,231 +807,225 @@ Docker 注意事项： - 覆盖共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - 在探测前从你的登录 shell（`~/.profile`）中加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证配置档案，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / 配置档案 / 模型的提供商 + - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 在可用时运行两种已声明的运行时模式： - - 仅提示词输入的 `generate` + - 使用仅提示词输入的 `generate` - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` - 当前共享通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：使用独立 Comfy 实时文件，不在此共享扫描中 -- 可选缩小范围： + - `comfy`：单独的 Comfy live 文件，不在本共享扫描中 +- 可选收窄： - `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` 强制使用配置档案存储认证，并忽略仅环境变量覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile 存储认证，并忽略仅环境变量的覆盖 -## 视频生成实时测试 +## 视频生成 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 提供商、每个提供商一个文生视频请求、一秒龙虾提示词，以及来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的按提供商操作上限（默认 `180000`） + - 默认使用对发布安全的冒烟测试路径：非 FAL 提供商、每个提供商一个文生视频请求、一秒钟的龙虾提示词，以及来自 `OPENCLAW_LIVE_VIDEO_GENERATION_TIMEOUT_MS` 的每提供商操作上限（默认 `180000`） - 默认跳过 FAL，因为提供商侧队列延迟可能主导发布时间；传入 `--video-providers fal` 或 `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="fal"` 可显式运行它 - 在探测前从你的登录 shell（`~/.profile`）中加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证配置档案，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用认证 / 配置档案 / 模型的提供商 - - 默认仅运行 `generate` - - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 后，还会在可用时运行已声明的转换模式： + - 默认优先使用 live / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 默认只运行 `generate` + - 设置 `OPENCLAW_LIVE_VIDEO_GENERATION_FULL_MODES=1` 可在可用时也运行已声明的转换模式： - 当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - 当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` - - 当前在共享扫描中“已声明但跳过”的 `imageToVideo` 提供商： - - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL + - 当前在共享扫描中已声明但被跳过的 `imageToVideo` 提供商： + - `vydra`，因为内置的 `veo3` 仅支持文本，而内置的 `kling` 需要远程图像 URL - 提供商特定的 Vydra 覆盖： - `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - 该文件会运行 `veo3` 文生视频，以及一个默认使用远程图像 URL 夹具的 `kling` 通道 - - 当前 `videoToVideo` 实时覆盖： + - 当前 `videoToVideo` live 覆盖： - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 - - 当前在共享扫描中“已声明但跳过”的 `videoToVideo` 提供商： - - `alibaba`、`qwen`、`xai`，因为这些路径目前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini / Veo 通道使用的是基于本地 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享通道缺少组织特定的视频修补 / remix 访问保证 -- 可选缩小范围： + - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： + - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL + - `google`，因为当前共享的 Gemini/Veo 通道使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享通道无法保证组织特定的视频 inpaint/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` 强制使用配置档案存储认证，并忽略仅环境变量覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制使用 profile 存储认证，并忽略仅环境变量的覆盖 -## 媒体实时 Harness +## 媒体 live harness - 命令：`pnpm test:live:media` - 目的： - - 通过一个仓库原生入口点运行共享的图像、音乐和视频实时套件 + - 通过一个仓库原生入口运行共享的图像、音乐和视频 live 套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个套件缩小到当前拥有可用认证的提供商 - - 复用 `scripts/test-live.mjs`，因此心跳和静默模式行为保持一致 + - 默认自动将每个套件收窄到当前拥有可用认证的提供商 + - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 - 示例： - `pnpm test:live:media` - `pnpm test:live:media image video --providers openai,google,minimax` - `pnpm test:live:media video --video-providers openai,runway --all-providers` - `pnpm test:live:media music --quiet` -## Docker 运行器（可选的“在 Linux 中可运行”检查） +## Docker 运行器（可选的“在 Linux 中可用”检查） 这些 Docker 运行器分为两类： -- 实时模型运行器：`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 扫描保持可行： +- live 模型运行器：`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-gateway` 默认设置 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=8`、 - `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000` 和 - `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你明确想要更大范围的穷尽扫描时，可覆盖这些环境变量。 -- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次实时 Docker 镜像，然后为两个实时 Docker 通道复用它。它还会通过 `test:docker:e2e-build` 构建一个共享的 `scripts/e2e/Dockerfile` 镜像，并为验证已构建应用的 E2E 容器冒烟运行器复用该镜像。 -- 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:npm-onboard-channel-agent`、`test:docker:gateway-network`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools`、`test:docker:cron-mcp-cleanup`、`test:docker:plugins`、`test:docker:plugin-update` 和 `test:docker:config-reload` 会启动一个或多个真实容器，并验证更高层级的集成路径。 + `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:e2e-build` 构建一个共享的 `scripts/e2e/Dockerfile` 镜像，并在执行已构建应用的 E2E 容器冒烟测试运行器中复用它。 +- 容器冒烟测试运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:npm-onboard-channel-agent`、`test:docker:gateway-network`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools`、`test:docker:cron-mcp-cleanup`、`test:docker:plugins`、`test:docker:plugin-update` 和 `test:docker:config-reload` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -实时模型 Docker 运行器还会只绑定挂载所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持项），然后在运行前将其复制到容器 home 中，这样外部 CLI OAuth 就能刷新令牌，而不会修改主机上的认证存储： +live 模型 Docker 运行器还只会绑定挂载所需的 CLI 认证 home（如果运行未收窄，则挂载所有受支持的 home），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就能刷新 token，同时不会修改宿主的认证存储： -- 直接模型：`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 后端冒烟：`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 网关 + 开发智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） -- Open WebUI 实时冒烟：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） +- Direct model：`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 后端冒烟测试：`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`） - 新手引导向导（TTY，完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） -- Npm tarball 新手引导 / 渠道 / 智能体冒烟：`pnpm test:docker:npm-onboard-channel-agent` 会在 Docker 中全局安装打包后的 OpenClaw tarball，通过 env-ref 新手引导配置 OpenAI，并默认配置 Telegram，验证启用插件时会按需安装其运行时依赖，运行 doctor，并执行一次模拟的 OpenAI 智能体轮次。可使用 `OPENCLAW_NPM_ONBOARD_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball，使用 `OPENCLAW_NPM_ONBOARD_HOST_BUILD=0` 跳过主机构建，或通过 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 切换渠道。 -- Bun 全局安装冒烟：`bash scripts/e2e/bun-global-install-smoke.sh` 会打包当前代码树，在隔离的 home 中通过 `bun install -g` 安装，并验证 `openclaw infer image providers --json` 返回的是内置图像提供商，而不是卡住。可使用 `OPENCLAW_BUN_GLOBAL_SMOKE_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball，使用 `OPENCLAW_BUN_GLOBAL_SMOKE_HOST_BUILD=0` 跳过主机构建，或通过 `OPENCLAW_BUN_GLOBAL_SMOKE_DIST_IMAGE=openclaw-dockerfile-smoke:local` 从已构建的 Docker 镜像复制 `dist/`。 -- 安装器 Docker 冒烟：`bash scripts/test-install-sh-docker.sh` 会在 root、update 和 direct-npm 容器之间共享同一个 npm 缓存。更新冒烟默认以 npm `latest` 作为稳定基线，然后升级到候选 tarball。非 root 安装器检查会保持独立 npm 缓存，以免 root 拥有的缓存条目掩盖用户本地安装行为。设置 `OPENCLAW_INSTALL_SMOKE_NPM_CACHE_DIR=/path/to/cache` 可在本地重跑时复用 root / update / direct-npm 缓存。 -- 安装冒烟 CI 会通过 `OPENCLAW_INSTALL_SMOKE_SKIP_NPM_GLOBAL=1` 跳过重复的 direct-npm 全局更新；若需要覆盖直接 `npm install -g`，请在本地不带该环境变量运行脚本。 +- 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` 切换渠道。 +- Bun 全局安装冒烟测试：`bash scripts/e2e/bun-global-install-smoke.sh` 会打包当前工作树，在隔离 home 中通过 `bun install -g` 安装它，并验证 `openclaw infer image providers --json` 返回的是内置图像提供商而不是卡住。可通过 `OPENCLAW_BUN_GLOBAL_SMOKE_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball，通过 `OPENCLAW_BUN_GLOBAL_SMOKE_HOST_BUILD=0` 跳过宿主构建，或通过 `OPENCLAW_BUN_GLOBAL_SMOKE_DIST_IMAGE=openclaw-dockerfile-smoke:local` 从已构建的 Docker 镜像复制 `dist/`。 +- 安装冒烟测试 Docker：`bash scripts/test-install-sh-docker.sh` 会在其 root、update 和 direct-npm 容器之间共享一个 npm 缓存。更新冒烟测试默认使用 npm `latest` 作为稳定基线，然后再升级到候选 tarball。非 root 安装器检查会保持独立的 npm 缓存，以避免 root 拥有的缓存条目掩盖用户本地安装行为。设置 `OPENCLAW_INSTALL_SMOKE_NPM_CACHE_DIR=/path/to/cache` 可在本地重跑之间复用 root / update / direct-npm 缓存。 +- Install Smoke CI 会通过 `OPENCLAW_INSTALL_SMOKE_SKIP_NPM_GLOBAL=1` 跳过重复的 direct-npm 全局更新；如果你需要覆盖直接 `npm install -g`，请在本地运行该脚本时不要设置此环境变量。 - Gateway 网关网络（两个容器，WS 认证 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） -- OpenAI Responses `web_search` 最小推理回归：`pnpm test:docker:openai-web-search-minimal`（脚本：`scripts/e2e/openai-web-search-minimal-docker.sh`）会通过 Gateway 网关运行一个模拟的 OpenAI 服务器，验证 `web_search` 会把 `reasoning.effort` 从 `minimal` 提升到 `low`，然后强制提供商 schema 拒绝，并检查原始细节是否出现在 Gateway 网关日志中。 -- MCP 渠道桥接（预置 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） -- Pi bundle MCP 工具（真实 stdio MCP 服务器 + 嵌入式 Pi 配置档案 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`） -- 插件（安装冒烟 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -- 插件更新未变化冒烟：`pnpm test:docker:plugin-update`（脚本：`scripts/e2e/plugin-update-unchanged-docker.sh`） -- 配置热重载元数据冒烟：`pnpm test:docker:config-reload`（脚本：`scripts/e2e/config-reload-source-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。 -- 在迭代时，可通过禁用无关场景来缩小内置插件运行时依赖测试范围，例如： +- OpenAI Responses `web_search` 最小推理回归测试：`pnpm test:docker:openai-web-search-minimal`（脚本：`scripts/e2e/openai-web-search-minimal-docker.sh`）会通过 Gateway 网关运行一个 mock 的 OpenAI 服务器，验证 `web_search` 会将 `reasoning.effort` 从 `minimal` 提升到 `low`，然后强制提供商 schema 拒绝，并检查原始细节是否出现在 Gateway 网关日志中。 +- MCP 渠道桥接（已预置 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） +- Pi 内置 MCP 工具（真实 stdio MCP 服务器 + 嵌入式 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`） +- 插件（安装冒烟测试 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） +- 插件更新无变更冒烟测试：`pnpm test:docker:plugin-update`（脚本：`scripts/e2e/plugin-update-unchanged-docker.sh`） +- 配置热重载元数据冒烟测试：`pnpm test:docker:config-reload`（脚本：`scripts/e2e/config-reload-source-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。 +- 在迭代时，可通过禁用无关场景来收窄内置插件运行时依赖测试，例如： `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`。 -如需手动预构建并复用共享的 built-app 镜像： +要手动预构建并复用共享的 built-app 镜像： ```bash OPENCLAW_DOCKER_E2E_IMAGE=openclaw-docker-e2e:local pnpm test:docker:e2e-build OPENCLAW_DOCKER_E2E_IMAGE=openclaw-docker-e2e:local OPENCLAW_SKIP_DOCKER_BUILD=1 pnpm test:docker:mcp-channels ``` -如设置了 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE` 之类的套件特定镜像覆盖，它们仍然优先生效。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时，脚本会在本地尚不存在时自动拉取它。QR 和安装器 Docker 测试保留各自的 Dockerfile，因为它们验证的是打包 / 安装行为，而不是共享的 built-app 运行时。 +设置后，像 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE` 这样的套件专用镜像覆盖仍然优先生效。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时，如果本地尚未存在，脚本会先拉取它。QR 和安装器 Docker 测试会保留各自独立的 Dockerfile，因为它们验证的是打包 / 安装行为，而不是共享的 built-app 运行时。 -实时模型 Docker 运行器还会将当前检出以只读方式绑定挂载，并在容器内暂存到一个临时工作目录中。这样可以保持运行时镜像精简，同时仍然针对你本地精确的源码 / 配置运行 Vitest。 -暂存步骤会跳过大型本地专用缓存和 app 构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及 app 本地 `.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` 代理发送一个真实聊天请求。 -第一次运行可能明显更慢，因为 Docker 可能需要拉取 Open WebUI 镜像，而 Open WebUI 也可能需要完成自己的冷启动设置。 -该通道需要一个可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 -成功运行会打印一小段 JSON 负载，例如 `{ "ok": true, "model": +live 模型 Docker 运行器还会将当前检出以只读方式绑定挂载，并将其准备到容器内的临时工作目录中。这样既能保持运行时镜像精简，又能让 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 覆盖时，也请一并传入 `OPENCLAW_LIVE_GATEWAY_*`。 +`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 payload，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 刻意设计为确定性测试，不需要真实的 -Telegram、Discord 或 iMessage 账号。它会启动一个预置的 Gateway -容器，再启动第二个容器来运行 `openclaw mcp serve`，然后通过真实的 stdio MCP bridge 验证路由后的会话发现、转录读取、附件元数据、实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。 -通知检查会直接检查原始 stdio MCP frame，因此该冒烟验证的是 bridge 实际发出的内容，而不仅仅是某个特定客户端 SDK 碰巧暴露出的内容。 -`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要实时模型密钥。它会构建仓库 Docker 镜像，在容器中启动一个真实的 stdio MCP 探针服务器，通过嵌入式 Pi bundle MCP 运行时实例化该服务器，执行工具，然后验证 `coding` 和 `messaging` 会保留 `bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会过滤它们。 -`test:docker:cron-mcp-cleanup` 是确定性的，不需要实时模型密钥。它会启动一个带有真实 stdio MCP 探针服务器的预置 Gateway 网关，运行一次隔离的 cron 轮次和一次 `/subagents spawn` 一次性子智能体轮次，然后验证 MCP 子进程在每次运行后都会退出。 +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要真实的 Telegram、Discord 或 iMessage 账号。它会启动一个已预置的 Gateway 网关容器，启动第二个容器以运行 `openclaw mcp serve`，然后验证经路由的会话发现、转录读取、附件元数据、live 事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 发送的 Claude 风格渠道 + 权限通知。通知检查会直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 bridge 实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露出的内容。 +`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要 live 模型密钥。它会构建仓库 Docker 镜像，在容器内启动一个真实 stdio MCP 探测服务器，通过嵌入式 Pi 内置 MCP 运行时将该服务器实体化，执行该工具，然后验证 `coding` 和 `messaging` 会保留 `bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会将其过滤掉。 +`test:docker:cron-mcp-cleanup` 是确定性的，不需要 live 模型密钥。它会启动一个带有真实 stdio MCP 探测服务器的已预置 Gateway 网关，运行一个隔离的 cron 轮次和一个 `/subagents spawn` 一次性子智能体轮次，然后验证 MCP 子进程会在每次运行后退出。 -手动 ACP 纯自然语言线程冒烟（非 CI）： +手动 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` 读取的环境变量，使用临时配置 / 工作区目录，且不挂载外部 CLI 认证 -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于 Docker 内缓存 CLI 安装 +- `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_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...` 用于缩小运行范围 + - 收窄后的提供商运行只会挂载根据 `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` 用于确保凭证来自配置档案存储（而非环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 用于为 Open WebUI 冒烟选择 gateway 暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟所使用的 nonce 检查提示词 +- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用现有 `openclaw:local-live` 镜像，以便在无需重建时重跑 +- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自 profile 存储（而不是环境变量） +- `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择 gateway 为 Open WebUI 冒烟测试暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试中使用的 nonce 检查提示词 - `OPENWEBUI_IMAGE=...` 用于覆盖固定的 Open WebUI 镜像标签 ## 文档完整性检查 -编辑文档后运行文档检查：`pnpm check:docs`。 -如果你还需要检查页内标题锚点，请运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 +修改文档后运行文档检查：`pnpm check:docs`。 +当你还需要完整的 Mintlify 锚点校验（包括页内标题检查）时，运行：`pnpm docs:check-links:anchors`。 -## 离线回归（CI 安全） +## 离线回归测试（CI 安全） -这些是不依赖真实提供商的“真实管线”回归： +这些是在没有真实提供商的情况下进行的“真实流水线”回归测试： -- Gateway 网关工具调用（模拟 OpenAI，真实 gateway + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） +- 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 + 智能体循环执行模拟工具调用（`src/gateway/gateway.test.ts`）。 -- 验证会话接线和配置影响的端到端向导流程（`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)）： -- **决策**：当提示中列出 Skills 时，智能体是否会选择正确的 skill（或避开无关项）？ -- **合规性**：智能体在使用前是否会读取 `SKILL.md`，并遵循要求的步骤 / 参数？ -- **工作流契约**：断言工具顺序、会话历史延续以及沙箱边界的多轮场景。 +- **决策**：当 Skills 在提示词中列出时，智能体是否会选择正确的 skill（或避免选择无关 skill）？ +- **合规**：智能体在使用前是否会读取 `SKILL.md`，并遵循要求的步骤 / 参数？ +- **工作流契约**：断言工具顺序、会话历史继承和沙箱边界的多轮场景。 -未来的评估应首先保持确定性： +未来的评估应优先保持确定性： -- 一个使用模拟提供商的场景运行器，用于断言工具调用及其顺序、skill 文件读取，以及会话接线。 -- 一小套聚焦 skill 的场景（使用 vs 避免、门控、提示注入）。 -- 仅在建立好对 CI 安全的套件之后，再添加可选的实时评估（选择性启用、受环境变量门控）。 +- 一个使用 mock 提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 +- 一小组聚焦 Skills 的场景（使用与避免、门禁、提示词注入）。 +- 只有在 CI 安全套件就位后，才添加可选的 live 评估（按需启用、受环境变量门禁控制）。 ## 契约测试（插件和渠道形状） -契约测试用于验证每个已注册插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一套关于形状和行为的断言。默认的 `pnpm test` 单元通道会刻意跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商接口时，请显式运行契约命令。 +契约测试用于验证每个已注册的插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一组关于形状和行为的断言。默认的 `pnpm test` 单元测试通道会刻意跳过这些共享接缝和冒烟测试文件；当你修改共享的渠道或提供商接口时，请显式运行契约测试命令。 ### 命令 -- 全部契约：`pnpm test:contracts` -- 仅渠道契约：`pnpm test:contracts:channels` -- 仅提供商契约：`pnpm test:contracts:plugins` +- 所有契约测试：`pnpm test:contracts` +- 仅渠道契约测试：`pnpm test:contracts:channels` +- 仅提供商契约测试：`pnpm test:contracts:plugins` -### 渠道契约 +### 渠道契约测试 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基础插件形状（id、名称、能力） +- **plugin** - 基本插件形状（id、名称、能力） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 -- **outbound-payload** - 消息负载结构 +- **outbound-payload** - 消息 payload 结构 - **inbound** - 入站消息处理 - **actions** - 渠道操作处理器 - **threading** - 线程 ID 处理 - **directory** - 目录 / roster API - **group-policy** - 群组策略强制执行 -### 提供商状态契约 +### 提供商状态契约测试 位于 `src/plugins/contracts/*.contract.test.ts`。 -- **status** - 渠道状态探针 +- **status** - 渠道状态探测 - **registry** - 插件注册表形状 -### 提供商契约 +### 提供商契约测试 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选择 / 选取 +- **auth-choice** - 认证选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 @@ -1043,17 +1039,17 @@ Telegram、Discord 或 iMessage 账号。它会启动一个预置的 Gateway - 添加或修改渠道或提供商插件之后 - 重构插件注册或发现逻辑之后 -契约测试会在 CI 中运行，不需要真实 API 密钥。 +契约测试会在 CI 中运行，并且不需要真实 API 密钥。 -## 添加回归测试（指南） +## 添加回归测试（指导） -当你修复一个在实时测试中发现的提供商 / 模型问题时： +当你修复在 live 中发现的提供商 / 模型问题时： -- 如果可能，添加一个对 CI 安全的回归测试（模拟 / stub 提供商，或捕获精确的请求形状转换） -- 如果它本质上只能通过实时测试发现（限流、认证策略），就让实时测试保持范围小，并通过环境变量选择性启用 -- 优先瞄准能捕捉该缺陷的最小层： - - 提供商请求转换 / 回放缺陷 → 直接模型测试 - - gateway 会话 / 历史 / 工具管线缺陷 → Gateway 网关实时冒烟或对 CI 安全的 gateway 模拟测试 -- SecretRef 遍历防护： - - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中，为每个 SecretRef 类派生一个采样目标，然后断言会拒绝 traversal-segment exec id。 - - 如果你在 `src/secrets/target-registry-data.ts` 中新增一个 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会在出现未分类目标 id 时刻意失败，以确保新类别不会被静默跳过。 +- 如果可能，添加一个对 CI 安全的回归测试（mock / stub 提供商，或捕获精确的请求形状转换） +- 如果它本质上只能通过 live 测试覆盖（速率限制、认证策略），请让 live 测试保持范围窄，并通过环境变量按需启用 +- 优先定位到能捕获该缺陷的最小层级： + - 提供商请求转换 / 重放缺陷 → direct models 测试 + - gateway 会话 / 历史 / 工具流水线缺陷 → Gateway 网关 live 冒烟测试或对 CI 安全的 gateway mock 测试 +- SecretRef 遍历防护栏： + - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言会拒绝 traversal-segment exec id。 + - 如果你在 `src/secrets/target-registry-data.ts` 中添加了新的 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会在遇到未分类目标 id 时有意失败，这样新类别就无法被静默跳过。