From 5af671d315a16bc618af692c8a56de941f5ebb2f Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Fri, 10 Apr 2026 22:12:12 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/help/testing.md | 658 ++++++++++++++-------------- docs/zh-CN/plugins/codex-harness.md | 128 +++--- 2 files changed, 392 insertions(+), 394 deletions(-) diff --git a/docs/zh-CN/help/testing.md b/docs/zh-CN/help/testing.md index df056e4ed..f1d01f7a2 100644 --- a/docs/zh-CN/help/testing.md +++ b/docs/zh-CN/help/testing.md @@ -3,13 +3,13 @@ read_when: - 在本地或 CI 中运行测试 - 为模型 / 提供商缺陷添加回归测试 - 调试 Gateway 网关 + 智能体行为 -summary: 测试工具包：单元 / e2e / 实时测试套件、Docker 运行器，以及每类测试覆盖的内容 +summary: 测试套件：单元 / e2e / 实时测试套件、Docker 运行器，以及每类测试覆盖的内容 title: 测试 x-i18n: - generated_at: "2026-04-10T20:28:58Z" + generated_at: "2026-04-10T22:08:59Z" model: gpt-5.4 provider: openai - source_hash: e19cfbfcc708c0075d77364e2f20d8e8b8c4300cba97b0c525524882612b7cad + source_hash: e7e00673ca5f54f05d016922432ae4394c3b4eefd867cc23b7a7a57b2c330c39 source_path: help/testing.md workflow: 15 --- @@ -20,273 +20,274 @@ OpenClaw 有三套 Vitest 测试套件（单元 / 集成、e2e、实时）以及 本文档是一份“我们如何测试”的指南： -- 每个测试套件覆盖什么内容（以及它刻意 _不_ 覆盖什么） +- 每个测试套件覆盖什么（以及它刻意 _不_ 覆盖什么） - 常见工作流应运行哪些命令（本地、推送前、调试） -- 实时测试如何发现凭证，以及如何选择模型 / 提供商 +- 实时测试如何发现凭证并选择模型 / 提供商 - 如何为真实世界中的模型 / 提供商问题添加回归测试 ## 快速开始 -大多数时候： +大多数情况下： -- 完整门禁（推送前预期执行）：`pnpm build && pnpm check && pnpm test` -- 在配置较好的机器上更快地运行本地全套测试：`pnpm test:max` -- 直接进入 Vitest 监听循环：`pnpm test:watch` -- 直接按文件定位现在也会路由扩展 / 渠道路径：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` -- 当你正在迭代单个失败用例时，优先选择有针对性的运行。 -- 基于 Docker 的 QA 站点：`pnpm qa:lab:up` -- 基于 Linux VM 的 QA 测试通道：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` +- 完整门禁（预期在推送前执行）：`pnpm build && pnpm check && pnpm test` +- 在配置宽裕的机器上更快地运行本地全套测试：`pnpm test:max` +- 直接使用 Vitest 监听循环：`pnpm test:watch` +- 现在也可将扩展 / 渠道路径直接路由到对应测试文件：`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` +- 当你在迭代修复某一个失败用例时，优先运行有针对性的测试。 +- Docker 支持的 QA 站点：`pnpm qa:lab:up` +- 基于 Linux VM 的 QA 通道：`pnpm openclaw qa suite --runner multipass --scenario channel-chat-baseline` -当你改动了测试或想获得更高信心时： +当你修改了测试或想获得更高信心时： - 覆盖率门禁：`pnpm test:coverage` - E2E 测试套件：`pnpm test:e2e` -当你在调试真实提供商 / 模型时（需要真实凭证）： +当你调试真实的提供商 / 模型时（需要真实凭证）： -- 实时测试套件（模型 + 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 环境变量来缩小实时测试范围。 ## QA 专用运行器 -当你需要 QA-lab 级别的真实环境时，这些命令与主测试套件配合使用： +当你需要接近 QA-lab 的真实环境时，这些命令与主测试套件配合使用： - `pnpm openclaw qa suite` - - 直接在主机上运行由仓库支持的 QA 场景。 - - 默认并行运行多个选定场景，并使用隔离的 Gateway 网关工作进程，最多 64 个工作进程或所选场景数量。使用 `--concurrency ` 调整工作进程数，或使用 `--concurrency 1` 进入旧的串行通道。 + - 直接在宿主机上运行由仓库支持的 QA 场景。 + - 默认会使用隔离的 Gateway 网关 worker 并行运行多个选定场景，最多 64 个 worker，或与所选场景数量相同。使用 `--concurrency ` 调整 worker 数量，或使用 `--concurrency 1` 走旧的串行通道。 - `pnpm openclaw qa suite --runner multipass` - - 在一次性的 Multipass Linux VM 中运行同一套 QA 测试。 - - 与主机上的 `qa suite` 保持相同的场景选择行为。 - - 复用 `qa suite` 相同的提供商 / 模型选择参数。 - - 实时运行会转发适合来宾环境使用的受支持 QA 凭证输入： + - 在一个一次性的 Multipass Linux VM 中运行同一套 QA 测试。 + - 保持与宿主机 `qa suite` 相同的场景选择行为。 + - 复用与 `qa suite` 相同的提供商 / 模型选择参数。 + - 实时运行会转发适合访客机使用的受支持 QA 认证输入： 基于环境变量的提供商密钥、QA 实时提供商配置路径，以及存在时的 `CODEX_HOME`。 - - 输出目录必须保持在仓库根目录下，以便来宾能通过挂载的工作区回写内容。 - - 会在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告 + 摘要以及 Multipass 日志。 + - 输出目录必须位于仓库根目录下，这样访客机才能通过挂载的工作区写回结果。 + - 将常规 QA 报告 + 摘要以及 Multipass 日志写入 + `.artifacts/qa-e2e/...`。 - `pnpm qa:lab:up` - - 启动基于 Docker 的 QA 站点，用于操作员风格的 QA 工作。 + - 启动基于 Docker 的 QA 站点，以便进行操作员风格的 QA 工作。 -## 测试套件（各自在哪里运行什么） +## 测试套件（各自运行在哪里） -可以把这些测试套件理解为“真实度逐步增加”（同时不稳定性 / 成本也逐步增加）： +可以把这些测试套件理解为“真实性逐步提升”（同时波动性 / 成本也逐步增加）： ### 单元 / 集成（默认） - 命令：`pnpm test` -- 配置：在现有作用域化 Vitest 项目上执行十个顺序分片运行（`vitest.full-*.config.ts`） +- 配置：十个顺序执行的分片运行（`vitest.full-*.config.ts`），覆盖现有的分域 Vitest 项目 - 文件：`src/**/*.test.ts`、`packages/**/*.test.ts`、`test/**/*.test.ts` 下的核心 / 单元测试清单，以及 `vitest.unit.config.ts` 覆盖的白名单 `ui` Node 测试 - 范围： - 纯单元测试 - - 进程内集成测试（Gateway 网关鉴权、路由、工具、解析、配置） - - 针对已知缺陷的确定性回归测试 + - 进程内集成测试（Gateway 网关 认证、路由、工具、解析、配置） + - 已知缺陷的确定性回归测试 - 预期： - 在 CI 中运行 - 不需要真实密钥 - 应该快速且稳定 - 项目说明： - - 不带目标的 `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` 不必承担完整根项目启动开销。 - - 当 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 harness 工作不影响廉价的 status / chunk / 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` 项目图，因为多分片 watch 循环并不现实。 + - `pnpm test`、`pnpm test:watch` 和 `pnpm test:perf:imports` 现在会优先将显式文件 / 目录目标路由到更小的分域通道，因此 `pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts` 不需要承担完整根项目启动成本。 + - `pnpm test:changed` 会在 diff 仅涉及可路由的源码 / 测试文件时，将变更的 git 路径扩展到相同的分域通道；配置 / setup 改动仍会回退到更宽泛的根项目重跑。 + - 部分 `plugin-sdk` 和 `commands` 测试也会通过专用的轻量通道运行，从而跳过 `test/setup-openclaw-runtime.ts`；而有状态 / 运行时较重的文件仍保留在现有通道中。 + - 部分 `plugin-sdk` 和 `commands` 辅助源码文件也会在 changed 模式下映射到这些轻量通道中的显式相邻测试，因此辅助代码改动不必为该目录重跑整套重量级测试。 + - `auto-reply` 现在有三个专用分桶：顶层核心辅助函数、顶层 `reply.*` 集成测试，以及 `src/auto-reply/reply/**` 子树。这使最重的 reply 测试框架工作不会压到轻量的 status / chunk / 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.loop.test.ts`。 - - 这些测试套件会验证作用域化 id 和压缩行为仍然会流经真实的 `run.ts` / `compact.ts` 路径；仅有辅助函数测试并不能充分替代这些集成路径。 -- 进程池说明： + - 这些测试套件验证带作用域的 id 和压缩行为仍会经过真实的 `run.ts` / `compact.ts` 路径；仅有辅助级测试不足以替代这些集成路径。 +- 线程池说明： - 基础 Vitest 配置现在默认使用 `threads`。 - - 共享 Vitest 配置还固定了 `isolate: false`，并在根项目、e2e 和实时配置中使用非隔离运行器。 + - 共享 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`。 + - 每个 `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` 保持相同的路由行为，只是使用更高的工作进程上限。 - - 本地工作进程自动缩放现在有意更保守，而且当主机负载平均值已经较高时也会回退，因此默认情况下多个并发 Vitest 运行造成的影响更小。 - - 基础 Vitest 配置将项目 / 配置文件标记为 `forceRerunTriggers`，从而在测试接线变更时保持 changed 模式重新运行的正确性。 - - 在受支持主机上，该配置会保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`；如果你想为直接性能分析指定一个明确缓存位置，可设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。 + - `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 ` 会针对该已提交 diff，比对已路由的 `test:changed` 与原生根项目路径，并打印总耗时和 macOS 最大 RSS。 -- `pnpm test:perf:changed:bench -- --worktree` 会将当前未提交工作树中的变更文件列表通过 `scripts/test-projects.mjs` 和根 Vitest 配置进行路由，并执行基准测试。 - - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动与转换开销写出主线程 CPU profile。 - - `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下，为单元测试套件写出运行器 CPU + 堆 profile。 + - `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及导入拆解输出。 + - `pnpm test:perf:imports:changed` 会将相同的性能分析视图限定到自 `origin/main` 以来修改的文件。 +- `pnpm test:perf:changed:bench -- --ref ` 会针对该提交的 diff，将路由后的 `test:changed` 与原生根项目路径进行比较，并打印总耗时和 macOS 最大 RSS。 +- `pnpm test:perf:changed:bench -- --worktree` 会对当前脏工作树进行基准测试：将变更文件列表分别通过 `scripts/test-projects.mjs` 和根 Vitest 配置运行。 + - `pnpm test:perf:profile:main` 会为 Vitest / Vite 启动与 transform 开销写出主线程 CPU profile。 + - `pnpm test:perf:profile:runner` 会在禁用文件级并行后，为单元测试套件写出运行器 CPU + 堆 profile。 -### E2E（Gateway 网关冒烟） +### E2E（Gateway 网关 冒烟测试） - 命令：`pnpm test:e2e` - 配置：`vitest.e2e.config.ts` - 文件：`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts` - 运行时默认值： - - 使用 Vitest `threads` 与 `isolate: false`，与仓库其余部分保持一致。 - - 使用自适应工作进程（CI：最多 2 个，本地：默认 1 个）。 - - 默认以静默模式运行，以减少控制台 I/O 开销。 + - 使用 Vitest `threads` 和 `isolate: false`，与仓库其他部分保持一致。 + - 使用自适应 worker（CI：最多 2，本地：默认 1）。 + - 默认静默运行，以减少控制台 I/O 开销。 - 常用覆盖项： - - `OPENCLAW_E2E_WORKERS=` 强制设置工作进程数（上限为 16）。 + - `OPENCLAW_E2E_WORKERS=` 强制指定 worker 数量（上限为 16）。 - `OPENCLAW_E2E_VERBOSE=1` 重新启用详细控制台输出。 - 范围： - - 多实例 Gateway 网关端到端行为 - - WebSocket / HTTP 接口、节点配对和更重的网络交互 + - 多实例 Gateway 网关 端到端行为 + - WebSocket / HTTP 接口、节点配对和更重的网络行为 - 预期： - 在 CI 中运行（当流水线启用时） - 不需要真实密钥 - - 比单元测试包含更多可变因素（可能更慢） + - 比单元测试包含更多可变部件（可能更慢） -### E2E：OpenShell 后端冒烟 +### E2E：OpenShell 后端冒烟测试 - 命令：`pnpm test:e2e:openshell` - 文件：`test/openshell-sandbox.e2e.test.ts` - 范围： - - 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关 + - 通过 Docker 在宿主机上启动隔离的 OpenShell Gateway 网关 - 从临时本地 Dockerfile 创建一个沙箱 - - 通过真实的 `sandbox ssh-config` + SSH 执行来验证 OpenClaw 的 OpenShell 后端 - - 通过沙箱文件系统桥验证远端规范化文件系统行为 + - 通过真实的 `sandbox ssh-config` + SSH 执行来测试 OpenClaw 的 OpenShell 后端 + - 通过沙箱 fs bridge 验证远端规范文件系统行为 - 预期： - - 仅按需启用；不属于默认 `pnpm test:e2e` 运行的一部分 + - 仅按需启用；不属于默认的 `pnpm test:e2e` 运行 - 需要本地 `openshell` CLI 和可用的 Docker daemon - - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 Gateway 网关和沙箱 + - 使用隔离的 `HOME` / `XDG_CONFIG_HOME`，然后销毁测试 Gateway 网关 和沙箱 - 常用覆盖项： - - `OPENCLAW_E2E_OPENSHELL=1` 在手动运行更广泛 e2e 测试套件时启用此测试 + - `OPENCLAW_E2E_OPENSHELL=1` 在手动运行更广泛 e2e 测试套件时启用该测试 - `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell` 指向非默认 CLI 二进制文件或包装脚本 -### 实时（真实提供商 + 真实模型） +### 实时测试（真实提供商 + 真实模型） - 命令：`pnpm test:live` - 配置：`vitest.live.config.ts` - 文件：`src/**/*.live.test.ts` -- 默认：由 `pnpm test:live` **启用**（设置 `OPENCLAW_LIVE_TEST=1`） +- 默认：通过 `pnpm test:live` **启用**（会设置 `OPENCLAW_LIVE_TEST=1`） - 范围： - - “这个提供商 / 模型 _今天_ 搭配真实凭证是否真的可用？” - - 捕获提供商格式变更、工具调用怪癖、鉴权问题和速率限制行为 + - “这个提供商 / 模型 _今天_ 是否真的能在真实凭证下正常工作？” + - 捕获提供商格式变更、工具调用怪癖、认证问题和速率限制行为 - 预期： - - 按设计不适合作为稳定 CI（真实网络、真实提供商策略、配额、故障） + - 从设计上就不是 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` 进行每次实时测试覆盖；测试会在收到速率限制响应时重试。 + - 更推荐运行收窄后的子集，而不是“全部跑一遍” +- 实时运行会读取 `~/.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 网关 / 探测心跳间隔。 + - 实时测试套件现在会将进度行输出到 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` -- 调试“我的机器人挂了” / 提供商特定故障 / 工具调用：运行缩小范围的 `pnpm test:live` +- 修改逻辑 / 测试：运行 `pnpm test`（如果改动很多，再运行 `pnpm test:coverage`） +- 涉及 Gateway 网关 网络 / WS 协议 / 配对：再加上 `pnpm test:e2e` +- 调试“我的机器人挂了” / 提供商特定失败 / 工具调用：运行收窄后的 `pnpm test:live` -## 实时：Android 节点能力扫描 +## 实时测试：Android 节点能力扫描 - 测试：`src/gateway/android-node.capabilities.live.test.ts` - 脚本：`pnpm android:test:integration` - 目标：调用已连接 Android 节点当前**宣告的每一个命令**，并断言命令契约行为。 - 范围： - - 依赖前置 / 手动设置（该测试套件不会安装 / 运行 / 配对应用）。 - - 针对所选 Android 节点，逐命令验证 Gateway 网关 `node.invoke`。 -- 必需的预先设置： - - Android 应用已经连接并与 Gateway 网关配对。 - - 应用保持在前台。 - - 你期望通过的能力所需权限 / 捕获授权已授予。 + - 依赖前置 / 手动 setup（该测试套件不会安装 / 运行 / 配对应用）。 + - 针对所选 Android 节点，逐条验证 Gateway 网关 `node.invoke`。 +- 必需的预先 setup： + - Android 应用已连接并已与 Gateway 网关 配对。 + - 应用保持前台运行。 + - 已为你期望通过的能力授予权限 / 捕获授权。 - 可选目标覆盖： - `OPENCLAW_ANDROID_NODE_ID` 或 `OPENCLAW_ANDROID_NODE_NAME`。 - `OPENCLAW_ANDROID_GATEWAY_URL` / `OPENCLAW_ANDROID_GATEWAY_TOKEN` / `OPENCLAW_ANDROID_GATEWAY_PASSWORD`。 - 完整 Android 设置详情：[Android App](/zh-CN/platforms/android) -## 实时：模型冒烟（profile 密钥） +## 实时测试：模型冒烟测试（profile 密钥） -实时测试分为两层，这样我们可以隔离故障： +实时测试分为两层，以便隔离故障： -- “直接模型”告诉我们，给定密钥下该提供商 / 模型是否至少能响应。 -- “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 网关冒烟 + - 为每个模型运行一次小型补全（在需要时添加定向回归测试） +- 启用方式： + - `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="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） - - modern / all 扫描默认带有一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行穷尽式 modern 扫描，或设置正数以使用更小的上限。 + - 或者设置 `OPENCLAW_LIVE_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,..."`（逗号分隔的 allowlist） + - modern / all 扫描默认有一个经过筛选的高信号上限；设置 `OPENCLAW_LIVE_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置正数来使用更小的上限。 - 如何选择提供商： - `OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"`（逗号分隔的 allowlist） -- 密钥来自哪里： +- 密钥来源： - 默认：profile 存储和环境变量回退 - - 设置 `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 网关 + 开发智能体冒烟（也就是 “@openclaw” 实际做的事） +### 第 2 层：Gateway 网关 + 开发智能体冒烟测试（也就是 “@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） - `OPENCLAW_LIVE_GATEWAY_MODELS=all` 是 modern allowlist 的别名 - 或设置 `OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"`（或逗号列表）来缩小范围 - - modern / all Gateway 网关扫描默认带有一个精心挑选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行穷尽式 modern 扫描，或设置正数以使用更小的上限。 -- 如何选择提供商（避免“OpenRouter 全都测”）： + - modern / all Gateway 网关 扫描默认有一个经过筛选的高信号上限；设置 `OPENCLAW_LIVE_GATEWAY_MAX_MODELS=0` 可执行完整的 modern 扫描，或设置正数使用更小的上限。 +- 如何选择提供商（避免“OpenRouter 全都测一遍”）： - `OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"`（逗号分隔的 allowlist） -- 工具 + 图像探测在这个实时测试中始终开启： - - `read` 探测 + `exec+read` 探测（工具压力测试） - - 当模型宣告支持图像输入时，会运行图像探测 - - 流程（高层级）： - - 测试生成一个带有 “CAT” + 随机代码的小型 PNG（`src/gateway/live-image-probe.ts`） +- 该实时测试中，工具 + 图像探针始终开启： + - `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 openclaw models list --json ``` -## 实时：CLI 后端冒烟（Claude、Codex、Gemini 或其他本地 CLI） +## 实时测试：CLI 后端冒烟测试（Claude、Codex、Gemini 或其他本地 CLI） - 测试：`src/gateway/gateway-cli-backend.live.test.ts` -- 目标：在不触碰默认配置的情况下，使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线。 -- 后端特定的冒烟默认值位于所属扩展的 `cli-backend.ts` 定义中。 +- 目标：在不触碰你的默认配置的情况下，使用本地 CLI 后端验证 Gateway 网关 + 智能体流水线。 +- 后端专属的冒烟测试默认值定义在所属扩展的 `cli-backend.ts` 中。 - 启用： - - `pnpm test:live`（或直接调用 Vitest 时设置 `OPENCLAW_LIVE_TEST=1`） + - `pnpm test:live`（或者如果你直接调用 Vitest，则设置 `OPENCLAW_LIVE_TEST=1`） - `OPENCLAW_LIVE_CLI_BACKEND=1` - 默认值： - 默认提供商 / 模型：`claude-cli/claude-sonnet-4-6` @@ -295,11 +296,11 @@ 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_MODE="repeat"`（或 `"list"`）控制在设置 `IMAGE_ARG` 时如何传递图像参数。 - - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 发送第二轮消息并验证恢复流程。 - - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 禁用默认的 Claude Sonnet -> Opus 同会话连续性探测（当所选模型支持切换目标时，设置为 `1` 可强制开启）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1` 发送真实图像附件（路径会注入到提示中）。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image"` 通过 CLI 参数而不是提示注入传递图像文件路径。 + - `OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"`（或 `"list"`）用于控制在设置 `IMAGE_ARG` 时如何传递图像参数。 + - `OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1` 发送第二轮对话并验证恢复流程。 + - `OPENCLAW_LIVE_CLI_BACKEND_MODEL_SWITCH_PROBE=0` 禁用默认的 Claude Sonnet -> Opus 同会话连续性探针（当所选模型支持切换目标时，设为 `1` 可强制开启）。 示例： @@ -327,27 +328,27 @@ pnpm test:docker:live-cli-backend:gemini 说明： - Docker 运行器位于 `scripts/test-live-cli-backend-docker.sh`。 -- 它会在仓库 Docker 镜像中以非 root 的 `node` 用户运行实时 CLI 后端冒烟测试。 -- 它会从所属扩展解析 CLI 冒烟元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到可缓存、可写的前缀 `OPENCLAW_DOCKER_CLI_TOOLS_DIR`（默认：`~/.cache/openclaw/docker-cli-tools`）。 -- `pnpm test:docker:live-cli-backend:claude-subscription` 要求通过以下任一方式提供可移植的 Claude Code 订阅 OAuth：带有 `claudeAiOauth.subscriptionType` 的 `~/.claude/.credentials.json`，或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN`。它会先在 Docker 中验证直接 `claude -p`，然后在不保留 Anthropic API 密钥环境变量的情况下运行两轮 Gateway 网关 CLI 后端测试。这个订阅通道默认禁用 Claude MCP / 工具和图像探测，因为 Claude 目前会将第三方应用使用计入额外用量计费，而不是普通订阅套餐额度。 -- 现在，实时 CLI 后端冒烟测试会对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后通过 Gateway 网关 CLI 验证 MCP `cron` 工具调用。 -- Claude 的默认冒烟测试还会将会话从 Sonnet 修补到 Opus，并验证恢复后的会话仍记得先前记录的笔记。 +- 它会在仓库 Docker 镜像中，以非 root 的 `node` 用户身份运行实时 CLI 后端冒烟测试。 +- 它会从所属扩展解析 CLI 冒烟测试元数据，然后将匹配的 Linux CLI 包（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）安装到一个可缓存、可写的前缀目录 `OPENCLAW_DOCKER_CLI_TOOLS_DIR`（默认：`~/.cache/openclaw/docker-cli-tools`）。 +- `pnpm test:docker:live-cli-backend:claude-subscription` 需要可移植的 Claude Code 订阅 OAuth，可通过 `~/.claude/.credentials.json` 中带有 `claudeAiOauth.subscriptionType` 的凭证，或来自 `claude setup-token` 的 `CLAUDE_CODE_OAUTH_TOKEN`。它会先验证 Docker 中的直连 `claude -p`，再在不保留 Anthropic API key 环境变量的情况下运行两轮 Gateway 网关 CLI 后端测试。这个订阅通道默认禁用 Claude MCP / 工具和图像探针，因为 Claude 当前会将第三方应用用量计入额外使用计费，而不是普通订阅计划额度。 +- 实时 CLI 后端冒烟测试现在对 Claude、Codex 和 Gemini 执行相同的端到端流程：文本轮次、图像分类轮次，然后通过 gateway CLI 验证 MCP `cron` 工具调用。 +- Claude 的默认冒烟测试还会将会话从 Sonnet 切换到 Opus，并验证恢复后的会话仍记得之前的备注。 -## 实时：ACP 绑定冒烟（`/acp spawn ... --bind here`） +## 实时测试：ACP 绑定冒烟测试（`/acp spawn ... --bind here`） - 测试：`src/gateway/gateway-acp-bind.live.test.ts` -- 目标：使用实时 ACP 智能体验证真实 ACP 会话绑定流程： +- 目标：使用实时 ACP 智能体验证真实 ACP 对话绑定流程： - 发送 `/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 私信风格的会话上下文 + - 直接执行 `pnpm test:live ...` 时使用的 ACP 智能体：`claude` + - 合成渠道：Slack 风格的私信会话上下文 - ACP 后端：`acpx` - 覆盖项： - `OPENCLAW_LIVE_ACP_BIND_AGENT=claude` @@ -356,8 +357,8 @@ pnpm test:docker:live-cli-backend:gemini - `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude,codex,gemini` - `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND='npx -y @agentclientprotocol/claude-agent-acp@'` - 说明： - - 这个通道使用 Gateway 网关 `chat.send` 接口和仅管理员可用的合成来源路由字段，以便测试能附加消息渠道上下文，而无需假装进行外部投递。 - - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中针对所选 ACP harness 智能体的内建智能体注册表。 + - 该通道使用 Gateway 网关 `chat.send` 接口，并附带仅管理员可用的合成 originating-route 字段，这样测试就可以附加消息渠道上下文，而无需假装真正对外投递。 + - 当未设置 `OPENCLAW_LIVE_ACP_BIND_AGENT_COMMAND` 时，测试会使用内置 `acpx` 插件中的内建智能体注册表来运行所选 ACP harness 智能体。 示例： @@ -384,27 +385,26 @@ pnpm test:docker:live-acp-bind:gemini Docker 说明： - Docker 运行器位于 `scripts/test-live-acp-bind-docker.sh`。 -- 默认情况下，它会按顺序对所有受支持的实时 CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后 `gemini`。 -- 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可缩小矩阵范围。 -- 它会读取 `~/.profile`，将匹配的 CLI 鉴权材料暂存到容器中，把 `acpx` 安装到可写 npm 前缀中，然后在缺失时安装所请求的实时 CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 -- 在 Docker 内部，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，这样 acpx 就能让从 profile 读取的提供商环境变量继续对其子 harness CLI 可用。 +- 默认情况下，它会依次对所有受支持的实时 CLI 智能体运行 ACP 绑定冒烟测试：`claude`、`codex`，然后 `gemini`。 +- 使用 `OPENCLAW_LIVE_ACP_BIND_AGENTS=claude`、`OPENCLAW_LIVE_ACP_BIND_AGENTS=codex` 或 `OPENCLAW_LIVE_ACP_BIND_AGENTS=gemini` 可缩小矩阵。 +- 它会读取 `~/.profile`，将匹配的 CLI 认证材料准备到容器中，将 `acpx` 安装到可写 npm 前缀，然后在缺失时安装请求的实时 CLI（`@anthropic-ai/claude-code`、`@openai/codex` 或 `@google/gemini-cli`）。 +- 在 Docker 内，运行器会设置 `OPENCLAW_LIVE_ACP_BIND_ACPX_COMMAND=$HOME/.npm-global/bin/acpx`，以便 `acpx` 让从已读取的 profile 中获得的提供商环境变量可供子 harness CLI 使用。 -## 实时：Codex app-server harness 冒烟 +## 实时测试：Codex app-server harness 冒烟测试 -- 目标：通过正常的 Gateway 网关 `agent` 方法验证插件自有的 Codex harness： - - 加载内置的 `codex` 插件 +- 目标：通过常规 Gateway 网关 `agent` 方法验证插件自有的 Codex harness： + - 加载内置 `codex` 插件 - 选择 `OPENCLAW_AGENT_RUNTIME=codex` - - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关智能体消息 - - 向同一个 OpenClaw 会话发送第二轮消息，并验证 app-server - 线程可以恢复 + - 向 `codex/gpt-5.4` 发送第一轮 Gateway 网关 智能体请求 + - 向同一个 OpenClaw 会话发送第二轮请求，并验证 app-server 线程能够恢复 + - 通过同一条 Gateway 网关 命令路径运行 `/codex status` 和 `/codex models` - 测试：`src/gateway/gateway-codex-harness.live.test.ts` - 启用：`OPENCLAW_LIVE_CODEX_HARNESS=1` - 默认模型：`codex/gpt-5.4` -- 可选图像探测：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` -- 可选 MCP / 工具探测：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` -- 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，因此损坏的 Codex - harness 不能通过静默回退到 PI 而误判为通过。 -- 鉴权：来自 shell / profile 的 `OPENAI_API_KEY`，以及可选复制的 +- 可选图像探针：`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=1` +- 可选 MCP / 工具探针：`OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=1` +- 该冒烟测试会设置 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`，因此损坏的 Codex harness 不能通过静默回退到 PI 而“误通过”。 +- 认证：来自 shell / profile 的 `OPENAI_API_KEY`，再加上可选复制的 `~/.codex/auth.json` 和 `~/.codex/config.toml` 本地配方： @@ -428,45 +428,44 @@ pnpm test:docker:live-codex-harness Docker 说明： - Docker 运行器位于 `scripts/test-live-codex-harness-docker.sh`。 -- 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI - 鉴权文件，将 `@openai/codex` 安装到可写的挂载 npm 前缀中，暂存源码树，然后只运行 Codex harness 实时测试。 -- Docker 默认启用图像和 MCP / 工具探测。当你需要更窄范围的调试运行时，设置 +- 它会读取挂载的 `~/.profile`，传递 `OPENAI_API_KEY`，在存在时复制 Codex CLI 认证文件，将 `@openai/codex` 安装到一个可写、可挂载的 npm 前缀中，准备源码树，然后只运行 Codex harness 实时测试。 +- Docker 默认启用图像和 MCP / 工具探针。当你需要更窄范围的调试运行时，可设置 `OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0` 或 `OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0`。 ### 推荐的实时测试配方 -范围明确、allowlist 收窄的运行方式最快，也最不容易出现不稳定问题： +范围窄、显式的 allowlist 运行得最快，也最不容易波动： -- 单模型，直接运行（无 Gateway 网关）： +- 单模型，直连（无 Gateway 网关）： - `OPENCLAW_LIVE_MODELS="openai/gpt-5.4" pnpm test:live src/agents/models.profiles.live.test.ts` -- 单模型，Gateway 网关冒烟： +- 单模型，Gateway 网关 冒烟测试： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- 跨多个提供商的工具调用： +- 多个提供商的工具调用： - `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3-flash-preview,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` -- Google 聚焦（Gemini API 密钥 + Antigravity）： +- 聚焦 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 密钥）。 -- `google-antigravity/...` 使用 Antigravity OAuth bridge（Cloud Code Assist 风格智能体端点）。 -- `google-gemini-cli/...` 使用你机器上的本地 Gemini CLI（单独的鉴权 + 工具行为差异）。 +- `google-antigravity/...` 使用 Antigravity OAuth bridge（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 调用本地 `gemini` 二进制文件；它有自己的认证方式，行为也可能不同（流式传输 / 工具支持 / 版本偏差）。 -## 实时：模型矩阵（我们覆盖哪些内容） +## 实时测试：模型矩阵（我们覆盖哪些） -没有固定的“CI 模型列表”（实时测试是按需启用的），但这些是在带有密钥的开发机器上**建议**定期覆盖的模型。 +没有固定的“CI 模型列表”（实时测试是按需启用的），但以下是**推荐**在具备密钥的开发机器上定期覆盖的模型。 -### 现代冒烟集（工具调用 + 图像） +### 现代冒烟测试集（工具调用 + 图像） -这是我们预期应持续保持正常工作的“常用模型”运行集： +这是我们预期持续保持可用的“常见模型”运行集： - OpenAI（非 Codex）：`openai/gpt-5.4`（可选：`openai/gpt-5.4-mini`） - OpenAI Codex：`openai-codex/gpt-5.4` @@ -476,7 +475,7 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -使用工具 + 图像运行 Gateway 网关冒烟： +运行带工具 + 图像的 Gateway 网关 冒烟测试： `OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.4,openai-codex/gpt-5.4,anthropic/claude-opus-4-6,google/gemini-3.1-pro-preview,google/gemini-3-flash-preview,google-antigravity/claude-opus-4-6-thinking,google-antigravity/gemini-3-flash,zai/glm-4.7,minimax/MiniMax-M2.7" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts` ### 基线：工具调用（Read + 可选 Exec） @@ -489,7 +488,7 @@ Docker 说明： - Z.AI（GLM）：`zai/glm-4.7` - MiniMax：`minimax/MiniMax-M2.7` -可选的额外覆盖（有则更好）： +可选附加覆盖（最好有，但不是必须）： - xAI：`xai/grok-4`（或最新可用版本） - Mistral：`mistral/`…（选择一个你已启用、支持工具的模型） @@ -498,37 +497,37 @@ Docker 说明： ### 视觉：图像发送（附件 → 多模态消息） -至少在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中包含一个支持图像的模型（Claude / Gemini / OpenAI 支持视觉的变体等），以覆盖图像探测。 +在 `OPENCLAW_LIVE_GATEWAY_MODELS` 中至少包含一个支持图像的模型（Claude / Gemini / OpenAI 的视觉变体等），以覆盖图像探针。 ### 聚合器 / 替代 Gateway 网关 -如果你启用了相应密钥，我们也支持通过以下方式进行测试： +如果你启用了相应密钥，我们也支持通过以下方式测试： -- OpenRouter：`openrouter/...`（数百种模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选模型） -- OpenCode：`opencode/...` 用于 Zen，`opencode-go/...` 用于 Go（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 鉴权） +- OpenRouter：`openrouter/...`（数百个模型；使用 `openclaw models scan` 查找支持工具 + 图像的候选模型） +- OpenCode：Zen 使用 `opencode/...`，Go 使用 `opencode-go/...`（通过 `OPENCODE_API_KEY` / `OPENCODE_ZEN_API_KEY` 认证） -如果你有凭证 / 配置，也可以将更多提供商加入实时矩阵： +你还可以将以下更多提供商加入实时测试矩阵（如果你有凭证 / 配置）： - 内置：`openai`、`openai-codex`、`anthropic`、`google`、`google-vertex`、`google-antigravity`、`google-gemini-cli`、`zai`、`openrouter`、`opencode`、`opencode-go`、`xai`、`groq`、`cerebras`、`mistral`、`github-copilot` -- 通过 `models.providers`（自定义端点）：`minimax`（云 / API），以及任何兼容 OpenAI / Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） +- 通过 `models.providers`（自定义端点）：`minimax`（云端 / API），以及任何兼容 OpenAI / Anthropic 的代理（LM Studio、vLLM、LiteLLM 等） -提示：不要试图在文档里硬编码“所有模型”。权威列表应以你机器上 `discoverModels(...)` 返回的结果以及当前可用密钥为准。 +提示：不要试图在文档中硬编码“所有模型”。权威列表始终是你机器上的 `discoverModels(...)` 返回结果 + 当前可用的密钥。 -## 凭证（切勿提交） +## 凭证（绝不要提交） 实时测试发现凭证的方式与 CLI 相同。实际含义如下： -- 如果 CLI 可以工作，实时测试应能找到相同的密钥。 -- 如果实时测试提示“无凭证”，请像调试 `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 密钥存储） -- 默认情况下，本地实时运行会把活动配置、各智能体的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 鉴权目录复制到临时测试 home 中；暂存的实时 home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，这样探测就不会落到你真实主机工作区上。 +- 旧版状态目录：`~/.openclaw/credentials/`（存在时会复制到已准备好的实时测试 home 中，但它不是主 profile-key 存储） +- 默认情况下，本地实时运行会将当前配置、按智能体划分的 `auth-profiles.json` 文件、旧版 `credentials/` 以及受支持的外部 CLI 认证目录复制到一个临时测试 home 中；准备好的实时 home 会跳过 `workspace/` 和 `sandboxes/`，并移除 `agents.*.workspace` / `agentDir` 路径覆盖，以确保探针不会落到你真实宿主机工作区中。 -如果你想依赖环境变量密钥（例如在你的 `~/.profile` 中导出的密钥），请在本地测试前运行 `source ~/.profile`，或使用下面的 Docker 运行器（它们可以将 `~/.profile` 挂载到容器中）。 +如果你想依赖环境变量密钥（例如导出在你的 `~/.profile` 中），请在本地测试前运行 `source ~/.profile`，或者使用下面的 Docker 运行器（它们可以把 `~/.profile` 挂载到容器中）。 -## Deepgram 实时（音频转录） +## Deepgram 实时测试（音频转录） - 测试：`src/media-understanding/providers/deepgram/audio.live.test.ts` - 启用：`DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts` @@ -544,8 +543,8 @@ 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 的图像、视频和 `music_generate` 路径 + - 除非已配置 `models.providers.comfy.`，否则会跳过对应能力 - 在修改 comfy 工作流提交、轮询、下载或插件注册后特别有用 ## 图像生成实时测试 @@ -555,9 +554,9 @@ Docker 说明： - Harness：`pnpm test:live:media image` - 范围： - 枚举每一个已注册的图像生成提供商插件 - - 在探测前从你的登录 shell（`~/.profile`）加载缺失的提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的鉴权 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实的 shell 凭证 - - 跳过没有可用鉴权 / profile / 模型的提供商 + - 在探测前从你的登录 shell（`~/.profile`）中加载缺失的提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 通过共享运行时能力运行标准图像生成变体： - `google:flash-generate` - `google:pro-generate` @@ -570,8 +569,8 @@ Docker 说明： - `OPENCLAW_LIVE_IMAGE_GENERATION_PROVIDERS="openai,google"` - `OPENCLAW_LIVE_IMAGE_GENERATION_MODELS="openai/gpt-image-1,google/gemini-3.1-flash-image-preview"` - `OPENCLAW_LIVE_IMAGE_GENERATION_CASES="google:flash-generate,google:pro-edit"` -- 可选鉴权行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储鉴权，并忽略仅环境变量的覆盖 +- 可选认证行为： + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅来自环境变量的覆盖 ## 音乐生成实时测试 @@ -581,23 +580,21 @@ Docker 说明： - 范围： - 覆盖共享的内置音乐生成提供商路径 - 当前覆盖 Google 和 MiniMax - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的鉴权 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实的 shell 凭证 - - 跳过没有可用鉴权 / profile / 模型的提供商 + - 在探测前从你的登录 shell（`~/.profile`）中加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 在可用时运行两种已声明的运行时模式： - `generate`，仅使用提示词输入 - - 当提供商声明 `capabilities.edit.enabled` 时运行 `edit` + - `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+"` -- 可选鉴权行为： - - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储鉴权，并忽略仅环境变量的覆盖 - -## 视频生成实时测试 +- 可选认证行为： + - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 强制使用 profile 存储认证，并忽略仅来自环境变量的覆盖 ## 视频生成实时测试 @@ -606,162 +603,161 @@ Docker 说明： - Harness：`pnpm test:live:media video` - 范围： - 覆盖共享的内置视频生成提供商路径 - - 在探测前从你的登录 shell（`~/.profile`）加载提供商环境变量 - - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的鉴权 profile，因此 `auth-profiles.json` 中过期的测试密钥不会掩盖真实的 shell 凭证 - - 跳过没有可用鉴权 / profile / 模型的提供商 + - 在探测前从你的登录 shell（`~/.profile`）中加载提供商环境变量 + - 默认优先使用实时 / 环境变量 API 密钥，而不是已存储的认证 profile，这样 `auth-profiles.json` 中过期的测试密钥就不会掩盖真实的 shell 凭证 + - 跳过没有可用认证 / profile / 模型的提供商 - 在可用时运行两种已声明的运行时模式： - `generate`，仅使用提示词输入 - - 当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时，运行 `imageToVideo` - - 当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时，运行 `videoToVideo` + - `imageToVideo`，当提供商声明 `capabilities.imageToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地图像输入时 + - `videoToVideo`，当提供商声明 `capabilities.videoToVideo.enabled`，且所选提供商 / 模型在共享扫描中接受基于 buffer 的本地视频输入时 - 当前在共享扫描中已声明但被跳过的 `imageToVideo` 提供商： - `vydra`，因为内置 `veo3` 仅支持文本，而内置 `kling` 需要远程图像 URL - - 提供商特定的 Vydra 覆盖： + - 提供商专属的 Vydra 覆盖： - `OPENCLAW_LIVE_TEST=1 OPENCLAW_LIVE_VYDRA_VIDEO=1 pnpm test:live -- extensions/vydra/vydra.live.test.ts` - - 该文件默认运行 `veo3` 文本转视频，以及一个使用远程图像 URL fixture 的 `kling` 通道 + - 该文件会运行 `veo3` 文本转视频，以及一个默认使用远程图像 URL fixture 的 `kling` 通道 - 当前 `videoToVideo` 实时覆盖： - - 仅 `runway`，并且仅当所选模型是 `runway/gen4_aleph` + - 仅 `runway`，且所选模型为 `runway/gen4_aleph` 时 - 当前在共享扫描中已声明但被跳过的 `videoToVideo` 提供商： - `alibaba`、`qwen`、`xai`，因为这些路径当前需要远程 `http(s)` / MP4 参考 URL - `google`，因为当前共享 Gemini / Veo 通道使用基于本地 buffer 的输入，而该路径在共享扫描中不被接受 - - `openai`，因为当前共享通道缺少组织特定的视频修补 / remix 访问保证 + - `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 存储鉴权，并忽略仅环境变量的覆盖 +- 可选认证行为： + - `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_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` 会启动一个或多个真实容器，并验证更高层级的集成路径。 + `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），然后在运行前将其复制到容器 home 中，这样外部 CLI OAuth 就可以刷新令牌，而不会修改宿主机上的鉴权存储： +这些实时模型 Docker 运行器还会只 bind-mount 所需的 CLI 认证主目录（如果运行未缩小范围，则挂载全部受支持主目录），然后在运行前将它们复制到容器 home 中，这样外部 CLI OAuth 就可以刷新令牌，而不会修改宿主机认证存储： -- 直接模型：`pnpm test:docker:live-models`（脚本：`scripts/test-live-models-docker.sh`） -- ACP 绑定冒烟：`pnpm test:docker:live-acp-bind`（脚本：`scripts/test-live-acp-bind-docker.sh`） -- CLI 后端冒烟：`pnpm test:docker:live-cli-backend`（脚本：`scripts/test-live-cli-backend-docker.sh`） -- Codex app-server harness 冒烟：`pnpm test:docker:live-codex-harness`（脚本：`scripts/test-live-codex-harness-docker.sh`） +- 直连模型：`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`） +- Codex app-server harness 冒烟测试：`pnpm test:docker:live-codex-harness`（脚本：`scripts/test-live-codex-harness-docker.sh`） - Gateway 网关 + 开发智能体：`pnpm test:docker:live-gateway`（脚本：`scripts/test-live-gateway-models-docker.sh`） -- Open WebUI 实时冒烟：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） -- 新手引导向导（TTY，完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） -- Gateway 网关网络（两个容器，WS 鉴权 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） -- MCP 渠道桥接（带种子数据的 Gateway 网关 + stdio bridge + 原始 Claude 通知帧冒烟）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） -- 插件（安装冒烟 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） +- Open WebUI 实时冒烟测试：`pnpm test:docker:openwebui`（脚本：`scripts/e2e/openwebui-docker.sh`） +- 新手引导向导（TTY、完整脚手架）：`pnpm test:docker:onboard`（脚本：`scripts/e2e/onboard-docker.sh`） +- Gateway 网关 网络（两个容器，WS 认证 + 健康检查）：`pnpm test:docker:gateway-network`（脚本：`scripts/e2e/gateway-network-docker.sh`） +- MCP 渠道桥接（已预置 Gateway 网关 + stdio bridge + 原始 Claude 通知帧冒烟测试）：`pnpm test:docker:mcp-channels`（脚本：`scripts/e2e/mcp-channels-docker.sh`） +- 插件（安装冒烟测试 + `/plugin` 别名 + Claude bundle 重启语义）：`pnpm test:docker:plugins`（脚本：`scripts/e2e/plugins-docker.sh`） -实时模型 Docker 运行器还会以只读方式 bind-mount 当前 checkout， -并把它暂存到容器内的临时工作目录中。这样可以保持运行时镜像精简， -同时仍然针对你精确的本地源码 / 配置运行 Vitest。 -该暂存步骤会跳过大型本地专用缓存和应用构建输出，例如 -`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地 `.build` 或 -Gradle 输出目录，因此 Docker 实时运行不会花上几分钟复制 -机器特定的产物。 -它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，这样 Gateway 网关实时探测就不会在容器内启动 -真实的 Telegram / Discord / 等渠道工作进程。 -`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要缩小范围或排除该 Docker 通道中的 Gateway 网关 -实时覆盖时，也请一并传入 +这些实时模型 Docker 运行器还会以只读方式 bind-mount 当前 checkout， +并将其准备到容器内的临时工作目录中。这样既能保持运行时镜像精简， +又仍然能针对你当前本地的精确源码 / 配置运行 Vitest。 +准备步骤会跳过大型本地专用缓存和应用构建产物，例如 +`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`，以及应用本地的 `.build` 或 +Gradle 输出目录，这样 Docker 实时运行就不会花几分钟去复制 +机器专属的构件。 +它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`，因此 Gateway 网关 实时探针不会在容器内启动 +真实的 Telegram / Discord / 等渠道 worker。 +`test:docker:live-models` 仍然运行 `pnpm test:live`，因此当你需要在该 Docker 通道中 +缩小范围或排除 Gateway 网关 实时覆盖时，也请一并传入 `OPENCLAW_LIVE_GATEWAY_*`。 -`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个启用了 -OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器， -再针对该 Gateway 网关启动一个固定版本的 Open WebUI 容器，通过 -Open WebUI 登录，验证 `/api/models` 暴露 `openclaw/default`，然后通过 -Open WebUI 的 `/api/chat/completions` 代理发送一个 -真实聊天请求。 -首次运行可能明显更慢，因为 Docker 可能需要拉取 -Open WebUI 镜像，且 Open WebUI 可能需要完成自身的冷启动设置。 +`test:docker:openwebui` 是一个更高层级的兼容性冒烟测试：它会启动一个 +启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关 容器， +再针对该 Gateway 网关 启动一个固定版本的 Open WebUI 容器，通过 +Open WebUI 登录，验证 `/api/models` 暴露了 `openclaw/default`，然后再通过 +Open WebUI 的 `/api/chat/completions` 代理发送一条真实聊天请求。 +第一次运行可能明显更慢，因为 Docker 可能需要拉取 +Open WebUI 镜像，并且 Open WebUI 可能需要完成自身的冷启动 setup。 这个通道需要可用的实时模型密钥，而 `OPENCLAW_PROFILE_FILE` -（默认 `~/.profile`）是在 Docker 化运行中提供它的主要方式。 -成功运行会打印一个小型 JSON 载荷，例如 `{ "ok": true, "model": +（默认是 `~/.profile`）是在 Docker 化运行中提供该密钥的主要方式。 +成功运行时会打印一个小型 JSON 负载，例如 `{ "ok": true, "model": "openclaw/default", ... }`。 -`test:docker:mcp-channels` 是有意保持确定性的，不需要 -真实的 Telegram、Discord 或 iMessage 账号。它会启动一个带种子数据的 Gateway 网关 -容器，启动第二个容器来运行 `openclaw mcp serve`，然后 -验证路由后的会话发现、转录读取、附件元数据、 -实时事件队列行为、出站发送路由，以及通过真实 stdio MCP bridge 发送的 Claude 风格渠道 + -权限通知。该通知检查会直接检查原始 stdio MCP 帧， -因此这个冒烟测试验证的是 bridge 实际发出的内容， -而不仅仅是某个特定客户端 SDK 恰好暴露出的内容。 +`test:docker:mcp-channels` 是刻意设计为确定性的，不需要真实的 +Telegram、Discord 或 iMessage 账号。它会启动一个已预置的 Gateway 网关 +容器，再启动第二个容器以运行 `openclaw mcp serve`，然后验证 +路由后的会话发现、记录读取、附件元数据、 +实时事件队列行为、出站发送路由，以及 Claude 风格的渠道 + +权限通知，全部通过真实的 stdio MCP bridge 进行。通知检查会 +直接检查原始 stdio MCP 帧，因此该冒烟测试验证的是 bridge 实际发出的内容， +而不仅仅是某个客户端 SDK 恰好暴露出来的内容。 -手动 ACP 明文线程冒烟测试（非 CI）： +手动 ACP 自然语言线程冒烟测试（非 CI）： - `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel ...` -- 保留这个脚本用于回归 / 调试工作流。后续可能还会需要它来验证 ACP 线程路由，因此不要删除它。 +- 请保留这个脚本用于回归 / 调试工作流。后续可能还需要它来验证 ACP 线程路由，因此不要删除。 常用环境变量： - `OPENCLAW_CONFIG_DIR=...`（默认：`~/.openclaw`）挂载到 `/home/node/.openclaw` - `OPENCLAW_WORKSPACE_DIR=...`（默认：`~/.openclaw/workspace`）挂载到 `/home/node/.openclaw/workspace` -- `OPENCLAW_PROFILE_FILE=...`（默认：`~/.profile`）挂载到 `/home/node/.profile` 并在运行测试前读取 -- `OPENCLAW_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_SKIP_DOCKER_BUILD=1` 复用现有 `openclaw:local-live` 镜像，用于无需重新构建的重跑 +- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于复用已有的 `openclaw:local-live` 镜像，以便在无需重建时重跑 - `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 确保凭证来自 profile 存储（而不是环境变量） -- `OPENCLAW_OPENWEBUI_MODEL=...` 选择 Gateway 网关为 Open WebUI 冒烟测试暴露的模型 -- `OPENCLAW_OPENWEBUI_PROMPT=...` 覆盖 Open WebUI 冒烟测试使用的 nonce 校验提示词 -- `OPENWEBUI_IMAGE=...` 覆盖固定版本的 Open WebUI 镜像标签 +- `OPENCLAW_OPENWEBUI_MODEL=...` 选择暴露给 Open WebUI 冒烟测试的模型 +- `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"） +- 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`）。 +- 通过真实 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）？ -- **遵循性：** 智能体在使用前是否会读取 `SKILL.md`，并遵循要求的步骤 / 参数？ -- **工作流契约：** 断言工具顺序、会话历史延续和沙箱边界的多轮场景。 +- **决策能力：** 当提示中列出 Skills 时，智能体是否会选择正确的 Skills（或避免选择无关项）？ +- **合规性：** 智能体在使用前是否会读取 `SKILL.md`，并遵循必需的步骤 / 参数？ +- **工作流契约：** 断言工具顺序、会话历史承接和沙箱边界的多轮场景。 -未来的评估应首先保持确定性： +未来的评估应优先保持确定性： -- 一个使用模拟提供商的场景运行器，用于断言工具调用 + 顺序、Skill 文件读取和会话接线。 -- 一小组聚焦 Skill 的场景（使用 vs 避免、门禁、提示注入）。 -- 只有在 CI 安全测试套件就位之后，才加入可选的实时评估（按需启用、由环境变量控制）。 +- 一个基于场景的运行器，使用模拟提供商来断言工具调用 + 顺序、skill 文件读取以及会话接线。 +- 一小套聚焦 Skills 的场景（使用 vs 避免、门禁、提示注入）。 +- 仅在 CI 安全套件就绪之后，再添加可选的实时评估（按需启用、由环境变量控制）。 ## 契约测试（插件和渠道形状） -契约测试会验证每个已注册插件和渠道都符合其接口契约。它们会遍历所有已发现的插件，并运行一组针对形状和行为的断言。默认的 `pnpm test` 单元测试通道会刻意跳过这些共享边界和冒烟文件；当你修改共享渠道或提供商接口时，请显式运行契约测试命令。 +契约测试会验证每个已注册插件和渠道是否符合其接口契约。它们会遍历所有已发现的插件，并运行一套关于结构与行为的断言。默认的 `pnpm test` 单元测试通道会刻意跳过这些共享接缝与冒烟测试文件；当你修改共享渠道或提供商接口时，请显式运行契约测试命令。 ### 命令 @@ -773,53 +769,53 @@ Open WebUI 镜像，且 Open WebUI 可能需要完成自身的冷启动设置。 位于 `src/channels/plugins/contracts/*.contract.test.ts`： -- **plugin** - 基础插件形状（id、名称、能力） +- **plugin** - 基础插件结构（id、名称、能力） - **setup** - 设置向导契约 - **session-binding** - 会话绑定行为 -- **outbound-payload** - 消息载荷结构 +- **outbound-payload** - 消息负载结构 - **inbound** - 入站消息处理 - **actions** - 渠道动作处理器 - **threading** - 线程 ID 处理 -- **directory** - 目录 / roster API -- **group-policy** - 群组策略执行 +- **directory** - 目录 / 成员列表 API +- **group-policy** - 群组策略强制执行 ### 提供商状态契约测试 位于 `src/plugins/contracts/*.contract.test.ts`。 - **status** - 渠道状态探测 -- **registry** - 插件注册表形状 +- **registry** - 插件注册表结构 ### 提供商契约测试 位于 `src/plugins/contracts/*.contract.test.ts`： -- **auth** - 鉴权流程契约 -- **auth-choice** - 鉴权选择 / 选择逻辑 +- **auth** - 认证流程契约 +- **auth-choice** - 认证选择 / 选择逻辑 - **catalog** - 模型目录 API - **discovery** - 插件发现 - **loader** - 插件加载 - **runtime** - 提供商运行时 -- **shape** - 插件形状 / 接口 +- **shape** - 插件结构 / 接口 - **wizard** - 设置向导 ### 何时运行 - 修改 `plugin-sdk` 导出或子路径之后 -- 添加或修改渠道插件或提供商插件之后 +- 新增或修改渠道插件或提供商插件之后 - 重构插件注册或发现逻辑之后 契约测试会在 CI 中运行，不需要真实 API 密钥。 ## 添加回归测试（指南） -当你修复在实时测试中发现的提供商 / 模型问题时： +当你修复了一个在实时测试中发现的提供商 / 模型问题时： - 如果可能，添加一个 CI 安全的回归测试（模拟 / stub 提供商，或捕获精确的请求形状转换） -- 如果它本质上只能通过实时测试覆盖（速率限制、鉴权策略），请让实时测试保持范围狭窄，并通过环境变量按需启用 -- 优先锁定能捕获该缺陷的最小层级： - - 提供商请求转换 / 回放缺陷 → 直接模型测试 - - Gateway 网关会话 / 历史 / 工具流水线缺陷 → Gateway 网关实时冒烟测试或 CI 安全的 Gateway 网关模拟测试 -- SecretRef 遍历防护规则： +- 如果问题天然只能在实时环境中复现（速率限制、认证策略），请让实时测试保持收窄范围，并通过环境变量按需启用 +- 优先瞄准能捕获该缺陷的最小层级： + - 提供商请求转换 / 重放缺陷 → 直连模型测试 + - 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 时有意失败，这样新类别就无法被静默跳过。 + - 如果你在 `src/secrets/target-registry-data.ts` 中新增了一个 `includeInPlan` SecretRef 目标族，请更新该测试中的 `classifyTargetClass`。该测试会故意在遇到未分类目标 id 时失败，这样新类别就无法被静默跳过。 diff --git a/docs/zh-CN/plugins/codex-harness.md b/docs/zh-CN/plugins/codex-harness.md index 5960416b7..f9286b60e 100644 --- a/docs/zh-CN/plugins/codex-harness.md +++ b/docs/zh-CN/plugins/codex-harness.md @@ -6,10 +6,10 @@ read_when: summary: 通过内置的 Codex app-server 测试框架运行 OpenClaw 嵌入式智能体轮次 title: Codex 测试框架 x-i18n: - generated_at: "2026-04-10T21:45:16Z" + generated_at: "2026-04-10T22:08:58Z" model: gpt-5.4 provider: openai - source_hash: 93aa65d08b8ffd39625d21c054856edb75a1e12d66fc7c6fae343fe398abab8b + source_hash: 71f4f8e67cfc8f573ad8f082dd4fc36ce6524f7bf235e2757117d4653cbb3d71 source_path: plugins/codex-harness.md workflow: 15 --- @@ -18,31 +18,31 @@ x-i18n: 内置的 `codex` 插件让 OpenClaw 可以通过 Codex app-server，而不是内置的 PI 测试框架，来运行嵌入式智能体轮次。 -当你希望由 Codex 接管底层智能体会话时使用此功能：模型发现、原生线程恢复、原生上下文压缩，以及 app-server 执行。OpenClaw 仍然负责聊天渠道、会话文件、模型选择、工具、审批、媒体传递，以及可见的转录镜像。 +当你希望由 Codex 接管底层智能体会话时，请使用此功能：模型发现、原生线程恢复、原生压缩以及 app-server 执行。OpenClaw 仍然负责聊天渠道、会话文件、模型选择、工具、审批、媒体传递，以及可见的转录镜像。 -该测试框架默认关闭。只有在启用 `codex` 插件且解析后的模型为 `codex/*` 模型时，或你显式强制设置 `embeddedHarness.runtime: "codex"` 或 `OPENCLAW_AGENT_RUNTIME=codex` 时，才会选中它。如果你从未配置 `codex/*`，现有的 PI、OpenAI、Anthropic、Gemini、本地和自定义提供商运行都会保持当前行为。 +该测试框架默认关闭。只有在启用 `codex` 插件且解析后的模型是 `codex/*` 模型时，或者你显式强制设置 `embeddedHarness.runtime: "codex"` 或 `OPENCLAW_AGENT_RUNTIME=codex` 时，才会选用它。如果你从未配置 `codex/*`，现有的 PI、OpenAI、Anthropic、Gemini、本地和自定义提供商运行将保持当前行为。 ## 选择正确的模型前缀 -OpenClaw 为 OpenAI 和 Codex 形态的访问提供了不同路径： +OpenClaw 为 OpenAI 和 Codex 形式的访问提供了不同路径： -| 模型引用 | 运行时路径 | 使用场景 | -| ---------------------- | ---------------------------------------------- | ------------------------------------------------------------------------ | -| `openai/gpt-5.4` | 通过 OpenClaw/PI 管道使用 OpenAI 提供商 | 你希望使用 `OPENAI_API_KEY` 直接访问 OpenAI Platform API。 | -| `openai-codex/gpt-5.4` | 通过 PI 使用 OpenAI Codex OAuth 提供商 | 你希望使用 ChatGPT/Codex OAuth，但不使用 Codex app-server 测试框架。 | -| `codex/gpt-5.4` | 内置 Codex 提供商加 Codex 测试框架 | 你希望对嵌入式智能体轮次使用原生 Codex app-server 执行。 | +| 模型引用 | 运行时路径 | 使用场景 | +| ---------------------- | -------------------------------------------- | ----------------------------------------------------------------------- | +| `openai/gpt-5.4` | 通过 OpenClaw/PI 流程的 OpenAI 提供商 | 你希望使用 `OPENAI_API_KEY` 直接访问 OpenAI Platform API。 | +| `openai-codex/gpt-5.4` | 通过 PI 的 OpenAI Codex OAuth 提供商 | 你希望使用 ChatGPT/Codex OAuth，而不使用 Codex app-server 测试框架。 | +| `codex/gpt-5.4` | 内置 Codex 提供商加 Codex 测试框架 | 你希望嵌入式智能体轮次使用原生 Codex app-server 执行。 | -Codex 测试框架只接管 `codex/*` 模型引用。现有的 `openai/*`、`openai-codex/*`、Anthropic、Gemini、xAI、本地和自定义提供商引用会继续走各自的正常路径。 +Codex 测试框架只接管 `codex/*` 模型引用。现有的 `openai/*`、`openai-codex/*`、Anthropic、Gemini、xAI、本地和自定义提供商引用将继续走其正常路径。 ## 要求 -- OpenClaw 已提供内置的 `codex` 插件。 +- OpenClaw，并且内置的 `codex` 插件可用。 - Codex app-server `0.118.0` 或更高版本。 - app-server 进程可用的 Codex 身份验证。 -该插件会阻止较旧版本或无版本的 app-server 握手。这可确保 OpenClaw 使用的是它已经针对其测试过的协议接口。 +该插件会阻止过旧或未带版本信息的 app-server 握手。这可以确保 OpenClaw 使用的是它已针对其进行测试的协议接口。 -对于实时和 Docker 冒烟测试，身份验证通常来自 `OPENAI_API_KEY`，以及可选的 Codex CLI 文件，例如 `~/.codex/auth.json` 和 `~/.codex/config.toml`。请使用与你本地 Codex app-server 相同的身份验证材料。 +对于实时测试和 Docker 冒烟测试，身份验证通常来自 `OPENAI_API_KEY`，以及可选的 Codex CLI 文件，如 `~/.codex/auth.json` 和 `~/.codex/config.toml`。请使用与你本地 Codex app-server 相同的身份验证材料。 ## 最小配置 @@ -69,7 +69,7 @@ Codex 测试框架只接管 `codex/*` 模型引用。现有的 `openai/*`、`ope } ``` -如果你的配置使用 `plugins.allow`，也请将 `codex` 包含进去： +如果你的配置使用了 `plugins.allow`，也请将 `codex` 包含在其中： ```json5 { @@ -84,11 +84,11 @@ Codex 测试框架只接管 `codex/*` 模型引用。现有的 `openai/*`、`ope } ``` -将 `agents.defaults.model` 或某个智能体模型设置为 `codex/` 也会自动启用内置的 `codex` 插件。显式插件条目在共享配置中依然很有用，因为它能让部署意图更明确。 +将 `agents.defaults.model` 或某个智能体模型设置为 `codex/` 也会自动启用内置的 `codex` 插件。显式的插件条目在共享配置中仍然很有用，因为它能让部署意图更加明确。 -## 添加 Codex 而不替换其他模型 +## 在不替换其他模型的情况下添加 Codex -当你希望 `codex/*` 模型使用 Codex，而其他所有模型仍使用 PI 时，请保持 `runtime: "auto"`： +如果你希望 `codex/*` 模型使用 Codex，而其他所有模型使用 PI，请保持 `runtime: "auto"`： ```json5 { @@ -120,16 +120,16 @@ Codex 测试框架只接管 `codex/*` 模型引用。现有的 `openai/*`、`ope } ``` -在这种结构下： +在这种配置下： - `/model codex` 或 `/model codex/gpt-5.4` 使用 Codex app-server 测试框架。 - `/model gpt` 或 `/model openai/gpt-5.4` 使用 OpenAI 提供商路径。 - `/model opus` 使用 Anthropic 提供商路径。 -- 如果选择的是非 Codex 模型，PI 仍作为兼容性测试框架使用。 +- 如果选择了非 Codex 模型，PI 仍然作为兼容性测试框架。 -## 仅 Codex 部署 +## 仅 Codex 的部署 -当你需要证明每个嵌入式智能体轮次都使用 Codex 测试框架时，请禁用 PI 回退： +当你需要证明每一次嵌入式智能体轮次都使用 Codex 测试框架时，请禁用 PI 回退： ```json5 { @@ -145,7 +145,7 @@ Codex 测试框架只接管 `codex/*` 模型引用。现有的 `openai/*`、`ope } ``` -环境变量覆盖： +环境覆盖： ```bash OPENCLAW_AGENT_RUNTIME=codex \ @@ -153,11 +153,11 @@ OPENCLAW_AGENT_HARNESS_FALLBACK=none \ openclaw gateway run ``` -禁用回退后，如果 Codex 插件被禁用、请求的模型不是 `codex/*` 引用、app-server 版本过旧，或者 app-server 无法启动，OpenClaw 就会提前失败。 +禁用回退后，如果 Codex 插件被禁用、请求的模型不是 `codex/*` 引用、app-server 版本过旧，或 app-server 无法启动，OpenClaw 将提前失败。 ## 按智能体使用 Codex -你可以让某一个智能体仅使用 Codex，而默认智能体继续保持正常的自动选择： +你可以让某一个智能体仅使用 Codex，而默认智能体保持正常的自动选择： ```json5 { @@ -188,17 +188,17 @@ openclaw gateway run } ``` -使用普通的会话命令切换智能体和模型。`/new` 会创建一个新的 OpenClaw 会话，而 Codex 测试框架会按需创建或恢复其辅助 app-server 线程。`/reset` 会清除该线程的 OpenClaw 会话绑定。 +使用常规会话命令来切换智能体和模型。`/new` 会创建一个新的 OpenClaw 会话，而 Codex 测试框架会按需创建或恢复其 sidecar app-server 线程。`/reset` 会清除该线程的 OpenClaw 会话绑定。 ## 模型发现 -默认情况下，Codex 插件会向 app-server 请求可用模型。如果发现失败或超时，它会使用内置回退目录： +默认情况下，Codex 插件会向 app-server 查询可用模型。如果发现失败或超时，它会使用内置的回退目录： - `codex/gpt-5.4` - `codex/gpt-5.4-mini` - `codex/gpt-5.2` -你可以在 `plugins.entries.codex.config.discovery` 下调整发现行为： +你可以在 `plugins.entries.codex.config.discovery` 下调整发现设置： ```json5 { @@ -218,7 +218,7 @@ openclaw gateway run } ``` -如果你希望启动时避免探测 Codex，并固定使用回退目录，请禁用发现： +如果你希望启动时避免探测 Codex 并固定使用回退目录，请禁用发现： ```json5 { @@ -239,13 +239,13 @@ openclaw gateway run ## App-server 连接和策略 -默认情况下，插件会通过以下命令在本地启动 Codex： +默认情况下，插件会使用以下命令在本地启动 Codex： ```bash codex app-server --listen stdio:// ``` -你可以保留这个默认值，只调整 Codex 原生策略： +你可以保留该默认设置，只调整 Codex 原生策略： ```json5 { @@ -290,21 +290,21 @@ codex app-server --listen stdio:// 支持的 `appServer` 字段： -| 字段 | 默认值 | 含义 | +| 字段 | 默认值 | 含义 | | ------------------- | ---------------------------------------- | ------------------------------------------------------------------------ | -| `transport` | `"stdio"` | `"stdio"` 会启动 Codex；`"websocket"` 会连接到 `url`。 | -| `command` | `"codex"` | 用于 stdio 传输的可执行文件。 | -| `args` | `["app-server", "--listen", "stdio://"]` | 用于 stdio 传输的参数。 | -| `url` | unset | WebSocket app-server URL。 | -| `authToken` | unset | 用于 WebSocket 传输的 Bearer token。 | -| `headers` | `{}` | 额外的 WebSocket headers。 | -| `requestTimeoutMs` | `60000` | app-server 控制平面调用的超时时间。 | -| `approvalPolicy` | `"never"` | 发送到线程启动/恢复/轮次的原生 Codex 审批策略。 | -| `sandbox` | `"workspace-write"` | 发送到线程启动/恢复的原生 Codex 沙箱模式。 | -| `approvalsReviewer` | `"user"` | 使用 `"guardian_subagent"` 让 Codex guardian 审查原生审批。 | -| `serviceTier` | unset | 可选的 Codex 服务层级，例如 `"priority"`。 | +| `transport` | `"stdio"` | `"stdio"` 会启动 Codex；`"websocket"` 会连接到 `url`。 | +| `command` | `"codex"` | 用于 stdio 传输的可执行文件。 | +| `args` | `["app-server", "--listen", "stdio://"]` | 用于 stdio 传输的参数。 | +| `url` | unset | WebSocket app-server URL。 | +| `authToken` | unset | 用于 WebSocket 传输的 Bearer token。 | +| `headers` | `{}` | 额外的 WebSocket 请求头。 | +| `requestTimeoutMs` | `60000` | app-server 控制平面调用的超时时间。 | +| `approvalPolicy` | `"never"` | 发送到线程启动、恢复和轮次中的原生 Codex 审批策略。 | +| `sandbox` | `"workspace-write"` | 发送到线程启动和恢复中的原生 Codex 沙箱模式。 | +| `approvalsReviewer` | `"user"` | 使用 `"guardian_subagent"` 让 Codex guardian 审核原生审批。 | +| `serviceTier` | unset | 可选的 Codex 服务层级，例如 `"priority"`。 | -对于本地测试，当对应配置字段未设置时，较旧的环境变量仍可作为回退使用： +旧的环境变量在对应配置字段未设置时，仍可作为本地测试的回退项使用： - `OPENCLAW_CODEX_APP_SERVER_BIN` - `OPENCLAW_CODEX_APP_SERVER_ARGS` @@ -312,9 +312,9 @@ codex app-server --listen stdio:// - `OPENCLAW_CODEX_APP_SERVER_SANDBOX` - `OPENCLAW_CODEX_APP_SERVER_GUARDIAN=1` -对于可重复部署，优先使用配置。 +对于可重复部署，优先推荐使用配置。 -## 常见方案 +## 常见配方 使用默认 stdio 传输的本地 Codex： @@ -330,7 +330,7 @@ codex app-server --listen stdio:// } ``` -仅 Codex 测试框架验证，禁用 PI 回退： +禁用 PI 回退的仅 Codex 测试框架验证： ```json5 { @@ -347,7 +347,7 @@ codex app-server --listen stdio:// } ``` -由 guardian 审查的 Codex 审批： +由 guardian 审核的 Codex 审批： ```json5 { @@ -368,7 +368,7 @@ codex app-server --listen stdio:// } ``` -带显式 headers 的远程 app-server： +带显式请求头的远程 app-server： ```json5 { @@ -391,11 +391,11 @@ codex app-server --listen stdio:// } ``` -模型切换仍由 OpenClaw 控制。当一个 OpenClaw 会话附加到现有 Codex 线程时，下一轮会再次将当前选定的 `codex/*` 模型、提供商、审批策略、沙箱和服务层级发送给 app-server。从 `codex/gpt-5.4` 切换到 `codex/gpt-5.2` 会保留线程绑定，但会要求 Codex 使用新选择的模型继续执行。 +模型切换仍由 OpenClaw 控制。当某个 OpenClaw 会话附加到现有 Codex 线程时，下一轮会再次将当前选定的 `codex/*` 模型、提供商、审批策略、沙箱和服务层级发送给 app-server。从 `codex/gpt-5.4` 切换到 `codex/gpt-5.2` 会保留线程绑定，但会要求 Codex 使用新选定的模型继续执行。 ## Codex 命令 -内置插件将 `/codex` 注册为已授权的斜杠命令。它是通用命令，可在任何支持 OpenClaw 文本命令的渠道上使用。 +内置插件将 `/codex` 注册为已授权的斜杠命令。它是通用命令，适用于任何支持 OpenClaw 文本命令的渠道。 常见形式： @@ -407,33 +407,35 @@ codex app-server --listen stdio:// - `/codex review` 为已附加的线程启动 Codex 原生审查。 - `/codex account` 显示账户和速率限制状态。 - `/codex mcp` 列出 Codex app-server MCP 服务器状态。 -- `/codex skills` 列出 Codex app-server skills。 +- `/codex skills` 列出 Codex app-server Skills。 -`/codex resume` 会写入与测试框架正常轮次相同的辅助绑定文件。在下一条消息时，OpenClaw 会恢复该 Codex 线程，将当前选择的 OpenClaw `codex/*` 模型传入 app-server，并保持启用扩展历史记录。 +`/codex resume` 会写入与测试框架在常规轮次中使用的同一个 sidecar 绑定文件。在下一条消息中，OpenClaw 会恢复该 Codex 线程，将当前选定的 OpenClaw `codex/*` 模型传入 app-server，并保持启用扩展历史记录。 -## 工具、媒体和上下文压缩 +命令接口要求 Codex app-server 为 `0.118.0` 或更高版本。如果未来版本或自定义 app-server 未暴露相应的 JSON-RPC 方法，各个控制方法会显示为 `unsupported by this Codex app-server`。 -Codex 测试框架只会更改底层嵌入式智能体执行器。 +## 工具、媒体和压缩 -OpenClaw 仍会构建工具列表，并从测试框架接收动态工具结果。文本、图片、视频、音乐、TTS、审批以及消息工具输出，都会继续通过正常的 OpenClaw 传递路径处理。 +Codex 测试框架只会更改底层的嵌入式智能体执行器。 -当所选模型使用 Codex 测试框架时，原生线程上下文压缩会委托给 Codex app-server。OpenClaw 会保留一个转录镜像，用于渠道历史、搜索、`/new`、`/reset`，以及未来的模型或测试框架切换。 +OpenClaw 仍然会构建工具列表，并从测试框架接收动态工具结果。文本、图像、视频、音乐、TTS、审批以及消息工具输出，都会继续通过正常的 OpenClaw 传递路径处理。 -媒体生成不依赖 PI。图片、视频、音乐、PDF、TTS 和媒体理解会继续使用相应的提供商/模型设置，例如 `agents.defaults.imageGenerationModel`、`videoGenerationModel`、`pdfModel` 和 `messages.tts`。 +当所选模型使用 Codex 测试框架时，原生线程压缩会委托给 Codex app-server。OpenClaw 会保留一份转录镜像，用于渠道历史、搜索、`/new`、`/reset`，以及未来的模型或测试框架切换。 + +媒体生成不需要 PI。图像、视频、音乐、PDF、TTS 和媒体理解仍会继续使用对应的提供商/模型设置，例如 `agents.defaults.imageGenerationModel`、`videoGenerationModel`、`pdfModel` 和 `messages.tts`。 ## 故障排除 -**`/model` 中没有显示 Codex：** 启用 `plugins.entries.codex.enabled`，设置一个 `codex/*` 模型引用，或者检查 `plugins.allow` 是否排除了 `codex`。 +**`/model` 中未显示 Codex：** 启用 `plugins.entries.codex.enabled`，设置 `codex/*` 模型引用，或检查 `plugins.allow` 是否排除了 `codex`。 **OpenClaw 回退到 PI：** 测试时设置 `embeddedHarness.fallback: "none"` 或 `OPENCLAW_AGENT_HARNESS_FALLBACK=none`。 -**app-server 被拒绝：** 升级 Codex，确保 app-server 握手报告的版本为 `0.118.0` 或更高。 +**app-server 被拒绝：** 升级 Codex，使 app-server 握手报告的版本为 `0.118.0` 或更高。 -**模型发现速度很慢：** 降低 `plugins.entries.codex.config.discovery.timeoutMs`，或禁用发现。 +**模型发现较慢：** 调低 `plugins.entries.codex.config.discovery.timeoutMs` 或禁用发现功能。 -**WebSocket 传输立即失败：** 检查 `appServer.url`、`authToken`，以及远程 app-server 是否使用相同的 Codex app-server 协议版本。 +**WebSocket 传输立即失败：** 检查 `appServer.url`、`authToken`，以及远程 app-server 是否使用相同版本的 Codex app-server 协议。 -**非 Codex 模型使用 PI：** 这是预期行为。Codex 测试框架只接管 `codex/*` 模型引用。 +**非 Codex 模型使用了 PI：** 这是预期行为。Codex 测试框架只接管 `codex/*` 模型引用。 ## 相关内容