From bf6e174753b387c167d8f39b7df3f582823be5b7 Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Sun, 26 Apr 2026 01:05:44 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/cli/crestodian.md | 124 ++-- docs/zh-CN/help/testing.md | 597 ++++++++++--------- docs/zh-CN/reference/rich-output-protocol.md | 40 +- 3 files changed, 383 insertions(+), 378 deletions(-) diff --git a/docs/zh-CN/cli/crestodian.md b/docs/zh-CN/cli/crestodian.md index bc311528a..467b0276d 100644 --- a/docs/zh-CN/cli/crestodian.md +++ b/docs/zh-CN/cli/crestodian.md @@ -1,40 +1,40 @@ --- read_when: - - 你在不带任何命令的情况下运行 openclaw，并且想了解 Crestodian - - 你需要一种无配置且安全的方式来检查或修复 OpenClaw + - 你在不带任何命令的情况下运行 `openclaw`，并且想了解 Crestodian + - 你需要一种无需配置且安全的方式来检查或修复 OpenClaw - 你正在设计或启用消息渠道救援模式 -summary: Crestodian 的 CLI 参考与安全模型：无配置且安全的设置与修复助手 +summary: Crestodian 的 CLI 参考和安全模型，即无需配置且安全的设置与修复助手 title: Crestodian x-i18n: - generated_at: "2026-04-25T12:18:33Z" + generated_at: "2026-04-26T01:02:55Z" model: gpt-5.4 provider: openai - source_hash: ebcd6a72f78134fa572a85acc6c2f0381747a27fd6be84269c273390300bb533 + source_hash: 28a613f828d5dfd5bd83c46f822639a06573aaabd23f3085603dca718cf8489c source_path: cli/crestodian.md workflow: 15 --- # `openclaw crestodian` -Crestodian 是 OpenClaw 的本地设置、修复和配置助手。它的设计目标是在正常的智能体路径损坏时，仍然保持可访问。 +Crestodian 是 OpenClaw 的本地设置、修复和配置助手。它的设计目标是在正常的智能体路径出现故障时，仍然能够访问。 -在不带任何命令的情况下运行 `openclaw`，会以交互式终端启动 Crestodian。运行 `openclaw crestodian` 则会显式启动同一个助手。 +在不带任何命令的情况下运行 `openclaw` 会以交互式终端启动 Crestodian。运行 `openclaw crestodian` 则会显式启动同一个助手。 ## Crestodian 会显示什么 -启动时，交互式 Crestodian 会打开与 `openclaw tui` 相同的 TUI shell，但使用 Crestodian 聊天后端。聊天日志会以一段简短的问候开始： +启动时，交互式 Crestodian 会打开与 `openclaw tui` 相同的 TUI shell，但使用 Crestodian 聊天后端。聊天日志会以简短的问候开头： - 何时应启动 Crestodian -- Crestodian 实际使用的模型或确定性规划器路径 +- Crestodian 实际正在使用的模型或确定性规划器路径 - 配置有效性和默认智能体 -- 首次启动探测得到的 Gateway 网关 可达性 -- Crestodian 接下来可以执行的调试操作 +- 首次启动探测得到的 Gateway 网关可达性 +- Crestodian 可以执行的下一步调试操作 -它不会为了启动而转储密钥，也不会加载插件 CLI 命令。TUI 仍然会提供常规的页眉、聊天日志、状态行、页脚、自动补全和编辑器控件。 +它不会为了启动就转储密钥，也不会加载插件 CLI 命令。TUI 仍然提供常规的页眉、聊天日志、状态行、页脚、自动补全和编辑器控件。 -使用 `status` 可查看详细清单，其中包括配置路径、文档/源码路径、本地 CLI 探测、API 密钥是否存在、智能体、模型以及 Gateway 网关 详情。 +使用 `status` 可查看详细清单，其中包括配置路径、文档 / 源码路径、本地 CLI 探测、API 密钥是否存在、智能体、模型以及 Gateway 网关详情。 -Crestodian 使用与常规智能体相同的 OpenClaw 参考发现机制。在 Git 检出中，它会将自身指向本地 `docs/` 和本地源码树。在 npm 包安装中，它会使用随包提供的文档，并链接到 [https://github.com/openclaw/openclaw](https://github.com/openclaw/openclaw)，同时明确提示当文档不足时应查看源码。 +Crestodian 使用与常规智能体相同的 OpenClaw 参考发现机制。在 Git 检出中，它会将自己指向本地 `docs/` 和本地源码树。在 npm 包安装中，它会使用随包提供的文档，并链接到 [https://github.com/openclaw/openclaw](https://github.com/openclaw/openclaw)，同时明确提示你在文档不足时查阅源码。 ## 示例 @@ -75,43 +75,43 @@ quit ## 安全启动 -Crestodian 的启动路径经过刻意精简。它可以在以下情况下运行： +Crestodian 的启动路径被有意保持得很小。在以下情况下它仍可运行： - `openclaw.json` 缺失 - `openclaw.json` 无效 -- Gateway 网关 已停止 +- Gateway 网关已停止 - 插件命令注册不可用 -- 尚未配置任何智能体 +- 还没有配置任何智能体 -`openclaw --help` 和 `openclaw --version` 仍然使用正常的快速路径。非交互式 `openclaw` 会输出一条简短消息后退出，而不是打印根帮助，因为无命令产品形态就是 Crestodian。 +`openclaw --help` 和 `openclaw --version` 仍然走常规快速路径。非交互式的 `openclaw` 会输出一条简短消息后退出，而不是打印根帮助，因为无命令产品就是 Crestodian。 ## 操作与批准 -Crestodian 使用类型化操作，而不是临时编辑配置。 +Crestodian 使用类型化操作，而不是临时随意编辑配置。 只读操作可以立即运行： - 显示概览 - 列出智能体 -- 显示模型/后端状态 -- 运行 `status` 或健康检查 -- 检查 Gateway 网关 可达性 -- 运行 `doctor`，但不执行交互式修复 +- 显示模型 / 后端状态 +- 运行状态或健康检查 +- 检查 Gateway 网关可达性 +- 在不进行交互式修复的情况下运行 Doctor - 验证配置 - 显示审计日志路径 -持久化操作在交互模式下需要通过对话批准，除非你为直接命令传入 `--yes`： +持久化操作在交互模式下需要对话式批准，除非你为直接命令传入 `--yes`： - 写入配置 - 运行 `config set` -- 通过 `config set-ref` 设置受支持的 `SecretRef` 值 -- 运行设置/新手引导引导流程 +- 通过 `config set-ref` 设置受支持的 SecretRef 值 +- 运行设置 / 新手引导引导流程 - 更改默认模型 - 启动、停止或重启 Gateway 网关 - 创建智能体 -- 运行会重写配置或状态的 `doctor` 修复 +- 运行会重写配置或状态的 Doctor 修复 -已应用的写入会记录在： +已应用的写入会记录到： ```text ~/.openclaw/audit/crestodian.jsonl @@ -119,11 +119,11 @@ Crestodian 使用类型化操作，而不是临时编辑配置。 发现过程不会被审计。只有已应用的操作和写入会被记录。 -`openclaw onboard --modern` 会将 Crestodian 作为现代新手引导预览启动。普通的 `openclaw onboard` 仍然会运行经典新手引导。 +`openclaw onboard --modern` 会将 Crestodian 作为现代新手引导预览启动。普通的 `openclaw onboard` 仍会运行经典新手引导。 -## 设置引导 +## Setup Bootstrap -`setup` 是以聊天为先的新手引导启动流程。它只会通过类型化配置操作进行写入，并且会先请求批准。 +`setup` 是以聊天为优先的新手引导引导流程。它只会通过类型化配置操作进行写入，并且会先请求批准。 ```text setup @@ -131,31 +131,31 @@ setup workspace ~/Projects/work setup workspace ~/Projects/work model openai/gpt-5.5 ``` -当未配置模型时，`setup` 会按以下顺序选择第一个可用后端，并告诉你它选择了什么： +当未配置模型时，setup 会按以下顺序选择第一个可用后端，并告诉你它选择了什么： -- 现有的显式模型（如果已配置） +- 现有显式模型（如果已配置） - `OPENAI_API_KEY` -> `openai/gpt-5.5` - `ANTHROPIC_API_KEY` -> `anthropic/claude-opus-4-7` - Claude Code CLI -> `claude-cli/claude-opus-4-7` - Codex CLI -> `codex-cli/gpt-5.5` -如果这些都不可用，`setup` 仍然会写入默认工作区，并将模型保留为未设置。安装或登录 Codex/Claude Code，或者暴露 `OPENAI_API_KEY`/`ANTHROPIC_API_KEY`，然后再次运行 `setup`。 +如果这些都不可用，setup 仍会写入默认工作区，但保持模型未设置。安装或登录 Codex / Claude Code，或者暴露 `OPENAI_API_KEY` / `ANTHROPIC_API_KEY`，然后再次运行 setup。 ## 模型辅助规划器 -Crestodian 始终以确定性模式启动。对于确定性解析器无法理解的模糊命令，本地 Crestodian 可以通过 OpenClaw 的正常运行时路径执行一次受限的规划器回合。它会优先使用已配置的 OpenClaw 模型。如果尚无可用的已配置模型，它可以回退到机器上已经存在的本地运行时： +Crestodian 始终以确定性模式启动。对于确定性解析器无法理解的模糊命令，本地 Crestodian 可以通过 OpenClaw 的常规运行时路径执行一次受限的规划器轮次。它会先使用已配置的 OpenClaw 模型。如果尚无任何可用的已配置模型，它可以回退到机器上已经存在的本地运行时： - Claude Code CLI：`claude-cli/claude-opus-4-7` -- Codex app-server harness：`openai/gpt-5.5`，其中 `embeddedHarness.runtime: "codex"` +- Codex app-server harness：`openai/gpt-5.5`，并设置 `embeddedHarness.runtime: "codex"` - Codex CLI：`codex-cli/gpt-5.5` -模型辅助规划器不能直接修改配置。它必须先将请求转换为 Crestodian 的某个类型化命令，然后才应用常规的批准和审计规则。Crestodian 会在执行任何操作之前打印它使用的模型以及解释后的命令。无配置的回退规划器回合是临时的，在运行时支持的情况下会禁用工具，并使用临时工作区/会话。 +模型辅助规划器不能直接修改配置。它必须先将请求转换为 Crestodian 的某个类型化命令，然后再应用常规的批准和审计规则。Crestodian 会在执行任何操作之前打印它所使用的模型以及解释后的命令。无需配置的回退规划器轮次是临时的，在运行时支持时会禁用工具，并使用临时工作区 / 会话。 -消息渠道救援模式不会使用模型辅助规划器。远程救援保持确定性，这样损坏或被入侵的正常智能体路径就不能被用作配置编辑器。 +消息渠道救援模式不会使用模型辅助规划器。远程救援保持确定性，以避免损坏或受入侵的常规智能体路径被用作配置编辑器。 ## 切换到智能体 -使用自然语言选择器可离开 Crestodian 并打开正常的 TUI： +使用自然语言选择器可离开 Crestodian 并打开常规 TUI： ```text talk to agent @@ -163,26 +163,26 @@ talk to work agent switch to main agent ``` -`openclaw tui`、`openclaw chat` 和 `openclaw terminal` 仍然会直接打开正常的智能体 TUI。它们不会启动 Crestodian。 +`openclaw tui`、`openclaw chat` 和 `openclaw terminal` 仍会直接打开常规智能体 TUI。它们不会启动 Crestodian。 -切换到正常 TUI 后，使用 `/crestodian` 可返回 Crestodian。你也可以附带后续请求： +切换进入常规 TUI 后，使用 `/crestodian` 返回 Crestodian。你也可以附带后续请求： ```text /crestodian /crestodian restart gateway ``` -TUI 内的智能体切换会留下提示，说明 `/crestodian` 可用。 +TUI 内的智能体切换会留下提示，表明 `/crestodian` 可用。 ## 消息救援模式 -消息救援模式是 Crestodian 的消息渠道入口点。它用于这样的情况：你的正常智能体已失效，但像 WhatsApp 这样的受信任渠道仍然可以接收命令。 +消息救援模式是 Crestodian 的消息渠道入口点。它适用于你的常规智能体已失效，但像 WhatsApp 这样的受信任渠道仍能接收命令的情况。 支持的文本命令： - `/crestodian ` -操作流程： +操作员流程： ```text You, in a trusted owner DM: /crestodian status @@ -193,28 +193,28 @@ You: /crestodian yes OpenClaw: Applied. Audit entry written. ``` -也可以通过本地提示符或救援模式排队创建智能体： +也可以从本地提示或救援模式中将智能体创建加入队列： ```text create agent work workspace ~/Projects/work model openai/gpt-5.5 /crestodian create agent work workspace ~/Projects/work ``` -远程救援模式是一个管理面。必须将其视为远程配置修复，而不是普通聊天。 +远程救援模式是一个管理表面。必须将其视为远程配置修复，而不是普通聊天。 -远程救援的安全约定： +远程救援的安全契约： -- 当沙箱隔离处于活动状态时禁用。如果某个智能体/会话处于沙箱隔离状态，Crestodian 必须拒绝远程救援，并说明需要本地 CLI 修复。 +- 当沙箱隔离处于活动状态时禁用。如果某个智能体 / 会话处于沙箱隔离状态，Crestodian 必须拒绝远程救援，并说明需要本地 CLI 修复。 - 默认有效状态为 `auto`：仅在受信任的 YOLO 操作中允许远程救援，也就是运行时已经具有未沙箱隔离的本地权限时。 -- 要求显式的所有者身份。救援不得接受通配符发送者规则、开放群组策略、未经身份验证的 webhook 或匿名渠道。 -- 默认仅限所有者私信。群组/渠道救援需要显式启用，并且仍应将批准提示路由到所有者私信。 -- 远程救援不能打开本地 TUI，也不能切换到交互式智能体会话。智能体交接请使用本地 `openclaw`。 +- 需要显式的所有者身份。救援不得接受通配发送者规则、开放群组策略、未认证 webhook 或匿名渠道。 +- 默认仅允许所有者私信。群组 / 渠道救援需要显式选择启用。 +- 远程救援不能打开本地 TUI，也不能切换进入交互式智能体会话。智能体交接请使用本地 `openclaw`。 - 即使在救援模式下，持久化写入仍然需要批准。 -- 审计每个已应用的救援操作，包括渠道、账号、发送者、会话键、操作、变更前配置哈希以及变更后配置哈希。 -- 绝不回显密钥。`SecretRef` 检查应报告可用性，而不是值。 -- 如果 Gateway 网关 存活，优先使用 Gateway 网关 类型化操作。如果 Gateway 网关 已停止，只使用不依赖正常 Agent loop 的最小本地修复面。 +- 审计每一个已应用的救援操作。消息渠道救援会记录渠道、账号、发送者和源地址元数据。修改配置的操作还会记录变更前后的配置哈希。 +- 绝不回显密钥。SecretRef 检查应报告可用性，而不是值。 +- 如果 Gateway 网关存活，优先使用 Gateway 网关类型化操作。如果 Gateway 网关已停止，则只使用不依赖常规 Agent loop 的最小本地修复表面。 -配置形状： +配置结构： ```jsonc { @@ -230,12 +230,12 @@ create agent work workspace ~/Projects/work model openai/gpt-5.5 `enabled` 应接受： - `"auto"`：默认值。仅当有效运行时为 YOLO 且沙箱隔离关闭时允许。 -- `false`：永不允许消息渠道救援。 -- `true`：当所有者/渠道检查通过时显式允许救援。但这仍然不能绕过沙箱隔离拒绝。 +- `false`：绝不允许消息渠道救援。 +- `true`：在所有者 / 渠道检查通过时显式允许救援。但这仍不得绕过沙箱隔离拒绝。 默认的 `"auto"` YOLO 姿态为： -- 沙箱模式解析为 `off` +- sandbox 模式解析为 `off` - `tools.exec.security` 解析为 `full` - `tools.exec.ask` 解析为 `off` @@ -245,13 +245,13 @@ create agent work workspace ~/Projects/work model openai/gpt-5.5 pnpm test:docker:crestodian-rescue ``` -无配置本地规划器回退由以下内容覆盖： +无需配置的本地规划器回退由以下内容覆盖： ```bash pnpm test:docker:crestodian-planner ``` -一个选择启用的实时渠道命令面冒烟测试会检查 `/crestodian status`，以及通过救援处理器完成一轮持久化批准往返： +一个选择启用的实时渠道命令表面冒烟测试会检查 `/crestodian status` 以及通过救援处理器完成的一次持久化批准往返： ```bash pnpm test:live:crestodian-rescue-channel @@ -263,7 +263,7 @@ pnpm test:live:crestodian-rescue-channel pnpm test:docker:crestodian-first-run ``` -该 lane 从空状态目录开始，将裸 `openclaw` 路由到 Crestodian，设置默认模型，创建一个额外智能体，通过插件启用加 token `SecretRef` 配置 Discord，验证配置，并检查审计日志。QA Lab 还为相同的 Ring 0 流程提供了一个基于仓库的场景： +该 lane 从空状态目录开始，将裸 `openclaw` 路由到 Crestodian，设置默认模型，创建一个额外智能体，通过插件启用加 token SecretRef 配置 Discord，验证配置，并检查审计日志。QA Lab 也有一个以仓库为基础的场景，用于覆盖相同的 Ring 0 流程： ```bash pnpm openclaw qa suite --scenario crestodian-ring-zero-setup @@ -275,4 +275,4 @@ pnpm openclaw qa suite --scenario crestodian-ring-zero-setup - [Doctor](/zh-CN/cli/doctor) - [TUI](/zh-CN/cli/tui) - [沙箱](/zh-CN/cli/sandbox) -- [安全性](/zh-CN/cli/security) +- [安全](/zh-CN/cli/security) diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index d45d06f2d..c6454da77 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,161 +1,161 @@ --- read_when: - 在本地或 CI 中运行测试 - - 为模型 / 提供商缺陷添加回归测试 + - 为模型/提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：单元 / e2e / live 测试套件、Docker 运行器，以及每项测试所涵盖的内容 +summary: 测试工具包：unit/e2e/live 测试套件、Docker 运行器，以及每项测试所涵盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-26T00:52:32Z" + generated_at: "2026-04-26T01:02:53Z" model: gpt-5.4 provider: openai - source_hash: ef1760772a9732e6a0cd82614b20acef99d4d765f44380fecf4b53cbfca34451 + source_hash: be861c3934bb2c4b23a5f060fc07294471ce7df112ca82cb9696bba82a81d1e9 source_path: help/testing.md workflow: 15 --- -OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、live）以及一小组 Docker 运行器。本文档是“我们如何测试”的指南： +OpenClaw 有三个 Vitest 测试套件（unit/integration、e2e、live）以及少量 Docker 运行器。本文档是一份“我们的测试方式”指南： -- 每个测试套件涵盖什么内容（以及它刻意 _不_ 涵盖什么）。 +- 每个测试套件覆盖什么内容（以及它刻意**不**覆盖什么）。 - 常见工作流应运行哪些命令（本地、推送前、调试）。 -- live 测试如何发现凭证并选择模型 / 提供商。 -- 如何为真实世界中的模型 / 提供商问题添加回归测试。 +- live 测试如何发现凭证并选择模型/提供商。 +- 如何为真实世界中的模型/提供商问题添加回归测试。 ## 快速开始 -大多数情况下： +大多数时候： -- 完整门禁（预期在推送前执行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` +- 完整门禁（预期在 push 前运行）：`pnpm build && pnpm check && pnpm check:test-types && pnpm test` - 在配置充足的机器上更快地运行本地完整测试套件：`pnpm test:max` -- 直接使用 Vitest 的 watch 循环：`pnpm test:watch` -- 现在也支持直接按文件路径定向到 extension / channel 路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` -- 当你在迭代单个失败用例时，优先使用定向运行。 +- 直接使用 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` +- 基于 Linux VM 的 QA lane：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` -当你修改测试或需要更高信心时： +当你修改了测试或想要更高置信度时： - 覆盖率门禁：`pnpm test:coverage` - E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商 / 模型时（需要真实凭证）： +当你在调试真实提供商/模型时（需要真实凭证）： -- live 测试套件（模型 + Gateway 网关 工具 / 图像探测）：`pnpm test:live` +- 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` 和其 schedule / release 调用方中。 + - 每个被选中的模型现在都会运行一次文本轮次以及一次小型 file-read 风格探针。元数据声明支持 `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 调用方中。 - 原生 Codex 绑定聊天冒烟测试：`pnpm test:docker:live-codex-bind` - - 在 Codex app-server 路径上运行一个 Docker live 通道，绑定一个带 `/codex bind` 的合成 Slack 私信，会执行 `/codex fast` 和 `/codex permissions`，然后验证普通回复和图像附件是通过原生插件绑定路由，而不是通过 ACP。 -- Crestodian rescue command 冒烟测试：`pnpm test:live:crestodian-rescue-channel` - - 这是针对消息渠道 rescue command 表面的可选双保险检查。它会执行 `/crestodian status`，排队一个持久化模型更改，回复 `/crestodian yes`，并验证审计 / 配置写入路径。 + - 在 Codex app-server 路径上运行一个 Docker live lane，绑定一个合成的 Slack 私信并执行 `/codex bind`，运行 `/codex fast` 和 `/codex permissions`，然后验证普通回复和图像附件都是通过原生插件绑定而不是 ACP 路由的。 +- Crestodian rescue 命令冒烟测试：`pnpm test:live:crestodian-rescue-channel` + - 用于消息渠道 rescue 命令表面的选择性双保险检查。它会执行 `/crestodian status`，排队一个持久模型变更，回复 `/crestodian yes`，并验证审计/配置写入路径。 - Crestodian planner Docker 冒烟测试：`pnpm test:docker:crestodian-planner` - - 在一个无配置容器中运行 Crestodian，并在 `PATH` 上提供假的 Claude CLI，验证模糊规划器回退会转换为带审计记录的类型化配置写入。 + - 在没有配置的容器中运行 Crestodian，并在 `PATH` 上放置一个假的 Claude CLI，验证模糊 planner 回退会转换为经过审计的类型化配置写入。 - Crestodian 首次运行 Docker 冒烟测试：`pnpm test:docker:crestodian-first-run` - - 从空的 OpenClaw 状态目录启动，将裸 `openclaw` 路由到 Crestodian，应用 setup / model / agent / Discord 插件 + SecretRef 写入，验证配置，并核对审计条目。相同的 Ring 0 设置路径也在 QA Lab 中通过 `pnpm openclaw qa suite --scenario crestodian-ring-zero-setup` 覆盖。 -- 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`。 + - 从空的 OpenClaw 状态目录启动，将裸 `openclaw` 路由到 Crestodian，应用 setup/model/agent/Discord plugin + SecretRef 写入，验证配置，并检查审计条目。相同的 Ring 0 设置路径也在 QA Lab 中通过 `pnpm openclaw qa suite --scenario crestodian-ring-zero-setup` 覆盖。 +- 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`。 提示：当你只需要一个失败用例时，优先通过下文描述的 allowlist 环境变量来收窄 live 测试范围。 ## QA 专用运行器 -当你需要 QA Lab 级别的真实环境时，这些命令与主测试套件并列使用： +当你需要 QA-lab 级别的真实环境时，这些命令与主测试套件并列存在： -CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上运行，也可通过手动触发配合 mock 提供商运行。`QA-Lab - All Lanes` 会在 `main` 上每晚运行，也可通过手动触发并行运行 mock parity gate、live Matrix 通道以及 Convex 管理的 live Telegram 通道。`OpenClaw Release Checks` 会在发布批准前运行同样的通道。 +CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上以及通过手动分发使用 mock 提供商运行。`QA-Lab - All Lanes` 会在 `main` 上每晚运行，并可通过手动分发并行运行 mock parity gate、live Matrix lane 和由 Convex 管理的 live Telegram lane 作业。`OpenClaw Release Checks` 会在发布批准前运行相同的 lane。 - `pnpm openclaw qa suite` - 直接在主机上运行基于仓库的 QA 场景。 - - 默认会以隔离的 Gateway 网关 worker 并行运行多个选定场景。`qa-channel` 默认并发为 4（受选定场景数量限制）。使用 `--concurrency ` 可调整 worker 数量，或使用 `--concurrency 1` 回退到旧的串行通道。 - - 只要有任一场景失败，就会以非零状态退出。如果你想保留产物但不希望退出码失败，可使用 `--allow-failures`。 - - 支持的提供商模式包括 `live-frontier`、`mock-openai` 和 `aimock`。`aimock` 会启动一个本地 AIMock 支持的 provider 服务器，用于实验性的 fixture 和协议 mock 覆盖，而不替代具备场景感知能力的 `mock-openai` 通道。 + - 默认并行运行多个所选场景，并使用隔离的 Gateway 网关 worker。`qa-channel` 默认并发数为 4（受所选场景数量限制）。使用 `--concurrency ` 调整 worker 数量，或使用 `--concurrency 1` 运行旧的串行 lane。 + - 任一场景失败时以非零状态退出。当你想保留产物但不希望退出码失败时，可使用 `--allow-failures`。 + - 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。`aimock` 会启动一个本地的 AIMock 支持的提供商服务器，用于实验性 fixture 和协议 mock 覆盖，而不会替代具备场景感知能力的 `mock-openai` lane。 - `pnpm openclaw qa suite --runner multipass` - - 在一次性 Multipass Linux VM 内运行同一套 QA 测试。 - - 与主机上的 `qa suite` 保持相同的场景选择行为。 - - 复用与 `qa suite` 相同的提供商 / 模型选择标志。 - - live 运行会转发对 guest 来说实用的受支持 QA 认证输入：基于环境变量的 provider 密钥、QA live provider 配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保持在仓库根目录之下，这样 guest 才能通过挂载的工作区回写内容。 - - 会在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告、摘要以及 Multipass 日志。 + - 在一次性的 Multipass Linux VM 内运行相同的 QA 测试套件。 + - 保留与主机上 `qa suite` 相同的场景选择行为。 + - 复用与 `qa suite` 相同的提供商/模型选择标志。 + - live 运行会转发适合 guest 使用的受支持 QA 凭证输入：基于环境变量的提供商密钥、QA live 提供商配置路径，以及存在时的 `CODEX_HOME`。 + - 输出目录必须保持在仓库根目录下，以便 guest 能通过挂载的工作区回写。 + - 在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告、摘要以及 Multipass 日志。 - `pnpm qa:lab:up` - 启动基于 Docker 的 QA 站点，用于偏操作员风格的 QA 工作。 - `pnpm test:docker:npm-onboard-channel-agent` - - 从当前检出构建 npm tarball，在 Docker 中全局安装，运行非交互式 OpenAI API key 新手引导，默认配置 Telegram，验证启用插件会按需安装运行时依赖，运行 doctor，并针对模拟的 OpenAI 端点运行一次本地智能体轮次。 - - 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 可在 Discord 下运行同一条打包安装通道。 + - 从当前检出构建一个 npm tarball，在 Docker 中全局安装，运行非交互式 OpenAI API-key 新手引导，默认配置 Telegram，验证启用插件时会按需安装运行时依赖，运行 doctor，并针对一个模拟的 OpenAI 端点执行一次本地智能体轮次。 + - 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 可在 Discord 上运行相同的打包安装 lane。 - `pnpm test:docker:session-runtime-context` - - 为嵌入式运行时上下文转录运行一个确定性的已构建应用 Docker 冒烟测试。它会验证隐藏的 OpenClaw 运行时上下文被持久化为不可显示的自定义消息，而不是泄漏到可见的用户轮次中；然后植入一个受影响的损坏会话 JSONL，并验证 `openclaw doctor --fix` 会将其重写到当前分支并创建备份。 + - 运行一个确定性的基于构建应用的 Docker 冒烟测试，用于嵌入式运行时上下文 transcript。它会验证隐藏的 OpenClaw 运行时上下文会作为不可显示的自定义消息持久化，而不是泄漏到可见的用户轮次中；随后注入一个受影响的损坏 session JSONL，并验证 `openclaw doctor --fix` 会将其重写到当前活动分支，同时创建备份。 - `pnpm test:docker:npm-telegram-live` - - 在 Docker 中安装一个已发布的 OpenClaw 包，运行已安装包的新手引导，通过已安装的 CLI 配置 Telegram，然后复用 live Telegram QA 通道，并将该已安装包作为被测 Gateway 网关。 - - 默认值为 `OPENCLAW_NPM_TELEGRAM_PACKAGE_SPEC=openclaw@beta`。 - - 使用与 `pnpm openclaw qa telegram` 相同的 Telegram 环境变量凭证或 Convex 凭证来源。对于 CI / 发布自动化，设置 `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_SOURCE=convex`，并同时设置 `OPENCLAW_QA_CONVEX_SITE_URL` 和角色密钥。如果在 CI 中存在 `OPENCLAW_QA_CONVEX_SITE_URL` 和 Convex 角色密钥，Docker 包装器会自动选择 Convex。 - - `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_ROLE=ci|maintainer` 仅为该通道覆盖共享的 `OPENCLAW_QA_CREDENTIAL_ROLE`。 - - GitHub Actions 将此通道公开为手动维护者工作流 `NPM Telegram Beta E2E`。它不会在合并时运行。该工作流使用 `qa-live-shared` 环境和 Convex CI 凭证租约。 + - 在 Docker 中安装已发布的 OpenClaw 包，运行已安装包的新手引导，通过已安装的 CLI 配置 Telegram，然后复用 live Telegram QA lane，并将该已安装包作为 SUT Gateway 网关。 + - 默认使用 `OPENCLAW_NPM_TELEGRAM_PACKAGE_SPEC=openclaw@beta`。 + - 使用与 `pnpm openclaw qa telegram` 相同的 Telegram 环境变量凭证或 Convex 凭证来源。对于 CI/发布自动化，设置 `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_SOURCE=convex`，以及 `OPENCLAW_QA_CONVEX_SITE_URL` 和角色密钥。如果在 CI 中存在 `OPENCLAW_QA_CONVEX_SITE_URL` 和 Convex 角色密钥，Docker 包装器会自动选择 Convex。 + - `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_ROLE=ci|maintainer` 可仅为此 lane 覆盖共享的 `OPENCLAW_QA_CREDENTIAL_ROLE`。 + - GitHub Actions 将此 lane 暴露为手动维护者工作流 `NPM Telegram Beta E2E`。它不会在 merge 时运行。该工作流使用 `qa-live-shared` environment 和 Convex CI 凭证租约。 - `pnpm test:docker:bundled-channel-deps` - - 在 Docker 中打包并安装当前 OpenClaw 构建，在配置好 OpenAI 的情况下启动 Gateway 网关，然后通过编辑配置启用内置 channel / 插件。 - - 验证 setup discovery 会让未配置插件的运行时依赖保持缺失状态；第一次配置后的 Gateway 网关 或 doctor 运行会按需安装每个内置插件的运行时依赖；第二次重启不会重新安装已激活的依赖。 - - 还会安装一个已知的旧 npm 基线版本，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 能修复内置 channel 运行时依赖，而无需 harness 侧的 postinstall 修复。 + - 在 Docker 中打包并安装当前 OpenClaw 构建，启动已配置 OpenAI 的 Gateway 网关，然后通过配置编辑启用内置 channel/plugins。 + - 验证设置发现过程会让未配置插件的运行时依赖保持未安装状态，首次配置后的 Gateway 网关或 doctor 运行会按需安装每个内置插件的运行时依赖，并且第二次重启不会重新安装已激活的依赖。 + - 还会安装一个已知较旧的 npm 基线版本，在运行 `openclaw update --tag ` 之前启用 Telegram，并验证候选版本的更新后 doctor 会修复内置渠道运行时依赖，而不需要 harness 侧的 postinstall 修复。 - `pnpm test:parallels:npm-update` - - 在 Parallels guest 上运行原生打包安装更新冒烟测试。每个选定平台会先安装所请求的基线包，然后在同一 guest 中运行已安装的 `openclaw update` 命令，并验证已安装版本、更新状态、gateway 就绪情况以及一次本地智能体轮次。 - - 在只迭代一个 guest 时，使用 `--platform macos`、`--platform windows` 或 `--platform linux`。使用 `--json` 获取摘要产物路径和每个通道的状态。 - - 将长时间本地运行包裹在主机超时中，以避免 Parallels 传输卡顿耗尽剩余测试窗口： + - 在 Parallels guest 上运行原生打包安装更新冒烟测试。每个选定的平台都会先安装请求的基线包，然后在同一 guest 中运行已安装的 `openclaw update` 命令，并验证已安装版本、更新状态、gateway 就绪情况以及一次本地智能体轮次。 + - 在迭代单个 guest 时，使用 `--platform macos`、`--platform windows` 或 `--platform linux`。使用 `--json` 获取摘要产物路径和各 lane 状态。 + - 用主机超时包装较长的本地运行，避免 Parallels 传输卡住耗尽剩余测试窗口： ```bash timeout --foreground 150m pnpm test:parallels:npm-update -- --json timeout --foreground 90m pnpm test:parallels:npm-update -- --platform windows --json ``` - - 该脚本会将嵌套通道日志写入 `/tmp/openclaw-parallels-npm-update.*`。在认定外层包装器卡住之前，先检查 `windows-update.log`、`macos-update.log` 或 `linux-update.log`。 - - 在冷启动 guest 上，Windows 更新可能会在更新后 doctor / 运行时依赖修复阶段耗时 10 到 15 分钟；只要嵌套的 npm 调试日志仍在推进，这就是健康状态。 - - 不要将这个聚合包装器与单独的 Parallels macOS、Windows 或 Linux 冒烟通道并行运行。它们共享 VM 状态，可能会在快照恢复、包服务或 guest gateway 状态上发生冲突。 - - 更新后的验证会运行正常的内置插件表面，因为像 speech、image generation 和 media understanding 这样的能力门面，是通过内置运行时 API 加载的，即使智能体轮次本身只检查简单的文本响应。 + - 脚本会将嵌套 lane 日志写入 `/tmp/openclaw-parallels-npm-update.*`。在断定外层包装器卡住之前，先检查 `windows-update.log`、`macos-update.log` 或 `linux-update.log`。 + - 在冷 guest 上，Windows 更新可能会花费 10 到 15 分钟进行更新后 doctor/运行时依赖修复；只要嵌套的 npm 调试日志仍在推进，这仍属于健康状态。 + - 不要将这个聚合包装器与单独的 Parallels macOS、Windows 或 Linux 冒烟 lane 并行运行。它们共享 VM 状态，可能在快照恢复、包服务或 guest gateway 状态上发生冲突。 + - 更新后的证明会运行常规内置插件表面，因为即使智能体轮次本身只检查简单的文本响应，语音、图像生成和媒体理解等能力门面仍然是通过内置运行时 API 加载的。 - `pnpm openclaw qa aimock` - - 仅启动本地 AIMock provider 服务器，用于直接的协议冒烟测试。 + - 仅启动本地 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 输出日志。 - - 默认会输出进度，并通过 `OPENCLAW_QA_MATRIX_TIMEOUT_MS` 强制执行硬性运行超时（默认为 30 分钟）。清理由 `OPENCLAW_QA_MATRIX_CLEANUP_TIMEOUT_MS` 限定，失败信息中会包含恢复命令 `docker compose ... down --remove-orphans`。 + - 针对一次性的基于 Docker 的 Tuwunel homeserver 运行 Matrix live QA lane。 + - 这个 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 不暴露共享凭证来源标志，因为该 lane 会在本地预配一次性用户。 + - 在 `.artifacts/qa-e2e/...` 下写入 Matrix QA 报告、摘要、observed-events 产物以及合并后的 stdout/stderr 输出日志。 + - 默认输出进度，并通过 `OPENCLAW_QA_MATRIX_TIMEOUT_MS` 强制执行硬性运行超时（默认 30 分钟）。清理由 `OPENCLAW_QA_MATRIX_CLEANUP_TIMEOUT_MS` 限制，失败信息中会包含恢复命令 `docker compose ... down --remove-orphans`。 - `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`。群组 id 必须是 Telegram 聊天的数字 id。 - - 支持 `--credential-source convex` 以使用共享池化凭证。默认使用环境变量模式，或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以启用池化租约。 - - 只要任一场景失败，就会以非零状态退出。如果你想保留产物但不希望退出码失败，可使用 `--allow-failures`。 - - 需要两个不同的 bot 位于同一个私有群组中，并且 SUT bot 需要暴露 Telegram 用户名。 - - 为了实现稳定的 bot 对 bot 观测，请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode，并确保 driver bot 能观测群组中的 bot 流量。 - - 会在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要以及 observed-messages 产物。回复类场景会包含从 driver 发送请求到观测到 SUT 回复的 RTT。 + - 使用环境变量中的 driver 和 SUT bot token，针对真实私有群组运行 Telegram live QA lane。 + - 需要 `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 对 bot 观察，请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode，并确保 driver bot 能观察群组中的 bot 流量。 + - 在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要以及 observed-messages 产物。回复场景包含从 driver 发送请求到观察到 SUT 回复之间的 RTT。 -live 传输通道共享一套标准契约，因此新增传输方式不会发生漂移： +live 传输 lane 共享一个标准契约，以避免新传输发生漂移： -`qa-channel` 仍然是更广泛的合成 QA 套件，不属于 live 传输覆盖矩阵的一部分。 +`qa-channel` 仍然是广覆盖的合成 QA 测试套件，不属于 live 传输覆盖矩阵的一部分。 -| 通道 | Canary | Mention gating | Allowlist block | 顶层回复 | 重启恢复 | 线程跟进 | 线程隔离 | 反应观测 | 帮助命令 | -| ---- | ------ | -------------- | --------------- | -------- | -------- | -------- | -------- | -------- | -------- | -| Matrix | x | x | x | x | x | x | x | x | | -| Telegram | x | | | | | | | | x | +| Lane | Canary | Mention gating | Allowlist block | Top-level reply | Restart resume | Thread follow-up | Thread isolation | Reaction observation | Help command | +| -------- | ------ | -------------- | --------------- | --------------- | -------------- | ---------------- | ---------------- | -------------------- | ------------ | +| 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 支持的池中获取一个独占租约，在 lane 运行期间为该租约发送心跳，并在关闭时释放租约。 -参考的 Convex 项目脚手架： +参考 Convex 项目脚手架： - `qa/convex-credential-broker/` 必需的环境变量： - `OPENCLAW_QA_CONVEX_SITE_URL`（例如 `https://your-deployment.convex.site`） -- 为所选角色配置一个密钥： - - `maintainer` 使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER` - - `ci` 使用 `OPENCLAW_QA_CONVEX_SECRET_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`） + - 环境变量默认值：`OPENCLAW_QA_CREDENTIAL_ROLE`（在 CI 中默认为 `ci`，否则默认为 `maintainer`） 可选环境变量： @@ -164,14 +164,14 @@ live 传输通道共享一套标准契约，因此新增传输方式不会发生 - `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_SITE_URL` 应使用 `https://`。 -维护者管理命令（池的添加 / 删除 / 列表）必须专门使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 +维护者管理命令（池的添加/删除/列出）必须专门使用 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。 -面向维护者的 CLI 辅助命令： +供维护者使用的 CLI 辅助命令： ```bash pnpm openclaw qa credentials doctor @@ -180,14 +180,14 @@ pnpm openclaw qa credentials list --kind telegram pnpm openclaw qa credentials remove --credential-id ``` -在 live 运行前使用 `doctor` 检查 Convex 站点 URL、broker 密钥、端点前缀、HTTP 超时以及 admin / list 可达性，同时不会打印密钥值。在脚本和 CI 工具中使用 `--json` 可获得机器可读输出。 +在 live 运行之前使用 `doctor`，可检查 Convex site URL、broker 密钥、端点前缀、HTTP 超时以及管理/列出可达性，同时不打印密钥值。在脚本和 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`） @@ -205,62 +205,62 @@ pnpm openclaw qa credentials remove --credential-id - 请求：`{ kind?, status?, includePayload?, limit? }` - 成功：`{ status: "ok", credentials, count }` -Telegram 类型的负载结构： +Telegram kind 的 payload 结构： - `{ groupId: string, driverToken: string, sutToken: string }` -- `groupId` 必须是 Telegram 聊天的数字 id 字符串。 -- `admin/add` 会在 `kind: "telegram"` 时校验此结构，并拒绝格式错误的负载。 +- `groupId` 必须是 Telegram chat id 的数字字符串。 +- 对于 `kind: "telegram"`，`admin/add` 会验证此结构，并拒绝格式错误的 payload。 ### 向 QA 添加一个渠道 向 Markdown QA 系统添加一个渠道，严格来说只需要两样东西： -1. 该渠道的传输适配器。 -2. 用于验证渠道契约的场景包。 +1. 一个适用于该渠道的传输适配器。 +2. 一个用于执行渠道契约的场景包。 -如果共享的 `qa-lab` 主机可以承载该流程，不要新增顶层 QA 命令根。 +如果共享的 `qa-lab` 主机可以拥有该流程，就不要新增顶层 QA 命令根。 `qa-lab` 负责共享主机机制： - `openclaw qa` 命令根 -- 套件启动与关闭 +- 测试套件启动和拆除 - worker 并发 - 产物写入 - 报告生成 - 场景执行 -- 对旧版 `qa-channel` 场景的兼容别名 +- 旧版 `qa-channel` 场景的兼容别名 运行器插件负责传输契约： -- 如何将 `openclaw qa ` 挂载到共享 `qa` 根下 +- `openclaw qa ` 如何挂载在共享的 `qa` 根下 - 如何为该传输配置 gateway - 如何检查就绪状态 - 如何注入入站事件 -- 如何观测出站消息 -- 如何暴露转录和归一化后的传输状态 -- 如何执行基于传输的操作 +- 如何观察出站消息 +- 如何暴露 transcript 和规范化后的传输状态 +- 如何执行由传输支持的操作 - 如何处理传输特定的重置或清理 -新渠道的最低采用门槛是： +新渠道的最低接入门槛是： -1. 保持由 `qa-lab` 拥有共享 `qa` 根。 +1. 保持 `qa-lab` 作为共享 `qa` 根的所有者。 2. 在共享的 `qa-lab` 主机接缝上实现传输运行器。 3. 将传输特定机制保留在运行器插件或渠道 harness 内部。 -4. 将运行器挂载为 `openclaw qa `，而不是注册一个相互竞争的根命令。 +4. 将运行器挂载为 `openclaw qa `，而不是注册一个竞争性的根命令。 运行器插件应在 `openclaw.plugin.json` 中声明 `qaRunners`，并从 `runtime-api.ts` 导出匹配的 `qaRunnerCliRegistrations` 数组。 - 保持 `runtime-api.ts` 足够轻量；惰性 CLI 和运行器执行应放在独立入口点之后。 + 保持 `runtime-api.ts` 轻量；惰性 CLI 和运行器执行应保留在独立入口点之后。 5. 在主题化的 `qa/scenarios/` 目录下编写或改造 Markdown 场景。 -6. 为新场景使用通用场景辅助函数。 -7. 除非仓库正在进行有意迁移，否则要保持现有兼容别名继续可用。 +6. 为新场景使用通用场景辅助方法。 +7. 保持现有兼容别名继续可用，除非仓库正在进行有意的迁移。 -决策规则很严格： +决策规则非常严格： -- 如果某种行为可以在 `qa-lab` 中表达一次，就把它放进 `qa-lab`。 -- 如果某种行为依赖单一渠道传输，就把它保留在该运行器插件或插件 harness 中。 -- 如果某个场景需要一个以上渠道都可使用的新能力，就添加一个通用辅助函数，而不是在 `suite.ts` 中增加渠道特定分支。 -- 如果某种行为仅对单一传输有意义，就让场景保持传输特定，并在场景契约中明确说明。 +- 如果某个行为可以在 `qa-lab` 中统一表达一次，就把它放在 `qa-lab`。 +- 如果某个行为依赖于单一渠道传输，就将它保留在该运行器插件或插件 harness 中。 +- 如果某个场景需要一个可被多个渠道使用的新能力，应添加通用辅助方法，而不是在 `suite.ts` 中加入特定渠道分支。 +- 如果某个行为只对单一传输有意义，就保持该场景为传输特定，并在场景契约中明确说明。 -新场景推荐使用的通用辅助函数名称是： +新场景推荐使用的通用辅助方法名称是： - `waitForTransportReady` - `waitForChannelReady` @@ -275,7 +275,7 @@ Telegram 类型的负载结构： - `formatTransportTranscript` - `resetTransport` -现有场景仍然可使用兼容别名，包括： +现有场景仍可使用兼容别名，包括： - `waitForQaChannelReady` - `waitForOutboundMessage` @@ -283,218 +283,219 @@ Telegram 类型的负载结构： - `formatConversationTranscript` - `resetBus` -新的渠道工作应使用通用辅助函数名称。 +新的渠道工作应使用这些通用辅助方法名称。 兼容别名的存在是为了避免一次性迁移日，而不是作为新场景编写的范式。 -## 测试套件（各自运行位置） +## 测试套件（哪些内容在哪里运行） -可以将这些套件理解为“真实性逐步提高”（同时也会增加不稳定性 / 成本）： +可以把这些测试套件理解为“真实性逐步增加”（同时波动性/成本也逐步增加）： -### 单元 / 集成（默认） +### Unit / integration（默认） - 命令：`pnpm test` -- 配置：未定向运行使用 `vitest.full-*.config.ts` 分片集，并且可能会将多项目分片展开为按项目划分的配置，以便并行调度 -- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core / unit 清单，以及 `vitest.unit.config.ts` 覆盖的已列入白名单的 `ui` Node 测试 +- 配置：未定向运行使用 `vitest.full-*.config.ts` 分片集合，并且可能会将多项目分片展开为按项目划分的配置，以便并行调度 +- 文件：核心/unit 清单位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts`，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试中 - 范围： - - 纯单元测试 - - 进程内集成测试（gateway 认证、路由、工具、解析、配置） - - 已知缺陷的确定性回归测试 + - 纯 unit 测试 + - 进程内 integration 测试（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`），而不是启动一个巨大的原生 root-project 进程。这样可以降低高负载机器上的峰值 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` 是窄范围工作时常用的智能本地门禁。它会将差异分类到 core、core tests、extensions、extension tests、apps、docs、release metadata、live Docker tooling 和 tooling，然后运行相应的 typecheck / lint / 测试通道。公共插件 SDK 和插件契约变更会额外包含一次 extension 验证，因为 extensions 依赖这些核心契约。仅涉及发布元数据的版本变更会运行定向的版本 / 配置 / 根依赖检查，而不是完整套件，并带有一个保护机制，拒绝顶层版本字段之外的包变更。 - - live Docker ACP harness 编辑会运行聚焦式本地门禁：检查 live Docker 认证脚本的 shell 语法、执行 live Docker 调度器 dry-run、运行 ACP bind 单元测试以及 ACPX extension 测试。除非差异也触及根级 / 全局表面（例如依赖或共享的 Vitest setup），否则不会触发完整的 Vitest 矩阵。 - - 来自 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/**` 子树。CI 还会进一步将 reply 子树拆分为 agent-runner、dispatch 和 commands / state-routing 分片，这样某一个导入开销较重的分桶就不会独占整个 Node 尾部时长。 + - 未定向的 `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` 会先通过带作用域的 lane 路由显式文件/目录目标，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 可以避免承担完整根项目启动的成本。 + - 当 diff 仅涉及可路由的源码/测试文件时，`pnpm test:changed` 会将变更过的 git 路径展开到相同的带作用域 lane；配置/setup 编辑仍会回退到更广泛的根项目重跑。 + - `pnpm check:changed` 是针对小范围工作使用的常规智能本地门禁。它会将 diff 分类为 core、core tests、extensions、extension tests、apps、docs、release metadata、live Docker tooling 和 tooling，然后运行匹配的 typecheck/lint/test lane。公开的 Plugin SDK 和插件契约变更会额外包含一次 extension 验证，因为 extensions 依赖这些 core 契约。仅涉及发布元数据的版本号变更会运行有针对性的版本/配置/根依赖检查，而不是完整测试套件，并带有一个保护机制，用于拒绝顶层版本字段之外的 package 更改。 + - live Docker ACP harness 编辑会运行一个聚焦的本地门禁：live Docker 鉴权脚本的 shell 语法检查、live Docker 调度器 dry-run、ACP bind unit 测试以及 ACPX extension 测试。仅当 diff 限定在 `scripts["test:docker:live-*"]` 时，才会包含 `package.json` 变更；依赖、导出、版本和其他 package 表面编辑仍然使用更广泛的保护。 + - 来自 agents、commands、plugins、auto-reply 辅助方法、`plugin-sdk` 以及类似纯工具区域的轻导入 unit 测试会通过 `unit-fast` lane 路由，该 lane 会跳过 `test/setup-openclaw-runtime.ts`；有状态/运行时较重的文件仍保留在现有 lane 上。 + - 部分 `plugin-sdk` 和 `commands` 辅助源码文件还会在 changed 模式下将运行映射到这些轻量 lane 中显式的同级测试，因此辅助方法编辑可以避免为该目录重跑完整的重型测试套件。 + - `auto-reply` 为顶层 core 辅助方法、顶层 `reply.*` integration 测试以及 `src/auto-reply/reply/**` 子树提供了专用分桶。CI 还会进一步将 reply 子树拆分为 agent-runner、dispatch 和 commands/state-routing 分片，这样某一个重导入分桶就不会独占整个 Node 收尾阶段。 - + - - 当你修改消息工具发现输入或压缩运行时上下文时，要同时保留两个层级的覆盖。 - - 为纯路由和归一化边界添加聚焦的 helper 回归测试。 - - 保持嵌入式运行器集成套件健康： + - 当你修改消息工具发现输入或压缩运行时上下文时，请同时保持两个层级的覆盖。 + - 为纯路由和规范化边界添加聚焦的辅助回归测试。 + - 保持嵌入式运行器 integration 测试套件健康： `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` 路径；仅有 helper 测试不足以替代这些集成路径。 + - 这些测试套件会验证带作用域的 id 和压缩行为仍会流经真实的 `run.ts` / `compact.ts` 路径；仅辅助方法级测试并不能充分替代这些 integration 路径。 - + - 基础 Vitest 配置默认使用 `threads`。 - - 共享 Vitest 配置固定设置 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 - - 根级 UI 通道会保留其 `jsdom` setup 和优化器，但也在共享的非隔离运行器上运行。 + - 共享 Vitest 配置固定为 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 + - 根 UI lane 保留其 `jsdom` setup 和优化器，但也运行在共享的非隔离运行器上。 - 每个 `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`。公共插件 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 changed:lanes` 会显示一个 diff 会触发哪些架构 lane。 + - pre-commit hook 仅负责格式化。它会重新暂存已格式化文件，不会运行 lint、typecheck 或测试。 + - 在交接或 push 前，如果你需要智能本地门禁，请显式运行 `pnpm check:changed`。公开的 Plugin SDK 和插件契约变更会额外包含一次 extension 验证。 + - 当变更路径能清晰映射到更小的测试套件时，`pnpm test:changed` 会通过带作用域的 lane 路由。 + - `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` 会启用 Vitest 导入耗时报告以及导入拆解输出。 - `pnpm test:perf:imports:changed` 会将相同的性能分析视图限定到自 `origin/main` 以来变更的文件。 - - 分片计时数据会写入 `.artifacts/vitest-shard-timings.json`。整配置运行使用配置路径作为键；include-pattern CI 分片会追加分片名称，以便单独跟踪过滤后的分片。 - - 当某个热点测试仍将大部分时间花在启动导入上时，应将重型依赖放在狭窄的本地 `*.runtime.ts` 接缝之后，并直接 mock 该接缝，而不是仅为了传给 `vi.mock(...)` 就深度导入运行时辅助模块。 - - `pnpm test:perf:changed:bench -- --ref ` 会针对该已提交差异，对比经路由的 `test:changed` 与原生 root-project 路径，并输出墙钟时间和 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 + heap profile。 + - 分片耗时数据会写入 `.artifacts/vitest-shard-timings.json`。 + 整个配置运行以配置路径作为键；带 include-pattern 的 CI 分片会附加分片名称，以便单独跟踪经过过滤的分片。 + - 当某个热点测试的大部分时间仍花在启动导入上时，应将重依赖放在狭窄的本地 `*.runtime.ts` 接缝之后，并直接 mock 该接缝，而不是为了传给 `vi.mock(...)` 就深度导入运行时辅助方法。 + - `pnpm test:perf:changed:bench -- --ref ` 会针对该已提交 diff，将经路由的 `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` 会在禁用文件并行的情况下，为 unit 测试套件写出运行器 CPU + 堆 profile。 -### 稳定性（Gateway 网关） +### 稳定性（gateway） - 命令：`pnpm test:stability:gateway` -- 配置：`vitest.gateway.config.ts`，强制单 worker +- 配置：`vitest.gateway.config.ts`，强制使用单 worker - 范围： - - 启动一个默认启用诊断功能的真实 loopback Gateway 网关 - - 通过诊断事件路径驱动合成的 gateway 消息、memory 和大负载 churn + - 默认启动一个启用了诊断功能的真实 loopback Gateway 网关 + - 通过诊断事件路径驱动合成的 gateway 消息、内存和大负载抖动 - 通过 Gateway 网关 WS RPC 查询 `diagnostics.stability` - - 覆盖诊断稳定性 bundle 持久化辅助函数 - - 断言记录器保持有界、合成 RSS 样本保持在压力预算之下，以及每个会话的队列深度会回落到零 + - 覆盖诊断稳定性 bundle 持久化辅助方法 + - 断言记录器保持有界、合成 RSS 样本保持在压力预算之下，并且每个 session 的队列深度最终回落为零 - 预期： - - 对 CI 安全且无需密钥 - - 是用于稳定性回归跟进的窄通道，不替代完整 Gateway 网关 套件 + - 对 CI 安全且不需要密钥 + - 是用于稳定性回归跟进的窄范围 lane，不替代完整 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`，与仓库其余部分保持一致。 + - 使用 Vitest `threads` 且 `isolate: false`，与仓库其余部分保持一致。 - 使用自适应 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 中运行（当流水线启用时） + - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比单元测试包含更多活动部件（可能更慢） + - 比 unit 测试有更多运动部件（可能更慢） -### E2E：OpenShell 后端冒烟测试 +### E2E：OpenShell 后端冒烟 - 命令：`pnpm test:e2e:openshell` - 文件：`extensions/openshell/src/backend.e2e.test.ts` - 范围： - 通过 Docker 在主机上启动一个隔离的 OpenShell gateway - 从临时本地 Dockerfile 创建一个沙箱 - - 通过真实的 `sandbox ssh-config` + SSH exec 来测试 OpenClaw 的 OpenShell 后端 - - 通过沙箱 fs bridge 验证远端规范化的文件系统行为 + - 通过真实的 `sandbox ssh-config` + SSH exec 运行 OpenClaw 的 OpenShell 后端 + - 通过沙箱 fs bridge 验证远端规范文件系统行为 - 预期： - - 仅按需启用；不属于默认的 `pnpm test:e2e` 运行内容 - - 需要本地 `openshell` CLI 和可用的 Docker daemon - - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 gateway 和沙箱 -- 常用覆盖项： - - 在手动运行更广泛的 e2e 套件时，设置 `OPENCLAW_E2E_OPENSHELL=1` 启用该测试 - - 设置 `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell` 以指向非默认的 CLI 二进制文件或包装脚本 + - 仅按需启用；不属于默认 `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 二进制或包装脚本 -### live（真实提供商 + 真实模型） +### Live（真实提供商 + 真实模型） - 命令：`pnpm test:live` - 配置：`vitest.live.config.ts` - 文件：`src/**/*.live.test.ts`、`test/**/*.live.test.ts`，以及 `extensions/` 下的内置插件 live 测试 -- 默认值：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） +- 默认：由 `pnpm test:live` **启用**（设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型 _今天_ 配合真实凭证是否真的能工作？” - - 捕获提供商格式变更、工具调用怪癖、认证问题以及速率限制行为 + - “这个提供商/模型**今天**在真实凭证下真的能工作吗？” + - 捕获提供商格式变更、工具调用怪癖、鉴权问题以及限流行为 - 预期： - - 设计上不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - - 会花钱 / 消耗速率限制 - - 优先运行收窄后的子集，而不是“全部都跑” -- live 运行会读取 `~/.profile`，以补齐缺失的 API 密钥。 -- 默认情况下，live 运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，这样单元 fixture 就无法修改你真实的 `~/.openclaw`。 -- 仅当你有意需要 live 测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 -- `pnpm test:live` 现在默认采用更安静的模式：会保留 `[live] ...` 进度输出，但会抑制额外的 `~/.profile` 提示，并静音 gateway 启动日志 / Bonjour 噪声。如果你希望恢复完整启动日志，可设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 -- API key 轮换（按提供商区分）：使用逗号 / 分号格式设置 `*_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 进度行会立即流式输出。 + - 天生不适合作为稳定 CI（真实网络、真实提供商策略、配额、故障） + - 会花钱 / 消耗限流额度 + - 优先运行收窄后的子集，而不是“全部” +- live 运行会 source `~/.profile`，以便拾取缺失的 API key。 +- 默认情况下，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 key 轮换（按提供商）：设置 `*_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 控制台拦截，因此提供商/gateway 进度行会在 live 运行期间立即流式输出。 - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整 direct-model 心跳。 - - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 gateway / probe 心跳。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 gateway/探针心跳。 ## 我应该运行哪个测试套件？ 使用这个决策表： -- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，也运行 `pnpm test:coverage`） +- 编辑逻辑/测试：运行 `pnpm test`（如果你改动很多，也运行 `pnpm test:coverage`） - 涉及 gateway 网络 / WS 协议 / 配对：额外运行 `pnpm test:e2e` -- 调试“我的 bot 挂了” / 提供商特定故障 / 工具调用：运行收窄后的 `pnpm test:live` +- 调试“我的 bot 挂了”/ 提供商特定故障 / 工具调用：运行收窄后的 `pnpm test:live` -## live（涉及网络的）测试 +## Live（触及网络的）测试 -关于 live 模型矩阵、CLI 后端冒烟测试、ACP 冒烟测试、Codex app-server harness，以及所有媒体提供商 live 测试（Deepgram、BytePlus、ComfyUI、image、music、video、media harness）——以及 live 运行的凭证处理——请参阅 [测试 — live 测试套件](/zh-CN/help/testing-live)。 +有关 live 模型矩阵、CLI 后端冒烟测试、ACP 冒烟测试、Codex app-server harness，以及所有媒体提供商 live 测试（Deepgram、BytePlus（国际版）、ComfyUI、image、music、video、media harness）——以及 live 运行的凭证处理——请参见 [测试 — live 测试套件](/zh-CN/help/testing-live)。 -## Docker 运行器（可选的“在 Linux 中能工作”检查） +## Docker 运行器（可选的“在 Linux 中可运行”检查） 这些 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 扫描仍然可行： +- 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`），并挂载你的本地配置目录和工作区（如果已挂载，也会 source `~/.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` 构建一次 live Docker 镜像，然后在 live Docker 通道中复用该镜像。它还会通过 `test:docker:e2e-build` 构建一个共享的 `scripts/e2e/Dockerfile` 镜像，并在测试已构建应用的 E2E 容器冒烟运行器中复用。该聚合器使用加权本地调度器：`OPENCLAW_DOCKER_ALL_PARALLELISM` 控制进程槽位，而资源上限会阻止高负载的 live、npm-install 和多服务通道同时启动。默认值为 10 个槽位、`OPENCLAW_DOCKER_ALL_LIVE_LIMIT=6`、`OPENCLAW_DOCKER_ALL_NPM_LIMIT=8` 和 `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7`；只有当 Docker 主机有更大余量时，才需要调整 `OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT` 或 `OPENCLAW_DOCKER_ALL_DOCKER_LIMIT`。运行器默认会执行 Docker 预检、清理过期的 OpenClaw E2E 容器、每 30 秒打印一次状态、将成功通道的耗时存储到 `.artifacts/docker-tests/lane-timings.json` 中，并在后续运行时利用这些耗时优先启动较长的通道。使用 `OPENCLAW_DOCKER_ALL_DRY_RUN=1` 可仅打印加权通道清单，而不构建或运行 Docker。 +- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后在各个 live Docker lane 中复用它。它还会通过 `test:docker:e2e-build` 构建一个共享的 `scripts/e2e/Dockerfile` 镜像，并在运行已构建应用的 E2E 容器冒烟运行器中复用该镜像。这个聚合流程使用带权重的本地调度器：`OPENCLAW_DOCKER_ALL_PARALLELISM` 控制进程槽位，而资源上限会防止重型 live、npm-install 和多服务 lane 同时全部启动。默认值为 10 个槽位、`OPENCLAW_DOCKER_ALL_LIVE_LIMIT=6`、`OPENCLAW_DOCKER_ALL_NPM_LIMIT=8` 和 `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7`；只有当 Docker 主机有更多余量时，才调整 `OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT` 或 `OPENCLAW_DOCKER_ALL_DOCKER_LIMIT`。该运行器默认执行 Docker 预检，移除陈旧的 OpenClaw E2E 容器，每 30 秒打印一次状态，将成功 lane 的耗时存储到 `.artifacts/docker-tests/lane-timings.json`，并在后续运行中利用这些耗时优先启动更长的 lane。使用 `OPENCLAW_DOCKER_ALL_DRY_RUN=1` 可在不构建或运行 Docker 的情况下打印带权重的 lane 清单。 - 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:npm-onboard-channel-agent`、`test:docker:session-runtime-context`、`test:docker:agents-delete-shared-workspace`、`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` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -live 模型 Docker 运行器还会只绑定挂载所需的 CLI 认证 home（如果运行未收窄，则挂载所有受支持的 home），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新 token，而不会修改主机上的认证存储： +live 模型 Docker 运行器还会只绑定挂载所需的 CLI 鉴权 home（如果运行未收窄，则挂载所有受支持的 home），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新令牌而不修改宿主机上的鉴权存储： - 直接模型：`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`；默认覆盖 Claude、Codex 和 Gemini，严格的 Droid / OpenCode 覆盖可通过 `pnpm test:docker:live-acp-bind:droid` 和 `pnpm test:docker:live-acp-bind:opencode` 运行） +- ACP 绑定冒烟测试：`pnpm test:docker:live-acp-bind`（脚本：`scripts/test-live-acp-bind-docker.sh`；默认覆盖 Claude、Codex 和 Gemini，对 Droid/OpenCode 的严格覆盖可通过 `pnpm test:docker:live-acp-bind:droid` 和 `pnpm test:docker:live-acp-bind:opencode` 运行） - 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 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，通过环境变量引用的新手引导配置 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` 切换渠道。 -- 会话运行时上下文冒烟测试：`pnpm test:docker:session-runtime-context` 会验证隐藏运行时上下文转录的持久化，以及 doctor 对受影响的重复 prompt-rewrite 分支的修复。 -- Bun 全局安装冒烟测试：`bash scripts/e2e/bun-global-install-smoke.sh` 会打包当前工作树，在隔离的 home 中通过 `bun install -g` 安装它，并验证 `openclaw infer image providers --json` 返回的是内置 image 提供商，而不是挂起。可使用 `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` 覆盖时，请在本地运行该脚本时不要设置这个环境变量。 -- Agents 删除共享工作区 CLI 冒烟测试：`pnpm test:docker:agents-delete-shared-workspace`（脚本：`scripts/e2e/agents-delete-shared-workspace-docker.sh`）默认会构建根 Dockerfile 镜像，在隔离的容器 home 中植入两个智能体和一个工作区，运行 `agents delete --json`，并验证 JSON 有效且工作区保留行为正确。可通过 `OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_IMAGE=openclaw-dockerfile-smoke:local OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_SKIP_BUILD=1` 复用 install-smoke 镜像。 -- 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`，然后强制 provider 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`） +- 新手引导向导（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` 切换渠道。 +- Session 运行时上下文冒烟测试：`pnpm test:docker:session-runtime-context` 会验证隐藏运行时上下文 transcript 的持久化，以及 doctor 对受影响的重复 prompt-rewrite 分支的修复。 +- Bun 全局安装冒烟测试：`bash scripts/e2e/bun-global-install-smoke.sh` 会打包当前工作树，在隔离的 home 中使用 `bun install -g` 安装它，并验证 `openclaw infer image providers --json` 会返回内置 image 提供商而不是卡住。可使用 `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/`。 +- Installer 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` 时，请在本地运行该脚本且不要设置此环境变量。 +- 智能体删除共享工作区 CLI 冒烟测试：`pnpm test:docker:agents-delete-shared-workspace`（脚本：`scripts/e2e/agents-delete-shared-workspace-docker.sh`）默认构建根 Dockerfile 镜像，在隔离的容器 home 中为两个智能体注入一个工作区，运行 `agents delete --json`，并验证 JSON 有效以及工作区保留行为。可通过 `OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_IMAGE=openclaw-dockerfile-smoke:local OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_SKIP_BUILD=1` 复用 install-smoke 镜像。 +- 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 profile 允许/拒绝冒烟测试）：`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。完整 Docker 聚合器会先预打包一次该 tarball，然后将内置渠道检查切分为独立通道，包括 Telegram、Discord、Slack、Feishu、memory-lancedb 和 ACPX 的独立更新通道。直接运行内置通道时，可通过 `OPENCLAW_BUNDLED_CHANNELS=telegram,slack` 收窄渠道矩阵，或通过 `OPENCLAW_BUNDLED_CHANNEL_UPDATE_TARGETS=telegram,acpx` 收窄更新场景。该通道还会验证 `channels..enabled=false` 和 `plugins.entries..enabled=false` 会抑制 doctor / 运行时依赖修复。 -- 在迭代时，如需收窄内置插件运行时依赖测试，可禁用无关场景，例如： - `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` +- 插件更新未变更冒烟测试：`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。完整 Docker 聚合流程会先预打包一次该 tarball，然后将内置渠道检查分片为独立 lane，其中包括 Telegram、Discord、Slack、Feishu、memory-lancedb 和 ACPX 的单独更新 lane。直接运行内置 lane 时，可使用 `OPENCLAW_BUNDLED_CHANNELS=telegram,slack` 收窄渠道矩阵，或使用 `OPENCLAW_BUNDLED_CHANNEL_UPDATE_TARGETS=telegram,acpx` 收窄更新场景。该 lane 还会验证 `channels..enabled=false` 和 `plugins.entries..enabled=false` 会抑制 doctor/运行时依赖修复。 +- 迭代期间可通过禁用无关场景来收窄内置插件运行时依赖检查，例如： + `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 镜像： @@ -503,81 +504,83 @@ 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` 指向远程共享镜像时，如果该镜像尚未存在于本地，脚本会自动拉取。二维码和安装器 Docker 测试会保留它们自己的 Dockerfile，因为它们验证的是包 / 安装行为，而不是共享的已构建应用运行时。 +设置后，诸如 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE` 之类的测试套件专用镜像覆盖项仍然优先生效。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时，如果该镜像尚未存在于本地，脚本会先拉取它。QR 和 installer Docker 测试保留各自独立的 Dockerfile，因为它们验证的是 package/install 行为，而不是共享的 built-app 运行时。 -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 容器，启动一个固定版本的 Open WebUI 容器并将其指向该 gateway，通过 Open WebUI 登录，验证 `/api/models` 暴露了 `openclaw/default`，然后通过 Open WebUI 的 `/api/chat/completions` 代理发送一次真实聊天请求。 -首次运行可能会明显更慢，因为 Docker 可能需要拉取 Open WebUI 镜像，而 Open WebUI 也可能需要完成自己的冷启动设置。 -该通道需要一个可用的 live 模型密钥，而在 Docker 化运行中，`OPENCLAW_PROFILE_FILE`（默认为 `~/.profile`）是提供它的主要方式。 -成功运行会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是有意设计为确定性的，不需要真实的 Telegram、Discord 或 iMessage 账号。它会启动一个预植入的 Gateway 网关 容器，再启动第二个容器来拉起 `openclaw mcp serve`，然后通过真实的 stdio MCP bridge 验证已路由会话发现、转录读取、附件元数据、live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。 -通知检查会直接检查原始 stdio MCP 帧，因此这个冒烟测试验证的是桥接实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露出来的内容。 -`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要 live 模型密钥。它会构建仓库 Docker 镜像，在容器内启动一个真实的 stdio MCP 探测服务器，通过嵌入式 Pi bundle MCP 运行时将该服务器实体化，执行工具，然后验证 `coding` 和 `messaging` 会保留 `bundle-mcp` 工具，而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会将其过滤掉。 -`test:docker:cron-mcp-cleanup` 是确定性的，不需要 live 模型密钥。它会启动一个带真实 stdio MCP 探测服务器的预植入 Gateway 网关，运行一个隔离的 cron 轮次和一个 `/subagents spawn` 一次性子智能体轮次，然后验证 MCP 子进程会在每次运行后退出。 +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 lane 中收窄或排除 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 也可能需要完成自己的冷启动设置。 +这个 lane 需要可用的 live 模型密钥，而在 Docker 化运行中，`OPENCLAW_PROFILE_FILE` +（默认是 `~/.profile`）是提供该密钥的主要方式。 +成功运行会打印一个简短的 JSON 载荷，例如 `{ "ok": true, "model": +"openclaw/default", ... }`。 +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要真实的 Telegram、Discord 或 iMessage 账号。它会启动一个已注入状态的 Gateway 网关容器，启动第二个容器来生成 `openclaw mcp serve`，然后验证经路由的会话发现、transcript 读取、附件元数据、live 事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 的 Claude 风格渠道 + 权限通知。通知检查会直接检查原始 stdio MCP 帧，因此这个冒烟测试验证的是 bridge 实际发出的内容，而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 +`test:docker:pi-bundle-mcp-tools` 是确定性的，不需要 live 模型密钥。它会构建仓库 Docker 镜像，在容器内启动一个真实的 stdio MCP 探针服务器，通过嵌入式 Pi bundle 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 安装 -- 位于 `$HOME` 下的外部 CLI 认证目录 / 文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` +- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile`，并在运行测试前 source +- `OPENCLAW_DOCKER_PROFILE_ENV_ONLY=1` 用于仅验证从 `OPENCLAW_PROFILE_FILE` source 的环境变量，使用临时 config/workspace 目录，并且不挂载外部 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` - - 收窄后的 provider 运行只会挂载从 `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_SKIP_DOCKER_BUILD=1` 用于复用已有的 `openclaw:local-live` 镜像，以便在不需要重新构建时进行重跑 - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自 profile 存储（而不是环境变量） - `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择在 Open WebUI 冒烟测试中由 gateway 暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试所使用的 nonce 检查提示词 +- `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 + Agent loop）：`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 网关工具调用（模拟 OpenAI、真实 gateway + Agent loop）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） +- Gateway 网关向导（WS `wizard.start`/`wizard.next`，强制写入配置 + auth）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） ## 智能体可靠性评估（Skills） -我们已经有一些对 CI 安全的测试，它们的行为类似于“智能体可靠性评估”： +我们已经有一些对 CI 安全、行为类似“智能体可靠性评估”的测试： -- 通过真实 gateway + Agent loop 的模拟工具调用（`src/gateway/gateway.test.ts`）。 -- 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 +- 通过真实 gateway + Agent loop 进行模拟工具调用（`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）？ -- **合规性：** 智能体是否会在使用前读取 `SKILL.md`，并遵循要求的步骤 / 参数？ -- **工作流契约：** 可断言工具顺序、会话历史延续以及沙箱边界的多轮场景。 +- **决策**：当提示词中列出 Skills 时，智能体是否会选择正确的 Skills（或避免不相关的 Skills）？ +- **合规性**：智能体在使用前是否会读取 `SKILL.md`，并遵循所要求的步骤/参数？ +- **工作流契约**：断言工具顺序、会话历史延续以及沙箱边界的多轮场景。 -未来的评估应首先保持确定性： +未来的评估应当首先保持确定性： -- 一个使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、Skill 文件读取以及会话接线。 -- 一小套以 Skill 为中心的场景（使用与避免、门控、提示注入）。 -- 只有在对 CI 安全的套件就位后，才考虑可选的 live 评估（按需启用、由环境变量门控）。 +- 一个使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话布线。 +- 一小套聚焦 skill 的场景（使用 vs 避免、门控、提示注入）。 +- 只有在对 CI 安全的测试套件到位后，才添加可选的 live 评估（选择加入、由环境变量门控）。 -## 契约测试（插件与渠道形状） +## 契约测试（插件和渠道形状） -契约测试用于验证每个已注册的插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一组关于结构与行为的断言。默认的 `pnpm test` 单元通道会有意跳过这些共享接缝与冒烟文件；当你修改共享渠道或提供商表面时，请显式运行契约命令。 +契约测试用于验证每个已注册的插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一组关于形状和行为的断言。默认的 `pnpm test` unit lane 会刻意跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商表面时，请显式运行契约命令。 ### 命令 @@ -589,58 +592,58 @@ live 模型 Docker 运行器还会以只读方式绑定挂载当前检出，并 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基础插件结构（id、名称、能力） +- **plugin** - 基本插件形状（id、name、capabilities） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 -- **outbound-payload** - 消息负载结构 +- **outbound-payload** - 消息载荷结构 - **inbound** - 入站消息处理 -- **actions** - 渠道动作处理器 +- **actions** - 渠道 action 处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录 / roster API -- **group-policy** - 群组策略强制执行 +- **directory** - 目录/成员列表 API +- **group-policy** - 群组策略执行 -### 提供商 Status 契约 +### 提供商状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 -- **status** - 渠道 Status 探测 -- **registry** - 插件注册表结构 +- **status** - 渠道 Status 探针 +- **registry** - 插件注册表形状 ### 提供商契约 位于 `src/plugins/contracts/*.contract.test.ts`： -- **auth** - 认证流程契约 -- **auth-choice** - 认证选择 / 选取 +- **auth** - 鉴权流程契约 +- **auth-choice** - 鉴权选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 - **runtime** - 提供商运行时 -- **shape** - 插件结构 / 接口 +- **shape** - 插件形状/接口 - **wizard** - 设置向导 ### 何时运行 -- 在修改插件 SDK 导出或子路径之后 -- 在添加或修改渠道或提供商插件之后 -- 在重构插件注册或发现逻辑之后 +- 修改 plugin-sdk 导出或子路径后 +- 添加或修改渠道或提供商插件后 +- 重构插件注册或发现逻辑后 -契约测试会在 CI 中运行，且不需要真实 API 密钥。 +契约测试会在 CI 中运行，不需要真实 API 密钥。 -## 添加回归测试（指南） +## 添加回归测试（指导） -当你修复在 live 中发现的提供商 / 模型问题时： +当你修复了一个在 live 中发现的提供商/模型问题时： -- 如果可能，添加一个对 CI 安全的回归测试（模拟 / stub 提供商，或捕获精确的请求形状转换） -- 如果它本质上只能在 live 中出现（速率限制、认证策略），就让 live 测试保持收窄，并通过环境变量按需启用 -- 优先定位到能够捕获该缺陷的最小层： - - provider 请求转换 / 回放缺陷 → 直接模型测试 - - gateway 会话 / 历史 / 工具流水线缺陷 → gateway live 冒烟测试，或对 CI 安全的 gateway mock 测试 +- 如果可能，添加一个对 CI 安全的回归测试（模拟/桩提供商，或捕获精确的请求形状转换） +- 如果它本质上只能在 live 中复现（限流、鉴权策略），就让 live 测试保持收窄，并通过环境变量选择启用 +- 优先定位能捕获该缺陷的最小层级： + - 提供商请求转换/重放缺陷 → 直接模型测试 + - gateway 会话/历史/工具流水线缺陷 → gateway live 冒烟测试或对 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/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历片段 exec id 会被拒绝。 + - 如果你在 `src/secrets/target-registry-data.ts` 中添加了新的 `includeInPlan` SecretRef 目标族，请更新该测试中的 `classifyTargetClass`。该测试会在目标 id 未分类时故意失败，从而避免新类别被静默跳过。 ## 相关内容 -- [Testing live](/zh-CN/help/testing-live) +- [测试 live](/zh-CN/help/testing-live) - [CI](/zh-CN/ci) diff --git a/docs/zh-CN/reference/rich-output-protocol.md b/docs/zh-CN/reference/rich-output-protocol.md index bb238fb5a..dc235608d 100644 --- a/docs/zh-CN/reference/rich-output-protocol.md +++ b/docs/zh-CN/reference/rich-output-protocol.md @@ -1,33 +1,35 @@ --- read_when: - - 更改 Control UI 中的助手输出渲染 - - 调试 `[embed ...]`、`MEDIA:`、reply 或音频呈现指令 -summary: 用于嵌入、媒体、音频提示和回复的富输出 shortcode 协议 + - 在 Control UI 中更改助手输出渲染方式 + - 调试 `[embed ...]`、`MEDIA:`、回复或音频呈现指令 +summary: 用于嵌入内容、媒体、音频提示和回复的富输出短代码协议 title: 富输出协议 x-i18n: - generated_at: "2026-04-25T17:31:32Z" + generated_at: "2026-04-26T01:02:55Z" model: gpt-5.4 provider: openai - source_hash: 89e01037a8cb80c9de36effd4642701dcc86131a2b8fb236d61c687845e64189 + source_hash: 3c62e41073196c2ff4867230af55469786fcfb29414f5cc5b7d38f6b1ffc3718 source_path: reference/rich-output-protocol.md workflow: 15 --- -助手输出可以携带一小组传递/渲染指令： +助手输出可以携带一小组投递/渲染指令： -- `MEDIA:` 用于附件传递 +- `MEDIA:` 用于附件投递 - `[[audio_as_voice]]` 用于音频呈现提示 - `[[reply_to_current]]` / `[[reply_to:]]` 用于回复元数据 - `[embed ...]` 用于 Control UI 富渲染 -这些指令彼此独立。`MEDIA:` 以及回复/语音标签仍然是传递元数据；`[embed ...]` 是仅限 Web 的富渲染路径。 -受信任的工具结果媒体在传递前使用相同的 `MEDIA:` / `[[audio_as_voice]]` 解析器，因此文本工具输出仍然可以将音频附件标记为语音便笺。 +远程 `MEDIA:` 附件必须是公开的 `https:` URL。普通 `http:`、loopback、链路本地、私有以及内部主机名会被忽略，不会作为附件指令处理；服务器端媒体抓取器仍会执行其自身的网络防护规则。 -启用分块流式传输时，`MEDIA:` 仍然是单轮消息的单次传递元数据。如果同一个媒体 URL 已在流式块中发送，又在最终助手负载中重复出现，OpenClaw 只会传递一次附件，并从最终负载中移除重复项。 +这些指令彼此独立。`MEDIA:` 和回复/语音标签仍然是投递元数据；`[embed ...]` 是仅限 Web 的富渲染路径。 +受信任工具结果中的媒体在投递前也会使用相同的 `MEDIA:` / `[[audio_as_voice]]` 解析器，因此文本工具输出仍然可以将音频附件标记为语音便笺。 + +启用分块流式传输时，`MEDIA:` 仍然是一次会话中的单次投递元数据。如果同一个媒体 URL 在流式块中发送，并且又在最终助手负载中重复出现，OpenClaw 只会投递一次该附件，并从最终负载中移除重复项。 ## `[embed ...]` -`[embed ...]` 是面向智能体的、用于 Control UI 的唯一富渲染语法。 +`[embed ...]` 是唯一面向智能体的 Control UI 富渲染语法。 自闭合示例： @@ -37,16 +39,16 @@ x-i18n: 规则： -- `[view ...]` 对于新输出已不再有效。 -- Embed shortcode 仅在助手消息表面中渲染。 -- 仅渲染有 URL 支撑的 embed。使用 `ref="..."` 或 `url="..."`。 -- 块形式的内联 HTML embed shortcode 不会渲染。 -- Web UI 会从可见文本中剥离该 shortcode，并以内联方式渲染 embed。 -- `MEDIA:` 不是 embed 别名，不应用于富 embed 渲染。 +- `[view ...]` 不再适用于新的输出。 +- 嵌入短代码仅在助手消息界面中渲染。 +- 仅渲染基于 URL 的嵌入。使用 `ref="..."` 或 `url="..."`。 +- 不会渲染块形式的内联 HTML 嵌入短代码。 +- Web UI 会从可见文本中移除该短代码，并以内联方式渲染嵌入内容。 +- `MEDIA:` 不是嵌入别名，不应当用于富嵌入渲染。 ## 存储的渲染形状 -规范化/存储后的助手内容块是结构化的 `canvas` 项： +规范化/存储后的助手内容块是一个结构化的 `canvas` 项： ```json { @@ -63,7 +65,7 @@ x-i18n: } ``` -已存储/已渲染的富块直接使用这个 `canvas` 形状。`present_view` 不会被识别。 +存储/渲染的富内容块直接使用这个 `canvas` 形状。`present_view` 不会被识别。 ## 相关内容