From d3eab491c4b87c71d00a38a2f63492200c0727fb Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Tue, 7 Apr 2026 08:16:24 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/help/testing.md | 569 +++++++++++++++++------------------ docs/zh-CN/reference/test.md | 76 ++--- 2 files changed, 322 insertions(+), 323 deletions(-) diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index ed6c30fa7..39e499df3 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -6,22 +6,22 @@ read_when: summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及各项测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-07T08:10:17Z" + generated_at: "2026-04-07T08:16:24Z" model: gpt-5.4 provider: openai - source_hash: f7ae891b3ad878e4295f94a385e95dbcfdb26c23c2c257984148708894c9546b + source_hash: 248868fe5726ca2086ffd3dffee1459bcd810ac9275414eba3a75576cdeec116 source_path: help/testing.md workflow: 15 --- # 测试 -OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 +OpenClaw 有三套 Vitest 测试套件（单元 / 集成、e2e、实时）以及一小组 Docker 运行器。 本文档是一份“我们如何测试”的指南： -- 各个套件覆盖什么内容（以及它明确 _不_ 覆盖什么） -- 常见工作流（本地、推送前、调试）应运行哪些命令 +- 每个测试套件覆盖什么内容（以及它刻意 _不_ 覆盖什么） +- 常见工作流该运行哪些命令（本地、推送前、调试） - 实时测试如何发现凭证并选择模型 / 提供商 - 如何为真实世界中的模型 / 提供商问题添加回归测试 @@ -29,79 +29,78 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 大多数时候： -- 完整门禁（预期应在 push 之前运行）：`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`） -- 文件：`vitest.unit.config.ts` 覆盖的 `src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元清单，以及白名单中的 `ui` Node 测试 +- 配置：对现有分域 Vitest 项目执行十个顺序分片运行（`vitest.full-*.config.ts`） +- 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 - 范围： - 纯单元测试 - 进程内集成测试（Gateway 网关认证、路由、工具、解析、配置） - - 已知缺陷的确定性回归测试 + - 针对已知缺陷的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - - 应当快速且稳定 + - 应该快速且稳定 - 项目说明： - - 未指定目标的 `pnpm test` 现在会运行十个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`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` 不必承担完整根项目启动成本。 - - 当 diff 只涉及可路由的源码 / 测试文件时，`pnpm test:changed` 会将变更过的 git 路径展开到同样的作用域测试通道；配置 / setup 编辑仍会回退到更广泛的根项目重跑。 - - 部分选定的 `plugin-sdk` 和 `commands` 测试还会通过专用的轻量测试通道运行，并跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时较重的文件仍保留在现有测试通道上。 - - 部分选定的 `plugin-sdk` 和 `commands` 辅助源码文件也会将 changed 模式映射到这些轻量测试通道中的显式同级测试，因此辅助文件改动不需要为该目录重跑完整的重型套件。 - - `auto-reply` 现在有三个专用分桶：顶层核心辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这让最重的 reply 测试工作不会挤占廉价的状态 / 分块 / token 测试。 + - 未指定目标的 `pnpm test` 现在运行 11 个更小的分片配置（`core-unit-src`、`core-unit-security`、`core-unit-ui`、`core-unit-support`、`core-support-boundary`、`core-contracts`、`core-bundled`、`core-runtime`、`agentic`、`auto-reply`、`extensions`），而不是一个庞大的原生根项目进程。这能降低高负载机器上的峰值 RSS，并避免 `auto-reply` / 扩展相关工作拖慢无关测试套件。 + - `pnpm test --watch` 仍然使用原生根 `vitest.config.ts` 项目图，因为多分片观察循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会先将明确的文件 / 目录目标路由到分域测试通道，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不必承担完整根项目启动的开销。 + - `pnpm test:changed` 会在差异只涉及可路由的源码 / 测试文件时，将变更过的 git 路径扩展到相同的分域测试通道；配置 / 设置修改仍会回退到更广泛的根项目重跑。 + - 部分 `plugin-sdk` 和 `commands` 测试也会通过专用的轻量测试通道运行，跳过 `test/setup-openclaw-runtime.ts`；有状态 / 运行时负载较重的文件仍保留在现有通道中。 + - 部分 `plugin-sdk` 和 `commands` 辅助源码文件也会在 changed 模式下映射到这些轻量通道中的显式同级测试，因此辅助文件修改无需重跑该目录下完整的重型测试套件。 + - `auto-reply` 现在有三个专用分桶：顶层核心辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这样可以让最重的回复测试 harness 工作不再压到轻量的状态 / 分块 / token 测试上。 - 嵌入式运行器说明： - 当你修改消息工具发现输入或压缩运行时上下文时， 要同时保留两个层级的覆盖。 - - 为纯路由 / 规范化边界添加聚焦的辅助函数回归测试。 - - 同时还要保证嵌入式运行器集成套件保持健康： + - 为纯路由 / 规范化边界添加聚焦的辅助回归测试。 + - 同时也要保证嵌入式运行器集成测试套件健康： `src/agents/pi-embedded-runner/compact.hooks.test.ts`、 - `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 和 + `src/agents/pi-embedded-runner/run.overflow-compaction.test.ts` 以及 `src/agents/pi-embedded-runner/run.overflow-compaction.loop.test.ts`。 - - 这些套件会验证作用域 id 和压缩行为仍然沿真实的 - `run.ts` / `compact.ts` 路径流动；仅有辅助函数测试 + - 这些测试套件会验证分域 id 和压缩行为仍然会通过真实的 `run.ts` / `compact.ts` 路径流转；仅有辅助函数测试 不能充分替代这些集成路径。 -- 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`，并在根项目、e2e 和实时配置中使用非隔离运行器。 + - 根 `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: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`。 + - 本地 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 的原生根项目路径进行比较，并输出总耗时与 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会通过 `scripts/test-projects.mjs` 和根 Vitest 配置，将当前脏工作树的变更文件列表路由后进行基准测试。 - - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动与转换开销写出主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件级并行的情况下，为单元套件写出运行器 CPU + 堆 profile。 + - `pnpm test:perf:imports` 会启用 Vitest 导入时长报告以及导入明细输出。 + - `pnpm test:perf:imports:changed` 会将相同的分析视图限制到自 `origin/main` 以来变更的文件。 +- `pnpm test:perf:changed:bench -- --ref ` 会把已路由的 `test:changed` 与针对该已提交差异的原生根项目路径进行比较，并输出总耗时以及 macOS 最大 RSS。 +- `pnpm test:perf:changed:bench -- --worktree` 会通过将变更文件列表路由到 `scripts/test-projects.mjs` 和根 Vitest 配置，对当前脏工作树进行基准测试。 + - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动和转换开销写出主线程 CPU profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件级并行的情况下，为单元测试套件写出运行器 CPU + 堆 profile。 ### E2E（Gateway 网关冒烟） @@ -109,36 +108,36 @@ 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_WORKERS=` 强制指定 worker 数量（上限为 16）。 - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - 多实例 Gateway 网关端到端行为 - - WebSocket / HTTP 接口、节点配对，以及更重的网络行为 + - WebSocket / HTTP 接口、节点配对和更重的网络交互 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比单元测试有更多可变部件（可能更慢） + - 比单元测试涉及更多活动部件（可能更慢） ### E2E：OpenShell 后端冒烟 - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - - 通过 Docker 在宿主机上启动一个隔离的 OpenShell Gateway 网关 - - 从临时本地 Dockerfile 创建一个沙箱 - - 通过真实 `sandbox ssh-config` + SSH exec，测试 OpenClaw 的 OpenShell 后端 - - 通过沙箱文件系统桥验证远端规范化文件系统行为 + - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 + - 从一个临时本地 Dockerfile 创建沙箱 + - 通过真实的 `sandbox ssh-config` + SSH exec 练习 OpenClaw 的 OpenShell 后端 + - 通过沙箱文件系统桥验证远程规范化文件系统行为 - 预期： - - 仅按需启用；不是默认 `pnpm test:e2e` 运行的一部分 + - 仅按需启用；不属于默认的 `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 二进制或包装脚本 ### 实时（真实提供商 + 真实模型） @@ -147,113 +146,113 @@ OpenClaw 有三个 Vitest 测试套件（单元 / 集成、e2e、实时）以及 - 文件：`src/**/*.live.test.ts` - 默认：由 `pnpm test:live` **启用**（设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型今天在真实凭证下是否真的可用？” - - 捕获提供商格式变化、工具调用怪癖、认证问题以及速率限制行为 + - “这个提供商 / 模型今天是否真的能在真实凭证下工作？” + - 捕获提供商格式变更、工具调用怪癖、认证问题和限流行为 - 预期： - - 按设计不保证 CI 稳定（真实网络、真实提供商策略、配额、故障） - - 会花钱 / 消耗速率限制 - - 优先运行缩小后的子集，而不是“一股脑全跑” -- 实时运行会读取 `~/.profile`，以获取缺失的 API 密钥。 -- 默认情况下，实时运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，这样单元测试夹具就不会修改你真实的 `~/.openclaw`。 -- 仅当你明确需要实时测试使用真实 home 目录时，才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。 -- `pnpm test:live` 现在默认采用更安静的模式：会保留 `[live] ...` 进度输出，但会隐藏额外的 `~/.profile` 提示，并静音 Gateway 网关启动日志 / Bonjour 杂讯。如果你想恢复完整启动日志，可设置 `OPENCLAW_LIVE_TEST_QUIET=0`。 -- API 密钥轮换（提供商特定）：设置 `*_API_KEYS`，使用逗号 / 分号格式，或设置 `*_API_KEY_1`、`*_API_KEY_2`（例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`），或者通过 `OPENCLAW_LIVE_*_KEY` 进行单次实时覆盖；测试会在收到速率限制响应时重试。 + - 按设计不适合 CI 稳定运行（真实网络、真实提供商策略、配额、故障） + - 会花钱 / 消耗限额 + - 优先运行缩小范围的子集，而不是“一切全跑” +- 实时运行会读取 `~/.profile` 以补全缺失的 API 密钥。 +- 默认情况下，实时运行仍会隔离 `HOME`，并将配置 / 认证材料复制到临时测试 home 中，这样单元测试 fixture 就不会修改你真实的 `~/.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 网关 / 探测心跳。 + - 实时测试套件现在会把进度行输出到 stderr，因此即使 Vitest 控制台捕获处于安静模式，长时间的提供商调用也能明显看出正在运行。 + - `vitest.live.config.ts` 禁用了 Vitest 控制台拦截，因此提供商 / Gateway 网关进度行会在实时测试期间立即流式输出。 + - 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直连模型的心跳间隔。 + - 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关 / 探测的心跳间隔。 -## 我应该运行哪个套件？ +## 我应该运行哪套测试？ -使用下面的决策表： +使用下面这个决策表： -- 编辑逻辑 / 测试：运行 `pnpm test`（如果你改动很多，再加上 `pnpm test:coverage`） -- 触及 Gateway 网关网络 / WS 协议 / 配对：增加 `pnpm test:e2e` -- 调试“我的 bot 挂了” / 提供商特定故障 / 工具调用：运行缩小后的 `pnpm test:live` +- 修改逻辑 / 测试：运行 `pnpm test`（如果改动较大，也运行 `pnpm test:coverage`） +- 触及 Gateway 网关网络 / WS 协议 / 配对：再加上 `pnpm test:e2e` +- 调试“我的 bot 挂了” / 提供商特定故障 / 工具调用：运行一个缩小范围的 `pnpm test:live` ## 实时：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` -- 目标：调用已连接 Android 节点当前**对外声明的每一个命令**，并断言命令契约行为。 +- 目标：调用已连接 Android 节点当前**宣告的每一条命令**，并断言命令契约行为。 - 范围： - - 依赖预先 / 手动 setup（该套件不会安装 / 运行 / 配对 app）。 - - 针对所选 Android 节点逐条命令执行 Gateway 网关 `node.invoke` 验证。 -- 所需预先 setup： - - Android app 已连接并与 Gateway 网关配对。 - - app 保持在前台。 - - 你期望通过的能力所需权限 / 捕获授权已授予。 -- 可选目标覆盖： + - 预设 / 手动设置（测试套件不会安装 / 运行 / 配对应用）。 + - 对所选 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） -实时测试分为两层，这样我们可以隔离故障： +实时测试拆分为两层，以便隔离故障： -- “直接模型”告诉我们，给定的密钥下提供商 / 模型是否至少能响应。 -- “Gateway 网关冒烟”告诉我们，针对该模型，完整的 Gateway 网关 + 智能体流水线是否正常工作（会话、历史、工具、沙箱策略等）。 +- “直连模型”告诉我们，给定密钥下该提供商 / 模型是否至少能作答。 +- “Gateway 网关冒烟”告诉我们，完整的 Gateway 网关 + 智能体流水线是否能针对该模型正常工作（会话、历史、工具、沙箱策略等）。 -### 第 1 层：直接模型补全（无 Gateway 网关） +### 第 1 层：直连模型补全（无 Gateway 网关） - 测试：`src/agents/models.profiles.live.test.ts` - 目标： - - 枚举发现到的模型 - - 使用 `getApiKeyForModel` 选择你拥有凭证的模型 - - 对每个模型运行一个小型补全（必要时运行针对性回归） -- 如何启用： - - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） -- 设置 `OPENCLAW_LIVE_MODELS=modern`（或 `all`，即 modern 的别名）才会真正运行该套件；否则会跳过，以便让 `pnpm test:live` 继续聚焦于 Gateway 网关冒烟 + - 枚举已发现的模型 + - 使用 `getApiKeyForModel` 选择你有凭证的模型 + - 对每个模型运行一个小型补全（必要时包含定向回归测试） +- 启用方式： + - `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=all` 是 modern allowlist 的别名 + - `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） - 如何选择提供商： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔 allowlist） - 密钥来源： - 默认：profile 存储和环境变量回退 - - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制**只使用 profile 存储** -- 存在原因： - - 将“提供商 API 坏了 / 密钥无效”与“Gateway 网关智能体流水线坏了”区分开 - - 容纳小型、孤立的回归测试（例如：OpenAI Responses / Codex Responses 推理回放 + 工具调用流程） + - 设置 `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 可强制只使用 **profile 存储** +- 该层存在的原因： + - 将“提供商 API 挂了 / 密钥无效”与“Gateway 网关智能体流水线挂了”分离 + - 容纳小而隔离的回归测试（例如：OpenAI Responses / Codex Responses 推理重放 + 工具调用流程） -### 第 2 层：Gateway 网关 + dev 智能体冒烟（也就是 “@openclaw” 实际做的事） +### 第 2 层：Gateway 网关 + dev 智能体冒烟（即 “@openclaw” 实际做的事） - 测试：`src/gateway/gateway-models.profiles.live.test.ts` - 目标： - 启动一个进程内 Gateway 网关 - 创建 / 修补一个 `agent:dev:*` 会话（每次运行按模型覆盖） - - 遍历带密钥的模型并断言： - - 有“有意义”的响应（无工具） - - 真实的工具调用可用（read 探测） - - 可选的额外工具探测（exec+read 探测） - - OpenAI 回归路径（仅工具调用 → 后续跟进）持续可用 + - 遍历“有密钥的模型”，并断言： + - 有“有意义”的回复（无工具） + - 真实工具调用可用（读取探测） + - 可选的额外工具探测可用（exec + read 探测） + - OpenAI 回归路径（仅工具调用 → 后续跟进）仍然正常 - 探测细节（这样你可以快速解释故障）： - - `read` 探测：测试会在工作区写入一个 nonce 文件，并要求智能体 `read` 它，再回显 nonce。 - - `exec+read` 探测：测试会要求智能体通过 `exec` 将 nonce 写入临时文件，再通过 `read` 读回。 + - `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） - - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是 modern allowlist 的别名 + - 默认：现代 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"`（或逗号列表）以缩小范围 -- 如何选择提供商（避免“OpenRouter 全量”）： +- 如何选择提供商（避免“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`） - 通过 `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 @@ -264,19 +263,19 @@ openclaw models list --json - 测试：`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 后端插件元数据。 -- 覆盖参数（可选）： + - 命令 / 参数 / 图像行为来自所属 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_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` 发送第二轮消息并验证恢复流程。 @@ -305,34 +304,34 @@ pnpm test:docker:live-cli-backend:gemini 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会以非 root 的 `node` 用户，在仓库 Docker 镜像内运行实时 CLI 后端冒烟。 -- 它会从归属扩展中解析 CLI 冒烟元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到可缓存的可写前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR`（默认：`~/.cache/openclaw/docker-cli-tools`）中。 +- 它会在仓库 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`）。 ## 实时：ACP 绑定冒烟（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用实时 ACP 智能体验证真实 ACP 会话绑定流程： +- 目标：使用实时 ACP 智能体验证真实的 ACP 对话绑定流程： - 发送 `/acp spawn --bind here` - - 就地绑定一个合成的消息渠道会话 - - 在同一个会话上发送一次普通后续消息 - - 验证该后续消息落入已绑定的 ACP 会话转录中 + - 就地绑定一个合成的消息渠道对话 + - 在同一个对话中发送正常的后续消息 + - 验证该后续消息进入已绑定 ACP 会话的转录记录 - 启用： - `pnpm test:live src/gateway/gateway-acp-bind.live.test.ts` - `OPENCLAW_LIVE_ACP_BIND=1` - 默认值： - Docker 中的 ACP 智能体：`claude,codex,gemini` - 直接 `pnpm test:live ...` 使用的 ACP 智能体：`claude` - - 合成渠道：类似 Slack 私信的会话上下文 + - 合成渠道：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 智能体提供的内置智能体注册表。 + - 这个测试通道使用 Gateway 网关 `chat.send` 接口，并带有仅管理员可用的合成 originating-route 字段，这样测试就能附加消息渠道上下文，而无需假装真的向外部投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件的内建智能体注册表来获取所选 ACP harness 智能体。 示例： @@ -359,16 +358,16 @@ pnpm test:docker:live-acp-bind:gemini Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会依次对所有受支持的实时 CLI 智能体运行 ACP 绑定冒烟：`claude`、`codex`、然后 `gemini`。 +- 默认情况下，它会按顺序针对所有受支持的实时 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 可用。 +- 它会读取 `~/.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 最快、也最不容易出问题： -- 单模型，直接调用（无 Gateway 网关）： +- 单模型，直连（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` - 单模型，Gateway 网关冒烟： @@ -384,34 +383,34 @@ Docker 说明： 说明： - `google/...` 使用 Gemini API（API 密钥）。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge（类似 Cloud Code Assist 风格的智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（独立认证 + 独特的工具行为）。 +- `google-antigravity/...` 使用 Antigravity OAuth 桥（Cloud Code Assist 风格的智能体端点）。 +- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的认证 + 工具行为差异）。 - Gemini API 与 Gemini CLI： - - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这也是大多数用户所说的 “Gemini”。 - - CLI：OpenClaw 会 shell out 到本地 `gemini` 二进制文件；它有自己独立的认证方式，并且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 + - API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥 / profile 认证）；这通常就是大多数用户所说的 “Gemini”。 + - CLI：OpenClaw 会 shell out 到本地 `gemini` 二进制；它有自己的认证方式，而且行为可能不同（流式传输 / 工具支持 / 版本偏差）。 ## 实时：模型矩阵（我们覆盖什么） -没有固定的“CI 模型列表”（实时测试是按需启用的），但以下是**推荐**在带有密钥的开发机上定期覆盖的模型。 +没有固定的“CI 模型列表”（实时测试是按需启用的），但下面这些是建议在有密钥的开发机器上定期覆盖的模型。 -### Modern 冒烟集（工具调用 + 图像） +### 现代冒烟集合（工具调用 + 图像） -这是我们预期要持续保持可用的“常见模型”运行集： +这是我们预期需要持续保持可用的“常见模型”运行集合： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` - Anthropic：`anthropic/claude-opus-4-6`（或 `anthropic/claude-sonnet-4-6`） -- Google（Gemini API）：`google/gemini-3.1-pro-preview` 和 `google/gemini-3-flash-preview`（避免旧版 Gemini 2.x 模型） +- Google（Gemini API）：`google/gemini-3.1-pro-preview` 和 `google/gemini-3-flash-preview`（避免较老的 Gemini 2.x 模型） - Google（Antigravity）：`google-antigravity/claude-opus-4-6-thinking` 和 `google-antigravity/gemini-3-flash` - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -运行带工具 + 图像的 Gateway 网关冒烟： +运行带工具 + 图像的 Gateway 网关冒烟测试： `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,openai-codex/gpt-5.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`） @@ -419,51 +418,51 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的附加覆盖（有则更好）： +可选的附加覆盖（有的话更好）： - xAI：`xai/grok-4`（或最新可用版本） -- Mistral：`mistral/`…（选一个你已启用、支持工具的模型） +- 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` 认证） -你还可以将更多提供商纳入实时矩阵（如果你有凭证 / 配置）： +你还可以将更多提供商纳入实时测试矩阵（如果你有凭证 / 配置）： - 内置：`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 可用，实时测试通常也应找到相同的密钥。 -- 如果实时测试提示“没有凭证”，按你调试 `openclaw models list` / 模型选择时的方式去调试即可。 +- 如果 CLI 可用，实时测试通常也应该能找到相同的密钥。 +- 如果实时测试提示“没有凭证”，请像调试 `openclaw models list` / 模型选择那样去调试。 -- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试中 “profile keys” 的含义） +- 每个智能体的认证 profile：`~/.openclaw/agents//agent/auth-profiles.json`（这就是实时测试里 “profile keys” 的含义） - 配置：`~/.openclaw/openclaw.json`（或 `OPENCLAW_CONFIG_PATH`） -- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到暂存的实时 home 中，但这不是主要的 profile-key 存储） -- 默认情况下，本地实时运行会把当前配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；该暂存配置中的 `agents.*.workspace` / `agentDir` 路径覆盖会被移除，这样探测就不会触及你真实宿主机的工作区。 +- 旧版状态目录：`~/.openclaw/credentials/`（若存在会复制到暂存的实时测试 home 中，但这不是主 profile-key 存储） +- 本地实时运行默认会把当前配置、每个智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到临时测试 home 中；在这个暂存配置中，`agents.*.workspace` / `agentDir` 路径覆盖会被去除，这样探测就不会落到你的真实主机工作区。 -如果你想依赖环境变量中的密钥（例如在你的 `~/.profile` 中导出），请在本地测试前运行 `source ~/.profile`，或者使用下文的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 +如果你希望依赖环境变量密钥（例如已在 `~/.profile` 中导出），请在 `source ~/.profile` 后再运行本地测试，或者使用下面的 Docker 运行器（它们可以把 `~/.profile` 挂载到容器中）。 ## 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` -## BytePlus（国际版）编码计划实时测试 +## BytePlus 编码计划实时测试 - 测试：`src/agents/byteplus.live.test.ts` - 启用：`BYTEPLUS_API_KEY=... BYTEPLUS_LIVE_TEST=1 pnpm test:live src/agents/byteplus.live.test.ts` @@ -474,9 +473,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 工作流提交、轮询、下载或插件注册后很有用 ## 图像生成实时测试 @@ -485,8 +484,8 @@ Docker 说明： - Harness：`pnpm test:live:media image` - 范围： - 枚举每个已注册的图像生成提供商插件 - - 在探测前，从你的登录 shell（`~/.profile`）中加载缺失的提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实的 shell 凭证 - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` @@ -509,18 +508,18 @@ 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`）中加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实的 shell 凭证 - 跳过没有可用认证 / profile / 模型的提供商 - 在可用时运行两种声明的运行时模式： - - `generate`，仅提示词输入 - - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` + - `generate`：仅使用提示词输入 + - `edit`：当提供商声明 `capabilities.edit.enabled` 时 - 当前共享测试通道覆盖： - `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+"` @@ -533,173 +532,173 @@ Docker 说明： - 启用：`OPENCLAW_LIVE_TEST=1 pnpm test:live -- extensions/video-generation-providers.live.test.ts` - Harness：`pnpm test:live:media video` - 范围： - - 测试共享的内置视频生成提供商路径 - - 在探测前，从你的登录 shell（`~/.profile`）中加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 练习共享的内置视频生成提供商路径 + - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实的 shell 凭证 - 跳过没有可用认证 / profile / 模型的提供商 - 在可用时运行两种声明的运行时模式： - - `generate`，仅提示词输入 - - 当提供商声明 `capabilities.imageToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - - 当提供商声明 `capabilities.videoToVideo.enabled` 且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` - - 当前在共享扫描中“已声明但跳过”的 `imageToVideo` 提供商： + - `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 夹具的 `kling` 测试通道 - - 当前 `videoToVideo` 实时覆盖： + - 该文件会运行 `veo3` 文本转视频，以及一个默认使用远程图像 URL fixture 的 `kling` 测试通道 + - 当前 `videoToVideo` 的实时覆盖： - 仅 `runway`，且所选模型为 `runway/gen4_aleph` - - 当前在共享扫描中“已声明但跳过”的 `videoToVideo` 提供商： + - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - - `google`，因为当前共享 Gemini / Veo 测试通道使用基于本地 buffer 的输入，而共享扫描不接受该路径 - - `openai`，因为当前共享测试通道无法保证具备组织特定的视频修补 / remix 访问权限 + - `google`，因为当前共享的 Gemini / Veo 测试通道使用本地 buffer 输入，而该路径在共享扫描中不被接受 + - `openai`，因为当前共享测试通道缺乏组织特定的视频修补 / remix 访问保证 - 可选缩小范围： - `OPENCLAW_LIVE_VIDEO_GENERATION_PROVIDERS="google,openai,runway"` - `OPENCLAW_LIVE_VIDEO_GENERATION_MODELS="google/veo-3.1-fast-generate-preview,openai/sora-2,runway/gen4_aleph"` - 可选认证行为： - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅环境变量提供的覆盖 -## 媒体实时 harness +## 媒体实时测试 harness - 命令：`pnpm test:live:media` -- 目的： - - 通过一个仓库原生入口运行共享的图像、音乐和视频实时套件 +- 用途： + - 通过一个仓库原生入口运行共享的图像、音乐和视频实时测试套件 - 自动从 `~/.profile` 加载缺失的提供商环境变量 - - 默认自动将每个套件缩小到当前拥有可用认证的提供商 - - 复用 `scripts/test-live.mjs`，因此心跳和静默模式行为保持一致 + - 默认自动将每个测试套件缩小到当前具有可用认证的提供商 + - 复用 `scripts/test-live.mjs`，因此心跳和安静模式行为保持一致 - 示例： - `pnpm test:live:media` - `pnpm test:live:media image video --providers openai,google,minimax` - `pnpm test:live:media video --video-providers openai,runway --all-providers` - `pnpm test:live:media music --quiet` -## Docker 运行器（可选的“在 Linux 中也能工作”检查） +## Docker 运行器（可选的“在 Linux 中可用”检查） -这些 Docker 运行器分为两类： +这些 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` 和 `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` 会启动一个或多个真实容器，并验证更高层级的集成路径。 -实时模型 Docker 运行器还会仅 bind-mount 所需的 CLI 认证 home（如果运行未缩小，则挂载全部受支持项），然后在运行前将其复制到容器 home 中，这样外部 CLI OAuth 就能刷新 token，而不会修改宿主机认证存储： +实时模型 Docker 运行器还会只绑定挂载所需的 CLI 认证 home（或在未缩小范围时挂载所有受支持的认证 home），然后在运行前将它们复制到容器 home 中，以便外部 CLI OAuth 可以刷新 token，而不会修改主机认证存储： -- 直接模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） +- 直连模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） - ACP 绑定冒烟：`pnpm test:docker:live-acp-bind`（脚本：`scripts/test-live-acp-bind-docker.sh`） - CLI 后端冒烟：`pnpm test:docker:live-cli-backend`（脚本：`scripts/test-live-cli-backend-docker.sh`） - Gateway 网关 + dev 智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） - Open WebUI 实时冒烟：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） - 新手引导向导（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`） +- 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`） -实时模型 Docker 运行器还会将当前 checkout 以只读方式 bind-mount，并 -将其暂存到容器内的临时工作目录中。这样可以保持运行时 -镜像精简，同时仍然针对你当前本地的准确源码 / 配置运行 Vitest。 -暂存步骤会跳过大型的本地专用缓存和 app 构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及 app 本地 `.build` 或 -Gradle 输出目录，因此 Docker 实时运行不会花上数分钟复制 -机器相关的构件。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关实时探测就不会在 -容器内启动真实的 Telegram / Discord / 等渠道 worker。 -`test:docker:live-models` 仍然会运行 `pnpm test:live`，因此当你需要缩小范围或 -从该 Docker 测试通道中排除 Gateway 网关实时覆盖时，也要同时传入 +实时模型 Docker 运行器还会将当前 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 网关 +实时覆盖时，也要一并传入 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是更高层级的兼容性冒烟：它会启动一个 -启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器， +`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个 +启用了兼容 OpenAI HTTP 端点的 OpenClaw Gateway 网关容器， 再针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器，通过 Open WebUI 完成登录，验证 `/api/models` 暴露 `openclaw/default`，然后通过 -Open WebUI 的 `/api/chat/completions` 代理发送一次真实聊天请求。 +Open WebUI 的 `/api/chat/completions` 代理发送一条真实聊天请求。 首次运行可能明显更慢，因为 Docker 可能需要拉取 -Open WebUI 镜像，而 Open WebUI 也可能需要完成自身的冷启动 setup。 -该测试通道需要可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 -成功运行会打印一个小型 JSON 载荷，如 `{ "ok": true, "model": +Open WebUI 镜像，而且 Open WebUI 可能需要完成自身的冷启动设置。 +这个测试通道需要一个可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` +（默认 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 +成功运行会输出一个小型 JSON 载荷，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 刻意设计为确定性运行，不需要真实的 -Telegram、Discord 或 iMessage 账号。它会启动一个已播种的 Gateway 网关 -容器，再启动第二个容器来运行 `openclaw mcp serve`，然后 -验证路由后的会话发现、转录读取、附件元数据、 -实时事件队列行为、出站发送路由，以及类似 Claude 的渠道 + -权限通知，这些都通过真实的 stdio MCP bridge 完成。通知检查 -会直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 -bridge 实际发出的内容，而不仅仅是某个特定客户端 SDK 恰好暴露的内容。 +`test:docker:mcp-channels` 刻意设计为确定性测试，不需要真实的 +Telegram、Discord 或 iMessage 账号。它会启动一个带种子数据的 Gateway 网关 +容器，启动第二个容器以运行 `openclaw mcp serve`，然后 +通过真实的 stdio MCP bridge 验证路由后的对话发现、转录读取、附件元数据、 +实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + +权限通知。通知检查会直接检查原始 stdio MCP 帧， +因此这个冒烟测试验证的是 bridge 实际发出的内容， +而不仅仅是某个特定客户端 SDK 恰好暴露出来的内容。 -手动 ACP 纯语言线程冒烟（非 CI）： +手动 ACP 纯自然语言线程冒烟测试（非 CI）： - `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel ...` -- 保留该脚本用于回归 / 调试工作流。以后可能仍然需要它来验证 ACP 线程路由，因此不要删除。 +- 请保留这个脚本用于回归 / 调试工作流。后续可能还需要它来验证 ACP 线程路由，所以不要删除它。 常用环境变量： - `OPENCLAW_CONFIG_DIR=...`（默认：`~/.openclaw`）挂载到 `/home/node/.openclaw` - `OPENCLAW_WORKSPACE_DIR=...`（默认：`~/.openclaw/workspace`）挂载到 `/home/node/.openclaw/workspace` -- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile`，并在运行测试前读取 -- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`（默认：`~/.cache/openclaw/docker-cli-tools`）挂载到 `/home/node/.npm-global`，用于在 Docker 内缓存 CLI 安装 -- `$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` 推断出的所需目录 / 文件 - - 可手动覆盖：`OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none`，或逗号列表，如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex` + - 缩小范围后的提供商运行只会挂载根据 `OPENCLAW_LIVE_PROVIDERS` / `OPENCLAW_LIVE_GATEWAY_PROVIDERS` 推断出的所需目录 / 文件 + - 可通过 `OPENCLAW_DOCKER_AUTH_DIRS=all`、`OPENCLAW_DOCKER_AUTH_DIRS=none` 或逗号列表手动覆盖，例如 `OPENCLAW_DOCKER_AUTH_DIRS=.claude,.codex` - `OPENCLAW_LIVE_GATEWAY_MODELS=...` / `OPENCLAW_LIVE_MODELS=...` 用于缩小运行范围 -- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于在容器内筛选提供商 +- `OPENCLAW_LIVE_GATEWAY_PROVIDERS=...` / `OPENCLAW_LIVE_PROVIDERS=...` 用于过滤容器内提供商 - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile 存储（而不是环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 选择在 Open WebUI 冒烟中由 Gateway 网关暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟所用的 nonce 检查提示词 +- `OPENCLAW_OPENWEBUI_MODEL=...` 选择在 Open WebUI 冒烟测试中由 Gateway 网关暴露的模型 +- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词 - `OPENWEBUI_IMAGE=...` 覆盖固定的 Open WebUI 镜像标签 ## 文档完整性检查 -文档编辑后运行文档检查：`pnpm check:docs`。 -如果还需要检查页内标题锚点，请运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 +修改文档后运行文档检查：`pnpm check:docs`。 +当你还需要检查页面内标题锚点时，运行完整的 Mintlify 锚点校验：`pnpm docs:check-links:anchors`。 ## 离线回归（CI 安全） -这些是在不依赖真实提供商情况下的“真实流水线”回归： +这些是在不依赖真实提供商的情况下验证“真实流水线”的回归测试： - Gateway 网关工具调用（模拟 OpenAI，真实 Gateway 网关 + 智能体循环）：`src/gateway/gateway.test.ts`（用例：“runs a mock OpenAI tool call end-to-end via gateway agent loop”） - Gateway 网关向导（WS `wizard.start` / `wizard.next`，强制写入配置 + 认证）：`src/gateway/gateway.test.ts`（用例：“runs wizard over ws and writes auth token config”） ## 智能体可靠性评估（Skills） -我们已经有一些 CI 安全的测试，表现方式类似“智能体可靠性评估”： +我们已经有一些 CI 安全的测试，它们的行为类似于“智能体可靠性评估”： -- 通过真实 Gateway 网关 + 智能体循环进行模拟工具调用（`src/gateway/gateway.test.ts`）。 -- 端到端向导流程，用于验证会话接线和配置效果（`src/gateway/gateway.test.ts`）。 +- 通过真实 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（或避开无关项）？ -- **合规性：** 智能体是否会在使用前读取 `SKILL.md`，并遵循要求的步骤 / 参数？ -- **工作流契约：** 断言工具顺序、会话历史延续以及沙箱边界的多轮场景。 +- **决策能力：** 当提示中列出 Skills 时，智能体是否会选择正确的 Skills（或避免选择无关的 Skills）？ +- **合规性：** 智能体是否会在使用前读取 `SKILL.md` 并遵循所需步骤 / 参数？ +- **工作流契约：** 断言工具调用顺序、会话历史继承以及沙箱边界的多轮场景。 -未来的评估应优先保持确定性： +未来的评估应当优先保持确定性： -- 一个使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、Skill 文件读取以及会话接线。 -- 一小组聚焦 Skill 的场景（使用与避免、门控、提示词注入）。 -- 仅在 CI 安全套件就位之后，再增加可选的实时评估（按需启用、环境变量门控）。 +- 使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、skill 文件读取和会话接线。 +- 一小组以 skill 为中心的场景（使用 vs 避免、门控、提示注入）。 +- 仅在 CI 安全套件到位之后，再添加可选的实时评估（按需启用、受环境变量控制）。 -## 契约测试（插件和渠道形状） +## 契约测试（插件与渠道形状） 契约测试用于验证每个已注册插件和渠道都符合其 接口契约。它们会遍历所有已发现的插件，并运行一组 -形状和行为断言。默认的 `pnpm test` 单元测试通道会刻意 -跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商表面时， +形状与行为断言。默认的 `pnpm test` 单元测试通道会刻意 +跳过这些共享接缝和冒烟文件；当你修改共享渠道或提供商接口时， 请显式运行这些契约命令。 ### 命令 -- 所有契约：`pnpm test:contracts` -- 仅渠道契约：`pnpm test:contracts:channels` -- 仅提供商契约：`pnpm test:contracts:plugins` +- 所有契约测试：`pnpm test:contracts` +- 仅渠道契约测试：`pnpm test:contracts:channels` +- 仅提供商契约测试：`pnpm test:contracts:plugins` -### 渠道契约 +### 渠道契约测试 位于 `src/channels/plugins/contracts/*.contract.test.ts`： @@ -710,22 +709,22 @@ Skills 仍然缺少的内容（参见 [Skills](/zh-CN/tools/skills)）： - **inbound** - 入站消息处理 - **actions** - 渠道动作处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录 / 花名册 API +- **directory** - 目录 / roster API - **group-policy** - 群组策略执行 -### 提供商状态契约 +### 提供商状态契约测试 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 - **registry** - 插件注册表形状 -### 提供商契约 +### 提供商契约测试 位于 `src/plugins/contracts/*.contract.test.ts`： - **auth** - 认证流程契约 -- **auth-choice** - 认证选项 / 选择 +- **auth-choice** - 认证方式 / 选择 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 @@ -735,21 +734,21 @@ Skills 仍然缺少的内容（参见 [Skills](/zh-CN/tools/skills)）： ### 何时运行 -- 修改 `plugin-sdk` 导出或子路径后 -- 添加或修改渠道或提供商插件后 -- 重构插件注册或发现逻辑后 +- 修改 plugin-sdk 导出或子路径之后 +- 添加或修改渠道或提供商插件之后 +- 重构插件注册或发现机制之后 契约测试会在 CI 中运行，不需要真实 API 密钥。 -## 添加回归测试（指导） +## 添加回归测试（指南） -当你修复了一个在实时环境中发现的提供商 / 模型问题时： +当你修复一个在实时测试中发现的提供商 / 模型问题时： -- 如果可能，添加一个 CI 安全的回归测试（模拟 / stub 提供商，或捕获精确的请求形状转换） -- 如果它本质上只能在实时环境中复现（速率限制、认证策略），请让实时测试保持范围小，并通过环境变量按需启用 +- 尽可能添加一个 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 未归类时故意失败，以防新类被悄悄跳过。 + - 提供商请求转换 / 重放缺陷 → 直连模型测试 + - 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 时故意失败，以防新类被悄悄跳过。 diff --git a/docs/zh-CN/reference/test.md b/docs/zh-CN/reference/test.md index f64708de4..7096e69bf 100644 --- a/docs/zh-CN/reference/test.md +++ b/docs/zh-CN/reference/test.md @@ -1,55 +1,55 @@ --- read_when: - 运行或修复测试时 -summary: 如何在本地运行测试（vitest）以及何时使用 force/coverage 模式 +summary: 如何在本地运行测试（vitest），以及何时使用 force/coverage 模式 title: 测试 x-i18n: - generated_at: "2026-04-06T23:41:28Z" + generated_at: "2026-04-07T08:14:21Z" model: gpt-5.4 provider: openai - source_hash: a25236a707860307cc324f32752ad13a53e448bee9341d8df2e11655561e841c + source_hash: f7c19390f7577b3a29796c67514c96fe4c86c9fa0c7686cd4e377c6e31dcd085 source_path: reference/test.md workflow: 15 --- # 测试 -- 完整测试工具包（测试套件、live、Docker）：[测试](/zh-CN/help/testing) +- 完整测试套件（测试套件、live、Docker）：[测试](/zh-CN/help/testing) -- `pnpm test:force`：终止任何仍占用默认控制端口的残留 Gateway 网关进程，然后使用隔离的 Gateway 网关端口运行完整的 Vitest 测试套件，以避免服务端测试与正在运行的实例发生冲突。当之前的 Gateway 网关运行导致端口 18789 仍被占用时，请使用此命令。 -- `pnpm test:coverage`：使用 V8 覆盖率运行单元测试套件（通过 `vitest.unit.config.ts`）。全局阈值为 70% 的行数 / 分支 / 函数 / 语句覆盖率。覆盖率统计会排除集成较重的入口点（CLI 接线、gateway/telegram 桥接、webchat 静态服务器），以便将目标聚焦在适合单元测试的逻辑上。 -- `pnpm test:coverage:changed`：仅对自 `origin/main` 以来变更的文件运行单元测试覆盖率。 -- `pnpm test:changed`：当 diff 仅涉及可路由的源码 / 测试文件时，将已变更的 git 路径展开为有范围限制的 Vitest 通道。配置 / 设置变更仍会回退到原生 root projects 运行方式，因此在需要时，接线类修改仍会触发更广泛的重跑。 -- `pnpm test`：通过有范围限制的 Vitest 通道来处理显式指定的文件 / 目录目标。未指定目标的运行现在会顺序执行十个分片配置（`vitest.full-core-unit-src.config.ts`、`vitest.full-core-unit-security.config.ts`、`vitest.full-core-unit-ui.config.ts`、`vitest.full-core-unit-support.config.ts`、`vitest.full-core-contracts.config.ts`、`vitest.full-core-bundled.config.ts`、`vitest.full-core-runtime.config.ts`、`vitest.full-agentic.config.ts`、`vitest.full-auto-reply.config.ts`、`vitest.full-extensions.config.ts`），而不是一个庞大的单一 root-project 进程。 -- 部分 `plugin-sdk` 和 `commands` 测试文件现在会通过专用的轻量通道运行，这些通道只保留 `test/setup.ts`，而运行时较重的用例仍保留在原有通道上。 -- 部分 `plugin-sdk` 和 `commands` 辅助源码文件现在也会将 `pnpm test:changed` 映射到这些轻量通道中的显式同级测试，因此小规模辅助函数改动可以避免重跑重量级、依赖运行时的测试套件。 -- `auto-reply` 现在也拆分为三个专用配置（`core`、`top-level`、`reply`），因此 reply 测试框架不会主导那些更轻量的顶层 status/token/helper 测试。 -- 基础 Vitest 配置现在默认使用 `pool: "threads"` 和 `isolate: false`，并在整个仓库配置中启用了共享的非隔离运行器。 +- `pnpm test:force`：终止任何仍在占用默认控制端口的 Gateway 网关残留进程，然后使用隔离的 Gateway 网关端口运行完整的 Vitest 测试套件，以避免服务端测试与正在运行的实例发生冲突。当之前的 Gateway 网关运行遗留了对端口 18789 的占用时，请使用此命令。 +- `pnpm test:coverage`：使用 V8 覆盖率运行单元测试套件（通过 `vitest.unit.config.ts`）。全局阈值为 70% 的行数/分支/函数/语句覆盖率。覆盖率排除了集成度较高的入口点（CLI 连接代码、gateway/telegram 桥接、webchat 静态服务器），以便将目标聚焦于可进行单元测试的逻辑。 +- `pnpm test:coverage:changed`：仅针对自 `origin/main` 以来发生变更的文件运行单元覆盖率。 +- `pnpm test:changed`：当 diff 只涉及可路由的源文件/测试文件时，将变更的 git 路径展开为有范围的 Vitest 通道。配置/设置变更仍会回退到原生根项目运行，因此在需要时，连接代码改动仍会触发更广泛的重新运行。 +- `pnpm test`：通过有范围的 Vitest 通道路由显式的文件/目录目标。现在，未指定目标的运行会顺序执行 11 个分片配置（`vitest.full-core-unit-src.config.ts`、`vitest.full-core-unit-security.config.ts`、`vitest.full-core-unit-ui.config.ts`、`vitest.full-core-unit-support.config.ts`、`vitest.full-core-support-boundary.config.ts`、`vitest.full-core-contracts.config.ts`、`vitest.full-core-bundled.config.ts`、`vitest.full-core-runtime.config.ts`、`vitest.full-agentic.config.ts`、`vitest.full-auto-reply.config.ts`、`vitest.full-extensions.config.ts`），而不是使用一个巨大的根项目进程。 +- 选定的 `plugin-sdk` 和 `commands` 测试文件现在会通过专用的轻量通道进行路由，这些通道仅保留 `test/setup.ts`，而运行时较重的用例仍保留在原有通道中。 +- 选定的 `plugin-sdk` 和 `commands` 辅助源文件现在也会将 `pnpm test:changed` 映射到这些轻量通道中的显式同级测试，因此对小型辅助函数的修改无需重新运行依赖较重运行时支持的测试套件。 +- `auto-reply` 现在也拆分为三个专用配置（`core`、`top-level`、`reply`），这样 reply 测试框架就不会主导较轻量的顶层状态/token/辅助函数测试。 +- 基础 Vitest 配置现在默认使用 `pool: "threads"` 和 `isolate: false`，并且在整个仓库配置中启用了共享的非隔离运行器。 - `pnpm test:channels` 运行 `vitest.channels.config.ts`。 - `pnpm test:extensions` 运行 `vitest.extensions.config.ts`。 -- `pnpm test:extensions`：运行 extension/plugin 测试套件。 -- `pnpm test:perf:imports`：启用 Vitest 导入时长 + 导入明细报告，同时仍对显式指定的文件 / 目录目标使用有范围限制的通道路由。 -- `pnpm test:perf:imports:changed`：相同的导入性能分析，但仅针对自 `origin/main` 以来变更的文件。 -- `pnpm test:perf:changed:bench -- --ref `：针对同一组已提交的 git diff，对路由后的 changed 模式路径与原生 root-project 运行进行基准对比。 -- `pnpm test:perf:changed:bench -- --worktree`：无需先提交，即可对当前 worktree 的变更集进行基准对比。 +- `pnpm test:extensions`：运行扩展/插件测试套件。 +- `pnpm test:perf:imports`：启用 Vitest 导入耗时 + 导入明细报告，同时仍对显式文件/目录目标使用有范围的通道路由。 +- `pnpm test:perf:imports:changed`：与导入性能分析相同，但仅针对自 `origin/main` 以来发生变更的文件。 +- `pnpm test:perf:changed:bench -- --ref `：针对同一组已提交 git diff，将已路由的 changed 模式路径与原生根项目运行进行基准测试比较。 +- `pnpm test:perf:changed:bench -- --worktree`：无需先提交，即可对当前工作区变更集进行基准测试。 - `pnpm test:perf:profile:main`：为 Vitest 主线程写入 CPU profile（`.artifacts/vitest-main-profile`）。 -- `pnpm test:perf:profile:runner`：为单元测试运行器写入 CPU + 堆 profile（`.artifacts/vitest-runner-profile`）。 -- Gateway 网关集成测试：可通过 `OPENCLAW_TEST_INCLUDE_GATEWAY=1 pnpm test` 或 `pnpm test:gateway` 选择启用。 -- `pnpm test:e2e`：运行 Gateway 网关端到端 smoke 测试（多实例 WS/HTTP/节点配对）。在 `vitest.e2e.config.ts` 中默认使用 `threads` + `isolate: false`，并启用自适应 worker；可用 `OPENCLAW_E2E_WORKERS=` 调整，并设置 `OPENCLAW_E2E_VERBOSE=1` 以输出详细日志。 -- `pnpm test:live`：运行提供商 live 测试（minimax/zai）。需要 API 密钥，并设置 `LIVE=1`（或提供商专用的 `*_LIVE_TEST=1`）以取消跳过。 -- `pnpm test:docker:openwebui`：启动 Docker 化的 OpenClaw + Open WebUI，通过 Open WebUI 登录，检查 `/api/models`，然后通过 `/api/chat/completions` 运行一次真实的代理聊天。需要可用的 live 模型密钥（例如在 `~/.profile` 中配置的 OpenAI），会拉取外部 Open WebUI 镜像，并且不像常规单元 / e2e 测试套件那样预期可在 CI 中保持稳定。 -- `pnpm test:docker:mcp-channels`：启动一个带种子数据的 Gateway 网关容器和第二个客户端容器，后者会启动 `openclaw mcp serve`，然后通过真实的 stdio 桥接验证路由会话发现、转录读取、附件元数据、live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。Claude 通知断言会直接读取原始 stdio MCP 帧，因此该 smoke 测试反映的是桥接实际发出的内容。 +- `pnpm test:perf:profile:runner`：为单元测试运行器写入 CPU + 堆 profiles（`.artifacts/vitest-runner-profile`）。 +- Gateway 网关集成测试：通过 `OPENCLAW_TEST_INCLUDE_GATEWAY=1 pnpm test` 或 `pnpm test:gateway` 选择启用。 +- `pnpm test:e2e`：运行 Gateway 网关端到端冒烟测试（多实例 WS/HTTP/节点配对）。默认在 `vitest.e2e.config.ts` 中使用 `threads` + `isolate: false` 和自适应 workers；可通过 `OPENCLAW_E2E_WORKERS=` 调整，并设置 `OPENCLAW_E2E_VERBOSE=1` 以输出详细日志。 +- `pnpm test:live`：运行提供商 live 测试（minimax/zai）。需要 API 密钥以及 `LIVE=1`（或提供商特定的 `*_LIVE_TEST=1`）才能取消跳过。 +- `pnpm test:docker:openwebui`：启动 Docker 化的 OpenClaw + Open WebUI，通过 Open WebUI 登录，检查 `/api/models`，然后通过 `/api/chat/completions` 运行一次真实的代理聊天。需要可用的 live 模型密钥（例如 `~/.profile` 中的 OpenAI），会拉取外部 Open WebUI 镜像，并不预期像常规单元/e2e 测试套件那样具备 CI 稳定性。 +- `pnpm test:docker:mcp-channels`：启动一个预置数据的 Gateway 网关容器和第二个客户端容器，后者会生成 `openclaw mcp serve`，然后通过真实的 stdio bridge 验证路由后的会话发现、转录读取、附件元数据、live 事件队列行为、出站发送路由，以及 Claude 风格的渠道 + 权限通知。Claude 通知断言会直接读取原始 stdio MCP 帧，因此该冒烟测试反映的是 bridge 实际发出的内容。 ## 本地 PR gate -对于本地 PR 提交 / gate 检查，请运行： +对于本地 PR 提交/gate 检查，请运行： - `pnpm check` - `pnpm build` - `pnpm test` - `pnpm check:docs` -如果 `pnpm test` 在负载较高的主机上出现偶发失败，请先重跑一次，再将其视为回归问题；然后使用 `pnpm test ` 进行定位。对于内存受限的主机，请使用： +如果 `pnpm test` 在高负载主机上偶发失败，请先重跑一次，再将其视为回归问题，然后用 `pnpm test ` 进行隔离。对于内存受限的主机，请使用： - `OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test` - `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/tmp/openclaw-vitest-cache pnpm test:changed` @@ -62,9 +62,9 @@ x-i18n: - `source ~/.profile && pnpm tsx scripts/bench-model.ts --runs 10` - 可选环境变量：`MINIMAX_API_KEY`、`MINIMAX_BASE_URL`、`MINIMAX_MODEL`、`ANTHROPIC_API_KEY` -- 默认提示词：“Reply with a single word: ok. No punctuation or extra text.” +- 默认提示词：“回复一个单词：ok。不要使用标点，也不要添加额外文本。” -上次运行（2025-12-31，20 次）： +最近一次运行（2025-12-31，20 次）： - minimax 中位数 1279ms（最小 1114，最大 2431） - opus 中位数 2454ms（最小 1224，最大 3170） @@ -96,35 +96,35 @@ x-i18n: - `real`：`health`、`status`、`status --json`、`sessions`、`sessions --json`、`agents list --json`、`gateway status`、`gateway status --json`、`gateway health --json`、`config get gateway.port` - `all`：同时包含两个预设 -输出包括每条命令的 `sampleCount`、avg、p50、p95、最小 / 最大值、退出码 / signal 分布，以及最大 RSS 汇总。可选的 `--cpu-prof-dir` / `--heap-prof-dir` 会为每次运行写入 V8 profile，以便计时与 profile 捕获使用同一个测试框架。 +输出包括每个命令的 `sampleCount`、avg、p50、p95、min/max、exit-code/signal 分布以及最大 RSS 摘要。可选的 `--cpu-prof-dir` / `--heap-prof-dir` 会为每次运行写入 V8 profile，因此计时与 profile 捕获使用的是同一个测试框架。 保存输出约定： -- `pnpm test:startup:bench:smoke` 会将目标 smoke 产物写入 `.artifacts/cli-startup-bench-smoke.json` +- `pnpm test:startup:bench:smoke` 会将目标冒烟产物写入 `.artifacts/cli-startup-bench-smoke.json` - `pnpm test:startup:bench:save` 会使用 `runs=5` 和 `warmup=1` 将完整测试套件产物写入 `.artifacts/cli-startup-bench-all.json` -- `pnpm test:startup:bench:update` 会使用 `runs=5` 和 `warmup=1` 刷新已签入的基线 fixture，路径为 `test/fixtures/cli-startup-bench.json` +- `pnpm test:startup:bench:update` 会使用 `runs=5` 和 `warmup=1` 刷新已检入的基线夹具 `test/fixtures/cli-startup-bench.json` -已签入的 fixture： +已检入的夹具： - `test/fixtures/cli-startup-bench.json` - 使用 `pnpm test:startup:bench:update` 刷新 -- 使用 `pnpm test:startup:bench:check` 将当前结果与该 fixture 进行比较 +- 使用 `pnpm test:startup:bench:check` 将当前结果与该夹具进行比较 ## 新手引导 E2E（Docker） -Docker 是可选的；只有在需要容器化的新手引导 smoke 测试时才需要它。 +Docker 是可选的；只有在进行容器化新手引导冒烟测试时才需要它。 -在一个干净的 Linux 容器中的完整冷启动流程： +在干净的 Linux 容器中的完整冷启动流程： ```bash scripts/e2e/onboard-docker.sh ``` -该脚本会通过伪终端驱动交互式向导，验证 config/workspace/session 文件，然后启动 Gateway 网关并运行 `openclaw health`。 +此脚本会通过 pseudo-tty 驱动交互式向导，验证 config/workspace/session 文件，然后启动 Gateway 网关并运行 `openclaw health`。 -## QR 导入 smoke 测试（Docker） +## 二维码导入冒烟测试（Docker） -确保 `qrcode-terminal` 能在受支持的 Docker Node 运行时下加载（默认 Node 24，兼容 Node 22）： +确保 `qrcode-terminal` 能在受支持的 Docker Node 运行时（默认 Node 24，兼容 Node 22）下加载： ```bash pnpm test:docker:qr