diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index eeffec6e1..37532fa9b 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,26 +1,26 @@ --- read_when: - - 在本地或 CI 中运行测试时 - - 为模型 / 提供商缺陷添加回归测试时 - - 调试 Gateway 网关 + 智能体行为时 -summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及各项测试覆盖的内容 + - 在本地或 CI 中运行测试 + - 为模型 / 提供商缺陷添加回归测试 + - 调试 Gateway 网关 + 智能体行为 +summary: 测试工具包：单元测试 / e2e / 实时测试套件、Docker 运行器，以及每类测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-09T00:42:56Z" + generated_at: "2026-04-09T16:02:43Z" model: gpt-5.4 provider: openai - source_hash: 01117f41d8b171a4f1da11ed78486ee700e70ae70af54eb6060c57baf64ab21b + source_hash: 0aa56e3d0486e90d208b54c4a70e201616cb3d160362a005a902c1295563e3d5 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 +OpenClaw 有三套 Vitest 测试套件（单元 / 集成、e2e、实时测试）以及一小组 Docker 运行器。 -本文档是“我们如何测试”的指南： +本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么内容（以及它刻意 _不_ 覆盖什么） +- 每套测试覆盖什么内容（以及它刻意**不**覆盖什么） - 常见工作流应运行哪些命令（本地、推送前、调试） - 实时测试如何发现凭证并选择模型 / 提供商 - 如何为真实世界中的模型 / 提供商问题添加回归测试 @@ -29,257 +29,258 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 大多数时候： -- 完整门禁（预期在推送前运行）：`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` -当你修改了测试或想获得更多信心时： +当你修改了测试或想要更多信心时： - 覆盖率门禁：`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` +- 实时测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` +- 安静地只跑一个实时测试文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -提示：当你只需要一个失败用例时，优先使用下面描述的 allowlist 环境变量来缩小实时测试范围。 +提示：如果你只需要一个失败用例，优先使用下文描述的 allowlist 环境变量来缩小实时测试范围。 ## 测试套件（各自在哪里运行） -可以把这些测试套件理解为“真实性逐步增加”（以及不稳定性 / 成本逐步增加）： +可以把这些测试套件理解为“真实性逐步增加”（同时波动性 / 成本也逐步增加）： ### 单元 / 集成（默认） - 命令：`pnpm test` -- 配置：在现有分域 Vitest 项目上运行十个顺序分片（`vitest.full-*.config.ts`） -- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 +- 配置：在现有作用域 Vitest project 上顺序运行十个分片（`vitest.full-*.config.ts`） +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 - 范围： - 纯单元测试 - - 进程内集成测试（Gateway 网关 鉴权、路由、工具、解析、配置） - - 已知缺陷的确定性回归测试 + - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） + - 针对已知缺陷的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - - 应当快速且稳定 -- 项目说明： - - 不带目标的 `pnpm test` 现在会运行十一组更小的分片配置（`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 路径扩展到同样的分域通道；配置 / setup 修改仍会回退到更广泛的根项目重跑。 - - 选定的 `plugin-sdk` 和 `commands` 测试也会通过专用的轻量通道进行路由，从而跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件仍留在现有通道上。 - - 选定的 `plugin-sdk` 和 `commands` 辅助源文件在变更模式运行中也会映射到这些轻量通道中的显式同级测试，因此辅助文件编辑不必重跑该目录下完整的重型测试套件。 - - `auto-reply` 现在有三个专用桶：顶层核心辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply harness 工作不影响廉价的 status / chunk / token 测试。 -- 嵌入式运行器说明： + - 应该快速且稳定 +- 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 说明： - 当你修改消息工具发现输入或压缩运行时上下文时， - 要同时保持两层覆盖。 - - 为纯路由 / 规范化边界添加聚焦的辅助函数回归测试。 - - 同时也要保证嵌入式运行器集成测试套件健康： + 要同时保留两个层级的覆盖。 + - 为纯路由 / 规范化边界添加聚焦的辅助回归测试。 + - 同时保持嵌入式 runner 集成套件健康： `src/agents/pi-embedded-runner/compact.hooks.test.ts`、 - `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts`，以及 + `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 和 `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`。 - - 这些测试套件会验证分域 id 和压缩行为仍然会通过真实的 `run.ts` / `compact.ts` 路径流转；仅有辅助函数测试并不能充分替代这些集成路径。 -- 池说明： + - 这些套件验证带作用域的 id 和压缩行为仍会通过真实的 `run.ts` / `compact.ts` 路径流动；仅有 helper 测试并不能充分替代这些集成路径。 +- Pool 说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置还固定了 `isolate: false`，并在根项目、e2e 和实时配置中使用非隔离运行器。 - - 根 `ui` 通道保留其 `jsdom` setup 和优化器，但现在也运行在共享的非隔离运行器上。 - - 每个 `pnpm test` 分片都继承自共享 Vitest 配置中的同一组 `threads` + `isolate: false` 默认值。 - - 共享的 `scripts/run-vitest.mjs` 启动器现在还会默认给 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原生 V8 行为做对比，可设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 + - 共享 Vitest 配置也固定了 `isolate: false`，并在 root projects、e2e 和实时测试配置中使用非隔离 runner。 + - 根级 UI lane 保留其 `jsdom` setup 和 optimizer，但现在也运行在共享的非隔离 runner 上。 + - 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 + - 共享的 `scripts/run-vitest.mjs` 启动器现在默认还会为 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原始 V8 行为对比，可设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 - 本地快速迭代说明： - - `pnpm test:changed` 会在变更路径可以清晰映射到更小测试套件时，通过分域通道进行路由。 - - `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由行为，只是有更高的 worker 上限。 - - 本地 worker 自动缩放现在有意采用更保守的策略，并且当宿主机负载平均值已经较高时也会退让，因此默认情况下多个并发 Vitest 运行造成的影响会更小。 - - 基础 Vitest 配置会将项目 / 配置文件标记为 `forceRerunTriggers`，以便在测试接线变化时，变更模式重跑仍然正确。 - - 配置会在受支持的主机上保持 `OPENCLAW_VITEST_FS_MODULE_CACHE` 启用；如果你想为直接性能分析指定一个明确的缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - `pnpm test:changed` 会在变更路径可清晰映射到较小套件时通过作用域 lane 路由。 + - `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`。 - 性能调试说明： - - `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: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` 会在禁用文件并行的情况下，为单元测试套件写出运行器 CPU + 堆 profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件级并行时，为单元测试套件写出 runner CPU + heap profile。 -### E2E（Gateway 网关 冒烟） +### E2E（Gateway 网关烟雾测试） - 命令：`pnpm test:e2e` - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` -- 运行时默认值： - - 使用带 `isolate: false` 的 Vitest `threads`，与仓库其余部分保持一致。 - - 使用自适应 worker（CI：最多 2 个，本地：默认 1 个）。 - - 默认以 silent 模式运行，以减少控制台 I/O 开销。 -- 常用覆盖： - - `OPENCLAW_E2E_WORKERS=` 强制指定 worker 数量（上限为 16）。 - - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 +- 默认运行时： + - 使用 Vitest `threads`，并启用 `isolate: false`，与仓库其余部分保持一致。 + - 使用自适应 workers（CI：最多 2 个，本地：默认 1 个）。 + - 默认以静默模式运行，以减少控制台 I/O 开销。 +- 常用覆盖项： + - `OPENCLAW_E2E_WORKERS=`：强制指定 worker 数（上限为 16）。 + - `OPENCLAW_E2E_VERBOSE=1`：重新启用详细控制台输出。 - 范围： - - 多实例 Gateway 网关 端到端行为 - - WebSocket / HTTP 表面、节点配对，以及更重的网络行为 + - 多实例 Gateway 网关端到端行为 + - WebSocket / HTTP 接口、节点配对以及更重的网络路径 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比单元测试涉及更多活动部件（可能更慢） + - 比单元测试包含更多活动部件（可能更慢） -### E2E：OpenShell 后端冒烟 +### E2E：OpenShell 后端烟雾测试 - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 - - 从一个临时本地 Dockerfile 创建沙箱 - - 通过真实的 `sandbox ssh-config` + SSH exec 运行 OpenClaw 的 OpenShell 后端 + - 从临时本地 Dockerfile 创建一个沙箱 + - 通过真实的 `sandbox ssh-config` + SSH 执行来测试 OpenClaw 的 OpenShell 后端 - 通过沙箱 fs bridge 验证远程规范文件系统行为 - 预期： - - 仅按需启用；不属于默认 `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 二进制或包装脚本 + - 仅按需启用；不属于默认的 `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 二进制或包装脚本 -### 实时（真实提供商 + 真实模型） +### 实时测试（真实提供商 + 真实模型） - 命令：`pnpm test:live` - 配置：`vitest.live.config.ts` - 文件：`src/**/*.live.test.ts` - 默认：由 `pnpm test:live` **启用**（设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型今天在真实凭证下是否确实可用？” - - 捕捉提供商格式变化、工具调用怪癖、鉴权问题和限流行为 + - “这个提供商 / 模型今天在真实凭证下是否真的可用？” + - 捕捉提供商格式变化、工具调用怪癖、认证问题以及限流行为 - 预期： - - 按设计不具备 CI 稳定性（真实网络、真实提供商策略、配额、中断） + - 按设计并不适合作为稳定的 CI 测试（真实网络、真实提供商策略、配额、故障） - 会花钱 / 消耗限流额度 - - 优先运行缩小范围的子集，而不是“全部” -- 实时运行会读取 `~/.profile` 以补充缺失的 API 密钥。 -- 默认情况下，实时运行仍会隔离 `HOME`，并将配置 / 鉴权材料复制到临时测试 home 中，这样单元测试 fixture 就不会修改你真实的 `~/.openclaw`。 + - 应优先运行缩小范围的子集，而不是“全部都跑” +- 实时运行会读取 `~/.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` 对单个实时运行进行覆盖；测试会在收到限流响应时重试。 +- `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` 调整 direct-model 心跳。 + - 可使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探测心跳。 -## 我应该运行哪个测试套件？ +## 我应该运行哪套测试？ -使用下面的决策表： +使用下面这个决策表： -- 编辑逻辑 / 测试：运行 `pnpm test`（如果改动很多，再运行 `pnpm test:coverage`） -- 修改 Gateway 网关 网络 / WS 协议 / 配对：追加运行 `pnpm test:e2e` +- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） +- 修改 Gateway 网关网络 / WS 协议 / 配对：加跑 `pnpm test:e2e` - 调试“我的 bot 挂了” / 提供商特定故障 / 工具调用：运行缩小范围的 `pnpm test:live` -## 实时：Android 节点能力扫描 +## 实时测试：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前通告的 **每一个命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前**通告的每一条命令**，并断言命令契约行为。 - 范围： - - 预先准备 / 手动 setup（该测试套件不会安装 / 运行 / 配对应用）。 - - 针对所选 Android 节点逐条验证 Gateway 网关 `node.invoke`。 -- 必需的预先 setup： - - 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 setup 详情：[Android App](/zh-CN/platforms/android) +- 完整 Android 设置详情： [Android App](/zh-CN/platforms/android) -## 实时：模型冒烟（profile keys） +## 实时测试：模型烟雾测试（profile keys） -实时测试分为两层，以便我们隔离故障： +实时测试被拆分成两层，以便我们隔离故障： -- “Direct model” 告诉我们该提供商 / 模型在给定密钥下是否至少能响应。 -- “Gateway smoke” 告诉我们完整的 Gateway 网关 + 智能体流水线是否适用于该模型（会话、历史、工具、沙箱策略等）。 +- “Direct model” 用来告诉我们该提供商 / 模型是否能用给定密钥正常响应。 +- “Gateway smoke” 用来告诉我们完整的 Gateway 网关 + 智能体流水线是否对该模型工作正常（会话、历史、工具、沙箱策略等）。 ### 第 1 层：Direct model completion（无 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 网关 冒烟 + - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 + - 对每个模型运行一次小型 completion（并在需要时运行有针对性的回归测试） +- 如何启用： + - `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` 可进行穷尽式 modern 扫描，或设置正整数以指定更小的上限。 + - `OPENCLAW_LIVE_MODELS=modern`：运行现代 allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - `OPENCLAW_LIVE_MODELS=all`：现代 allowlist 的别名 + - 或者 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） + - modern / all 扫描默认有一个精心筛选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行完整的现代模型扫描，或设置为正数以使用较小上限。 - 如何选择提供商： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔的 allowlist） - 密钥来源： - - 默认：profile store 和 env 回退值 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制 **仅使用 profile store** -- 存在原因： - - 将“提供商 API 坏了 / 密钥无效”与“Gateway 网关 智能体流水线坏了”区分开 - - 容纳小型、隔离的回归测试（例如：OpenAI Responses / Codex Responses 的推理重放 + 工具调用流程） + - 默认：profile store 和环境变量回退 + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 以强制**仅**使用 profile store +- 为什么需要它： + - 将“提供商 API 已损坏 / 密钥无效”与“Gateway 网关智能体流水线已损坏”区分开来 + - 包含小型、隔离的回归测试（例如：OpenAI Responses / Codex Responses 推理重放 + 工具调用流程） -### 第 2 层：Gateway 网关 + dev 智能体冒烟（也就是 “@openclaw” 实际做的事） +### 第 2 层：Gateway 网关 + dev 智能体烟雾测试（也就是 “@openclaw” 实际执行的内容） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - 启动一个进程内 Gateway 网关 - - 创建 / 修补一个 `agent:dev:*` 会话（每次运行都覆盖模型） - - 遍历带密钥的模型并断言： - - “有意义的”响应（无工具） - - 真实工具调用可用（read 探测） + - 创建 / 修补一个 `agent:dev:*` 会话（每次运行按模型覆盖） + - 遍历带密钥的模型，并断言： + - 有“有意义”的响应（不使用工具） + - 一次真实的工具调用可正常工作（read 探测） - 可选的额外工具探测（exec+read 探测） - OpenAI 回归路径（仅工具调用 → 后续跟进）保持可用 -- 探测细节（这样你就能快速解释故障）： - - `read` 探测：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 该文件并回显 nonce。 - - `exec+read` 探测：测试会要求智能体通过 `exec` 将一个 nonce 写入临时文件，然后再 `read` 回来。 +- 探测细节（这样你能更快解释故障）： + - `read` 探测：测试会在工作区写入一个 nonce 文件，并要求智能体读取它并回显该 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` 可进行穷尽式 modern 扫描，或设置正整数以指定更小上限。 -- 如何选择提供商（避免 “OpenRouter 全家桶”）： + - `OPENCLAW_LIVE_GATEWAY_MODELS=all`：现代 allowlist 的别名 + - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）以缩小范围 + - modern / all Gateway 网关扫描默认有一个精心筛选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行完整的现代模型扫描，或设置为正数以使用较小上限。 +- 如何选择提供商（避免“OpenRouter 全都跑”）： - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） - 工具 + 图像探测在这个实时测试中始终开启： - `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-backend.ts` 定义中。 - 启用： - - `pnpm test:live`（或直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） - `OPENCLAW_LIVE_CLI_BACKEND=1` - 默认值： - 默认提供商 / 模型：`claude-cli/claude-sonnet-4-6` - - 命令 / 参数 / 图像行为来自所属 CLI 后端插件元数据。 -- 覆盖（可选）： + - command / args / 图像行为来自所属 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` 发送第二轮并验证恢复流程。 - - `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`：发送第二轮对话并验证 resume 流程。 + - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0`：禁用默认的 Claude Sonnet -> Opus 同会话连续性探测（当所选模型支持切换目标时，可设置为 `1` 强制开启）。 示例： @@ -289,13 +290,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 @@ -306,36 +307,36 @@ 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 会话绑定流程： +- 目标：通过一个实时 ACP 智能体验证真实的 ACP conversation-bind 流程： - 发送 `/acp spawn --bind here` - - 就地绑定一个合成的消息渠道会话 - - 在同一个会话上发送一次正常跟进 - - 验证该跟进落在已绑定 ACP 会话的 transcript 中 + - 原地绑定一个合成的消息渠道会话 + - 在同一会话上发送一次普通后续消息 + - 验证该后续消息会进入已绑定的 ACP 会话 transcript - 启用： - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` - 默认值： - Docker 中的 ACP 智能体：`claude,codex,gemini` - 直接 `pnpm test:live ...` 使用的 ACP 智能体：`claude` - - 合成渠道：Slack 私信 风格的会话上下文 + - 合成渠道：Slack 私信风格的会话上下文 - ACP 后端：`acpx` -- 覆盖： +- 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` - `OPENCLAW_LIVE_ACP_BIND_AGENT=codex` - `OPENCLAW_LIVE_ACP_BIND_AGENT=gemini` - `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude,codex,gemini` - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - 说明： - - 这个通道使用 Gateway 网关 `chat.send` 表面以及仅管理员可用的合成 originating-route 字段，这样测试就能附加消息渠道上下文，而无需伪装成外部投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用嵌入式 `acpx` 插件的内置智能体注册表来获取所选 ACP harness 智能体。 + - 此 lane 使用 Gateway 网关 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，这样测试就可以附加消息渠道上下文，而无需假装向外部实际投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件的内建智能体注册表来处理所选 ACP harness 智能体。 示例： @@ -345,13 +346,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 @@ -362,44 +363,44 @@ 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 鉴权材料暂存到容器中，在可写 npm 前缀中安装 `acpx`，然后在缺失时安装所请求的实时 CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 -- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 acpx 就能让从 profile 中读取的 provider 环境变量继续对其子 harness CLI 可用。 +- 默认情况下，它会按顺序对所有受支持的实时 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。 -### 推荐的实时配方 +### 推荐的实时测试用法 -范围窄、显式的 allowlist 最快，也最不容易不稳定： +范围小且明确的 allowlist 最快，也最不容易波动： - 单模型，direct（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` -- 单模型，Gateway 网关 冒烟： +- 单模型，Gateway 网关烟雾测试： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 跨多个提供商的工具调用： +- 多个提供商上的工具调用： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 聚焦 Google（Gemini API key + Antigravity）： - - Gemini（API key）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` +- 聚焦 Google（Gemini API 密钥 + Antigravity）： + - Gemini（API 密钥）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - Antigravity（OAuth）：`OPENCLAW_LIVE_GATEWAY_MODELS="google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-pro-high" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` 说明： -- `google/...` 使用 Gemini API（API key）。 +- `google/...` 使用 Gemini API（API 密钥）。 - `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的鉴权 + 工具怪癖）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的认证 + 工具行为怪癖）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API key / profile auth）；这是大多数用户说“Gemini”时指的内容。 - - CLI：OpenClaw 会调用本地 `gemini` 二进制；它有自己的一套鉴权机制，行为也可能不同（流式传输 / 工具支持 / 版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这通常就是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 会 shell out 到本地 `gemini` 二进制；它有自己的认证方式，而且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 -## 实时：模型矩阵（我们覆盖什么） +## 实时测试：模型矩阵（我们覆盖什么） -没有固定的“CI 模型列表”（实时测试是按需启用的），但以下是建议在拥有密钥的开发机器上定期覆盖的模型。 +没有固定的“CI 模型列表”（实时测试是按需启用的），但以下是**推荐**在带有密钥的开发机器上定期覆盖的模型。 -### 现代冒烟集（工具调用 + 图像） +### 现代烟雾测试集（工具调用 + 图像） -这是我们预期应持续保持可用的“常见模型”运行： +这是我们期望持续保持可用的“常用模型”运行集： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -409,12 +410,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`） @@ -422,7 +423,7 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的附加覆盖（有更好，没有也可以）： +可选的额外覆盖（有的话更好）： - xAI：`xai/grok-4`（或最新可用版本） - Mistral：`mistral/`…（选择一个你已启用、支持 “tools” 的模型） @@ -431,37 +432,37 @@ Docker 说明： ### 视觉：图像发送（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的视觉变体等），以运行图像探测。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / 支持视觉的 OpenAI 变体等），以运行图像探测。 ### 聚合器 / 替代 Gateway 网关 -如果你启用了相关密钥，我们也支持通过以下方式测试： +如果你已启用相应密钥，我们也支持通过以下方式进行测试： -- OpenRouter：`openrouter/...`（数百个模型；用 `openclaw models scan` 找出支持 tool + image 的候选） -- OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 Go（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 鉴权） +- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选项） +- OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 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 可用，实时测试通常也应能找到同样的密钥。 -- 如果实时测试提示 “no creds”，就像调试 `openclaw models list` / 模型选择一样去调试。 +- 如果 CLI 可用，实时测试通常也应能找到相同的密钥。 +- 如果某个实时测试提示“没有凭证”，请按调试 `openclaw models list` / 模型选择的同样方式来调试。 -- 按智能体划分的 auth profiles：`~/.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 存储） -- 默认情况下，本地实时运行会将当前配置、各智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 鉴权目录复制到临时测试 home；暂存的实时 home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，从而确保探测不会落到你的真实宿主工作区中。 +- 旧版状态目录：`~/.openclaw/credentials/`（如果存在，会复制到暂存的实时测试 home 中，但它不是主要的 profile-key store） +- 默认情况下，本地实时运行会把当前活动配置、各智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home；暂存的实时测试 home 会跳过 `workspace/` 和 `sandboxes/`，并去除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探测就不会触碰你宿主机上的真实工作区。 -如果你想依赖 env 密钥（例如在你的 `~/.profile` 中导出的那些），请在本地运行测试前执行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载进容器）。 +如果你想依赖环境变量密钥（例如导出在你的 `~/.profile` 中），请在执行本地测试前先运行 `source ~/.profile`，或使用下面的 Docker 运行器（它们可以把 `~/.profile` 挂载进容器）。 -## Deepgram 实时（音频转录） +## Deepgram 实时测试（音频转录） - 测试：`src/media-understanding/providers/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts` @@ -477,9 +478,9 @@ 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` 路径 - - 如果未配置 `models.providers.comfy.`，则会跳过对应能力 - - 在修改 comfy 工作流提交、轮询、下载或插件注册后特别有用 + - 测试内置 comfy 图像、视频和 `music_generate` 路径 + - 除非配置了 `models.providers.comfy.`，否则会跳过各项能力 + - 在修改 comfy 工作流提交、轮询、下载或插件注册后非常有用 ## 图像生成实时测试 @@ -488,9 +489,9 @@ Docker 说明： - Harness：`pnpm test:live:media image` - 范围： - 枚举每个已注册的图像生成提供商插件 - - 在探测前从你的登录 shell（`~/.profile`）中加载缺失的 provider 环境变量 - - 默认优先使用实时 / env API 密钥，而不是已存储的 auth profiles，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用 auth / profile / model 的提供商 + - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` @@ -503,8 +504,8 @@ Docker 说明： - `OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS="openai,google"` - `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 鉴权，并忽略仅 env 的覆盖 +- 可选认证行为： + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`：强制使用 profile store 认证，并忽略仅环境变量的覆盖 ## 音乐生成实时测试 @@ -512,23 +513,23 @@ Docker 说明： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` - Harness：`pnpm test:live:media music` - 范围： - - 运行共享的内置音乐生成提供商路径 + - 测试共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - - 在探测前从你的登录 shell（`~/.profile`）中加载 provider 环境变量 - - 默认优先使用实时 / env API 密钥，而不是已存储的 auth profiles，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用 auth / profile / model 的提供商 - - 在可用时运行两种声明的运行时模式： - - `generate`，仅使用提示词输入 - - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` - - 当前共享通道覆盖： + - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 在可用时运行两种已声明的运行时模式： + - `generate`：仅提示词输入 + - `edit`：当提供商声明 `capabilities.edit.enabled` 时 + - 当前共享 lane 覆盖： - `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 鉴权，并忽略仅 env 的覆盖 +- 可选认证行为： + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`：强制使用 profile store 认证，并忽略仅环境变量的覆盖 ## 视频生成实时测试 @@ -536,223 +537,223 @@ Docker 说明： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` - Harness：`pnpm test:live:media video` - 范围： - - 运行共享的内置视频生成提供商路径 - - 在探测前从你的登录 shell（`~/.profile`）中加载 provider 环境变量 - - 默认优先使用实时 / env API 密钥，而不是已存储的 auth profiles，因此 `auth-profiles.json` 中陈旧的测试密钥不会掩盖真实 shell 凭证 - - 跳过没有可用 auth / profile / model 的提供商 - - 在可用时运行两种声明的运行时模式： - - `generate`，仅使用提示词输入 - - 当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - - 当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` - - 当前在共享扫描中已声明但被跳过的 `imageToVideo` 提供商： - - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL - - 提供商专属的 Vydra 覆盖： + - 测试共享的内置视频生成提供商路径 + - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 + - 在可用时运行两种已声明的运行时模式： + - `generate`：仅提示词输入 + - `imageToVideo`：当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时 + - `videoToVideo`：当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时 + - 当前在共享扫描中已声明但会跳过的 `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` 通道 + - 该文件会运行 `veo3` 文本转视频，以及默认使用远程图像 URL fixture 的 `kling` lane - 当前 `videoToVideo` 实时覆盖： - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 - - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - - `alibaba`、`qwen`、`xai`，因为这些路径目前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini / Veo 通道使用的是基于本地 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享通道不保证具备组织级视频 inpaint / remix 访问权限 + - 当前在共享扫描中已声明但会跳过的 `videoToVideo` 提供商： + - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL + - `google`，因为当前共享的 Gemini / Veo lane 使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享 lane 无法保证组织特定的视频修补 / 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 鉴权，并忽略仅 env 的覆盖 +- 可选认证行为： + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1`：强制使用 profile store 认证，并忽略仅环境变量的覆盖 -## 媒体实时 harness +## 媒体实时测试 Harness - 命令：`pnpm test:live:media` - 目的： - 通过一个仓库原生入口运行共享的图像、音乐和视频实时测试套件 - - 自动从 `~/.profile` 加载缺失的 provider 环境变量 - - 默认自动将每个测试套件缩小到当前确实有可用 auth 的提供商 - - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 + - 自动从 `~/.profile` 加载缺失的提供商环境变量 + - 默认自动将每个套件缩小到当前具有可用认证的提供商 + - 复用 `scripts/test-live.mjs`，因此心跳和静默模式行为保持一致 - 示例： - `pnpm test:live:media` - `pnpm test:live:media image video --providers openai,google,minimax` - `pnpm test:live:media video --video-providers openai,runway --all-providers` - `pnpm test:live:media music --quiet` -## Docker 运行器（可选的“在 Linux 上也能工作”检查） +## Docker 运行器（可选的“在 Linux 中可用”检查） 这些 Docker 运行器分为两类： -- 实时模型运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 仅在仓库 Docker 镜像中运行各自对应的 profile-key 实时测试文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，也会读取 `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 -- Docker 实时运行器默认使用更小的冒烟上限，以便完整 Docker 扫描仍然切实可行： - `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_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` 会启动一个或多个真实容器，并验证更高层的集成路径。 + 明确想执行更大范围的完整扫描时，可覆盖这些环境变量。 +- `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` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -实时模型 Docker 运行器还只会绑定挂载所需的 CLI 鉴权 home（当运行未缩小时，则挂载所有受支持的项），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就能刷新 token，而不会修改宿主机鉴权存储： +实时模型 Docker 运行器还会仅 bind mount 所需的 CLI 认证 home（如果未缩小范围，则挂载所有受支持项），然后在运行前将它们复制到容器 home 中，这样外部 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`） +- 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 通知帧冒烟）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） -- 插件（安装冒烟 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-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`） -实时模型 Docker 运行器还会以只读方式绑定挂载当前 checkout， -并将其暂存到容器内的临时 workdir 中。这样既能保持运行时 -镜像精简，又仍可对你当前本地的精确源码 / 配置运行 Vitest。 -暂存步骤会跳过大型本地专用缓存和应用构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地 `.build` 或 -Gradle 输出目录，因此 Docker 实时运行不会花上数分钟复制 -与机器相关的构件。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关 实时探测就不会在容器内启动 +实时模型 Docker 运行器还会以只读方式 bind mount 当前 checkout， +并将其暂存到容器内的临时工作目录中。这样既能保持运行时 +镜像精简，又仍然可以针对你本地的确切源码 / 配置运行 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 通道中的 Gateway 网关 -实时覆盖时，也要一并传递 +`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要缩小范围或排除 +该 Docker lane 中的 Gateway 网关实时覆盖时，也要一并传入 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层的兼容性冒烟：它会启动一个 -启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关 容器， -启动一个指向该 Gateway 网关 的固定 Open WebUI 容器，通过 -Open WebUI 登录，验证 `/api/models` 暴露 `openclaw/default`，然后通过 -Open WebUI 的 `/api/chat/completions` 代理发送一条真实聊天请求。 -第一次运行可能会明显更慢，因为 Docker 可能需要拉取 -Open WebUI 镜像，而 Open WebUI 也可能需要完成自己的冷启动 setup。 -这个通道需要一个可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 +`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 需要可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` +（默认是 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 成功运行会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 刻意保持确定性，不需要 -真实的 Telegram、Discord 或 iMessage 账号。它会启动一个预置的 Gateway 网关 -容器，再启动第二个容器来执行 `openclaw mcp serve`，然后 +`test:docker:mcp-channels` 是刻意保持确定性的，不需要 +真实的 Telegram、Discord 或 iMessage 账号。它会启动一个已注入数据的 Gateway 网关 +容器，再启动第二个容器来运行 `openclaw mcp serve`，然后 验证路由后的会话发现、transcript 读取、附件元数据、 -实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + -权限通知，全部通过真实的 stdio MCP bridge 完成。通知检查 -会直接检查原始 stdio MCP 帧，因此这个冒烟验证的是 -bridge 实际发出的内容，而不是某个特定客户端 SDK 恰好暴露出的内容。 +实时事件队列行为、出站发送路由，以及类 Claude 的渠道 + +权限通知在真实 stdio MCP bridge 上的行为。通知检查 +会直接检查原始 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_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/...` +- `$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（而不是 env） -- `OPENCLAW_OPENWEBUI_MODEL=...` 选择在 Open WebUI 冒烟中由 Gateway 网关 暴露的模型 -- `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 store（而非环境变量） +- `OPENCLAW_OPENWEBUI_MODEL=...`：选择 Gateway 网关为 Open WebUI 烟雾测试暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...`：覆盖 Open WebUI 烟雾测试使用的 nonce 检查提示词 +- `OPENWEBUI_IMAGE=...`：覆盖固定的 Open WebUI 镜像标签 ## 文档完整性检查 -文档编辑后运行文档检查：`pnpm check:docs`。 +编辑文档后运行文档检查：`pnpm check:docs`。 当你还需要页内标题检查时，运行完整的 Mintlify anchor 验证：`pnpm docs:check-links:anchors`。 -## 离线回归（CI 安全） +## 离线回归测试（CI 安全） -这些是在没有真实提供商的情况下进行的“真实流水线”回归测试： +这些是在不依赖真实提供商的情况下，对“真实流水线”进行的回归测试： -- Gateway 网关 工具调用（mock OpenAI，真实 Gateway 网关 + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） -- Gateway 网关 向导（WS `wizard.start` / `wizard.next`，写入配置 + 强制 auth）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） +- 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 网关 + 智能体循环进行 mock 工具调用（`src/gateway/gateway.test.ts`）。 -- 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 +- 通过真实 Gateway 网关 + 智能体循环进行模拟工具调用（`src/gateway/gateway.test.ts`）。 +- 验证会话布线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 -针对 Skills 仍缺少的内容（参见 [Skills](/zh-CN/tools/skills)）： +对于 Skills，当前仍缺少的内容（见 [Skills](/zh-CN/tools/skills)）： -- **决策能力：** 当 Skills 列在提示词中时，智能体会选择正确的技能（或避开无关技能）吗？ -- **合规性：** 智能体在使用前是否会读取 `SKILL.md`，并遵循要求的步骤 / 参数？ -- **工作流契约：** 断言工具顺序、会话历史延续以及沙箱边界的多轮场景。 +- **决策**：当 Skills 列在提示词中时，智能体是否会选择正确的 skill（或避开无关的 skill）？ +- **合规性**：智能体是否会在使用前读取 `SKILL.md`，并遵循要求的步骤 / 参数？ +- **工作流契约**：断言工具顺序、会话历史继承和沙箱边界的多轮场景。 -未来的评估应优先保持确定性： +未来的评估应先保持确定性： -- 使用 mock providers 的场景运行器，用于断言工具调用 + 顺序、技能文件读取以及会话接线。 -- 一组小型、聚焦 Skills 的场景（使用还是避免、门控、提示注入）。 -- 只有在 CI 安全套件就位后，再增加可选的实时评估（按需启用、受 env 控制）。 +- 一个使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话布线。 +- 一小组聚焦 skill 的场景（使用与避免、门禁、提示注入）。 +- 仅在 CI 安全套件就位之后，才添加可选的实时评估（按需启用、受环境变量门控）。 ## 契约测试（插件和渠道形状） 契约测试用于验证每个已注册插件和渠道都符合其 接口契约。它们会遍历所有已发现的插件，并运行一组 -形状和行为断言。默认的 `pnpm test` 单元通道会刻意 -跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商表面时， -请显式运行契约命令。 +针对结构和行为的断言。默认的 `pnpm test` 单元 lane 会刻意 +跳过这些共享 seam 和烟雾测试文件；当你修改共享渠道或提供商表面时， +请显式运行这些契约命令。 ### 命令 -- 所有契约：`pnpm test:contracts` -- 仅渠道契约：`pnpm test:contracts:channels` -- 仅提供商契约：`pnpm test:contracts:plugins` +- 所有契约测试：`pnpm test:contracts` +- 仅渠道契约测试：`pnpm test:contracts:channels` +- 仅提供商契约测试：`pnpm test:contracts:plugins` -### 渠道契约 +### 渠道契约测试 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基础插件形状（id、name、capabilities） +- **plugin** - 基本插件结构（id、名称、能力） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 - **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 - **actions** - 渠道操作处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录 / 花名册 API -- **group-policy** - 群组策略强制执行 +- **directory** - 目录 / roster API +- **group-policy** - 群组策略执行 -### 提供商状态契约 +### 提供商状态契约测试 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 -- **registry** - 插件注册表形状 +- **registry** - 插件注册表结构 -### 提供商契约 +### 提供商契约测试 位于 `src/plugins/contracts/*.contract.test.ts`： -- **auth** - 鉴权流程契约 -- **auth-choice** - 鉴权选项 / 选择 +- **auth** - 认证流程契约 +- **auth-choice** - 认证选项 / 选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 - **runtime** - 提供商运行时 -- **shape** - 插件形状 / 接口 +- **shape** - 插件结构 / 接口 - **wizard** - 设置向导 ### 何时运行 -- 在修改 plugin-sdk 导出或子路径之后 -- 在添加或修改渠道或提供商插件之后 -- 在重构插件注册或发现逻辑之后 +- 修改 `plugin-sdk` 导出或子路径之后 +- 添加或修改渠道或提供商插件之后 +- 重构插件注册或发现逻辑之后 -契约测试会在 CI 中运行，不需要真实 API 密钥。 +契约测试会在 CI 中运行，并且不需要真实 API 密钥。 -## 添加回归测试（指导） +## 添加回归测试（指南） -当你修复了在实时测试中发现的某个提供商 / 模型问题时： +当你修复在实时测试中发现的提供商 / 模型问题时： -- 如果可能，添加一个 CI 安全回归测试（mock / stub 提供商，或捕获精确的请求形状转换） -- 如果它本质上只能做实时测试（限流、鉴权策略），就让实时测试保持范围窄，并通过 env vars 按需启用 -- 优先针对能捕获该缺陷的最小层级： +- 如果可能，添加一个 CI 安全的回归测试（模拟 / stub 提供商，或捕获精确的请求形状转换） +- 如果它本质上只能在实时测试中复现（限流、认证策略），就让实时测试保持范围小，并通过环境变量按需启用 +- 优先定位到能捕获该缺陷的最小层级： - 提供商请求转换 / 重放缺陷 → direct models 测试 - - Gateway 网关 会话 / 历史 / 工具流水线缺陷 → Gateway 网关 实时冒烟或 CI 安全的 Gateway 网关 mock 测试 + - Gateway 网关会话 / 历史 / 工具流水线缺陷 → Gateway 网关实时烟雾测试或 CI 安全的 Gateway 网关 mock 测试 - SecretRef 遍历护栏： - - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历分段 exec id 会被拒绝。 - - 如果你在 `src/secrets/target-registry-data.ts` 中添加了一个新的 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。该测试会刻意在遇到未分类目标 id 时失败，从而确保新类别不会被悄悄跳过。 + - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言会拒绝 traversal-segment exec id。 + - 如果你在 `src/secrets/target-registry-data.ts` 中新增了一个 `includeInPlan` SecretRef 目标家族，请更新该测试中的 `classifyTargetClass`。这个测试会在目标 id 未分类时故意失败，这样新类别就不能被悄悄跳过。