diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index 5c8eb5585..b3d2ec33f 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -1,61 +1,61 @@ --- read_when: - - 在本地或 CI 中运行测试时 - - 为模型 / 提供商缺陷添加回归测试时 - - 调试 Gateway 网关 + 智能体行为时 -summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及每类测试覆盖的内容 + - 在本地或 CI 中运行测试 + - 为模型/提供商缺陷添加回归测试 + - 调试 Gateway 网关 + 智能体行为 +summary: 测试工具包：unit/e2e/live 套件、Docker 运行器，以及每类测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-06T23:43:01Z" + generated_at: "2026-04-07T05:10:21Z" model: gpt-5.4 provider: openai - source_hash: 61b1856fff7d09dcfdbaacf1b5c8fbc3284750e360fc37d5e15852011b6a5bb5 + source_hash: 77c61126344d03c7b04ccf1f9aba0381cf8c7c73042d69b2d9f3f07a5eba70d3 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 +OpenClaw 有三个 Vitest 测试套件（unit/integration、e2e、live）以及一小组 Docker 运行器。 本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么内容（以及它刻意 _不_ 覆盖什么） -- 常见工作流该运行哪些命令（本地、推送前、调试） -- 实时测试如何发现凭证并选择模型 / 提供商 -- 如何为真实世界中的模型 / 提供商问题添加回归测试 +- 每个套件覆盖什么内容（以及它明确 _不_ 覆盖什么） +- 常见工作流应运行哪些命令（本地、推送前、调试） +- live 测试如何发现凭证并选择模型/提供商 +- 如何为真实世界中的模型/提供商问题添加回归测试 ## 快速开始 大多数时候： -- 完整 gate（预期在推送前执行）：`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 build && pnpm check && pnpm test` +- 在资源充足的机器上更快地运行本地全套测试：`pnpm test:max` +- 直接使用 Vitest 监视循环：`pnpm test:watch` +- 直接按文件定位现在也会路由 extension/channel 路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` +- Docker 支持的 QA 站点：`pnpm qa:lab:up` -当你修改了测试或想获得更高的信心时： +当你修改了测试，或希望获得更高信心时： -- 覆盖率 gate：`pnpm test:coverage` -- E2E 测试套件：`pnpm test:e2e` +- 覆盖率门禁：`pnpm test:coverage` +- E2E 套件：`pnpm test:e2e` -在调试真实提供商 / 模型时（需要真实凭证）： +当你调试真实提供商/模型时（需要真实凭证）： -- 实时测试套件（模型 + Gateway 网关工具 / 图像探测）：`pnpm test:live` -- 安静地只运行一个实时测试文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` +- live 套件（模型 + Gateway 网关工具/图像探测）：`pnpm test:live` +- 安静地只运行一个 live 文件：`pnpm test:live -- src/agents/models.profiles.live.test.ts` -提示：当你只需要一个失败用例时，优先通过下面介绍的 allowlist 环境变量缩小实时测试范围。 +提示：当你只需要一个失败用例时，优先使用下面描述的 allowlist 环境变量来缩小 live 测试范围。 -## 测试套件（各自运行位置） +## 测试套件（各自在哪里运行什么） -可以把这些测试套件理解为“真实性逐步增加”（同时不稳定性 / 成本也逐步增加）： +可以把这些套件理解为“真实度逐步提高”（同时不稳定性/成本也逐步增加）： -### 单元 / 集成（默认） +### Unit / integration（默认） - 命令：`pnpm test` -- 配置：在现有分层 Vitest projects 上顺序运行十个 shard（`vitest.full-*.config.ts`） -- 文件：位于 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 的核心 / 单元清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 +- 配置：基于现有按范围划分的 Vitest 项目执行十个顺序分片运行（`vitest.full-*.config.ts`） +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的 core/unit 清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` node 测试 - 范围： - 纯单元测试 - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） @@ -64,44 +64,42 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 - 在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 -- Projects 说明： - - 未指定目标的 `pnpm test` 现在运行十个更小的 shard 配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个巨大的原生根 project 进程。这样可以降低高负载机器上的峰值 RSS，并避免 auto-reply / 扩展工作拖累无关测试套件。 - - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` project 图，因为多 shard 的 watch 循环并不现实。 - - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会先把显式文件 / 目录目标路由到对应的分层 lane，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根 project 启动的开销。 - - 当 diff 只涉及可路由的源码 / 测试文件时，`pnpm test:changed` 会把改动的 git 路径扩展到相同的分层 lane；配置 / setup 修改仍会回退到更广泛的根 project 重跑。 - - 选定的 `plugin-sdk` 和 `commands` 测试也会通过专用轻量 lane 路由，从而跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件仍留在现有 lane 中。 - - 选定的 `plugin-sdk` 和 `commands` 辅助源码文件也会在 changed 模式下映射到这些轻量 lane 中的显式同级测试，因此辅助文件修改无需重跑该目录下完整的重型测试套件。 - - `auto-reply` 现在有三个专用 bucket：顶层核心辅助、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以把最重的 reply harness 工作与轻量的状态 / 分块 / token 测试分开。 -- 嵌入式 runner 说明： +- 项目说明： + - 无目标的 `pnpm test` 现在运行十个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个巨大的原生 root-project 进程。这样可以降低高负载机器上的峰值 RSS，并避免 auto-reply/extension 工作拖慢无关套件。 + - `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` 现在有三个专用分桶：顶层 core 辅助、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的 reply 测试工作负载远离轻量级的 status/chunk/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` 路径流动；仅有辅助级测试 - 并不能充分替代这些集成路径。 -- Pool 说明： + - 这些套件会验证带范围的 id 和压缩行为仍然会流经真实的 `run.ts` / `compact.ts` 路径；仅有辅助级测试并不能充分替代这些集成路径。 +- 池说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置还固定了 `isolate: false`，并在根 projects、e2e 和实时配置中使用非隔离 runner。 - - 根 UI lane 保留其 `jsdom` setup 和 optimizer，但现在也运行在共享的非隔离 runner 上。 - - 每个 `pnpm test` shard 都从共享 Vitest 配置继承相同的 `threads` + `isolate: false` 默认值。 - - 共享的 `scripts/run-vitest.mjs` 启动器现在还会默认给 Vitest 子 Node 进程添加 `--no-maglev`，以减少大型本地运行期间的 V8 编译抖动。如果你需要与原始 V8 行为做对比，请设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1`。 -- 本地快速迭代说明： - - 当改动路径可以清晰映射到更小的测试套件时，`pnpm test:changed` 会通过分层 lane 路由。 - - `pnpm test:max` 和 `pnpm test:changed:max` 保留相同的路由行为，只是 worker 上限更高。 - - 本地 worker 自动扩缩现在刻意更保守，并且在主机负载均值已经很高时也会回退，因此默认情况下多个并发 Vitest 运行对系统的影响更小。 - - 基础 Vitest 配置把 projects / 配置文件标记为 `forceRerunTriggers`，以便在测试接线发生变化时，changed 模式重跑仍然正确。 - - 在受支持的主机上，该配置会保持 `OPENCLAW_VITEST_FS_MODULE_CACHE` 启用；如果你想为直接分析指定一个明确的缓存位置，请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - 共享 Vitest 配置还固定了 `isolate: false`，并在根项目、e2e 和 live 配置中使用非隔离运行器。 + - 根级 UI 通道仍保留其 `jsdom` 设置和优化器，但现在也在共享的非隔离运行器上运行。 + - 每个 `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`，以便在测试布线发生变化时，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` 与该已提交 diff 的原生根 project 路径进行比较，并输出总耗时以及 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和根 Vitest 配置，将当前脏树的变更文件列表进行路由并做基准比较。 - - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动和 transform 开销写出主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为单元测试套件写出 runner 的 CPU + heap profiles。 + - `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 启动和 transform 开销写出主线程 CPU profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为 unit 套件写出 runner CPU+heap profile。 ### E2E（Gateway 网关冒烟） @@ -109,15 +107,15 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` - 运行时默认值： - - 使用 Vitest `threads` 且 `isolate: false`，与仓库其余部分保持一致。 - - 使用自适应 workers（CI：最多 2 个，本地：默认 1 个）。 + - 使用带 `isolate: false` 的 Vitest `threads`，与仓库其余部分保持一致。 + - 使用自适应 worker（CI：最多 2 个，本地：默认 1 个）。 - 默认以静默模式运行，以减少控制台 I/O 开销。 -- 常用覆盖项： +- 有用的覆盖项： - `OPENCLAW_E2E_WORKERS=` 强制指定 worker 数量（上限为 16）。 - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - 多实例 Gateway 网关端到端行为 - - WebSocket / HTTP 接口、节点配对，以及更重的网络场景 + - WebSocket/HTTP 接口、节点配对以及更重的网络场景 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 @@ -130,142 +128,142 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 - 范围： - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 - 从一个临时本地 Dockerfile 创建沙箱 - - 通过真实的 `sandbox ssh-config` + SSH 执行，测试 OpenClaw 的 OpenShell 后端 - - 通过沙箱 fs bridge 验证远端规范文件系统行为 + - 通过真实的 `sandbox ssh-config` + SSH exec，测试 OpenClaw 的 OpenShell 后端 + - 通过沙箱 fs bridge 验证远端规范化文件系统行为 - 预期： - 仅按需启用；不是默认 `pnpm test:e2e` 运行的一部分 - 需要本地 `openshell` CLI 和可用的 Docker daemon - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 Gateway 网关和沙箱 -- 常用覆盖项： - - `OPENCLAW_E2E_OPENSHELL=1` 在手动运行更广泛 e2e 测试套件时启用该测试 - - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell` 指向非默认 CLI 二进制或包装脚本 +- 有用的覆盖项： + - `OPENCLAW_E2E_OPENSHELL=1`，在手动运行更广泛的 e2e 套件时启用该测试 + - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`，指向非默认 CLI 二进制文件或包装脚本 -### 实时（真实提供商 + 真实模型） +### Live（真实提供商 + 真实模型） - 命令：`pnpm test:live` - 配置：`vitest.live.config.ts` - 文件：`src/**/*.live.test.ts` -- 默认：由 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） +- 默认：由 `pnpm test:live` **启用**（设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型在 _今天_ 配合真实凭证是否真的可用？” - - 捕获提供商格式变更、工具调用怪癖、认证问题以及速率限制行为 + - “这个提供商/模型 _今天_ 是否真的能用真实凭证工作？” + - 捕获提供商格式变化、工具调用怪癖、认证问题和速率限制行为 - 预期： - - 按设计不追求 CI 稳定性（真实网络、真实提供商策略、配额、故障） + - 按设计不具备 CI 稳定性（真实网络、真实提供商策略、配额、故障） - 会花钱 / 消耗速率限制 - - 优先运行收窄后的子集，而不是“全部” -- 实时运行会 source `~/.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` 为单个实时运行单独覆盖；测试会在遇到速率限制响应时重试。 -- 进度 / 心跳输出： - - 实时测试套件现在会把进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用仍然可见。 - - `vitest.live.config.ts` 禁用了 Vitest 控制台拦截，因此提供商 / Gateway 网关进度行会在实时运行期间立即流出。 - - 用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型心跳。 - - 用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探针心跳。 + - 优先运行缩小范围的子集，而不是“全部” +- live 运行会读取 `~/.profile` 以获取缺失的 API 密钥。 +- 默认情况下，live 运行仍会隔离 `HOME`，并将配置/认证材料复制到一个临时测试 home 中，这样单元测试夹具就无法修改你真实的 `~/.openclaw`。 +- 只有当你明确需要 live 测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 +- `pnpm test:live` 现在默认使用更安静的模式：它会保留 `[live] ...` 进度输出，但会抑制额外的 `~/.profile` 提示，并静音 Gateway 网关启动日志/Bonjour 噪声。如果你想重新看到完整启动日志，请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 +- API 密钥轮换（按提供商）：设置 `*_API_KEYS`，使用逗号/分号格式，或设置 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），或者通过 `OPENCLAW_LIVE_*_KEY` 进行每个 live 测试的覆盖；测试在遇到速率限制响应时会重试。 +- 进度/心跳输出： + - live 套件现在会将进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用也会显示为正在活动。 + - `vitest.live.config.ts` 禁用了 Vitest 控制台拦截，因此在 live 运行期间，提供商/Gateway 网关进度行会立即流式输出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整 direct-model 心跳。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关/probe 心跳。 -## 我应该运行哪个测试套件？ +## 我应该运行哪个套件？ -使用下面的决策表： +使用这个决策表： -- 修改逻辑 / 测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） -- 涉及 Gateway 网关网络 / WS 协议 / 配对：补跑 `pnpm test:e2e` -- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行一个收窄后的 `pnpm test:live` +- 编辑逻辑/测试：运行 `pnpm test`（如果改动很多，再运行 `pnpm test:coverage`） +- 修改 Gateway 网关网络 / WS 协议 / 配对：再加上 `pnpm test:e2e` +- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行一个缩小范围的 `pnpm test:live` -## 实时：Android 节点能力扫描 +## Live：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 应用](/zh-CN/platforms/android) +- 完整 Android 设置详情：[Android App](/zh-CN/platforms/android) -## 实时：模型冒烟（profile keys） +## Live：模型冒烟（profile keys） -实时测试分为两层，以便我们隔离故障： +live 测试分为两层，以便我们隔离故障： -- “直接模型”告诉我们，给定密钥时该提供商 / 模型是否至少能回答。 -- “Gateway 网关冒烟”告诉我们，针对该模型，完整的 Gateway 网关 + 智能体流水线是否工作正常（会话、历史、工具、沙箱策略等）。 +- “Direct model” 告诉我们：在给定密钥下，提供商/模型是否至少能够响应。 +- “Gateway smoke” 告诉我们：该模型的完整 Gateway 网关 + 智能体流水线是否正常工作（会话、历史记录、工具、沙箱策略等）。 -### 第 1 层：直接模型补全（无 Gateway 网关） +### 第 1 层：Direct model completion（无 Gateway 网关） - 测试：`src/agents/models.profiles.live.test.ts` - 目标： - 枚举发现到的模型 - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 - - 对每个模型运行一次小型补全（以及需要时的定向回归） + - 针对每个模型运行一个小型 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` 运行 modern allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - `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） - 如何选择提供商： - `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 推理重放 + 工具调用流） + - 设置 `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 探针） - - 可选的额外工具探针（exec+read 探针） - - OpenAI 回归路径（仅工具调用 → 后续跟进）持续可用 -- 探针细节（这样你可以快速解释故障）： - - `read` 探针：测试会在工作区中写入一个 nonce 文件，并要求智能体 `read` 该文件然后把 nonce 回显出来。 - - `exec+read` 探针：测试会要求智能体用 `exec` 把 nonce 写入一个临时文件，然后再 `read` 回来。 - - 图像探针：测试会附加一个生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 + - 创建/修补一个 `agent:dev:*` 会话（每次运行按模型覆盖） + - 遍历有密钥的模型并断言： + - “有意义的”响应（无工具） + - 真实工具调用可用（read 探测） + - 可选的额外工具探测（exec+read 探测） + - OpenAI 回归路径（仅工具调用 → 后续跟进）持续正常 +- 探测细节（这样你可以快速解释故障）： + - `read` 探测：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 它并把 nonce 回显回来。 + - `exec+read` 探测：测试会要求智能体使用 `exec` 将 nonce 写入临时文件，然后再 `read` 回来。 + - 图像探测：测试会附加一个生成的 PNG（猫 + 随机代码），并期望模型返回 `cat `。 - 实现参考：`src/gateway/gateway-models.profiles.live.test.ts` 和 `src/gateway/live-image-probe.ts`。 - 如何启用： - - `pnpm test:live`（或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） - 如何选择模型： - - 默认：modern allowlist（Opus / Sonnet 4.6+、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.7、Grok 4） + - 默认：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"`（或逗号列表）来缩小范围 -- 如何选择提供商（避免“OpenRouter 全部都跑”）： +- 如何选择提供商（避免“OpenRouter 全家桶”）： - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） -- 工具 + 图像探针在这个实时测试中始终开启： - - `read` 探针 + `exec+read` 探针（工具压力测试） - - 当模型声明支持图像输入时，会运行图像探针 - - 流程（高层）： +- 工具 + 图像探测在这个 live 测试中始终启用： + - `read` 探测 + `exec+read` 探测（工具压力测试） + - 当模型宣告支持图像输入时，图像探测会运行 + - 流程（高层级）： - 测试生成一个带有 “CAT” + 随机代码的小型 PNG（`src/gateway/live-image-probe.ts`） - - 通过 `agent` 的 `attachments: [{ mimeType: "image/png", content: "" }]` 发送 - - Gateway 网关把附件解析为 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） - - 嵌入式智能体把多模态用户消息转发给模型 + - 通过 `agent` `attachments: [{ mimeType: "image/png", content: "" }]` 发送 + - Gateway 网关将附件解析为 `images[]`（`src/gateway/server-methods/agent.ts` + `src/gateway/chat-attachments.ts`） + - 嵌入式智能体将多模态用户消息转发给模型 - 断言：回复包含 `cat` + 该代码（OCR 容错：允许轻微错误） -提示：如果你想查看自己的机器上可以测试什么（以及精确的 `provider/model` id），请运行： +提示：如果你想查看在自己的机器上可以测试什么（以及确切的 `provider/model` id），请运行： ```bash openclaw models list openclaw models list --json ``` -## 实时：CLI 后端冒烟（Codex CLI 或其他本地 CLI） +## Live：CLI 后端冒烟（Codex CLI 或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线，同时不触碰你的默认配置。 +- 目标：在不触碰你的默认配置的情况下，使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线。 - 启用： - - `pnpm test:live`（或者在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或在直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） - `OPENCLAW_LIVE_CLI_BACKEND=1` - 默认值： - 模型：`codex-cli/gpt-5.4` @@ -275,10 +273,10 @@ openclaw models list --json - `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_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_RESUME_PROBE=1` 发送第二轮对话并验证 resume 流程。 示例： @@ -297,31 +295,33 @@ pnpm test:docker:live-cli-backend 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它在仓库 Docker 镜像中以非 root 的 `node` 用户身份运行实时 CLI 后端冒烟。 -- 对于 `codex-cli`，它会把 Linux 版 `@openai/codex` 包安装到一个可缓存、可写的前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR` 中（默认：`~/.cache/openclaw/docker-cli-tools`）。 +- 它会在仓库 Docker 镜像内，以非 root 的 `node` 用户运行 live CLI 后端冒烟测试。 +- 对于 `codex-cli`，它会将 Linux 版 `@openai/codex` 包安装到一个可缓存的可写前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR`（默认：`~/.cache/openclaw/docker-cli-tools`）中。 -## 实时：ACP 绑定冒烟（`/acp spawn ... --bind here`） +## Live：ACP 绑定冒烟（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用实时 ACP 智能体验证真实 ACP 会话绑定流程： +- 目标：使用 live ACP 智能体验证真实 ACP 会话绑定流程： - 发送 `/acp spawn --bind here` - - 原地绑定一个合成的消息渠道会话 - - 在同一会话上发送一条普通后续消息 - - 验证该后续消息确实落入已绑定的 ACP 会话 transcript 中 + - 原地绑定一个合成的 message-channel 会话 + - 在同一个会话上发送普通后续消息 + - 验证后续消息落入已绑定的 ACP 会话转录中 - 启用： - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` - 默认值： - - ACP 智能体：`claude` - - 合成渠道：类似 Slack 私信 的会话上下文 + - Docker 中的 ACP 智能体：`claude,codex` + - 直接 `pnpm test:live ...` 使用的 ACP 智能体：`claude` + - 合成渠道：Slack 私信风格的会话上下文 - ACP 后端：`acpx` - 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` - `OPENCLAW_LIVE_ACP_BIND_AGENT=codex` + - `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude,codex` - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - 说明： - - 这一 lane 使用 Gateway 网关 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，因此测试可以附加消息渠道上下文，而无需假装向外部实际投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会为所选 ACP harness 智能体使用内置 `acpx` 插件自带的智能体注册表。 + - 此测试通道使用 Gateway 网关 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，因此测试可以附加 message-channel 上下文，而无需伪装为真实外部投递。 + - 当 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 未设置时，测试会对所选 ACP 测试智能体使用内置 `acpx` 插件自带的智能体注册表。 示例： @@ -337,17 +337,26 @@ Docker 配方： pnpm test:docker:live-acp-bind ``` +单智能体 Docker 配方： + +```bash +pnpm test:docker:live-acp-bind:claude +pnpm test:docker:live-acp-bind:codex +``` + Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 它会 source `~/.profile`，将匹配的 CLI 认证材料暂存进容器，在可写 npm 前缀中安装 `acpx`，然后在缺失时安装所请求的实时 CLI（`@anthropic-ai/claude-code` 或 `@openai/codex`）。 -- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，从而让 acpx 保持从已 source 的 profile 中获得的提供商环境变量对子 harness CLI 子进程可用。 +- 默认情况下，它会依次针对两个受支持的 live CLI 智能体运行 ACP 绑定冒烟：先 `claude`，后 `codex`。 +- 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 可缩小矩阵范围。 +- 它会读取 `~/.profile`，将匹配的 CLI 认证材料暂存进容器，在可写 npm 前缀中安装 `acpx`，然后在缺失时安装请求的 live CLI（`@anthropic-ai/claude-code` 或 `@openai/codex`）。 +- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 acpx 就能让从 profile 中读取到的 provider 环境变量继续对其子测试 CLI 可用。 -### 推荐的实时测试配方 +### 推荐的 live 配方 -范围窄、显式的 allowlist 最快也最不容易出问题： +缩小范围、显式 allowlist 的运行方式最快，也最不容易抖动： -- 单模型，直接模式（无 Gateway 网关）： +- 单模型，direct（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` - 单模型，Gateway 网关冒烟： @@ -356,26 +365,26 @@ Docker 说明： - 跨多个提供商的工具调用： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 聚焦 Google（Gemini API key + Antigravity）： - - Gemini（API key）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` +- 聚焦 Google（Gemini API 密钥 + Antigravity）： + - Gemini（API 密钥）：`OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` - Antigravity（OAuth）：`OPENCLAW_LIVE_GATEWAY_MODELS="google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-pro-high" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` 说明： -- `google/...` 使用 Gemini API（API key）。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge（类似 Cloud Code Assist 风格的智能体端点）。 +- `google/...` 使用 Gemini API（API 密钥）。 +- `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格的智能体端点）。 - `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的认证 + 工具怪癖）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API key / profile auth）；这通常就是大多数用户所说的“Gemini”。 - - CLI：OpenClaw 调用本地 `gemini` 二进制；它有自己的认证方式，并且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；大多数用户说“Gemini”时指的是这个。 + - CLI：OpenClaw 会 shell out 到本地 `gemini` 二进制文件；它有自己的认证方式，行为也可能不同（流式传输/工具支持/版本偏差）。 -## 实时：模型矩阵（我们覆盖什么） +## Live：模型矩阵（我们覆盖什么） -没有固定的“CI 模型列表”（实时测试是按需启用的），但以下是在开发机器上配有密钥时，**推荐**定期覆盖的模型。 +没有固定的“CI 模型列表”（live 是按需启用的），但这些是在装有密钥的开发机上建议定期覆盖的**推荐**模型。 -### Modern 冒烟集（工具调用 + 图像） +### 现代冒烟集（工具调用 + 图像） -这是我们预期要持续保持可用的“常用模型”运行集： +这是我们预期应持续可用的“常见模型”运行集： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -390,7 +399,7 @@ Docker 说明： ### 基线：工具调用（Read + 可选 Exec） -每个提供商家族至少选一个： +每个提供商族至少选一个： - OpenAI：`openai/gpt-5.4`（或 `openai/gpt-5.4-mini`） - Anthropic：`anthropic/claude-opus-4-6`（或 `anthropic/claude-sonnet-4-6`） @@ -398,277 +407,275 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选附加覆盖（有更好，没有也行）： +可选的额外覆盖（有更好，没有也可以）： -- xAI：`xai/grok-4`（或当前可用的最新版本） -- Mistral：`mistral/`…（选择一个你已启用、支持 “tools” 的模型） +- xAI：`xai/grok-4`（或最新可用版本） +- Mistral：`mistral/`…（选择一个你已启用、具备 “tools” 能力的模型） - Cerebras：`cerebras/`…（如果你有访问权限） - LM Studio：`lmstudio/`…（本地；工具调用取决于 API 模式） -### Vision：图像发送（附件 → 多模态消息） +### 视觉：图像发送（附件 → 多模态消息） -在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少加入一个支持图像的模型（Claude / Gemini / OpenAI 的视觉变体等），以覆盖图像探针。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude/Gemini/OpenAI 的视觉变体等），以触发图像探测。 -### 聚合器 / 替代 Gateway 网关 +### 聚合器 / 备用网关 -如果你启用了相应密钥，我们也支持通过以下方式测试： +如果你已启用对应密钥，我们也支持通过以下方式进行测试： -- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选项） +- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具+图像的候选项） - OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 Go（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） -你还可以把更多提供商纳入实时矩阵（如果你有凭证 / 配置）： +如果你有凭证/配置，也可以把更多提供商纳入 live 矩阵： - 内置：`openai`、`openai-codex`、`anthropic`、`google`、`google-vertex`、`google-antigravity`、`google-gemini-cli`、`zai`、`openrouter`、`opencode`、`opencode-go`、`xai`、`groq`、`cerebras`、`mistral`、`github-copilot` -- 通过 `models.providers`（自定义端点）：`minimax`（云端 / API），以及任何兼容 OpenAI / Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） +- 通过 `models.providers`（自定义端点）：`minimax`（云/API），以及任何兼容 OpenAI/Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） -提示：不要试图在文档中硬编码“所有模型”。权威列表始终是你机器上的 `discoverModels(...)` 返回结果，以及当前可用的密钥。 +提示：不要试图在文档里硬编码“所有模型”。权威列表始终是你机器上的 `discoverModels(...)` 返回结果，加上当前可用的密钥。 -## 凭证（绝不要提交） +## 凭证（切勿提交） -实时测试发现凭证的方式与 CLI 相同。实际含义如下： +live 测试发现凭证的方式与 CLI 相同。实际含义是： -- 如果 CLI 可用，实时测试应该也能找到相同的密钥。 -- 如果实时测试提示 “no creds”，就用你调试 `openclaw models list` / 模型选择时相同的方法去调试。 +- 如果 CLI 能工作，live 测试就应该能找到相同的密钥。 +- 如果 live 测试提示“无凭证”，请用与调试 `openclaw models list` / 模型选择相同的方式来调试。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试中 “profile keys” 的含义） +- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是 live 测试中 “profile keys” 的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（如果存在，会被复制到暂存的实时 home 中，但不是主 profile-key store） -- 默认情况下，本地实时运行会把活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；在该暂存配置里，`agents.*.workspace` / `agentDir` 路径覆盖会被移除，这样探针就不会落到你真实宿主机的工作区。 +- 旧版状态目录：`~/.openclaw/credentials/`（如果存在，会复制到暂存的 live home 中，但这不是主 profile-key 存储） +- 默认情况下，本地 live 运行会将活动配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；在该暂存配置里，`agents.*.workspace` / `agentDir` 路径覆盖会被剥离，因此探测不会触及你的真实主机工作区。 -如果你想依赖环境变量中的密钥（例如导出在你的 `~/.profile` 中），请在 `source ~/.profile` 之后运行本地测试，或者使用下面的 Docker 运行器（它们可以把 `~/.profile` 挂载进容器）。 +如果你希望依赖环境变量密钥（例如从你的 `~/.profile` 导出），请在本地测试前运行 `source ~/.profile`，或使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载进容器）。 -## Deepgram 实时测试（音频转录） +## Deepgram live（音频转录） - 测试：`src/media-understanding/providers/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts` -## BytePlus（国际版） coding plan 实时测试 +## BytePlus（国际版） 编码计划 live - 测试：`src/agents/byteplus.live.test.ts` - 启用：`BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` - 可选模型覆盖：`BYTEPLUS_CODING_MODEL=ark-code-latest` -## ComfyUI workflow 媒体实时测试 +## ComfyUI 工作流媒体 live - 测试：`extensions/comfy/comfy.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 COMFY_LIVE_TEST=1 pnpm test:live -- extensions/comfy/comfy.live.test.ts` - 范围： - 测试内置 comfy 图像、视频和 `music_generate` 路径 - - 除非配置了 `models.providers.comfy.`，否则会跳过各项能力 - - 在修改 comfy workflow 提交、轮询、下载或插件注册后很有用 + - 除非已配置 `models.providers.comfy.`，否则会跳过各项能力 + - 在你修改 comfy 工作流提交、轮询、下载或插件注册后尤其有用 -## 图像生成实时测试 +## 图像生成 live - 测试：`src/image-generation/runtime.live.test.ts` - 命令：`pnpm test:live src/image-generation/runtime.live.test.ts` - Harness：`pnpm test:live:media image` - 范围： - 枚举每个已注册的图像生成 provider 插件 - - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖你真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 + - 在探测前，从你的登录 shell（`~/.profile`）加载缺失的 provider 环境变量 + - 默认优先使用 live/env API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证/profile/模型的 provider - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` - `google:pro-edit` - `openai:default-generate` -- 当前覆盖的内置提供商： +- 当前覆盖的内置 provider： - `openai` - `google` -- 可选收窄： +- 可选缩小范围： - `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 认证并忽略仅环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile-store 认证，并忽略仅环境变量的覆盖 -## 音乐生成实时测试 +## 音乐生成 live - 测试：`extensions/music-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/music-generation-providers.live.test.ts` - Harness：`pnpm test:live:media music` - 范围： - - 测试共享内置音乐生成 provider 路径 + - 测试共享的内置音乐生成 provider 路径 - 当前覆盖 Google 和 MiniMax - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖你真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 - - 在可用时运行两个声明的运行时模式： - - 使用仅提示输入的 `generate` - - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` - - 当前共享 lane 覆盖： + - 在探测前，从你的登录 shell（`~/.profile`）加载 provider 环境变量 + - 默认优先使用 live/env API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证/profile/模型的 provider + - 在可用时运行两个已声明的运行时模式： + - `generate`，仅使用提示词输入 + - 当 provider 声明 `capabilities.edit.enabled` 时，运行 `edit` + - 当前共享测试通道覆盖： - `google`：`generate`、`edit` - `minimax`：`generate` - - `comfy`：独立的 Comfy 实时测试文件，不在此共享扫描中 -- 可选收窄： + - `comfy`：单独的 Comfy live 文件，不属于本共享扫描 +- 可选缩小范围： - `OPENCLAW_LIVE_MUSIC_GENERATION_PROVIDERS="google,minimax"` - `OPENCLAW_LIVE_MUSIC_GENERATION_MODELS="google/lyria-3-clip-preview,minimax/music-2.5+"` - 可选认证行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile-store 认证并忽略仅环境变量的覆盖 + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile-store 认证，并忽略仅环境变量的覆盖 -## 视频生成实时测试 +## 视频生成 live - 测试：`extensions/video-generation-providers.live.test.ts` - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` - Harness：`pnpm test:live:media video` - 范围： - - 测试共享内置视频生成 provider 路径 - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖你真实 shell 凭证 - - 跳过没有可用认证 / profile / 模型的提供商 - - 在可用时运行两个声明的运行时模式： - - 使用仅提示输入的 `generate` - - 当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - - 当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` - - 当前在共享扫描中已声明但被跳过的 `imageToVideo` 提供商： - - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL - - 提供商特定的 Vydra 覆盖： + - 测试共享的内置视频生成 provider 路径 + - 在探测前，从你的登录 shell（`~/.profile`）加载 provider 环境变量 + - 默认优先使用 live/env API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实 shell 凭证 + - 跳过没有可用认证/profile/模型的 provider + - 在可用时运行两个已声明的运行时模式： + - `generate`，仅使用提示词输入 + - 当 provider 声明 `capabilities.imageToVideo.enabled` 且所选 provider/model 在共享扫描中接受缓冲区支持的本地图像输入时，运行 `imageToVideo` + - 当 provider 声明 `capabilities.videoToVideo.enabled` 且所选 provider/model 在共享扫描中接受缓冲区支持的本地视频输入时，运行 `videoToVideo` + - 当前在共享扫描中已声明但被跳过的 `imageToVideo` provider： + - `vydra`，因为内置 `veo3` 仅支持文本，且内置 `kling` 需要远程图像 URL + - provider 特定的 Vydra 覆盖： - `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - - 该文件会运行 `veo3` 文本转视频，以及一个默认使用远程图像 URL fixture 的 `kling` lane - - 当前 `videoToVideo` 实时覆盖： - - 仅 `runway`，当所选模型为 `runway/gen4_aleph` 时 - - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - - `alibaba`、`qwen`、`xai`，因为这些路径目前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini / Veo lane 使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享 lane 不保证组织特定的视频修补 / remix 访问权限 -- 可选收窄： + - 该文件会运行 `veo3` 文本转视频，以及默认使用远程图像 URL 夹具的 `kling` 测试通道 + - 当前 `videoToVideo` 的 live 覆盖： + - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 + - 当前在共享扫描中已声明但被跳过的 `videoToVideo` provider： + - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL + - `google`，因为当前共享 Gemini/Veo 通道使用本地缓冲区支持输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享测试通道无法保证组织特定的视频修补/重混访问权限 +- 可选缩小范围： - `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-store 认证，并忽略仅环境变量的覆盖 -## 媒体实时 harness +## 媒体 live harness - 命令：`pnpm test:live:media` - 目的： - - 通过一个仓库原生入口运行共享的图像、音乐和视频实时测试套件 - - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动把每个测试套件收窄到当前拥有可用认证的提供商 - - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 + - 通过一个仓库原生入口点运行共享的图像、音乐和视频 live 套件 + - 自动从 `~/.profile` 加载缺失的 provider 环境变量 + - 默认自动将每个套件缩小到当前具有可用认证的 provider + - 复用 `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 运行器分成两类： +这些 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`），并挂载你的本地配置目录和工作区（如果已挂载，也会 source `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 -- Docker 实时运行器默认采用更小的冒烟上限，这样完整 Docker 扫描才保持实际可行： +- live-model 运行器：`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像中运行各自匹配的 profile-key live 文件（`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`），并挂载你的本地配置目录和工作区（如果已挂载，也会读取 `~/.profile`）。对应的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。 +- Docker live 运行器默认采用更小的冒烟上限，以便完整 Docker 扫描仍然可行： `test:docker:live-models` 默认设置 `OPENCLAW_LIVE_MAX_MODELS=12`，而 `test:docker:live-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` 会启动一个或多个真实容器，并验证更高层的集成路径。 + 明确需要更大的穷举扫描时，再覆盖这些环境变量。 +- `test:docker:all` 会先通过 `test:docker:live-build` 构建一次 live Docker 镜像，然后在两个 live Docker 测试通道中复用它。 +- 容器冒烟运行器：`test:docker:openwebui`、`test:docker:onboard`、`test:docker:gateway-network`、`test:docker:mcp-channels` 和 `test:docker:plugins` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -这些实时模型 Docker 运行器还只会 bind-mount 所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持项），然后在运行前把它们复制进容器 home，这样外部 CLI OAuth 就能刷新 token，同时不会改动宿主机认证存储： +live-model Docker 运行器还只会绑定挂载所需的 CLI 认证 home（如果运行未缩小范围，则挂载所有受支持项），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 可以刷新令牌，而不会修改宿主机认证存储： -- 直接模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） +- 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`） - 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 live 冒烟：`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 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 运行器还会以只读方式 bind-mount 当前 checkout， -并将其暂存到容器内的临时 workdir 中。这样可以让运行时 -镜像保持精简，同时仍然能针对你精确的本地源码 / 配置运行 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_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层的兼容性冒烟：它会启动一个 -启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器， +live-model Docker 运行器还会以只读方式绑定挂载当前 checkout，并将其暂存到容器内的临时工作目录中。这样既能让运行时镜像保持轻量，又仍然能针对你本地的确切源代码/配置运行 Vitest。 +暂存步骤会跳过大型本地专用缓存和应用构建输出，例如 +`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地的 `.build` 或 +Gradle 输出目录，这样 Docker live 运行就不会花上数分钟去复制 +机器特定的产物。 +它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关 live 探测就不会在容器中启动 +真实的 Telegram/Discord 等渠道 worker。 +`test:docker:live-models` 仍然会运行 `pnpm test:live`，因此当你需要缩小或排除该 Docker 测试通道中的 Gateway 网关 +live 覆盖时，也请一并传递 +`OPENCLAW_LIVE_GATEWAY_*`。 +`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个启用了 OpenAI 兼容 HTTP 端点的 +OpenClaw Gateway 网关容器， 再针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器，通过 -Open WebUI 完成登录，验证 `/api/models` 暴露了 `openclaw/default`，然后通过 +Open WebUI 完成登录，验证 `/api/models` 暴露 `openclaw/default`，然后通过 Open WebUI 的 `/api/chat/completions` 代理发送一次真实聊天请求。 -第一次运行可能明显更慢，因为 Docker 可能需要拉取 -Open WebUI 镜像，而 Open WebUI 也可能需要完成自身的冷启动 setup。 -这一 lane 需要一个可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 -成功运行会打印一小段 JSON 载荷，例如 `{ "ok": true, "model": +首次运行可能明显更慢，因为 Docker 可能需要拉取 +Open WebUI 镜像，而且 Open WebUI 可能需要完成自身的冷启动设置。 +这个测试通道需要一个可用的 live 模型密钥，而 `OPENCLAW_PROFILE_FILE` +（默认是 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 +成功运行会打印一小段 JSON 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是刻意做成确定性的，不需要真实的 -Telegram、Discord 或 iMessage 账号。它会启动一个带种子的 Gateway 网关 -容器，启动第二个容器来执行 `openclaw mcp serve`，然后 -验证已路由会话发现、transcript 读取、附件元数据、 -实时事件队列行为、出站发送路由，以及类 Claude 的渠道 + -权限通知在真实 stdio MCP bridge 上的表现。通知检查 -会直接检查原始 stdio MCP frame，因此该冒烟验证的是 -bridge 实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露出的内容。 +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要 +真实的 Telegram、Discord 或 iMessage 账号。它会启动一个带种子数据的 Gateway 网关 +容器，再启动第二个容器来拉起 `openclaw mcp serve`，然后 +验证已路由的会话发现、转录读取、附件元数据、 +live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + +权限通知，所有这些都通过真实的 stdio MCP bridge 完成。通知检查 +会直接检查原始 stdio MCP 帧，因此这个冒烟测试验证的是 bridge +实际发出的内容，而不只是某个特定客户端 SDK 恰好暴露出来的内容。 手动 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`，并在运行测试前 source -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于 Docker 内部缓存 CLI 安装 -- `$HOME` 下的外部 CLI 认证目录 / 文件会以只读方式挂载到 `/host-auth...` 下，然后在测试开始前复制到 `/home/node/...` +- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile` 并在运行测试前读取 +- `OPENCLAW_DOCKER_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` 推断出的所需目录 / 文件 + - 缩小范围的 provider 运行只会挂载根据 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录/文件 - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none` 或逗号列表（如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex`）手动覆盖 - `OPENCLAW_LIVE_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...` 用于缩小运行范围 -- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于在容器内筛选提供商 -- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile store（而不是环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 选择 Open WebUI 冒烟中由 Gateway 网关暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟所用的 nonce 校验提示 +- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于过滤容器内的 provider +- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile store（而非环境变量） +- `OPENCLAW_OPENWEBUI_MODEL=...` 选择在 Open WebUI 冒烟中由 Gateway 网关暴露的模型 +- `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”） +- Gateway 网关工具调用（mock OpenAI，真实 Gateway 网关 + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） +- Gateway 网关向导（WS `wizard.start`/`wizard.next`，强制写入配置 + 认证）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） ## 智能体可靠性评估（Skills） -我们已经有一些 CI 安全的测试，它们的行为类似“智能体可靠性评估”： +我们已经有一些 CI 安全的测试，它们的行为类似于“智能体可靠性评估”： -- 通过真实 Gateway 网关 + 智能体循环进行模拟工具调用（`src/gateway/gateway.test.ts`）。 -- 验证会话接线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 +- 通过真实 Gateway 网关 + 智能体循环执行 mock 工具调用（`src/gateway/gateway.test.ts`）。 +- 验证会话布线和配置效果的端到端向导流程（`src/gateway/gateway.test.ts`）。 -对于 Skills，仍然缺少的内容是（参见 [Skills](/zh-CN/tools/skills)）： +对于 Skills，我们目前仍缺少的是（参见 [Skills](/zh-CN/tools/skills)）： -- **决策能力：** 当 prompt 中列出了 Skills 时，智能体能否选择正确的 skill（或避开无关 skill）？ -- **合规性：** 智能体是否会在使用前读取 `SKILL.md` 并遵循要求的步骤 / 参数？ -- **工作流契约：** 多轮场景下断言工具顺序、会话历史延续以及沙箱边界。 +- **决策能力：** 当提示词中列出了 Skills 时，智能体是否会选择正确的 skill（或避免使用无关 skill）？ +- **合规性：** 智能体是否会在使用前读取 `SKILL.md`，并遵循要求的步骤/参数？ +- **工作流契约：** 断言工具顺序、会话历史承接和沙箱边界的多轮场景。 -未来的评估首先应保持确定性： +未来的评估应首先保持确定性： -- 一个使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 -- 一小套聚焦 skill 的场景（使用 vs 避免、gate、prompt 注入）。 -- 只有在 CI 安全套件就位之后，才增加可选的实时评估（按需启用、由环境变量 gating）。 +- 一个使用 mock provider 的场景运行器，用来断言工具调用 + 顺序、skill 文件读取以及会话布线。 +- 一小套聚焦于 skill 的场景（该用还是不该用、门禁、提示注入）。 +- 只有在 CI 安全套件建立之后，才增加可选的 live 评估（按需启用、受环境变量门控）。 ## 契约测试（插件和渠道形状） -契约测试会验证每个已注册插件和渠道都符合其 +契约测试用于验证每个已注册的插件和渠道都符合其 接口契约。它们会遍历所有发现到的插件，并运行一组 -关于形状和行为的断言。默认的 `pnpm test` 单元 lane 会有意 +形状和行为断言。默认的 `pnpm test` unit 测试通道会刻意 跳过这些共享 seam 和冒烟文件；当你修改共享渠道或提供商接口时， 请显式运行契约命令。 @@ -676,7 +683,7 @@ bridge 实际发出的内容，而不只是某个特定客户端 SDK 恰好暴 - 所有契约：`pnpm test:contracts` - 仅渠道契约：`pnpm test:contracts:channels` -- 仅提供商契约：`pnpm test:contracts:plugins` +- 仅 provider 契约：`pnpm test:contracts:plugins` ### 渠道契约 @@ -685,50 +692,50 @@ bridge 实际发出的内容，而不只是某个特定客户端 SDK 恰好暴 - **plugin** - 基本插件形状（id、name、capabilities） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 -- **outbound-payload** - 消息载荷结构 +- **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 - **actions** - 渠道动作处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录 / 花名册 API -- **group-policy** - 群组策略强制执行 +- **directory** - 目录/花名册 API +- **group-policy** - 群组策略执行 -### 提供商状态契约 +### Provider 状态契约 位于 `src/plugins/contracts/*.contract.test.ts`。 -- **status** - 渠道状态探针 +- **status** - 渠道状态探测 - **registry** - 插件注册表形状 -### 提供商契约 +### Provider 契约 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选择 +- **auth-choice** - 认证选择/选取 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 -- **runtime** - 提供商运行时 -- **shape** - 插件形状 / 接口 +- **runtime** - provider 运行时 +- **shape** - 插件形状/接口 - **wizard** - 设置向导 ### 何时运行 -- 在修改 plugin-sdk 导出或子路径后 -- 在添加或修改渠道或 provider 插件后 -- 在重构插件注册或发现逻辑后 +- 修改 plugin-sdk 导出或子路径之后 +- 添加或修改渠道插件或 provider 插件之后 +- 重构插件注册或发现逻辑之后 -契约测试会在 CI 中运行，不需要真实 API 密钥。 +契约测试会在 CI 中运行，并且不需要真实 API 密钥。 -## 添加回归测试（指导） +## 添加回归测试（指南） -当你修复一个在实时测试中发现的提供商 / 模型问题时： +当你修复了一个在 live 中发现的 provider/model 问题时： -- 如果可能，添加一个 CI 安全的回归测试（模拟 / stub 提供商，或捕获确切的请求形状转换） -- 如果它天生只能实时测试（速率限制、认证策略），就让实时测试保持范围窄，并通过环境变量按需启用 -- 优先定位到能捕获该缺陷的最小层级： - - 提供商请求转换 / 重放缺陷 → 直接模型测试 - - Gateway 网关会话 / 历史 / 工具流水线缺陷 → Gateway 网关实时冒烟或 CI 安全的 Gateway 网关模拟测试 -- SecretRef 遍历防护栏： - - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历片段 exec id 会被拒绝。 - - 如果你在 `src/secrets/target-registry-data.ts` 中新增了一个 `includeInPlan` SecretRef 目标族，请更新该测试中的 `classifyTargetClass`。该测试会在遇到未分类目标 id 时故意失败，这样新类别就不会被悄悄跳过。 +- 如果可能，添加一个 CI 安全的回归测试（mock/stub provider，或捕获准确的请求形状转换） +- 如果这个问题天然只能在 live 中复现（速率限制、认证策略），请让 live 测试保持范围小，并通过环境变量按需启用 +- 优先定位能捕捉该缺陷的最小层级： + - provider 请求转换/回放缺陷 → direct models 测试 + - Gateway 网关会话/历史记录/工具流水线缺陷 → Gateway 网关 live 冒烟或 CI 安全的 Gateway 网关 mock 测试 +- SecretRef 遍历护栏： + - `src/secrets/exec-secret-ref-id-parity.test.ts` 会从注册表元数据（`listSecretTargetRegistryEntries()`）中为每个 SecretRef 类派生一个采样目标，然后断言遍历段 exec id 会被拒绝。 + - 如果你在 `src/secrets/target-registry-data.ts` 中添加了新的 `includeInPlan` SecretRef 目标族，请更新该测试中的 `classifyTargetClass`。该测试会在目标 id 未分类时故意失败，这样新类别就无法被悄悄跳过。