Skip to content

测试

OpenClaw 有三个 Vitest 测试套件(单元/集成、e2e、实时)和一小组 Docker 运行器。

本文档是一份"我们如何测试"的指南:

  • 每个套件覆盖的内容(以及它刻意_不_覆盖的内容)
  • 常见工作流的运行命令(本地、推送前、调试)
  • 实时测试如何发现凭证并选择模型/提供商
  • 如何为真实的模型/提供商问题添加回归测试

快速开始

日常工作:

  • 完整门控(推送前预期运行):pnpm build && pnpm check && pnpm test

当您修改测试或需要额外信心时:

  • 覆盖率门控:pnpm test:coverage
  • E2E 套件:pnpm test:e2e

调试真实提供商/模型时(需要真实凭证):

  • 实时套件(模型 + 网关工具/镜像探测):pnpm test:live

提示:当您只需要一个失败用例时,建议通过下面描述的允许列表环境变量缩小实时测试范围。

测试套件(在哪里运行什么)

将这些套件视为"递增的真实性"(以及递增的不稳定性/成本):

单元 / 集成(默认)

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

E2E(网关冒烟测试)

  • 命令:pnpm test:e2e
  • 配置:vitest.e2e.config.ts
  • 文件:src/**/*.e2e.test.ts
  • 范围:
    • 多实例网关端到端行为
    • WebSocket/HTTP 接口、节点配对和更重的网络负载
  • 预期:
    • 在 CI 中运行(当管道中启用时)
    • 不需要真实密钥
    • 比单元测试有更多移动部件(可能较慢)

实时(真实提供商 + 真实模型)

  • 命令:pnpm test:live
  • 配置:vitest.live.config.ts
  • 文件:src/**/*.live.test.ts
  • 默认:通过 pnpm test:live 启用(设置 OPENCLAW_LIVE_TEST=1
  • 范围:
    • "这个提供商/模型在_今天_使用真实凭证时是否真的能工作?"
    • 捕获提供商格式变更、工具调用怪癖、认证问题和速率限制行为
  • 预期:
    • 设计上不稳定于 CI(真实网络、真实提供商策略、配额、中断)
    • 花费金钱 / 使用速率限制
    • 建议运行缩小的子集而不是"全部"
    • 实时运行将加载 ~/.profile 以获取缺失的 API 密钥
    • Anthropic 密钥轮换:设置 OPENCLAW_LIVE_ANTHROPIC_KEYS="sk-...,sk-..."(或 OPENCLAW_LIVE_ANTHROPIC_KEY=sk-...)或多个 ANTHROPIC_API_KEY* 变量;测试将在速率限制时重试

我应该运行哪个套件?

使用此决策表:

  • 编辑逻辑/测试:运行 pnpm test(如果您改动很多,还需要 pnpm test:coverage
  • 修改网关网络 / WS 协议 / 配对:添加 pnpm test:e2e
  • 调试"我的机器人宕机了" / 特定于提供商的失败 / 工具调用:运行缩小的 pnpm test:live

实时:模型冒烟测试(配置文件密钥)

实时测试分为两层,以便我们可以隔离失败:

  • "直接模型"告诉我们提供商/模型是否能用给定的密钥回答。
  • "网关冒烟测试"告诉我们完整的网关+代理管道是否适用于该模型(会话、历史、工具、沙箱策略等)。

第 1 层:直接模型补全(无网关)

  • 测试:src/agents/models.profiles.live.test.ts
  • 目标:
    • 枚举发现的模型
    • 使用 getApiKeyForModel 选择您有凭证的模型
    • 为每个模型运行小型补全(并在需要时运行针对性回归测试)
  • 如何启用:
    • pnpm test:live(或直接调用 Vitest 时使用 OPENCLAW_LIVE_TEST=1
  • 设置 OPENCLAW_LIVE_MODELS=modern(或 all,现代版别名)以实际运行此套件;否则它会跳过,以保持 pnpm test:live 专注于网关冒烟测试
  • 如何选择模型:
    • OPENCLAW_LIVE_MODELS=modern 运行现代允许列表(Opus/Sonnet/Haiku 4.5、GPT-5.x + Codex、Gemini 3、GLM 4.7、MiniMax M2.1、Grok 4)
    • OPENCLAW_LIVE_MODELS=all 是现代允许列表的别名
    • OPENCLAW_LIVE_MODELS="openai/gpt-5.2,anthropic/claude-opus-4-5,..."(逗号分隔的允许列表)
  • 如何选择提供商:
    • OPENCLAW_LIVE_PROVIDERS="google,google-antigravity,google-gemini-cli"(逗号分隔的允许列表)
  • 密钥来源:
    • 默认:配置文件存储和环境变量回退
    • 设置 OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1 以仅强制使用配置文件存储
  • 为什么存在:
    • 将"提供商 API 损坏/密钥无效"与"网关代理管道损坏"分开
    • 包含小型、独立的回归测试(例如:OpenAI Responses/Codex Responses 推理重放 + 工具调用流程)

第 2 层:网关 + 开发代理冒烟测试("@openclaw" 实际做的事情)

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

提示:要查看您可以在机器上测试的内容(以及确切的 provider/model ID),运行:

bash
openclaw models list
openclaw models list --json

实时: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

设置示例:

bash
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

实时:CLI 后端冒烟测试(Claude Code CLI 或其他本地 CLI)

  • 测试:src/gateway/gateway-cli-backend.live.test.ts
  • 目标:使用本地 CLI 后端验证网关 + 代理管道,而不修改您的默认配置。
  • 启用:
    • 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 发送真实镜像附件(路径注入到提示中)。
    • 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_DISABLE_MCP_CONFIG=0 保持 Claude Code CLI MCP 配置启用(默认使用临时空文件禁用 MCP 配置)。

示例:

bash
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

推荐的实时配方

缩小的明确允许列表是最快且最不易出错的:

  • 单个模型,直接(无网关):

    • OPENCLAW_LIVE_MODELS="openai/gpt-5.2" pnpm test:live src/agents/models.profiles.live.test.ts
  • 单个模型,网关冒烟测试:

    • OPENCLAW_LIVE_GATEWAY_MODELS="openai/gpt-5.2" pnpm test:live src/gateway/gateway-models.profiles.live.test.ts
  • 跨多个提供商的工具调用:

    • 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 风格的代理端点)。
  • google-gemini-cli/... 使用您机器上的本地 Gemini CLI(单独的认证 + 工具怪癖)。
  • Gemini API 与 Gemini CLI:
    • API:OpenClaw 通过 HTTP 调用 Google 的托管 Gemini API(API 密钥/配置文件认证);这是大多数用户所说的"Gemini"。
    • CLI:OpenClaw 调用本地 gemini 二进制文件;它有自己的认证,行为可能不同(流式传输/工具支持/版本偏差)。

实时:模型矩阵(我们覆盖的内容)

没有固定的"CI 模型列表"(实时是可选的),但这些是推荐在有密钥的开发机器上定期覆盖的模型。

现代冒烟测试集(工具调用 + 镜像)

这是我们期望保持工作的"常见模型"运行:

  • 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-previewgoogle/gemini-3-flash-preview(避免旧版 Gemini 2.x 模型)
  • Google(Antigravity):google-antigravity/claude-opus-4-5-thinkinggoogle-antigravity/gemini-3-flash
  • Z.AI(GLM):zai/glm-4.7
  • MiniMax:minimax/minimax-m2.1

使用工具 + 镜像运行网关冒烟测试: 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

基线:工具调用(读取 + 可选执行)

每个提供商系列至少选择一个:

  • 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 认证)

您可以在实时矩阵中包含更多提供商(如果您有凭证/配置):

  • 内置:openaiopenai-codexanthropicgooglegoogle-vertexgoogle-antigravitygoogle-gemini-clizaiopenrouteropencodexaigroqcerebrasmistralgithub-copilot
  • 通过 models.providers(自定义端点):minimax(云/API),以及任何 OpenAI/Anthropic 兼容的代理(LM Studio、vLLM、LiteLLM 等)

提示:不要尝试在文档中硬编码"所有模型"。权威列表是您机器上 discoverModels(...) 返回的内容 + 任何可用的密钥。

凭证(永不提交)

实时测试以 CLI 相同的方式发现凭证。实际影响:

  • 如果 CLI 有效,实时测试应该找到相同的密钥。

  • 如果实时测试显示"无凭证",以调试 openclaw models list / 模型选择的相同方式进行调试。

  • 配置文件存储:~/.openclaw/credentials/(首选;测试中"配置文件密钥"的含义)

  • 配置:~/.openclaw/openclaw.json(或 OPENCLAW_CONFIG_PATH

如果您想依赖环境密钥(例如在 ~/.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

Docker 运行器(可选的"在 Linux 中工作"检查)

这些在仓库 Docker 镜像内运行 pnpm test:live,挂载您的本地配置目录和工作区(如果挂载则加载 ~/.profile):

  • 直接模型:pnpm test:docker:live-models(脚本:scripts/test-live-models-docker.sh
  • 网关 + 开发代理:pnpm test:docker:live-gateway(脚本:scripts/test-live-gateway-models-docker.sh
  • 引导向导(TTY,完整脚手架):pnpm test:docker:onboard(脚本:scripts/e2e/onboard-docker.sh
  • 网关网络(两个容器,WS 认证 + 健康检查):pnpm test:docker:gateway-network(脚本:scripts/e2e/gateway-network-docker.sh
  • 插件(自定义扩展加载 + 注册表冒烟测试):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 并在运行测试前加载
  • OPENCLAW_LIVE_GATEWAY_MODELS=... / OPENCLAW_LIVE_MODELS=... 缩小运行范围
  • OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1 确保凭证来自配置文件存储(而非环境变量)

文档健全性

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

离线回归(CI 安全)

这些是没有真实提供商的"真实管道"回归测试:

  • 网关工具调用(模拟 OpenAI,真实网关 + 代理循环):src/gateway/gateway.tool-calling.mock-openai.test.ts
  • 网关向导(WS wizard.start/wizard.next,写入配置 + 强制认证):src/gateway/gateway.wizard.e2e.test.ts

代理可靠性评估(技能)

我们已经有一些 CI 安全的测试,行为类似于"代理可靠性评估":

  • 通过真实网关 + 代理循环进行模拟工具调用(src/gateway/gateway.tool-calling.mock-openai.test.ts)。
  • 验证会话连接和配置效果的端到端向导流程(src/gateway/gateway.wizard.e2e.test.ts)。

技能仍然缺少的内容(见 Skills):

  • 决策:当技能在提示中列出时,代理是否选择了正确的技能(或避免了不相关的技能)?
  • 合规性:代理在使用前是否阅读 SKILL.md 并遵循所需的步骤/参数?
  • 工作流契约:断言工具顺序、会话历史传递和沙箱边界的多轮场景。

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

  • 使用模拟提供商的场景运行器,以断言工具调用 + 顺序、技能文件读取和会话连接。
  • 一小组以技能为重点的场景(使用与避免、门控、提示注入)。
  • 可选的实时评估(可选、环境门控)仅在 CI 安全套件到位后进行。

添加回归测试(指导)

当您修复在实时中发现的提供商/模型问题时:

  • 尽可能添加 CI 安全的回归测试(模拟/存根提供商,或捕获确切的请求形状转换)
  • 如果它本质上仅限于实时(速率限制、认证策略),通过环境变量保持实时测试范围缩小且可选
  • 优先针对捕获 bug 的最小层:
    • 提供商请求转换/重放 bug → 直接模型测试
    • 网关会话/历史/工具管道 bug → 网关实时冒烟测试或 CI 安全网关模拟测试