From e4cd4565f1afefedbf1f4a37779f3f6223b1337e Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Thu, 9 Apr 2026 22:57:02 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/concepts/qa-e2e-automation.md | 63 ++- docs/zh-CN/help/testing.md | 630 ++++++++++++----------- 2 files changed, 360 insertions(+), 333 deletions(-) diff --git a/docs/zh-CN/concepts/qa-e2e-automation.md b/docs/zh-CN/concepts/qa-e2e-automation.md index 3cfbcca97..793766b4b 100644 --- a/docs/zh-CN/concepts/qa-e2e-automation.md +++ b/docs/zh-CN/concepts/qa-e2e-automation.md @@ -1,28 +1,28 @@ --- read_when: - - 扩展 qa-lab 或 qa-channel 时 - - 添加仓库支持的 QA 场景时 - - 围绕 Gateway 网关仪表板构建更高拟真度的 QA 自动化时 + - 扩展 qa-lab 或 qa-channel + - 添加仓库支持的 QA 场景 + - 围绕 Gateway 网关仪表板构建更高真实性的 QA 自动化 summary: 用于 qa-lab、qa-channel、种子场景和协议报告的私有 QA 自动化形态 title: QA 端到端自动化 x-i18n: - generated_at: "2026-04-09T00:27:33Z" + generated_at: "2026-04-09T22:54:35Z" model: gpt-5.4 provider: openai - source_hash: c922607d67e0f3a2489ac82bc9f510f7294ced039c1014c15b676d826441d833 + source_hash: 357d6698304ff7a8c4aa8a7be97f684d50f72b524740050aa761ac0ee68266de source_path: concepts/qa-e2e-automation.md workflow: 15 --- # QA 端到端自动化 -私有 QA 技术栈旨在以比单个单元测试更贴近真实渠道形态的方式来验证 OpenClaw。 +私有 QA 栈旨在以比单个单元测试更贴近真实、渠道形态化的方式来验证 OpenClaw。 当前组成部分: -- `extensions/qa-channel`:合成消息渠道,提供私信、渠道、线程、反应、编辑和删除等交互层面。 -- `extensions/qa-lab`:调试器 UI 和 QA 总线,用于观察转录内容、注入入站消息,以及导出 Markdown 报告。 -- `qa/`:为启动任务和基线 QA 场景提供的仓库支持种子资源。 +- `extensions/qa-channel`:合成消息渠道,提供私信、渠道、线程、反应、编辑和删除等交互界面。 +- `extensions/qa-lab`:调试器 UI 和 QA 总线,用于观察转录内容、注入入站消息以及导出 Markdown 报告。 +- `qa/`:由仓库支持的启动任务种子资源和基线 QA 场景。 当前的 QA 操作流程是一个双窗格 QA 站点: @@ -35,9 +35,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 构建产物的方式启动该栈: ```bash pnpm openclaw qa docker-build-image @@ -46,16 +46,26 @@ 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` 会在变更时重新构建该产物,当 QA Lab 资源哈希发生变化时,浏览器会自动重新加载。 -## 仓库支持的种子资源 +如果你想使用一次性的 Linux VM 执行通道,而不将 Docker 引入 QA 路径,请运行: -种子资源位于 `qa/`: +```bash +pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline +``` + +这会启动一个全新的 Multipass 来宾系统,安装依赖,在来宾系统内构建 OpenClaw,运行 `qa suite`,然后将常规 QA 报告和摘要复制回宿主机上的 `.artifacts/qa-e2e/...`。 +它会复用与宿主机上 `qa suite` 相同的场景选择行为。 +实时运行会转发适合来宾环境使用的受支持 QA 凭证输入:基于环境变量的提供商密钥、QA 实时提供商配置路径,以及存在时的 `CODEX_HOME`。请将 `--output-dir` 保持在仓库根目录下,以便来宾系统能够通过已挂载的工作区写回内容。 + +## 由仓库支持的种子资源 + +种子资源位于 `qa/` 中: - `qa/scenarios/index.md` - `qa/scenarios/*.md` -这些内容特意保存在 git 中,以便人类和智能体都能看到 QA 计划。基线列表应保持足够广泛,以覆盖: +这些内容有意保存在 git 中,以便人类和智能体都能看到 QA 计划。基线列表应保持足够广泛,以覆盖: - 私信和渠道聊天 - 线程行为 @@ -70,14 +80,14 @@ pnpm qa:lab:watch ## 报告 `qa-lab` 会根据观察到的总线时间线导出 Markdown 协议报告。 -报告应回答以下问题: +该报告应回答: -- 哪些内容有效 +- 哪些内容正常工作 - 哪些内容失败 -- 哪些内容仍然受阻 +- 哪些内容仍被阻塞 - 值得补充哪些后续场景 -对于角色特征和风格检查,请在多个实时模型引用上运行同一场景,并编写一份评判后的 Markdown 报告: +对于角色和风格检查,请在多个实时模型引用上运行同一个场景,并写出一份经评判的 Markdown 报告: ```bash pnpm openclaw qa character-eval \ @@ -96,17 +106,18 @@ pnpm openclaw qa character-eval \ --judge-concurrency 16 ``` -该命令运行的是本地 QA Gateway 网关子进程,而不是 Docker。角色特征评估场景应通过 `SOUL.md` 设置 persona,然后运行普通用户轮次,例如聊天、工作区帮助和小型文件任务。候选模型不应被告知它正在接受评估。该命令会保留每份完整转录、记录基础运行统计信息,然后要求评审模型在快速模式下使用 `xhigh` 推理,按自然度、氛围和幽默感对各次运行进行排序。 -在比较不同提供商时,请使用 `--blind-judge-models`:评审提示仍会获取每份转录和运行状态,但候选引用会被替换为诸如 `candidate-01` 之类的中性标签;报告会在解析后将排序结果映射回真实引用。 -候选运行默认使用 `high` 思考等级,对于支持该选项的 OpenAI 模型则使用 `xhigh`。你可以通过 `--model provider/model,thinking=` 为特定候选项内联覆盖。`--thinking ` 仍可设置全局回退值,而较旧的 `--model-thinking ` 形式也会为兼容性保留。 -OpenAI 候选引用默认使用快速模式,因此在提供商支持时会使用优先处理。若某个候选项或评审模型需要覆盖,可内联添加 `,fast`、`,no-fast` 或 `,fast=false`。仅当你希望为每个候选模型强制启用快速模式时,才传入 `--fast`。候选和评审的耗时都会记录在报告中用于基准分析,但评审提示会明确说明不要按速度进行排序。 -候选和评审模型运行默认都使用 16 的并发度。当提供商限制或本地 Gateway 网关压力导致运行噪声过大时,可降低 `--concurrency` 或 `--judge-concurrency`。 -当未传入候选 `--model` 时,角色特征评估默认使用 +该命令运行的是本地 QA Gateway 网关子进程,而不是 Docker。角色评估场景应通过 `SOUL.md` 设置 persona,然后运行普通用户轮次,例如聊天、工作区帮助和小型文件任务。候选模型不应被告知自己正在接受评估。该命令会保留每份完整转录内容,记录基础运行统计信息,然后要求评判模型在快速模式下以 `xhigh` 推理强度按自然度、氛围和幽默感对这些运行结果进行排序。 +在比较提供商时,请使用 `--blind-judge-models`:评判提示仍会获取每份转录内容和运行状态,但候选引用会被替换为中性标签,例如 `candidate-01`;在解析完成后,报告会将排序结果映射回真实引用。 +候选运行默认使用 `high` 推理强度,对于支持它的 OpenAI 模型则使用 `xhigh`。你可以使用 +`--model provider/model,thinking=` 为特定候选内联覆盖。`--thinking ` 仍会设置全局回退值,而较旧的 `--model-thinking ` 形式会出于兼容性而保留。 +OpenAI 候选引用默认使用快速模式,因此在提供商支持时会启用优先处理。如果某个单独候选或评判需要覆盖,请内联添加 `,fast`、`,no-fast` 或 `,fast=false`。只有当你想为每个候选模型都强制启用快速模式时,才传递 `--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` 时,评审默认使用 +当未传入 `--judge-model` 时,评判默认使用 `openai/gpt-5.4,thinking=xhigh,fast` 和 `anthropic/claude-opus-4-6,thinking=high`。 diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index 37532fa9b..809b7e4c4 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -3,143 +3,160 @@ read_when: - 在本地或 CI 中运行测试 - 为模型 / 提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包:单元测试 / e2e / 实时测试套件、Docker 运行器,以及每类测试覆盖的内容 +summary: 测试工具包:单元 / e2e / 实时测试套件、Docker 运行器,以及每项测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-09T16:02:43Z" + generated_at: "2026-04-09T22:54:34Z" model: gpt-5.4 provider: openai - source_hash: 0aa56e3d0486e90d208b54c4a70e201616cb3d160362a005a902c1295563e3d5 + source_hash: 21b78e59a5189f4e8e6e1b490d350f4735c0395da31d21fc5d10b825313026b4 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三套 Vitest 测试套件(单元 / 集成、e2e、实时测试)以及一小组 Docker 运行器。 +OpenClaw 有三个 Vitest 测试套件(单元 / 集成、e2e、实时)以及一小组 Docker 运行器。 本文档是一份“我们如何测试”的指南: -- 每套测试覆盖什么内容(以及它刻意**不**覆盖什么) -- 常见工作流应运行哪些命令(本地、推送前、调试) +- 每个测试套件覆盖什么(以及它刻意 _不_ 覆盖什么) +- 常见工作流(本地、推送前、调试)应运行哪些命令 - 实时测试如何发现凭证并选择模型 / 提供商 - 如何为真实世界中的模型 / 提供商问题添加回归测试 ## 快速开始 -大多数时候: +大多数情况下: -- 完整门禁(推送前通常应运行):`pnpm build && pnpm check && 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 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` +- 安静地只针对一个实时测试文件:`pnpm test:live -- src/agents/models.profiles.live.test.ts` -提示:如果你只需要一个失败用例,优先使用下文描述的 allowlist 环境变量来缩小实时测试范围。 +提示:当你只需要一个失败用例时,优先使用下面描述的 allowlist 环境变量来缩小实时测试范围。 + +## QA 专用运行器 + +当你需要接近 QA-lab 的真实环境时,这些命令可与主测试套件配合使用: + +- `pnpm openclaw qa suite` + - 直接在主机上运行基于仓库的 QA 场景。 +- `pnpm openclaw qa suite --runner multipass` + - 在一次性 Multipass Linux VM 中运行相同的 QA 测试套件。 + - 保持与主机上 `qa suite` 相同的场景选择行为。 + - 复用与 `qa suite` 相同的提供商 / 模型选择标志。 + - 实时运行会转发对来宾系统切实可行的受支持 QA 认证输入: + 基于环境变量的提供商密钥、QA 实时提供商配置路径,以及存在时的 `CODEX_HOME`。 + - 输出目录必须保持在仓库根目录下,以便来宾系统能够通过挂载的工作区回写。 + - 会在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要以及 Multipass 日志。 +- `pnpm qa:lab:up` + - 启动基于 Docker 的 QA 站点,以供偏操作员风格的 QA 工作使用。 ## 测试套件(各自在哪里运行) -可以把这些测试套件理解为“真实性逐步增加”(同时波动性 / 成本也逐步增加): +可以把这些测试套件理解为“真实度逐步提高”(同时也更容易波动 / 成本更高): ### 单元 / 集成(默认) - 命令:`pnpm test` -- 配置:在现有作用域 Vitest project 上顺序运行十个分片(`vitest.full-*.config.ts`) -- 文件:`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core / 单元测试清单,以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 +- 配置:在现有分域 Vitest 项目上执行十个顺序分片运行(`vitest.full-*.config.ts`) +- 文件:`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元清单,以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 - 范围: - 纯单元测试 - 进程内集成测试(Gateway 网关认证、路由、工具、解析、配置) - - 针对已知缺陷的确定性回归测试 + - 已知缺陷的确定性回归测试 - 预期: - - 在 CI 中运行 + - 会在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 -- Projects 说明: - - 未指定目标的 `pnpm test` 现在会运行 11 个较小的分片配置(`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`),而不是一个巨大的原生 root-project 进程。这样可以降低高负载机器上的峰值 RSS,并避免 auto-reply / 扩展工作挤占无关套件。 - - `pnpm test --watch` 仍然使用原生根级 `vitest.config.ts` project graph,因为多分片监听循环并不现实。 - - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会先将显式文件 / 目录目标路由到作用域 lane,因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整 root project 启动成本。 - - `pnpm test:changed` 会在 diff 只涉及可路由的源码 / 测试文件时,将 Git 变更路径展开到同样的作用域 lane;配置 / setup 编辑仍会回退到更广泛的 root-project 重跑。 - - 部分 `plugin-sdk` 和 `commands` 测试也会通过专用的轻量 lane 路由,并跳过 `test/setup-openclaw-runtime.ts`;有状态 / 运行时较重的文件仍留在现有 lane 中。 - - 部分 `plugin-sdk` 和 `commands` 辅助源码文件也会让 changed 模式运行映射到这些轻量 lane 中的显式同级测试,因此辅助代码修改无需为该目录重跑完整的重型套件。 - - `auto-reply` 现在有三个专用桶:顶层 core 辅助工具、顶层 `reply.*` 集成测试,以及 `src/auto-reply/reply/**` 子树。这使最重的 reply harness 工作不会影响轻量的 status / chunk / token 测试。 -- Embedded runner 说明: - - 当你修改消息工具发现输入或压缩运行时上下文时, - 要同时保留两个层级的覆盖。 +- 项目说明: + - 无目标的 `pnpm test` 现在会运行 11 个更小的分片配置(`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`),而不是一个庞大的原生根项目进程。这样可以降低高负载机器上的峰值 RSS,并避免 auto-reply / 扩展工作拖慢无关的测试套件。 + - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` 项目图,因为多分片监听循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会优先通过分域通道路由显式文件 / 目录目标,因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 可以避免承担完整根项目启动成本。 + - `pnpm test:changed` 会在差异仅涉及可路由的源码 / 测试文件时,将变更的 git 路径展开到相同的分域通道;配置 / 设置修改仍会回退到更宽范围的根项目重跑。 + - 某些 `plugin-sdk` 和 `commands` 测试也会通过专用轻量通道运行,这些通道会跳过 `test/setup-openclaw-runtime.ts`;有状态 / 运行时较重的文件仍留在现有通道中。 + - 某些 `plugin-sdk` 和 `commands` 辅助源码文件也会在 changed 模式运行中映射到这些轻量通道中的显式同级测试,因此辅助文件修改可以避免重新运行该目录的完整重型套件。 + - `auto-reply` 现在有三个专用分桶:顶层核心辅助工具、顶层 `reply.*` 集成测试,以及 `src/auto-reply/reply/**` 子树。这让最重的回复测试框架工作不再影响轻量级的状态 / 分块 / token 测试。 +- 嵌入式运行器说明: + - 当你修改消息工具发现输入或压缩运行时上下文时,请同时保持两层覆盖。 - 为纯路由 / 规范化边界添加聚焦的辅助回归测试。 - - 同时保持嵌入式 runner 集成套件健康: + - 同时也要保持嵌入式运行器集成测试套件健康: `src/agents/pi-embedded-runner/compact.hooks.test.ts`、 `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 和 `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`。 - - 这些套件验证带作用域的 id 和压缩行为仍会通过真实的 `run.ts` / `compact.ts` 路径流动;仅有 helper 测试并不能充分替代这些集成路径。 -- Pool 说明: + - 这些测试套件会验证分域 id 和压缩行为仍然会流经真实的 `run.ts` / `compact.ts` 路径;仅有辅助测试并不足以替代这些集成路径。 +- 池说明: - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置也固定了 `isolate: false`,并在 root projects、e2e 和实时测试配置中使用非隔离 runner。 - - 根级 UI lane 保留其 `jsdom` setup 和 optimizer,但现在也运行在共享的非隔离 runner 上。 + - 共享 Vitest 配置还固定了 `isolate: false`,并在根项目、e2e 和实时配置中使用非隔离运行器。 + - 根 UI 通道保留其 `jsdom` 设置和优化器,但现在也在共享的非隔离运行器上运行。 - 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 - - 共享的 `scripts/run-vitest.mjs` 启动器现在默认还会为 Vitest 子 Node 进程添加 `--no-maglev`,以减少大型本地运行期间的 V8 编译抖动。如果你需要与原始 V8 行为对比,可设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 + - 共享的 `scripts/run-vitest.mjs` 启动器现在还会默认为 Vitest 子 Node 进程添加 `--no-maglev`,以减少大型本地运行期间的 V8 编译抖动。如果你需要与默认 V8 行为对比,请设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 - 本地快速迭代说明: - - `pnpm test:changed` 会在变更路径可清晰映射到较小套件时通过作用域 lane 路由。 + - `pnpm test:changed` 会在变更路径能够清晰映射到较小测试套件时,通过分域通道进行路由。 - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为,只是使用更高的 worker 上限。 - - 本地 worker 自动伸缩现在刻意更保守,并且当宿主机 load average 已经较高时也会回退,因此默认情况下多个并发 Vitest 运行带来的影响更小。 - - 基础 Vitest 配置将 projects / config 文件标记为 `forceRerunTriggers`,这样当测试布线变化时,changed 模式重跑仍然正确。 - - 配置会在受支持主机上保持 `OPENCLAW_VITEST_FS_MODULE_CACHE` 启用;如果你想为直接性能分析指定一个明确的缓存位置,可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - 本地 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` 以来变更的文件。 -- `pnpm test:perf:changed:bench -- --ref ` 会将已提交 diff 的路由 `test:changed` 与原生 root-project 路径进行比较,并打印耗时和 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和 root Vitest 配置,将当前脏工作树的变更文件列表送入路由流程进行基准测试。 - - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动与 transform 开销写出主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件级并行时,为单元测试套件写出 runner CPU + heap profile。 + - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及导入明细输出。 + - `pnpm test:perf:imports:changed` 会将相同的性能分析视图限定到自 `origin/main` 以来发生变化的文件。 +- `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。 -### E2E(Gateway 网关烟雾测试) +### E2E(Gateway 网关冒烟测试) - 命令:`pnpm test:e2e` - 配置:`vitest.e2e.config.ts` - 文件:`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` -- 默认运行时: - - 使用 Vitest `threads`,并启用 `isolate: false`,与仓库其余部分保持一致。 +- 运行时默认值: + - 使用 Vitest `threads` 和 `isolate: false`,与仓库其余部分保持一致。 - 使用自适应 workers(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 接口、节点配对以及更重的网络路径 + - WebSocket / HTTP 接口、节点配对和更重的网络行为 - 预期: - - 在 CI 中运行(当流水线启用时) + - 会在 CI 中运行(当流水线中启用时) - 不需要真实密钥 - - 比单元测试包含更多活动部件(可能更慢) + - 比单元测试有更多可变部件(可能更慢) -### E2E:OpenShell 后端烟雾测试 +### E2E:OpenShell 后端冒烟测试 - 命令:`pnpm test:e2e:openshell` - 文件:`test/openshell-sandbox.e2e.test.ts` - 范围: - - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 + - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 - 从临时本地 Dockerfile 创建一个沙箱 - - 通过真实的 `sandbox ssh-config` + SSH 执行来测试 OpenClaw 的 OpenShell 后端 - - 通过沙箱 fs bridge 验证远程规范文件系统行为 + - 通过真实的 `sandbox ssh-config` + SSH 执行来验证 OpenClaw 的 OpenShell 后端 + - 通过沙箱文件系统桥接验证远程规范文件系统行为 - 预期: - - 仅按需启用;不属于默认的 `pnpm test:e2e` 运行范围 - - 需要本地 `openshell` CLI 和可工作的 Docker daemon + - 仅为选择加入;不属于默认 `pnpm test:e2e` 运行的一部分 + - 需要本地 `openshell` CLI 和可用的 Docker 守护进程 - 使用隔离的 `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 二进制文件或包装脚本 -### 实时测试(真实提供商 + 真实模型) +### 实时(真实提供商 + 真实模型) - 命令:`pnpm test:live` - 配置:`vitest.live.config.ts` @@ -147,140 +164,140 @@ OpenClaw 有三套 Vitest 测试套件(单元 / 集成、e2e、实时测试) - 默认:由 `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 稳定性(真实网络、真实提供商策略、配额、故障) + - 会花钱 / 消耗速率限制 + - 优先运行缩小范围的子集,而不是“全部” +- 实时运行会加载 `~/.profile`,以获取缺失的 API 密钥。 +- 默认情况下,实时运行仍会隔离 `HOME`,并将配置 / 认证材料复制到临时测试主目录中,这样单元测试夹具就不会改动你的真实 `~/.openclaw`。 +- 只有在你明确需要让实时测试使用真实主目录时,才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 +- `pnpm test:live` 现在默认使用更安静的模式:它会保留 `[live] ...` 进度输出,但会抑制额外的 `~/.profile` 提示,并静音 Gateway 网关启动日志 / Bonjour 杂音。如果你想恢复完整启动日志,请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 +- API 密钥轮换(按提供商):设置 `*_API_KEYS`,使用逗号 / 分号格式,或设置 `*_API_KEY_1`、`*_API_KEY_2`(例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`),也可以通过 `OPENCLAW_LIVE_*_KEY` 进行逐项实时覆盖;测试会在收到速率限制响应时重试。 - 进度 / 心跳输出: - - 实时套件现在会向 stderr 输出进度行,因此即使 Vitest 控制台捕获处于安静模式,长时间的提供商调用也能显示仍在活跃。 - - `vitest.live.config.ts` 禁用了 Vitest 控制台拦截,因此提供商 / Gateway 网关进度行会在实时运行期间立即流式输出。 - - 可使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整 direct-model 心跳。 - - 可使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探测心跳。 + - 实时测试套件现在会将进度行输出到 stderr,因此即使 Vitest 控制台捕获较安静,长时间的提供商调用也能明显看出仍在运行。 + - `vitest.live.config.ts` 会禁用 Vitest 控制台拦截,以便提供商 / Gateway 网关进度行在实时运行期间立即流式输出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳。 + - 使用 `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` +- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用:运行缩小范围的 `pnpm test:live` -## 实时测试:Android 节点能力扫描 +## 实时:Android 节点能力扫描 - 测试:`src/gateway/android-node.capabilities.live.test.ts` - 脚本:`pnpm android:test:integration` -- 目标:调用已连接 Android 节点当前**通告的每一条命令**,并断言命令契约行为。 +- 目标:调用已连接 Android 节点当前**声明的每一个命令**,并断言命令契约行为。 - 范围: - - 已预设 / 需手动准备(该套件不会安装 / 运行 / 配对应用)。 - - 针对所选 Android 节点,逐命令验证 Gateway 网关 `node.invoke`。 -- 必要预先设置: - - Android 应用已连接并与 Gateway 网关配对。 + - 预先准备 / 手动设置(该测试套件不会安装 / 运行 / 配对应用)。 + - 针对所选 Android 节点逐命令验证 Gateway 网关 `node.invoke`。 +- 必需的预先设置: + - Android 应用已连接并与 Gateway 网关完成配对。 - 应用保持在前台。 - - 你预期应通过的能力所需权限 / 捕获授权已授予。 -- 可选目标覆盖项: + - 你希望通过的能力对应的权限 / 捕获授权已授予。 +- 可选目标覆盖: - `OPENCLAW_ANDROID_NODE_ID` 或 `OPENCLAW_ANDROID_NODE_NAME`。 - `OPENCLAW_ANDROID_GATEWAY_URL` / `OPENCLAW_ANDROID_GATEWAY_TOKEN` / `OPENCLAW_ANDROID_GATEWAY_PASSWORD`。 -- 完整 Android 设置详情: [Android App](/zh-CN/platforms/android) +- 完整 Android 设置详情:[Android App](/zh-CN/platforms/android) -## 实时测试:模型烟雾测试(profile keys) +## 实时:模型冒烟测试(profile 密钥) -实时测试被拆分成两层,以便我们隔离故障: +实时测试分为两层,这样我们就可以隔离故障: -- “Direct model” 用来告诉我们该提供商 / 模型是否能用给定密钥正常响应。 -- “Gateway smoke” 用来告诉我们完整的 Gateway 网关 + 智能体流水线是否对该模型工作正常(会话、历史、工具、沙箱策略等)。 +- “直接模型”告诉我们,给定密钥下该提供商 / 模型是否至少能响应。 +- “Gateway 网关冒烟测试”告诉我们,针对该模型,完整的 Gateway 网关 + 智能体管线是否正常工作(会话、历史、工具、沙箱策略等)。 -### 第 1 层:Direct model completion(无 Gateway 网关) +### 第 1 层:直接模型补全(无 Gateway 网关) - 测试:`src/agents/models.profiles.live.test.ts` - 目标: - 枚举已发现的模型 - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 - - 对每个模型运行一次小型 completion(并在需要时运行有针对性的回归测试) -- 如何启用: - - `pnpm test:live`(或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`) -- 设置 `OPENCLAW_LIVE_MODELS=modern`(或 `all`,即 `modern` 的别名)后才会真正运行此套件;否则它会跳过,以便让 `pnpm test:live` 聚焦于 Gateway 网关烟雾测试 + - 对每个模型运行一个小型补全(并在需要时运行定向回归测试) +- 启用方式: + - `pnpm test:live`(或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`) +- 设置 `OPENCLAW_LIVE_MODELS=modern`(或 `all`,即 modern 的别名)后才会实际运行该测试套件;否则会跳过,以便让 `pnpm test:live` 聚焦于 Gateway 网关冒烟测试 - 如何选择模型: - - `OPENCLAW_LIVE_MODELS=modern`:运行现代 allowlist(Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4) - - `OPENCLAW_LIVE_MODELS=all`:现代 allowlist 的别名 - - 或者 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`(逗号分隔的 allowlist) - - modern / all 扫描默认有一个精心筛选的高信号上限;设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行完整的现代模型扫描,或设置为正数以使用较小上限。 + - `OPENCLAW_LIVE_MODELS=modern` 运行 modern allowlist(Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4) + - `OPENCLAW_LIVE_MODELS=all` 是 modern allowlist 的别名 + - 或 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`(逗号分隔的 allowlist) + - modern / all 扫描默认有一个精心挑选的高信号上限;设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可进行完整的 modern 扫描,或设置为正数以使用更小的上限。 - 如何选择提供商: - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`(逗号分隔的 allowlist) - 密钥来源: - - 默认:profile store 和环境变量回退 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 以强制**仅**使用 profile store -- 为什么需要它: - - 将“提供商 API 已损坏 / 密钥无效”与“Gateway 网关智能体流水线已损坏”区分开来 - - 包含小型、隔离的回归测试(例如:OpenAI Responses / Codex Responses 推理重放 + 工具调用流程) + - 默认:profile 存储和环境变量回退 + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 以强制**仅**使用 profile 存储 +- 存在原因: + - 将“提供商 API 已损坏 / 密钥无效”与“Gateway 网关智能体管线损坏”分离 + - 容纳小型、隔离的回归测试(例如:OpenAI Responses / Codex Responses 推理回放 + 工具调用流程) -### 第 2 层:Gateway 网关 + dev 智能体烟雾测试(也就是 “@openclaw” 实际执行的内容) +### 第 2 层:Gateway 网关 + dev 智能体冒烟测试(即 “@openclaw” 实际执行的内容) - 测试:`src/gateway/gateway-models.profiles.live.test.ts` - 目标: - 启动一个进程内 Gateway 网关 - 创建 / 修补一个 `agent:dev:*` 会话(每次运行按模型覆盖) - - 遍历带密钥的模型,并断言: - - 有“有意义”的响应(不使用工具) - - 一次真实的工具调用可正常工作(read 探测) - - 可选的额外工具探测(exec+read 探测) - - OpenAI 回归路径(仅工具调用 → 后续跟进)保持可用 -- 探测细节(这样你能更快解释故障): - - `read` 探测:测试会在工作区写入一个 nonce 文件,并要求智能体读取它并回显该 nonce。 - - `exec+read` 探测:测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件,然后再将其 `read` 读回。 + - 遍历有密钥的模型并断言: + - “有意义”的响应(无工具) + - 一次真实工具调用可正常工作(读取探测) + - 可选的额外工具探测(执行 + 读取探测) + - OpenAI 回归路径(仅工具调用 → 后续跟进)持续可用 +- 探测细节(这样你可以快速解释故障): + - `read` 探测:测试会在工作区中写入一个 nonce 文件,并要求智能体 `read` 它并回显该 nonce。 + - `exec+read` 探测:测试会要求智能体通过 `exec` 将 nonce 写入临时文件,然后再将其 `read` 回来。 - 图像探测:测试会附加一个生成的 PNG(猫 + 随机代码),并期望模型返回 `cat `。 - 实现参考:`src/gateway/gateway-models.profiles.live.test.ts` 和 `src/gateway/live-image-probe.ts`。 -- 如何启用: - - `pnpm test:live`(或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`) +- 启用方式: + - `pnpm test:live`(或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`) - 如何选择模型: - - 默认:现代 allowlist(Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4) - - `OPENCLAW_LIVE_GATEWAY_MODELS=all`:现代 allowlist 的别名 - - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`(或逗号列表)以缩小范围 - - modern / all Gateway 网关扫描默认有一个精心筛选的高信号上限;设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行完整的现代模型扫描,或设置为正数以使用较小上限。 -- 如何选择提供商(避免“OpenRouter 全都跑”): + - 默认: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"`(逗号分隔的 allowlist) -- 工具 + 图像探测在这个实时测试中始终开启: +- 工具 + 图像探测在该实时测试中始终启用: - `read` 探测 + `exec+read` 探测(工具压力测试) - 当模型声明支持图像输入时,会运行图像探测 - 流程(高层级): - - 测试生成一个带有 “CAT” + 随机代码的小型 PNG(`src/gateway/live-image-probe.ts`) + - 测试会生成一个带有 “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) +## 实时: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` - - command / args / 图像行为来自所属 CLI 后端插件元数据。 + - 命令 / 参数 / 图像行为来自所属 CLI 后端插件元数据。 - 覆盖项(可选): - `OPENCLAW_LIVE_CLI_BACKEND_MODEL="codex-cli/gpt-5.4"` - `OPENCLAW_LIVE_CLI_BACKEND_COMMAND="/full/path/to/codex"` - `OPENCLAW_LIVE_CLI_BACKEND_ARGS='["exec","--json","--color","never","--sandbox","read-only","--skip-git-repo-check"]'` - - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1`:发送真实图像附件(路径会注入到提示词中)。 - - `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`:发送第二轮对话并验证 resume 流程。 - - `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` 可强制启用)。 示例: @@ -290,13 +307,13 @@ OPENCLAW_LIVE_CLI_BACKEND=1 \ pnpm test:live src/gateway/gateway-cli-backend.live.test.ts ``` -Docker 用法: +Docker 配方: ```bash pnpm test:docker:live-cli-backend ``` -单提供商 Docker 用法: +单提供商 Docker 配方: ```bash pnpm test:docker:live-cli-backend:claude @@ -307,19 +324,19 @@ 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`)。 -- 实时 CLI 后端烟雾测试现在会为 Claude、Codex 和 Gemini 执行相同的端到端流程:文本轮次、图像分类轮次,然后通过 Gateway 网关 CLI 验证 MCP `cron` 工具调用。 -- Claude 的默认烟雾测试还会将会话从 Sonnet 修补到 Opus,并验证恢复后的会话仍然记得更早的备注。 +- 它会在仓库 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`)。 +- 实时 CLI 后端冒烟测试现在会对 Claude、Codex 和 Gemini 执行相同的端到端流程:文本轮次、图像分类轮次,然后通过 Gateway 网关 CLI 验证 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet 修补为 Opus,并验证恢复后的会话仍记得之前的备注。 -## 实时测试:ACP 绑定烟雾测试(`/acp spawn ... --bind here`) +## 实时:ACP 绑定冒烟测试(`/acp spawn ... --bind here`) - 测试:`src/gateway/gateway-acp-bind.live.test.ts` -- 目标:通过一个实时 ACP 智能体验证真实的 ACP conversation-bind 流程: +- 目标:使用实时 ACP 智能体验证真实的 ACP 会话绑定流程: - 发送 `/acp spawn --bind here` - - 原地绑定一个合成的消息渠道会话 - - 在同一会话上发送一次普通后续消息 - - 验证该后续消息会进入已绑定的 ACP 会话 transcript + - 就地绑定一个合成的消息渠道会话 + - 在同一个会话上发送普通后续消息 + - 验证后续消息落在已绑定的 ACP 会话转录中 - 启用: - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` @@ -335,8 +352,8 @@ pnpm test:docker:live-cli-backend:gemini - `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude,codex,gemini` - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - 说明: - - 此 lane 使用 Gateway 网关 `chat.send` 接口,并带有仅管理员可用的合成 originating-route 字段,这样测试就可以附加消息渠道上下文,而无需假装向外部实际投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时,测试会使用内置 `acpx` 插件的内建智能体注册表来处理所选 ACP harness 智能体。 + - 该通道使用 Gateway 网关 `chat.send` 接口,并带有仅管理员可用的合成来源路由字段,因此测试可以附加消息渠道上下文,而无需假装进行外部投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时,测试会对所选 ACP 测试智能体使用内置 `acpx` 插件的内建智能体注册表。 示例: @@ -346,13 +363,13 @@ OPENCLAW_LIVE_ACP_BIND=1 \ pnpm test:live src/gateway/gateway-acp-bind.live.test.ts ``` -Docker 用法: +Docker 配方: ```bash pnpm test:docker:live-acp-bind ``` -单智能体 Docker 用法: +单智能体 Docker 配方: ```bash pnpm test:docker:live-acp-bind:claude @@ -363,22 +380,22 @@ pnpm test:docker:live-acp-bind:gemini 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。 +- 默认情况下,它会按顺序对所有受支持的实时 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 的提供商环境变量继续可用于子测试 CLI。 -### 推荐的实时测试用法 +### 推荐的实时测试配方 -范围小且明确的 allowlist 最快,也最不容易波动: +范围窄、显式的 allowlist 速度最快,也最不容易波动: -- 单模型,direct(无 Gateway 网关): +- 单模型,直接模式(无 Gateway 网关): - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` -- 单模型,Gateway 网关烟雾测试: +- 单模型,Gateway 网关冒烟测试: - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 多个提供商上的工具调用: +- 跨多个提供商的工具调用: - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - 聚焦 Google(Gemini API 密钥 + Antigravity): @@ -388,19 +405,19 @@ Docker 说明: 说明: - `google/...` 使用 Gemini API(API 密钥)。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge(Cloud Code Assist 风格的智能体端点)。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI(单独的认证 + 工具行为怪癖)。 +- `google-antigravity/...` 使用 Antigravity OAuth 桥接(Cloud Code Assist 风格的智能体端点)。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI(独立的认证 + 工具行为差异)。 - Gemini API 与 Gemini CLI: - - API:OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API(API 密钥 / profile 认证);这通常就是大多数用户所说的 “Gemini”。 - - CLI:OpenClaw 会 shell out 到本地 `gemini` 二进制;它有自己的认证方式,而且行为可能不同(流式传输 / 工具支持 / 版本偏差)。 + - API:OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API(API 密钥 / profile 认证);这通常是大多数用户所说的 “Gemini”。 + - CLI:OpenClaw 会调用本地 `gemini` 二进制;它有自己的认证方式,并且行为可能不同(流式传输 / 工具支持 / 版本偏差)。 -## 实时测试:模型矩阵(我们覆盖什么) +## 实时:模型矩阵(我们覆盖什么) -没有固定的“CI 模型列表”(实时测试是按需启用的),但以下是**推荐**在带有密钥的开发机器上定期覆盖的模型。 +没有固定的“CI 模型列表”(实时测试是可选启用的),但以下是在开发机器具备密钥时,**推荐**定期覆盖的模型。 -### 现代烟雾测试集(工具调用 + 图像) +### 现代冒烟测试集(工具调用 + 图像) -这是我们期望持续保持可用的“常用模型”运行集: +这是我们预期应持续可用的“常见模型”运行集: - OpenAI(非 Codex):`openai/gpt-5.4`(可选:`openai/gpt-5.4-mini`) - OpenAI Codex:`openai-codex/gpt-5.4` @@ -410,12 +427,12 @@ Docker 说明: - 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.4,anthropic/claude-opus-4-6,google/gemini-3.1-pro-preview,google/gemini-3-flash-preview,google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-flash,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` ### 基线:工具调用(Read + 可选 Exec) -每个提供商家族至少选择一个: +每个提供商系列至少选择一个: - OpenAI:`openai/gpt-5.4`(或 `openai/gpt-5.4-mini`) - Anthropic:`anthropic/claude-opus-4-6`(或 `anthropic/claude-sonnet-4-6`) @@ -423,44 +440,44 @@ 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 模式) ### 视觉:图像发送(附件 → 多模态消息) -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型(Claude / Gemini / 支持视觉的 OpenAI 变体等),以运行图像探测。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型(Claude / Gemini / OpenAI 支持视觉的变体等),以触发图像探测。 ### 聚合器 / 替代 Gateway 网关 -如果你已启用相应密钥,我们也支持通过以下方式进行测试: +如果你启用了相关密钥,我们也支持通过以下方式测试: - OpenRouter:`openrouter/...`(数百个模型;使用 `openclaw models scan` 查找支持工具 + 图像的候选项) -- OpenCode:`opencode/...` 用于 Zen,`opencode-go/...` 用于 Go(通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证) +- OpenCode:Zen 使用 `opencode/...`,Go 使用 `opencode-go/...`(通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证) -如果你有凭证 / 配置,还可以把更多提供商加入实时测试矩阵: +你还可以将更多提供商纳入实时矩阵中(如果你有凭证 / 配置): - 内置:`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 完全相同。实际含义如下: +实时测试发现凭证的方式与 CLI 相同。实际含义如下: -- 如果 CLI 可用,实时测试通常也应能找到相同的密钥。 -- 如果某个实时测试提示“没有凭证”,请按调试 `openclaw models list` / 模型选择的同样方式来调试。 +- 如果 CLI 能工作,实时测试通常也能找到相同的密钥。 +- 如果实时测试提示“没有凭证”,就按调试 `openclaw models list` / 模型选择的方式来调试。 -- 按智能体区分的认证 profile:`~/.openclaw/agents//agent/auth-profiles.json`(这就是实时测试中 “profile keys” 的含义) +- 每个智能体的认证 profile:`~/.openclaw/agents//agent/auth-profiles.json`(这就是实时测试中 “profile keys” 的含义) - 配置:`~/.openclaw/openclaw.json`(或 `OPENCLAW_CONFIG_PATH`) -- 旧版状态目录:`~/.openclaw/credentials/`(如果存在,会复制到暂存的实时测试 home 中,但它不是主要的 profile-key store) -- 默认情况下,本地实时运行会把当前活动配置、各智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home;暂存的实时测试 home 会跳过 `workspace/` 和 `sandboxes/`,并去除 `agents.*.workspace` / `agentDir` 路径覆盖,这样探测就不会触碰你宿主机上的真实工作区。 +- 旧版状态目录:`~/.openclaw/credentials/`(存在时会复制到暂存的实时测试主目录中,但它不是主 profile-key 存储) +- 本地实时运行默认会将当前配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试主目录中;暂存的实时测试主目录会跳过 `workspace/` 和 `sandboxes/`,并移除 `agents.*.workspace` / `agentDir` 路径覆盖,这样探测就不会落到你的真实主机工作区上。 -如果你想依赖环境变量密钥(例如导出在你的 `~/.profile` 中),请在执行本地测试前先运行 `source ~/.profile`,或使用下面的 Docker 运行器(它们可以把 `~/.profile` 挂载进容器)。 +如果你想依赖环境变量密钥(例如导出在你的 `~/.profile` 中),请在执行本地测试前运行 `source ~/.profile`,或者使用下面的 Docker 运行器(它们可以将 `~/.profile` 挂载到容器中)。 ## Deepgram 实时测试(音频转录) @@ -478,19 +495,19 @@ Docker 说明: - 测试:`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` 路径 + - 验证内置 comfy 图像、视频和 `music_generate` 路径 - 除非配置了 `models.providers.comfy.`,否则会跳过各项能力 - - 在修改 comfy 工作流提交、轮询、下载或插件注册后非常有用 + - 在修改 comfy 工作流提交、轮询、下载或插件注册后特别有用 ## 图像生成实时测试 - 测试:`src/image-generation/runtime.live.test.ts` - 命令:`pnpm test:live src/image-generation/runtime.live.test.ts` -- Harness:`pnpm test:live:media image` +- 测试框架:`pnpm test:live:media image` - 范围: - 枚举每个已注册的图像生成提供商插件 - 在探测前从你的登录 shell(`~/.profile`)加载缺失的提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥,而不是已存储的认证 profile,这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 默认优先使用实时 / 环境变量 API 密钥,而不是已存储的认证 profile,这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实 shell 凭证 - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体: - `google:flash-generate` @@ -505,70 +522,70 @@ Docker 说明: - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-1,google/gemini-3.1-flash-image-preview"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit"` - 可选认证行为: - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`:强制使用 profile store 认证,并忽略仅环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证并忽略仅环境变量覆盖 ## 音乐生成实时测试 - 测试:`extensions/music-generation-providers.live.test.ts` - 启用:`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` -- Harness:`pnpm test:live:media music` +- 测试框架:`pnpm test:live:media music` - 范围: - - 测试共享的内置音乐生成提供商路径 + - 验证共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - 在探测前从你的登录 shell(`~/.profile`)加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥,而不是已存储的认证 profile,这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 默认优先使用实时 / 环境变量 API 密钥,而不是已存储的认证 profile,这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实 shell 凭证 - 跳过没有可用认证 / profile / 模型的提供商 - - 在可用时运行两种已声明的运行时模式: - - `generate`:仅提示词输入 - - `edit`:当提供商声明 `capabilities.edit.enabled` 时 - - 当前共享 lane 覆盖: + - 在可用时运行两个已声明的运行时模式: + - `generate`,仅使用提示输入 + - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` + - 当前共享通道覆盖: - `google`:`generate`、`edit` - `minimax`:`generate` - - `comfy`:单独的 Comfy 实时测试文件,不属于这次共享扫描 + - `comfy`:单独的 Comfy 实时测试文件,不在该共享扫描中 - 可选缩小范围: - `OPENCLAW_LIVE_MUSIC_GENERATION_PROVIDERS="google,minimax"` - `OPENCLAW_LIVE_MUSIC_GENERATION_MODELS="google/lyria-3-clip-preview,minimax/music-2.5+"` - 可选认证行为: - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`:强制使用 profile store 认证,并忽略仅环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证并忽略仅环境变量覆盖 ## 视频生成实时测试 - 测试:`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` +- 测试框架:`pnpm test:live:media video` - 范围: - - 测试共享的内置视频生成提供商路径 + - 验证共享的内置视频生成提供商路径 - 在探测前从你的登录 shell(`~/.profile`)加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥,而不是已存储的认证 profile,这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 默认优先使用实时 / 环境变量 API 密钥,而不是已存储的认证 profile,这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实 shell 凭证 - 跳过没有可用认证 / profile / 模型的提供商 - - 在可用时运行两种已声明的运行时模式: - - `generate`:仅提示词输入 - - `imageToVideo`:当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时 - - `videoToVideo`:当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时 - - 当前在共享扫描中已声明但会跳过的 `imageToVideo` 提供商: - - `vydra`,因为内置 `veo3` 仅支持文本,且内置 `kling` 需要远程图像 URL + - 在可用时运行两个已声明的运行时模式: + - `generate`,仅使用提示输入 + - 当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时运行 `imageToVideo` + - 当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时运行 `videoToVideo` + - 当前在共享扫描中已声明但被跳过的 `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 fixture 的 `kling` lane + - 该文件会运行 `veo3` 文本转视频,以及一个默认使用远程图像 URL 固定夹具的 `kling` 通道 - 当前 `videoToVideo` 实时覆盖: - 仅 `runway`,且所选模型为 `runway/gen4_aleph` 时 - - 当前在共享扫描中已声明但会跳过的 `videoToVideo` 提供商: + - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商: - `alibaba`、`qwen`、`xai`,因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - - `google`,因为当前共享的 Gemini / Veo lane 使用基于本地 buffer 的输入,而该路径在共享扫描中不被接受 - - `openai`,因为当前共享 lane 无法保证组织特定的视频修补 / remix 访问权限 + - `google`,因为当前共享 Gemini / Veo 通道使用基于本地 buffer 的输入,而该路径在共享扫描中不被接受 + - `openai`,因为当前共享通道无法保证具备组织特定的视频修补 / remix 访问权限 - 可选缩小范围: - `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="google,openai,runway"` - `OPENCLAW_LIVE_VIDEO_GENERATION_MODELS="google/veo-3.1-fast-generate-preview,openai/sora-2,runway/gen4_aleph"` - 可选认证行为: - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`:强制使用 profile store 认证,并忽略仅环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证并忽略仅环境变量覆盖 -## 媒体实时测试 Harness +## 媒体实时测试框架 - 命令:`pnpm test:live:media` - 目的: - 通过一个仓库原生入口运行共享的图像、音乐和视频实时测试套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个套件缩小到当前具有可用认证的提供商 + - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 - 复用 `scripts/test-live.mjs`,因此心跳和静默模式行为保持一致 - 示例: - `pnpm test:live:media` @@ -578,163 +595,162 @@ Docker 说明: ## Docker 运行器(可选的“在 Linux 中可用”检查) -这些 Docker 运行器分为两类: +这些 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 扫描仍然可行: - `test:docker:live-models` 默认使用 `OPENCLAW_LIVE_MAX_MODELS=12`,并且 - `test:docker:live-gateway` 默认使用 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 +- 实时模型运行器:`test:docker:live-models` 和 `test:docker:live-gateway` 仅在仓库 Docker 镜像内运行各自匹配的 profile-key 实时测试文件(`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`),并挂载你的本地配置目录和工作区(如果已挂载,也会加载 `~/.profile`)。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 +- Docker 实时运行器默认使用较小的冒烟测试上限,以便完整的 Docker 扫描仍然切实可行: + `test:docker:live-models` 默认设置 `OPENCLAW_LIVE_MAX_MODELS=12`,而 + `test:docker:live-gateway` 默认设置 `OPENCLAW_LIVE_GATEWAY_SMOKE=1`、 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=8`、 - `OPENCLAW_LIVE_GATEWAY_STEP_TIMEOUT_MS=45000` 以及 - `OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。当你 - 明确想执行更大范围的完整扫描时,可覆盖这些环境变量。 -- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次实时测试 Docker 镜像,然后在两个 Docker 实时 lane 中复用该镜像。 -- 容器烟雾测试运行器:`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels` 和 `test:docker:plugins` 会启动一个或多个真实容器,并验证更高层级的集成路径。 + `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:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels` 和 `test:docker:plugins` 会启动一个或多个真实容器,并验证更高层级的集成路径。 -实时模型 Docker 运行器还会仅 bind mount 所需的 CLI 认证 home(如果未缩小范围,则挂载所有受支持项),然后在运行前将它们复制到容器 home 中,这样外部 CLI OAuth 就能刷新令牌,而不会修改宿主机认证存储: +实时模型 Docker 运行器还会仅绑定挂载所需的 CLI 认证主目录(如果运行未缩小范围,则挂载所有受支持的目录),然后在运行前将其复制到容器主目录中,这样外部 CLI OAuth 就能刷新令牌,而不会改动主机认证存储: -- Direct models:`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`) +- 直接模型:`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`) - Gateway 网关 + dev 智能体:`pnpm test:docker:live-gateway`(脚本:`scripts/test-live-gateway-models-docker.sh`) -- Open WebUI 实时烟雾测试:`pnpm test:docker:openwebui`(脚本:`scripts/e2e/openwebui-docker.sh`) +- Open WebUI 实时冒烟测试:`pnpm test:docker:openwebui`(脚本:`scripts/e2e/openwebui-docker.sh`) - 新手引导向导(TTY,完整脚手架):`pnpm test:docker:onboard`(脚本:`scripts/e2e/onboard-docker.sh`) - Gateway 网关网络(两个容器,WS 认证 + 健康检查):`pnpm test:docker:gateway-network`(脚本:`scripts/e2e/gateway-network-docker.sh`) -- MCP 渠道桥接(已注入数据的 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 烟雾测试):`pnpm test:docker:mcp-channels`(脚本:`scripts/e2e/mcp-channels-docker.sh`) -- 插件(安装烟雾测试 + `/plugin` 别名 + Claude bundle 重启语义):`pnpm test:docker:plugins`(脚本:`scripts/e2e/plugins-docker.sh`) +- MCP 渠道桥接(带种子数据的 Gateway 网关 + stdio bridge + 原始 Claude 通知帧冒烟测试):`pnpm test:docker:mcp-channels`(脚本:`scripts/e2e/mcp-channels-docker.sh`) +- 插件(安装冒烟测试 + `/plugin` 别名 + Claude 内置包重启语义):`pnpm test:docker:plugins`(脚本:`scripts/e2e/plugins-docker.sh`) -实时模型 Docker 运行器还会以只读方式 bind mount 当前 checkout, -并将其暂存到容器内的临时工作目录中。这样既能保持运行时 -镜像精简,又仍然可以针对你本地的确切源码 / 配置运行 Vitest。 -暂存步骤会跳过较大的本地专用缓存和应用构建输出,例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__` 以及应用本地的 `.build` 或 +实时模型 Docker 运行器还会以只读方式绑定挂载当前检出内容, +并将其暂存到容器内的临时工作目录中。这样可以在保持运行时 +镜像精简的同时,仍然针对你当前本地的精确源码 / 配置运行 Vitest。 +暂存步骤会跳过大型本地专用缓存和应用构建输出,例如 +`.pnpm-store`、`.worktrees`、`__openclaw_vitest__` 以及应用本地 `.build` 或 Gradle 输出目录,因此 Docker 实时运行不会花费数分钟去复制 -与机器相关的产物。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`,这样 Gateway 网关实时探测就不会在容器内启动 -真实的 Telegram / Discord / 等渠道 worker。 -`test:docker:live-models` 仍然运行 `pnpm test:live`,因此当你需要缩小范围或排除 -该 Docker lane 中的 Gateway 网关实时覆盖时,也要一并传入 +与机器相关的构件。 +它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`,这样 Gateway 网关实时探测就不会在 +容器内启动真实的 Telegram / Discord / 等渠道 worker。 +`test:docker:live-models` 仍然运行 `pnpm test:live`,因此当你需要缩小范围 +或从该 Docker 通道中排除 Gateway 网关实时覆盖时,也请同时传入 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是更高层级的兼容性烟雾测试:它会启动一个 +`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试:它会启动一个 启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器, -再针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器,通过 -Open WebUI 完成登录,验证 `/api/models` 暴露了 `openclaw/default`,然后通过 -Open WebUI 的 `/api/chat/completions` 代理发送一个真实的聊天请求。 +针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器,通过 +Open WebUI 登录,验证 `/api/models` 暴露出 `openclaw/default`,然后通过 +Open WebUI 的 `/api/chat/completions` 代理发送一次真实聊天请求。 首次运行可能会明显更慢,因为 Docker 可能需要拉取 -Open WebUI 镜像,而且 Open WebUI 可能还需要完成自身的冷启动设置。 -这个 lane 需要可用的实时模型密钥,而 `OPENCLAW_PROFILE_FILE` +Open WebUI 镜像,而 Open WebUI 也可能需要完成自身的冷启动设置。 +该通道需要可用的实时模型密钥,且 `OPENCLAW_PROFILE_FILE` (默认是 `~/.profile`)是在 Docker 化运行中提供它的主要方式。 -成功运行会打印一个小型 JSON 负载,例如 `{ "ok": true, "model": +成功运行会打印一个小型 JSON 载荷,例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是刻意保持确定性的,不需要 -真实的 Telegram、Discord 或 iMessage 账号。它会启动一个已注入数据的 Gateway 网关 -容器,再启动第二个容器来运行 `openclaw mcp serve`,然后 -验证路由后的会话发现、transcript 读取、附件元数据、 -实时事件队列行为、出站发送路由,以及类 Claude 的渠道 + +`test:docker:mcp-channels` 是刻意设计为确定性的,不需要 +真实的 Telegram、Discord 或 iMessage 账号。它会启动一个带种子数据的 Gateway 网关 +容器,启动第二个会生成 `openclaw mcp serve` 的容器,然后 +验证路由会话发现、转录读取、附件元数据、 +实时事件队列行为、出站发送路由,以及 Claude 风格的渠道 + 权限通知在真实 stdio MCP bridge 上的行为。通知检查 -会直接检查原始 stdio MCP 帧,因此这个烟雾测试验证的是 -bridge 实际发出的内容,而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 +会直接检查原始 stdio MCP 帧,因此这个冒烟测试验证的是 bridge 实际发出的内容, +而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 -手动 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_CLI_TOOLS_DIR=...`(默认:`~/.cache/openclaw/docker-cli-tools`),挂载到 `/home/node/.npm-global`,用于 Docker 内缓存 CLI 安装 +- `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_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_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...`:在容器内筛选提供商 -- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`:确保凭证来自 profile store(而非环境变量) -- `OPENCLAW_OPENWEBUI_MODEL=...`:选择 Gateway 网关为 Open WebUI 烟雾测试暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...`:覆盖 Open WebUI 烟雾测试使用的 nonce 检查提示词 -- `OPENWEBUI_IMAGE=...`:覆盖固定的 Open WebUI 镜像标签 + - 缩小到特定提供商的运行只会挂载根据 `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_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile 存储(而非环境变量) +- `OPENCLAW_OPENWEBUI_MODEL=...` 选择暴露给 Open WebUI 冒烟测试的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示 +- `OPENWEBUI_IMAGE=...` 覆盖固定的 Open WebUI 镜像标签 ## 文档完整性检查 -编辑文档后运行文档检查:`pnpm check:docs`。 -当你还需要页内标题检查时,运行完整的 Mintlify anchor 验证:`pnpm docs:check-links:anchors`。 +修改文档后运行文档检查:`pnpm check:docs`。 +当你还需要完整的 Mintlify 锚点校验,包括页内标题检查时,运行:`pnpm docs:check-links:anchors`。 ## 离线回归测试(CI 安全) -这些是在不依赖真实提供商的情况下,对“真实流水线”进行的回归测试: +这些是在没有真实提供商的情况下,对“真实管线”进行的回归测试: - Gateway 网关工具调用(模拟 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`)。 +- 验证会话接线和配置效果的端到端向导流程(`src/gateway/gateway.test.ts`)。 -对于 Skills,当前仍缺少的内容(见 [Skills](/zh-CN/tools/skills)): +对于 Skills,当前仍缺少的内容(参见 [Skills](/zh-CN/tools/skills)): -- **决策**:当 Skills 列在提示词中时,智能体是否会选择正确的 skill(或避开无关的 skill)? -- **合规性**:智能体是否会在使用前读取 `SKILL.md`,并遵循要求的步骤 / 参数? -- **工作流契约**:断言工具顺序、会话历史继承和沙箱边界的多轮场景。 +- **决策能力:** 当提示中列出 Skills 时,智能体是否会选择正确的 Skill(或避免选择无关的 Skill)? +- **合规性:** 智能体是否会在使用前读取 `SKILL.md`,并遵循必需的步骤 / 参数? +- **工作流契约:** 断言工具顺序、会话历史延续以及沙箱边界的多轮场景。 -未来的评估应先保持确定性: +未来的评估应首先保持确定性: -- 一个使用模拟提供商的场景运行器,用于断言工具调用 + 顺序、skill 文件读取和会话布线。 -- 一小组聚焦 skill 的场景(使用与避免、门禁、提示注入)。 -- 仅在 CI 安全套件就位之后,才添加可选的实时评估(按需启用、受环境变量门控)。 +- 一个使用模拟提供商的场景运行器,用于断言工具调用 + 顺序、Skill 文件读取以及会话接线。 +- 一小组聚焦 Skill 的场景(使用与避免、门控、提示注入)。 +- 只有在 CI 安全套件就位之后,才添加可选的实时评估(选择启用、由环境变量控制)。 ## 契约测试(插件和渠道形状) 契约测试用于验证每个已注册插件和渠道都符合其 接口契约。它们会遍历所有已发现的插件,并运行一组 -针对结构和行为的断言。默认的 `pnpm test` 单元 lane 会刻意 -跳过这些共享 seam 和烟雾测试文件;当你修改共享渠道或提供商表面时, -请显式运行这些契约命令。 +形状和行为断言。默认的 `pnpm test` 单元通道会刻意 +跳过这些共享接缝和冒烟测试文件;当你修改共享渠道或提供商表面时, +请显式运行契约命令。 ### 命令 - 所有契约测试:`pnpm test:contracts` -- 仅渠道契约测试:`pnpm test:contracts:channels` -- 仅提供商契约测试:`pnpm test:contracts:plugins` +- 仅渠道契约:`pnpm test:contracts:channels` +- 仅提供商契约:`pnpm test:contracts:plugins` -### 渠道契约测试 +### 渠道契约 位于 `src/channels/plugins/contracts/*.contract.test.ts`: -- **plugin** - 基本插件结构(id、名称、能力) +- **plugin** - 基本插件形状(id、name、capabilities) - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 -- **outbound-payload** - 消息负载结构 +- **outbound-payload** - 消息载荷结构 - **inbound** - 入站消息处理 -- **actions** - 渠道操作处理器 +- **actions** - 渠道动作处理器 - **threading** - 线程 ID 处理 - **directory** - 目录 / roster API - **group-policy** - 群组策略执行 -### 提供商状态契约测试 +### 提供商状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 -- **registry** - 插件注册表结构 +- **registry** - 插件注册表形状 -### 提供商契约测试 +### 提供商契约 位于 `src/plugins/contracts/*.contract.test.ts`: - **auth** - 认证流程契约 -- **auth-choice** - 认证选项 / 选择 +- **auth-choice** - 认证选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 - **runtime** - 提供商运行时 -- **shape** - 插件结构 / 接口 +- **shape** - 插件形状 / 接口 - **wizard** - 设置向导 ### 何时运行 @@ -745,15 +761,15 @@ bridge 实际发出的内容,而不仅仅是某个特定客户端 SDK 恰好 契约测试会在 CI 中运行,并且不需要真实 API 密钥。 -## 添加回归测试(指南) +## 添加回归测试(指导) 当你修复在实时测试中发现的提供商 / 模型问题时: -- 如果可能,添加一个 CI 安全的回归测试(模拟 / stub 提供商,或捕获精确的请求形状转换) -- 如果它本质上只能在实时测试中复现(限流、认证策略),就让实时测试保持范围小,并通过环境变量按需启用 +- 如果可能,添加一个 CI 安全的回归测试(模拟 / 存根提供商,或捕获精确的请求形状转换) +- 如果它本质上只能通过实时测试验证(速率限制、认证策略),就让实时测试保持范围窄,并通过环境变量选择启用 - 优先定位到能捕获该缺陷的最小层级: - - 提供商请求转换 / 重放缺陷 → direct models 测试 - - Gateway 网关会话 / 历史 / 工具流水线缺陷 → Gateway 网关实时烟雾测试或 CI 安全的 Gateway 网关 mock 测试 + - 提供商请求转换 / 回放缺陷 → 直接模型测试 + - 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 未分类时故意失败,这样新类别就不能被悄悄跳过。 + - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据(`listSecretTargetRegistryEntries()`)中为每个 SecretRef 类派生一个采样目标,然后断言遍历段 exec id 会被拒绝。 + - 如果你在 `src/secrets/target-registry-data.ts` 中新增了一个 `includeInPlan` SecretRef 目标系列,请更新该测试中的 `classifyTargetClass`。该测试会在遇到未分类目标 id 时故意失败,以确保新类别不会被悄悄跳过。