测试

OpenClaw 有三个 Vitest 测试套件（单元/集成、e2e、live）和一小组 Docker 运行器。

本文档是一个”我们如何测试”的指南：

  • 每个套件覆盖什么（以及它故意不覆盖什么）
  • 常见工作流程要运行哪些命令（本地、推送前、调试）
  • Live 测试如何发现凭证并选择模型/Provider
  • 如何为真实的模型/Provider 问题添加回归测试

快速开始

日常使用：

  • 完整检查（推送前必须）：pnpm build && pnpm check && pnpm test

当你修改测试或想要额外信心时：

  • 覆盖率检查：pnpm test:coverage
  • E2E 套件：pnpm test:e2e

调试真实 Provider/模型时（需要真实凭证）：

  • Live 套件（模型 + Gateway 工具/图像探测）：pnpm test:live

提示：当你只需要一个失败用例时，优先通过下面描述的 Allowlist 环境变量缩小 live 测试范围。

测试套件（在哪里运行什么）

把这些套件想象成”逐渐增加的真实性”（以及逐渐增加的不稳定性/成本）：

单元/集成（默认）

  • 命令：pnpm test
  • 配置：vitest.config.ts
  • 文件：src/**/*.test.ts
  • 范围：
    • 纯单元测试
    • 进程内集成测试（Gateway 认证、路由、工具、解析、配置）
    • 已知问题的确定性回归测试
  • 预期：
    • 在 CI 中运行
    • 不需要真实密钥
    • 应该快速且稳定

E2E（Gateway 冒烟测试）

  • 命令：pnpm test:e2e
  • 配置：vitest.e2e.config.ts
  • 文件：src/**/*.e2e.test.ts
  • 范围：
    • 多实例 Gateway 端到端行为
    • WebSocket/HTTP 接口、节点配对和更重的网络操作
  • 预期：
    • 在 CI 中运行（当在流水线中启用时）
    • 不需要真实密钥
    • 比单元测试有更多活动部件（可能更慢）

Live（真实 Provider + 真实模型）

  • 命令：pnpm test:live
  • 配置：vitest.live.config.ts
  • 文件：src/**/*.live.test.ts
  • 默认：通过 pnpm test:live（设置 OPENCLAW_LIVE_TEST=1）启用
  • 范围：
    • “这个 Provider/模型今天用真实凭证实际能工作吗？”
    • 捕获 Provider 格式变化、工具调用特性、认证问题和速率限制行为
  • 预期：
    • 设计上不适合 CI 稳定运行（真实网络、真实 Provider 策略、配额、故障）
    • 花钱/使用速率限制
    • 优先运行缩小范围的子集而不是”所有”
    • Live 运行会 source ~/.profile 来获取缺失的 API 密钥
    • Anthropic 密钥轮换：设置 OPENCLAW_LIVE_ANTHROPIC_KEYS="sk-...,sk-..."（或 OPENCLAW_LIVE_ANTHROPIC_KEY=sk-...）或多个 ANTHROPIC_API_KEY* 变量；测试会在速率限制时重试

应该运行哪个套件？

使用这个决策表：

  • 编辑逻辑/测试：运行 pnpm test（如果改动很多，加上 pnpm test:coverage）
  • 涉及 Gateway 网络/WS 协议/配对：加上 pnpm test:e2e
  • 调试”我的机器人挂了”/Provider 特定故障/工具调用：运行缩小范围的 pnpm test:live

Live：模型冒烟测试（配置密钥）

Live 测试分为两层，以便隔离故障：

  • “直接模型”告诉我们 Provider/模型能否用给定密钥回答。
  • “Gateway 冒烟测试”告诉我们完整的 Gateway+Agent 管道对该模型是否工作（Session、历史、工具、Sandbox 策略等）。

第一层：直接模型完成（无 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 冒烟测试
  • 如何选择模型：
    • OPENCLAW_LIVE_MODELS=modern 运行现代 Allowlist（Opus/Sonnet/Haiku 4.5、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.1、Grok 4）
    • OPENCLAW_LIVE_MODELS=all 是现代 Allowlist 的别名
    • 或 OPENCLAW_LIVE_MODELS="openai/gpt-5.2,anthropic/claude-opus-4-5,..."（逗号分隔的 Allowlist）
  • 如何选择 Provider：
    • OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"（逗号分隔的 Allowlist）
  • 密钥来源：
    • 默认：配置存储和环境变量回退
    • 设置 OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1 强制只使用配置存储
  • 为什么存在：
    • 将”Provider API 坏了/密钥无效”与”Gateway Agent 管道坏了”分开
    • 包含小型、隔离的回归测试（例如：OpenAI Responses/Codex Responses 推理重放 + 工具调用流程）

第二层：Gateway + dev Agent 冒烟测试（“@openclaw”实际做什么）

  • 测试：src/gateway/gateway-models.profiles.live.test.ts
  • 目标：
    • 启动一个进程内 Gateway
    • 创建/修补一个 agent:dev:* Session（每次运行覆盖模型）
    • 遍历有密钥的模型并断言：
      • “有意义的”响应（无工具）
      • 真实工具调用工作（read 探测）
      • 可选的额外工具探测（exec+read 探测）
      • OpenAI 回归路径（仅工具调用 → 后续）保持工作
  • 探测详情（方便快速解释故障）：
    • read 探测：测试在 Workspace 中写入一个 nonce 文件，要求 Agent read 它并回显 nonce。
    • exec+read 探测：测试要求 Agent exec 写入一个 nonce 到临时文件，然后 read 回来。
    • 图像探测：测试附加一个生成的 PNG（猫 + 随机代码），期望模型返回 cat <CODE>。
    • 实现参考：src/gateway/gateway-models.profiles.live.test.ts 和 src/gateway/live-image-probe.ts。
  • 如何启用：
    • pnpm test:live（或直接调用 Vitest 时 OPENCLAW_LIVE_TEST=1）
  • 如何选择模型：
    • 默认：现代 Allowlist（Opus/Sonnet/Haiku 4.5、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.1、Grok 4）
    • OPENCLAW_LIVE_GATEWAY_MODELS=all 是现代 Allowlist 的别名
    • 或设置 OPENCLAW_LIVE_GATEWAY_MODELS="provider/model"（或逗号列表）来缩小范围
  • 如何选择 Provider（避免”OpenRouter 所有”）：
    • OPENCLAW_LIVE_GATEWAY_PROVIDERS="google,google-antigravity,google-gemini-cli,openai,anthropic,zai,minimax"（逗号分隔的 Allowlist）
  • 工具 + 图像探测在此 live 测试中始终开启：
    • read 探测 + exec+read 探测（工具压力测试）
    • 当模型声明支持图像输入时运行图像探测
    • 流程（高层）：
      • 测试生成一个带有”CAT”+ 随机代码的小 PNG（src/gateway/live-image-probe.ts）
      • 通过 agent attachments: [{ mimeType: "image/png", content: "<base64>" }] 发送
      • Gateway 将附件解析为 images[]（src/gateway/server-methods/agent.ts + src/gateway/chat-attachments.ts）
      • 嵌入式 Agent 向模型转发多模态用户消息
      • 断言：回复包含 cat + 代码（OCR 容差：允许小错误）

提示：要查看你的机器上可以测试什么（以及确切的 provider/model ID），运行：

openclaw models list
openclaw models list --json

Live：Anthropic setup-token 冒烟测试

  • 测试：src/agents/anthropic.setup-token.live.test.ts
  • 目标：验证 Claude Code CLI setup-token（或粘贴的 setup-token 配置）能完成 Anthropic 提示。
  • 启用：
    • pnpm test:live（或直接调用 Vitest 时 OPENCLAW_LIVE_TEST=1）
    • OPENCLAW_LIVE_SETUP_TOKEN=1
  • Token 来源（选一个）：
    • 配置：OPENCLAW_LIVE_SETUP_TOKEN_PROFILE=anthropic:setup-token-test
    • 原始 Token：OPENCLAW_LIVE_SETUP_TOKEN_VALUE=sk-ant-oat01-...
  • 模型覆盖（可选）：
    • OPENCLAW_LIVE_SETUP_TOKEN_MODEL=anthropic/claude-opus-4-5

设置示例：

openclaw models auth paste-token --provider anthropic --profile-id anthropic:setup-token-test
OPENCLAW_LIVE_SETUP_TOKEN=1 OPENCLAW_LIVE_SETUP_TOKEN_PROFILE=anthropic:setup-token-test pnpm test:live src/agents/anthropic.setup-token.live.test.ts

Live：CLI 后端冒烟测试（Claude Code CLI 或其他本地 CLI）

  • 测试：src/gateway/gateway-cli-backend.live.test.ts
  • 目标：使用本地 CLI 后端验证 Gateway + Agent 管道，不触及默认配置。
  • 启用：
    • pnpm test:live（或直接调用 Vitest 时 OPENCLAW_LIVE_TEST=1）
    • OPENCLAW_LIVE_CLI_BACKEND=1
  • 默认值：
    • 模型：claude-cli/claude-sonnet-4-5
    • 命令：claude
    • 参数：["-p","--output-format","json","--dangerously-skip-permissions"]
  • 覆盖（可选）：
    • OPENCLAW_LIVE_CLI_BACKEND_MODEL="claude-cli/claude-opus-4-5"
    • OPENCLAW_LIVE_CLI_BACKEND_MODEL="codex-cli/gpt-5.2-codex"
    • OPENCLAW_LIVE_CLI_BACKEND_COMMAND="/full/path/to/claude"
    • OPENCLAW_LIVE_CLI_BACKEND_ARGS='["-p","--output-format","json","--permission-mode","bypassPermissions"]'
    • OPENCLAW_LIVE_CLI_BACKEND_CLEAR_ENV='["ANTHROPIC_API_KEY","ANTHROPIC_API_KEY_OLD"]'
    • OPENCLAW_LIVE_CLI_BACKEND_IMAGE_PROBE=1 发送真实图像附件（路径注入到 Prompt 中）。
    • OPENCLAW_LIVE_CLI_BACKEND_IMAGE_ARG="--image" 将图像文件路径作为 CLI 参数传递而不是 Prompt 注入。
    • OPENCLAW_LIVE_CLI_BACKEND_IMAGE_MODE="repeat"（或 "list"）控制设置 IMAGE_ARG 时如何传递图像参数。
    • OPENCLAW_LIVE_CLI_BACKEND_RESUME_PROBE=1 发送第二轮并验证恢复流程。
  • OPENCLAW_LIVE_CLI_BACKEND_DISABLE_MCP_CONFIG=0 保持 Claude Code CLI MCP 配置启用（默认用临时空文件禁用 MCP 配置）。

示例：

OPENCLAW_LIVE_CLI_BACKEND=1 \
  OPENCLAW_LIVE_CLI_BACKEND_MODEL="claude-cli/claude-sonnet-4-5" \
  pnpm test:live src/gateway/gateway-cli-backend.live.test.ts

推荐的 live 配方

缩小范围、明确的 Allowlist 最快且最不易出问题：

  • 单个模型，直接（无 Gateway）：

    • OPENCLAW_LIVE_MODELS="openai/gpt-5.2" pnpm test:live src/agents/models.profiles.live.test.ts

  • 单个模型，Gateway 冒烟测试：

    • OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.2" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts

  • 跨多个 Provider 的工具调用：

    • OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.2,anthropic/claude-opus-4-5,google/gemini-3-flash-preview,zai/glm-4.7,minimax/minimax-m2.1" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts

  • Google 专注（Gemini API 密钥 + Antigravity）：

    • Gemini（API 密钥）：OPENCLAW_LIVE_GATEWAY_MODELS="google/gemini-3-flash-preview" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts
    • Antigravity（OAuth）：OPENCLAW_LIVE_GATEWAY_MODELS="google-antigravity/claude-opus-4-5-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 桥接（Cloud Code Assist 风格的 Agent 端点）。
  • google-gemini-cli/... 使用你机器上的本地 Gemini CLI（独立的认证 + 工具特性）。
  • Gemini API vs Gemini CLI：
    • API：OpenClaw 通过 HTTP 调用 Google 托管的 Gemini API（API 密钥/配置认证）；这是大多数用户说的”Gemini”。
    • CLI：OpenClaw 调用本地 gemini 二进制文件；它有自己的认证，行为可能不同（流式/工具支持/版本差异）。

Live：模型矩阵（我们覆盖什么）

没有固定的”CI 模型列表”（live 是可选的），但这些是建议在有密钥的开发机器上定期覆盖的推荐模型。

现代冒烟测试集（工具调用 + 图像）

这是我们期望保持工作的”常用模型”运行：

  • OpenAI（非 Codex）：openai/gpt-5.2（可选：openai/gpt-5.1）
  • OpenAI Codex：openai-codex/gpt-5.2（可选：openai-codex/gpt-5.2-codex）
  • Anthropic：anthropic/claude-opus-4-5（或 anthropic/claude-sonnet-4-5）
  • Google（Gemini API）：google/gemini-3-pro-preview 和 google/gemini-3-flash-preview（避免旧的 Gemini 2.x 模型）
  • Google（Antigravity）：google-antigravity/claude-opus-4-5-thinking 和 google-antigravity/gemini-3-flash
  • Z.AI（GLM）：zai/glm-4.7
  • MiniMax：minimax/minimax-m2.1

运行带工具 + 图像的 Gateway 冒烟测试： OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.2,openai-codex/gpt-5.2,anthropic/claude-opus-4-5,google/gemini-3-pro-preview,google/gemini-3-flash-preview,google-antigravity/claude-opus-4-5-thinking,google-antigravity/gemini-3-flash,zai/glm-4.7,minimax/minimax-m2.1" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts

基线：工具调用（Read + 可选 Exec）

每个 Provider 系列至少选一个：

  • OpenAI：openai/gpt-5.2（或 openai/gpt-5-mini）
  • Anthropic：anthropic/claude-opus-4-5（或 anthropic/claude-sonnet-4-5）
  • Google：google/gemini-3-flash-preview（或 google/gemini-3-pro-preview）
  • Z.AI（GLM）：zai/glm-4.7
  • MiniMax：minimax/minimax-m2.1

可选的额外覆盖（有更好）：

  • xAI：xai/grok-4（或最新可用）
  • Mistral：mistral/…（选一个你启用的”工具”能力模型）
  • Cerebras：cerebras/…（如果你有访问权限）
  • LM Studio：lmstudio/…（本地；工具调用取决于 API 模式）

视觉：图像发送（附件 → 多模态消息）

在 OPENCLAW_LIVE_GATEWAY_MODELS 中至少包含一个支持图像的模型（Claude/Gemini/OpenAI 视觉能力变体等）来测试图像探测。

聚合器/备用网关

如果你启用了密钥，我们也支持通过以下方式测试：

  • OpenRouter：openrouter/...（数百个模型；用 openclaw models scan 找工具+图像能力的候选）
  • OpenCode Zen：opencode/...（通过 OPENCODE_API_KEY / OPENCODE_ZEN_API_KEY 认证）

更多你可以包含在 live 矩阵中的 Provider（如果你有凭证/配置）：

  • 内置：openai、openai-codex、anthropic、google、google-vertex、google-antigravity、google-gemini-cli、zai、openrouter、opencode、xai、groq、cerebras、mistral、github-copilot
  • 通过 models.providers（自定义端点）：minimax（云/API），加上任何 OpenAI/Anthropic 兼容代理（LM Studio、vLLM、LiteLLM 等）

提示：不要试图在文档中硬编码”所有模型”。权威列表是你机器上 discoverModels(...) 返回的内容 + 可用的密钥。

凭证（永远不要提交）

Live 测试发现凭证的方式与 CLI 相同。实际含义：

  • 如果 CLI 工作，live 测试应该能找到相同的密钥。

  • 如果 live 测试说”没有凭证”，用调试 openclaw models list / 模型选择的方式来调试。

  • 配置存储：~/.openclaw/credentials/（首选；测试中”配置密钥”的含义）

  • 配置：~/.openclaw/openclaw.json（或 OPENCLAW_CONFIG_PATH）

如果你想依赖环境变量密钥（例如在 ~/.profile 中导出的），在 source ~/.profile 后运行本地测试，或使用下面的 Docker 运行器（它们可以将 ~/.profile 挂载到容器中）。

Deepgram live（音频转录）

  • 测试：src/media-understanding/providers/deepgram/audio.live.test.ts
  • 启用：DEEPGRAM_API_KEY=... DEEPGRAM_LIVE_TEST=1 pnpm test:live src/media-understanding/providers/deepgram/audio.live.test.ts

Docker 运行器（可选的”在 Linux 中工作”检查）

这些在仓库 Docker 镜像中运行 pnpm test:live，挂载你的本地配置目录和 Workspace（如果挂载了会 source ~/.profile）：

  • 直接模型：pnpm test:docker:live-models（脚本：scripts/test-live-models-docker.sh）
  • Gateway + dev Agent：pnpm test:docker:live-gateway（脚本：scripts/test-live-gateway-models-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）
  • Plugin（自定义扩展加载 + 注册表冒烟测试）：pnpm test:docker:plugins（脚本：scripts/e2e/plugins-docker.sh）

有用的环境变量：

  • OPENCLAW_CONFIG_DIR=...（默认：~/.openclaw）挂载到 /home/node/.openclaw
  • OPENCLAW_WORKSPACE_DIR=...（默认：~/.openclaw/workspace）挂载到 /home/node/.openclaw/workspace
  • OPENCLAW_PROFILE_FILE=...（默认：~/.profile）挂载到 /home/node/.profile 并在运行测试前 source
  • OPENCLAW_LIVE_GATEWAY_MODELS=... / OPENCLAW_LIVE_MODELS=... 缩小运行范围
  • OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1 确保凭证来自配置存储（不是环境变量）

文档检查

编辑文档后运行文档检查：pnpm docs:list。

离线回归（CI 安全）

这些是没有真实 Provider 的”真实管道”回归：

  • Gateway 工具调用（模拟 OpenAI，真实 Gateway + Agent 循环）：src/gateway/gateway.tool-calling.mock-openai.test.ts
  • Gateway 向导（WS wizard.start/wizard.next，写入配置 + 强制认证）：src/gateway/gateway.wizard.e2e.test.ts

Agent 可靠性评估（Skills）

我们已经有一些行为类似”Agent 可靠性评估”的 CI 安全测试：

  • 通过真实 Gateway + Agent 循环的模拟工具调用（src/gateway/gateway.tool-calling.mock-openai.test.ts）。
  • 验证 Session 连接和配置效果的端到端向导流程（src/gateway/gateway.wizard.e2e.test.ts）。

Skills 还缺少什么（见 Skills）：

  • 决策：当 Skills 列在 Prompt 中时，Agent 是否选择正确的 Skill（或避免不相关的）？
  • 合规：Agent 是否在使用前读取 SKILL.md 并遵循必需的步骤/参数？
  • 工作流契约：断言工具顺序、Session 历史延续和 Sandbox 边界的多轮场景。

未来的评估应该首先保持确定性：

  • 使用模拟 Provider 断言工具调用 + 顺序、Skill 文件读取和 Session 连接的场景运行器。
  • 一小组专注于 Skill 的场景（使用 vs 避免、门控、Prompt 注入）。
  • 可选的 live 评估（可选、环境变量门控）只在 CI 安全套件就位后。

添加回归测试（指南）

当你修复在 live 中发现的 Provider/模型问题时：

  • 如果可能，添加 CI 安全的回归测试（模拟/存根 Provider，或捕获确切的请求形状转换）
  • 如果本质上只能 live（速率限制、认证策略），保持 live 测试范围小且通过环境变量可选
  • 优先针对能捕获问题的最小层：
    • Provider 请求转换/重放问题 → 直接模型测试
    • Gateway Session/历史/工具管道问题 → Gateway live 冒烟测试或 CI 安全的 Gateway 模拟测试