chore(i18n): refresh zh-CN translations
This commit is contained in:
parent
6a63a3789d
commit
60f62ff370
340
docs/zh-CN/ci.md
340
docs/zh-CN/ci.md
@ -1,94 +1,94 @@
|
||||
---
|
||||
read_when:
|
||||
- 你需要了解 CI 作业为何运行或为何没有运行
|
||||
- 你正在调试一项失败的 GitHub Actions 检查
|
||||
- 你需要了解某个 CI 作业为什么运行或未运行
|
||||
- 你正在调试一个失败的 GitHub Actions 检查
|
||||
- 你正在协调一次发布验证运行或重新运行
|
||||
- 你正在更改 ClawSweeper 调度或 GitHub 活动转发
|
||||
summary: CI 作业图、范围门禁、发布伞形流程和本地命令等效项
|
||||
summary: CI 作业图、范围门禁、发布总括流程和本地等效命令
|
||||
title: CI 流水线
|
||||
x-i18n:
|
||||
generated_at: "2026-05-02T15:53:12Z"
|
||||
generated_at: "2026-05-02T15:57:46Z"
|
||||
model: gpt-5.5
|
||||
provider: openai
|
||||
source_hash: 1cf280f1f46d49462656de86001b7f2bef7c63f133dbb8d208a7497c48fa3497
|
||||
source_hash: 9687e386ce6beb96df10b57b43616af5366f231bd603e575ec20df386671564f
|
||||
source_path: ci.md
|
||||
workflow: 16
|
||||
---
|
||||
|
||||
OpenClaw CI 会在每次推送到 `main` 和每个拉取请求时运行。`preflight` 作业会对 diff 进行分类,并在只有无关区域发生变更时关闭高成本通道。手动 `workflow_dispatch` 运行会有意绕过智能范围限定,并为候选发布版本和广泛验证展开完整图。Android 通道通过 `include_android` 保持可选启用。仅发布使用的插件覆盖率位于单独的 [`插件预发布`](#plugin-prerelease) 工作流中,并且只会从 [`完整发布验证`](#full-release-validation) 或显式手动派发运行。
|
||||
OpenClaw CI 会在每次推送到 `main` 以及每个拉取请求上运行。`preflight` 作业会对差异进行分类,并在只有无关区域发生变化时关闭开销较高的任务线。手动 `workflow_dispatch` 运行会有意绕过智能范围限定,并为候选发布和广泛验证展开完整图。Android 任务线通过 `include_android` 保持选择性启用。仅发布使用的插件覆盖位于单独的 [`Plugin Prerelease`](#plugin-prerelease) 工作流中,并且只会从 [`Full Release Validation`](#full-release-validation) 或显式手动分发运行。
|
||||
|
||||
## 流水线概览
|
||||
|
||||
| 作业 | 用途 | 运行时机 |
|
||||
| 作业 | 用途 | 运行时机 |
|
||||
| -------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
||||
| `preflight` | 检测仅文档变更、变更范围、变更扩展,并构建 CI 清单 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `security-scm-fast` | 通过 `zizmor` 进行私钥检测和工作流审计 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `security-dependency-audit` | 针对 npm 安全公告进行无依赖的生产 lockfile 审计 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `security-fast` | 快速安全作业所需的聚合项 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `check-dependencies` | 生产 Knip 仅依赖检查,以及未使用文件 allowlist 防护 | Node 相关变更 |
|
||||
| `build-artifacts` | 构建 `dist/`、Control UI、构建产物检查,以及可复用的下游产物 | Node 相关变更 |
|
||||
| `checks-fast-core` | 快速 Linux 正确性通道,例如内置/插件契约/协议检查 | Node 相关变更 |
|
||||
| `checks-fast-contracts-channels` | 分片的渠道契约检查,并带有稳定的聚合检查结果 | Node 相关变更 |
|
||||
| `checks-node-core-test` | 核心 Node 测试分片,不包括渠道、内置、契约和扩展通道 | Node 相关变更 |
|
||||
| `check` | 分片的主要本地门禁等价项:生产类型、lint、防护、测试类型和严格 smoke | Node 相关变更 |
|
||||
| `check-additional` | 架构、边界、扩展表面防护、包边界和 gateway-watch 分片 | Node 相关变更 |
|
||||
| `build-smoke` | 已构建 CLI smoke 测试和启动内存 smoke | Node 相关变更 |
|
||||
| `checks` | 已构建产物渠道测试的验证器 | Node 相关变更 |
|
||||
| `checks-node-compat-node22` | Node 22 兼容性构建和 smoke 通道 | 发布用手动 CI 派发 |
|
||||
| `check-docs` | 文档格式化、lint 和断链检查 | 文档已变更 |
|
||||
| `skills-python` | 面向 Python 支持的 Skills 的 Ruff + pytest | Python Skills 相关变更 |
|
||||
| `checks-windows` | Windows 特定进程/路径测试,以及共享运行时导入说明符回归测试 | Windows 相关变更 |
|
||||
| `macos-node` | 使用共享构建产物的 macOS TypeScript 测试通道 | macOS 相关变更 |
|
||||
| `macos-swift` | macOS 应用的 Swift lint、构建和测试 | macOS 相关变更 |
|
||||
| `android` | 两种 flavor 的 Android 单元测试,以及一次 debug APK 构建 | Android 相关变更 |
|
||||
| `test-performance-agent` | 可信活动后的每日 Codex 慢测试优化 | 主 CI 成功或手动派发 |
|
||||
| `openclaw-performance` | 每日/按需 Kova 运行时性能报告,包含 mock-provider、deep-profile 和 GPT 5.4 实时通道 | 定时和手动派发 |
|
||||
| `preflight` | 检测仅文档变更、变更范围、变更扩展,并构建 CI 清单 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `security-scm-fast` | 通过 `zizmor` 进行私钥检测和工作流审计 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `security-dependency-audit` | 针对 npm advisories 进行无依赖的生产 lockfile 审计 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `security-fast` | 快速安全作业所需的聚合项 | 始终在非草稿推送和 PR 上运行 |
|
||||
| `check-dependencies` | 仅生产 Knip 依赖检查,以及未使用文件 allowlist 守卫 | Node 相关变更 |
|
||||
| `build-artifacts` | 构建 `dist/`、Control UI、构建产物检查,以及可复用的下游产物 | Node 相关变更 |
|
||||
| `checks-fast-core` | 快速 Linux 正确性任务线,例如内置/插件契约/协议检查 | Node 相关变更 |
|
||||
| `checks-fast-contracts-channels` | 分片的渠道契约检查,并提供稳定的聚合检查结果 | Node 相关变更 |
|
||||
| `checks-node-core-test` | 核心 Node 测试分片,不包括渠道、内置、契约和扩展任务线 | Node 相关变更 |
|
||||
| `check` | 分片的主要本地门禁等价项:生产类型、lint、守卫、测试类型和严格冒烟测试 | Node 相关变更 |
|
||||
| `check-additional` | 架构、边界、扩展表面守卫、包边界和 gateway-watch 分片 | Node 相关变更 |
|
||||
| `build-smoke` | 已构建 CLI 冒烟测试和启动内存冒烟测试 | Node 相关变更 |
|
||||
| `checks` | 已构建产物渠道测试的验证器 | Node 相关变更 |
|
||||
| `checks-node-compat-node22` | Node 22 兼容性构建和冒烟任务线 | 面向发布的手动 CI 分发 |
|
||||
| `check-docs` | 文档格式化、lint 和断链检查 | 文档已变更 |
|
||||
| `skills-python` | 面向 Python 支持的 Skills 的 Ruff + pytest | Python Skill 相关变更 |
|
||||
| `checks-windows` | Windows 特定的进程/路径测试,以及共享运行时 import specifier 回归测试 | Windows 相关变更 |
|
||||
| `macos-node` | 使用共享构建产物的 macOS TypeScript 测试任务线 | macOS 相关变更 |
|
||||
| `macos-swift` | macOS 应用的 Swift lint、构建和测试 | macOS 相关变更 |
|
||||
| `android` | 两种 flavor 的 Android 单元测试,以及一次 debug APK 构建 | Android 相关变更 |
|
||||
| `test-performance-agent` | 受信任活动之后的每日 Codex 慢测试优化 | Main CI 成功或手动分发 |
|
||||
| `openclaw-performance` | 每日/按需 Kova 运行时性能报告,包含 mock-provider、deep-profile 和 GPT 5.4 实时任务线 | 定时和手动分发 |
|
||||
|
||||
## Fail-fast 顺序
|
||||
## 快速失败顺序
|
||||
|
||||
1. `preflight` 决定哪些通道实际存在。`docs-scope` 和 `changed-scope` 逻辑是此作业内部的步骤,不是独立作业。
|
||||
2. `security-scm-fast`、`security-dependency-audit`、`security-fast`、`check`、`check-additional`、`check-docs` 和 `skills-python` 会快速失败,而不会等待更重的产物和平台矩阵作业。
|
||||
3. `build-artifacts` 会与快速 Linux 通道重叠运行,这样下游消费者可以在共享构建就绪后立即开始。
|
||||
4. 更重的平台和运行时通道随后展开:`checks-fast-core`、`checks-fast-contracts-channels`、`checks-node-core-test`、`checks`、`checks-windows`、`macos-node`、`macos-swift` 和 `android`。
|
||||
1. `preflight` 决定哪些任务线实际存在。`docs-scope` 和 `changed-scope` 逻辑是此作业内的步骤,而不是独立作业。
|
||||
2. `security-scm-fast`、`security-dependency-audit`、`security-fast`、`check`、`check-additional`、`check-docs` 和 `skills-python` 会快速失败,无需等待更重的产物和平台矩阵作业。
|
||||
3. `build-artifacts` 会与快速 Linux 任务线重叠运行,使下游消费者可在共享构建就绪后立即开始。
|
||||
4. 更重的平台和运行时任务线随后展开:`checks-fast-core`、`checks-fast-contracts-channels`、`checks-node-core-test`、`checks`、`checks-windows`、`macos-node`、`macos-swift` 和 `android`。
|
||||
|
||||
当同一 PR 或 `main` ref 上有更新的推送落地时,GitHub 可能会将被取代的作业标记为 `cancelled`。除非同一 ref 的最新运行也在失败,否则将其视为 CI 噪声。聚合分片检查使用 `!cancelled() && always()`,因此它们仍会报告正常的分片失败,但不会在整个工作流已被取代后继续排队。自动 CI 并发键带有版本号(`CI-v7-*`),因此 GitHub 侧旧队列组中的僵尸任务无法无限期阻塞更新的 main 运行。手动完整套件运行使用 `CI-manual-v1-*`,并且不会取消正在进行的运行。
|
||||
当同一 PR 或 `main` ref 上有较新的推送落地时,GitHub 可能会将被取代的作业标记为 `cancelled`。除非同一 ref 的最新运行也失败,否则应将其视为 CI 噪声。聚合分片检查使用 `!cancelled() && always()`,因此它们仍会报告正常的分片失败,但不会在整个工作流已经被取代后继续排队。自动 CI 并发键带有版本号(`CI-v7-*`),因此 GitHub 侧旧队列组中的僵尸任务无法无限期阻塞较新的 main 运行。手动全套件运行使用 `CI-manual-v1-*`,并且不会取消正在进行的运行。
|
||||
|
||||
## 范围和路由
|
||||
|
||||
范围逻辑位于 `scripts/ci-changed-scope.mjs`,并由 `src/scripts/ci-changed-scope.test.ts` 中的单元测试覆盖。手动派发会跳过变更范围检测,并让 preflight 清单表现得像每个限定范围区域都发生了变更。
|
||||
范围逻辑位于 `scripts/ci-changed-scope.mjs`,并由 `src/scripts/ci-changed-scope.test.ts` 中的单元测试覆盖。手动分发会跳过变更范围检测,并让 preflight 清单表现得像每个限定范围区域都已变更。
|
||||
|
||||
- **CI 工作流编辑**会验证 Node CI 图和工作流 lint,但其本身不会强制 Windows、Android 或 macOS 原生构建;这些平台通道仍限定到平台源代码变更。
|
||||
- **仅 CI 路由编辑、选定的低成本核心测试 fixture 编辑,以及窄范围插件契约辅助/测试路由编辑**会使用快速的仅 Node 清单路径:`preflight`、security 和单个 `checks-fast-core` 任务。当变更仅限于该快速任务直接覆盖的路由或辅助表面时,该路径会跳过构建产物、Node 22 兼容性、渠道契约、完整核心分片、内置插件分片和额外防护矩阵。
|
||||
- **Windows Node 检查**限定于 Windows 特定进程/路径包装器、npm/pnpm/UI 运行器辅助工具、包管理器配置,以及执行该通道的 CI 工作流表面;无关源码、插件、install-smoke 和仅测试变更仍保留在 Linux Node 通道上。
|
||||
- **CI 工作流编辑** 会验证 Node CI 图和工作流 lint,但不会单独强制运行 Windows、Android 或 macOS 原生构建;这些平台任务线仍限定为平台源代码变更。
|
||||
- **仅 CI 路由编辑、选定的低成本核心测试 fixture 编辑,以及窄范围插件契约 helper/测试路由编辑** 使用快速的仅 Node 清单路径:`preflight`、安全检查,以及单个 `checks-fast-core` 任务。当变更仅限于该快速任务直接覆盖的路由或 helper 表面时,此路径会跳过构建产物、Node 22 兼容性、渠道契约、完整核心分片、内置插件分片和额外守卫矩阵。
|
||||
- **Windows Node 检查** 限定于 Windows 特定的进程/路径 wrapper、npm/pnpm/UI runner helper、包管理器配置,以及执行该任务线的 CI 工作流表面;无关源码、插件、install-smoke 和仅测试变更仍留在 Linux Node 任务线上。
|
||||
|
||||
最慢的 Node 测试族会被拆分或平衡,以便每个作业保持较小规模而不过度预留 runner:渠道契约作为三个加权分片运行,小型核心单元通道成对运行,auto-reply 作为四个平衡 worker 运行(reply 子树拆分为 agent-runner、dispatch 和 commands/state-routing 分片),agentic gateway/plugin 配置分散到现有的仅源码 agentic Node 作业中,而不是等待构建产物。广泛的浏览器、QA、媒体和杂项插件测试使用其专用 Vitest 配置,而不是共享插件 catch-all。包含模式分片使用 CI 分片名称记录计时条目,因此 `.artifacts/vitest-shard-timings.json` 可以区分整个配置和筛选后的分片。`check-additional` 将包边界编译/canary 工作保持在一起,并将运行时拓扑架构与 gateway watch 覆盖率分离;边界防护分片会在一个作业内并发运行其小型独立防护。Gateway 网关 watch、渠道测试和核心支持边界分片会在 `dist/` 和 `dist-runtime/` 已构建后,在 `build-artifacts` 内并发运行。
|
||||
最慢的 Node 测试族会被拆分或均衡,使每个作业保持较小规模且不会过度预留 runner:渠道契约作为三个加权分片运行,小型核心单元任务线会成对运行,auto-reply 作为四个均衡 worker 运行(reply 子树拆分为 agent-runner、dispatch 和 commands/state-routing 分片),agentic gateway/插件配置会分布在现有仅源码的 agentic Node 作业中,而不是等待构建产物。广泛的浏览器、QA、媒体和杂项插件测试使用它们专用的 Vitest 配置,而不是共享的插件 catch-all。include-pattern 分片使用 CI 分片名称记录计时条目,因此 `.artifacts/vitest-shard-timings.json` 可以区分完整配置和过滤后的分片。`check-additional` 将包边界编译/canary 工作保持在一起,并将运行时拓扑架构与 gateway watch 覆盖分开;边界守卫分片会在一个作业内并发运行其小型独立守卫。Gateway watch、渠道测试和核心支持边界分片会在 `dist/` 和 `dist-runtime/` 已构建后,在 `build-artifacts` 内并发运行。
|
||||
|
||||
Android CI 会同时运行 `testPlayDebugUnitTest` 和 `testThirdPartyDebugUnitTest`,然后构建 Play debug APK。第三方 flavor 没有单独的 source set 或 manifest;其单元测试通道仍会使用 SMS/call-log BuildConfig 标志编译该 flavor,同时避免在每个 Android 相关推送上重复执行 debug APK 打包作业。
|
||||
Android CI 会同时运行 `testPlayDebugUnitTest` 和 `testThirdPartyDebugUnitTest`,然后构建 Play debug APK。third-party flavor 没有单独的源集或 manifest;它的单元测试任务线仍会使用 SMS/call-log BuildConfig 标志编译该 flavor,同时避免在每个 Android 相关推送上重复运行 debug APK 打包作业。
|
||||
|
||||
`check-dependencies` 分片运行 `pnpm deadcode:dependencies`(一个生产 Knip 仅依赖检查,固定到最新 Knip 版本,并在 `dlx` 安装时禁用 pnpm 的最小发布时间)和 `pnpm deadcode:unused-files`,后者会将 Knip 的生产未使用文件发现结果与 `scripts/deadcode-unused-files.allowlist.mjs` 进行比较。当 PR 新增了未审查的未使用文件,或留下陈旧的 allowlist 条目时,未使用文件防护会失败,同时保留 Knip 无法静态解析的有意动态插件、生成、构建、实时测试和包桥接表面。
|
||||
`check-dependencies` 分片会运行 `pnpm deadcode:dependencies`(仅生产 Knip 依赖检查,固定到最新 Knip 版本,并为 `dlx` 安装禁用 pnpm 的最小发布年龄)和 `pnpm deadcode:unused-files`,后者会将 Knip 的生产未使用文件发现结果与 `scripts/deadcode-unused-files.allowlist.mjs` 进行比较。当 PR 新增未经审核的未使用文件或留下过期 allowlist 条目时,未使用文件守卫会失败,同时保留 Knip 无法静态解析的有意动态插件、生成文件、构建、实时测试和包桥接表面。
|
||||
|
||||
## ClawSweeper 活动转发
|
||||
|
||||
`.github/workflows/clawsweeper-dispatch.yml` 是从 OpenClaw 仓库活动到 ClawSweeper 的目标侧桥接。它不会签出或执行不可信的拉取请求代码。该工作流会从 `CLAWSWEEPER_APP_PRIVATE_KEY` 创建 GitHub App token,然后向 `openclaw/clawsweeper` 派发紧凑的 `repository_dispatch` payload。
|
||||
`.github/workflows/clawsweeper-dispatch.yml` 是从 OpenClaw 仓库活动到 ClawSweeper 的目标侧桥接。它不会 checkout 或执行不受信任的拉取请求代码。该工作流会从 `CLAWSWEEPER_APP_PRIVATE_KEY` 创建 GitHub App token,然后向 `openclaw/clawsweeper` 分发紧凑的 `repository_dispatch` payload。
|
||||
|
||||
该工作流有四个通道:
|
||||
该工作流有四条任务线:
|
||||
|
||||
- `clawsweeper_item` 用于精确的 issue 和拉取请求 review 请求;
|
||||
- `clawsweeper_item` 用于精确的 issue 和拉取请求审查请求;
|
||||
- `clawsweeper_comment` 用于 issue 评论中的显式 ClawSweeper 命令;
|
||||
- `clawsweeper_commit_review` 用于 `main` 推送上的提交级 review 请求;
|
||||
- `clawsweeper_commit_review` 用于 `main` 推送上的提交级审查请求;
|
||||
- `github_activity` 用于 ClawSweeper 智能体可能检查的一般 GitHub 活动。
|
||||
|
||||
`github_activity` 通道只转发规范化元数据:事件类型、动作、actor、仓库、条目编号、URL、标题、状态,以及存在评论或 review 时的简短摘录。它有意避免转发完整 webhook body。`openclaw/clawsweeper` 中的接收工作流是 `.github/workflows/github-activity.yml`,它会将规范化事件发布到 OpenClaw Gateway 网关 hook,供 ClawSweeper 智能体使用。
|
||||
`github_activity` 任务线只转发规范化元数据:事件类型、动作、actor、仓库、条目编号、URL、标题、状态,以及存在评论或审查时的短摘录。它有意避免转发完整 webhook body。`openclaw/clawsweeper` 中的接收工作流是 `.github/workflows/github-activity.yml`,它会将规范化事件发布到面向 ClawSweeper 智能体的 OpenClaw Gateway 网关钩子。
|
||||
|
||||
一般活动是观察,而不是默认投递。ClawSweeper 智能体会在其提示中收到 Discord 目标,并且只应在事件令人意外、可操作、有风险或对运维有用时发布到 `#clawsweeper`。例行打开、编辑、机器人扰动、重复 webhook 噪声和正常 review 流量应产生 `NO_REPLY`。
|
||||
一般活动是观察,而不是默认投递。ClawSweeper 智能体会在其提示中收到 Discord 目标,并且只应在事件令人意外、可操作、有风险或对运营有用时发布到 `#clawsweeper`。常规打开、编辑、bot 噪声、重复 webhook 噪声和正常审查流量应产生 `NO_REPLY`。
|
||||
|
||||
在整个路径中,将 GitHub 标题、评论、正文、review 文本、分支名称和提交消息视为不可信数据。它们是用于摘要和分诊的输入,而不是工作流或智能体运行时的指令。
|
||||
在整个路径中,将 GitHub 标题、评论、正文、审查文本、分支名称和提交消息视为不受信任的数据。它们是用于摘要和分诊的输入,而不是工作流或智能体运行时的指令。
|
||||
|
||||
## 手动派发
|
||||
## 手动分发
|
||||
|
||||
手动 CI 调度运行与常规 CI 相同的作业图,但会强制开启每个非 Android 范围的通道:Linux Node 分片、内置插件分片、渠道契约、Node 22 兼容性、`check`、`check-additional`、构建冒烟、文档检查、Python Skills、Windows、macOS 和 Control UI i18n。独立的手动 CI 调度仅在 `include_android=true` 时运行 Android;完整发布伞形流程会通过传入 `include_android=true` 启用 Android。插件预发布静态检查、仅发布使用的 `agentic-plugins` 分片、完整扩展批量扫描以及插件预发布 Docker 通道均不包含在 CI 中。Docker 预发布套件仅在 `Full Release Validation` 通过启用发布验证门禁来调度单独的 `Plugin Prerelease` 工作流时运行。
|
||||
手动 CI 分发运行与普通 CI 相同的作业图,但会强制启用每个非 Android 作用域检查通道:Linux Node 分片、内置插件分片、渠道契约、Node 22 兼容性、`check`、`check-additional`、构建冒烟、文档检查、Python skills、Windows、macOS,以及 Control UI i18n。独立的手动 CI 分发仅在 `include_android=true` 时运行 Android;完整发布伞形流程会通过传入 `include_android=true` 启用 Android。插件预发布静态检查、仅发布使用的 `agentic-plugins` 分片、完整 extension 批量扫描,以及插件预发布 Docker 检查通道不包含在 CI 中。Docker 预发布套件仅在 `Full Release Validation` 分发单独的 `Plugin Prerelease` workflow 并启用发布验证门禁时运行。
|
||||
|
||||
手动运行会使用唯一的并发组,因此候选发布版本的完整套件不会被同一 ref 上的另一个 push 或 PR 运行取消。可选的 `target_ref` 输入允许受信任的调用方在使用所选调度 ref 中的工作流文件的同时,针对分支、标签或完整提交 SHA 运行该作业图。
|
||||
手动运行使用唯一的并发组,因此发布候选完整套件不会被同一 ref 上的另一次 push 或 PR 运行取消。可选的 `target_ref` 输入让受信任的调用方可以在使用所选分发 ref 的 workflow 文件时,针对分支、标签或完整提交 SHA 运行该作业图。
|
||||
|
||||
```bash
|
||||
gh workflow run ci.yml --ref release/YYYY.M.D
|
||||
@ -100,15 +100,15 @@ gh workflow run full-release-validation.yml --ref main -f ref=<branch-or-sha>
|
||||
|
||||
| 运行器 | 作业 |
|
||||
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ubuntu-24.04` | `preflight`、快速安全作业和聚合项(`security-scm-fast`、`security-dependency-audit`、`security-fast`)、快速协议/契约/内置检查、分片渠道契约检查、除 lint 外的 `check` 分片、`check-additional` 分片和聚合项、Node 测试聚合验证器、文档检查、Python Skills、workflow-sanity、labeler、auto-response;install-smoke 预检也使用 GitHub 托管的 Ubuntu,以便 Blacksmith 矩阵可以更早排队 |
|
||||
| `blacksmith-4vcpu-ubuntu-2404` | `CodeQL Critical Quality`、较低权重的扩展分片、`checks-fast-core`、`checks-node-compat-node22`、`check-prod-types` 和 `check-test-types` |
|
||||
| `ubuntu-24.04` | `preflight`、快速安全作业与聚合(`security-scm-fast`、`security-dependency-audit`、`security-fast`)、快速协议/契约/内置检查、分片渠道契约检查、除 lint 外的 `check` 分片、`check-additional` 分片与聚合、Node 测试聚合验证器、文档检查、Python skills、workflow-sanity、labeler、auto-response;install-smoke preflight 也使用 GitHub 托管的 Ubuntu,以便 Blacksmith 矩阵可以更早排队 |
|
||||
| `blacksmith-4vcpu-ubuntu-2404` | `CodeQL Critical Quality`、较低权重的 extension 分片、`checks-fast-core`、`checks-node-compat-node22`、`check-prod-types` 和 `check-test-types` |
|
||||
| `blacksmith-8vcpu-ubuntu-2404` | `build-artifacts`、build-smoke、Linux Node 测试分片、内置插件测试分片、`android` |
|
||||
| `blacksmith-16vcpu-ubuntu-2404` | `check-lint`(对 CPU 足够敏感,8 vCPU 的成本高于节省的成本);install-smoke Docker 构建(32-vCPU 排队时间的成本高于节省的成本) |
|
||||
| `blacksmith-16vcpu-ubuntu-2404` | `check-lint`(对 CPU 足够敏感,8 vCPU 节省的成本反而低于额外成本);install-smoke Docker 构建(32-vCPU 排队时间成本高于节省的时间) |
|
||||
| `blacksmith-16vcpu-windows-2025` | `checks-windows` |
|
||||
| `blacksmith-6vcpu-macos-latest` | `openclaw/openclaw` 上的 `macos-node`;fork 回退到 `macos-latest` |
|
||||
| `blacksmith-12vcpu-macos-latest` | `openclaw/openclaw` 上的 `macos-swift`;fork 回退到 `macos-latest` |
|
||||
|
||||
## 本地等效命令
|
||||
## 本地等价命令
|
||||
|
||||
```bash
|
||||
pnpm changed:lanes # inspect the local changed-lane classifier for origin/main...HEAD
|
||||
@ -137,28 +137,28 @@ pnpm perf:kova:summary --report .artifacts/kova/reports/mock-provider/report.jso
|
||||
|
||||
## OpenClaw 性能
|
||||
|
||||
`OpenClaw Performance` 是产品/运行时性能工作流。它每天在 `main` 上运行,也可以手动调度:
|
||||
`OpenClaw Performance` 是产品/运行时性能 workflow。它每天在 `main` 上运行,也可以手动分发:
|
||||
|
||||
```bash
|
||||
gh workflow run openclaw-performance.yml --ref main -f profile=diagnostic -f repeat=3
|
||||
gh workflow run openclaw-performance.yml --ref main -f profile=smoke -f repeat=1 -f deep_profile=true -f live_gpt54=true
|
||||
```
|
||||
|
||||
该工作流会从固定发布版本安装 OCM,并从固定的 `kova_ref` 输入安装 Kova,然后运行三个通道:
|
||||
该 workflow 从固定版本安装 OCM,并从固定的 `kova_ref` 输入安装 Kova,然后运行三个检查通道:
|
||||
|
||||
- `mock-provider`:针对本地构建运行时运行 Kova 诊断场景,并使用确定性的假 OpenAI 兼容认证。
|
||||
- `mock-deep-profile`:针对启动、Gateway 网关和智能体回合热点进行 CPU/堆/跟踪剖析。
|
||||
- `live-gpt54`:一次真实的 OpenAI `openai/gpt-5.4` 智能体回合,在 `OPENAI_API_KEY` 不可用时跳过。
|
||||
- `mock-provider`:针对本地构建运行时的 Kova 诊断场景,使用确定性的假 OpenAI 兼容认证。
|
||||
- `mock-deep-profile`:针对启动、Gateway 网关 和 agent turn 热点的 CPU/堆/跟踪分析。
|
||||
- `live-gpt54`:真实的 OpenAI `openai/gpt-5.4` agent turn,当 `OPENAI_API_KEY` 不可用时跳过。
|
||||
|
||||
每个通道都会上传 GitHub 工件。配置 `CLAWGRIT_REPORTS_TOKEN` 后,该工作流还会将 `report.json`、`report.md`、bundle 和 `index.md` 提交到 `openclaw/clawgrit-reports` 的 `openclaw-performance/<ref>/<run-id>-<attempt>/<lane>/` 下。当前分支指针会写入为 `openclaw-performance/<ref>/latest-<lane>.json`。
|
||||
每个检查通道都会上传 GitHub 构件。配置 `CLAWGRIT_REPORTS_TOKEN` 后,该 workflow 还会将 `report.json`、`report.md`、bundle 和 `index.md` 提交到 `openclaw/clawgrit-reports` 的 `openclaw-performance/<ref>/<run-id>-<attempt>/<lane>/` 下。当前分支指针会写入 `openclaw-performance/<ref>/latest-<lane>.json`。
|
||||
|
||||
## 完整发布验证
|
||||
|
||||
`Full Release Validation` 是用于“发布前运行所有内容”的手动伞形工作流。它接受分支、标签或完整提交 SHA,使用该目标调度手动 `CI` 工作流,调度 `Plugin Prerelease` 以提供仅发布使用的插件/包/静态/Docker 证明,并调度 `OpenClaw Release Checks` 以执行安装冒烟、包验收、Docker 发布路径套件、live/E2E、OpenWebUI、QA Lab parity、Matrix 和 Telegram 通道。使用 `rerun_group=all` 和 `release_profile=full` 时,它还会针对发布检查中的 `release-package-under-test` 工件运行 `NPM Telegram Beta E2E`。发布后,传入 `npm_telegram_package_spec` 可针对已发布的 npm 包重新运行同一 Telegram 包通道。
|
||||
`Full Release Validation` 是“发布前运行所有内容”的手动伞形 workflow。它接受分支、标签或完整提交 SHA,分发以该目标为对象的手动 `CI` workflow,分发 `Plugin Prerelease` 以提供仅发布使用的插件/包/静态/Docker 证明,并分发 `OpenClaw Release Checks` 以运行安装冒烟、包验收、Docker 发布路径套件、live/E2E、OpenWebUI、QA Lab parity、Matrix 和 Telegram 检查通道。使用 `rerun_group=all` 和 `release_profile=full` 时,它还会针对来自发布检查的 `release-package-under-test` 构件运行 `NPM Telegram Beta E2E`。发布后,传入 `npm_telegram_package_spec` 可针对已发布的 npm 包重新运行同一个 Telegram 包检查通道。
|
||||
|
||||
请参阅[完整发布验证](/zh-CN/reference/full-release-validation),了解阶段矩阵、确切的工作流作业名称、配置文件差异、工件和聚焦重运行句柄。
|
||||
参见 [完整发布验证](/zh-CN/reference/full-release-validation),了解阶段矩阵、精确的 workflow 作业名称、配置差异、构件和定向重跑句柄。
|
||||
|
||||
`OpenClaw Release Publish` 是会产生变更的手动发布工作流。在发布标签存在且 OpenClaw npm 预检成功后,从 `release/YYYY.M.D` 或 `main` 调度它。它会验证 `pnpm plugins:sync:check`,为所有可发布的插件包调度 `Plugin NPM Release`,为同一发布 SHA 调度 `Plugin ClawHub Release`,然后才使用保存的 `preflight_run_id` 调度 `OpenClaw NPM Release`。
|
||||
`OpenClaw Release Publish` 是会产生变更的手动发布 workflow。发布标签存在且 OpenClaw npm preflight 成功后,从 `release/YYYY.M.D` 或 `main` 分发它。它会验证 `pnpm plugins:sync:check`,为所有可发布插件包分发 `Plugin NPM Release`,为同一发布 SHA 分发 `Plugin ClawHub Release`,然后才使用保存的 `preflight_run_id` 分发 `OpenClaw NPM Release`。
|
||||
|
||||
```bash
|
||||
gh workflow run openclaw-release-publish.yml \
|
||||
@ -174,29 +174,29 @@ gh workflow run openclaw-release-publish.yml \
|
||||
pnpm ci:full-release --sha <full-sha>
|
||||
```
|
||||
|
||||
GitHub 工作流调度 ref 必须是分支或标签,不能是原始提交 SHA。该辅助命令会在目标 SHA 处推送一个临时 `release-ci/<sha>-...` 分支,从该固定 ref 调度 `Full Release Validation`,验证每个子工作流的 `headSha` 都与目标匹配,并在运行完成后删除临时分支。如果任何子工作流运行在不同 SHA 上,伞形验证器也会失败。
|
||||
GitHub workflow 分发 ref 必须是分支或标签,不能是原始提交 SHA。该辅助命令会在目标 SHA 处推送一个临时 `release-ci/<sha>-...` 分支,从该固定 ref 分发 `Full Release Validation`,验证每个子 workflow 的 `headSha` 都与目标匹配,并在运行完成后删除临时分支。如果任何子 workflow 在不同的 SHA 上运行,伞形验证器也会失败。
|
||||
|
||||
`release_profile` 控制传入发布检查的 live/提供商覆盖范围。手动发布工作流默认使用 `stable`;仅在你有意需要广泛的建议性提供商/媒体矩阵时才使用 `full`。
|
||||
`release_profile` 控制传入发布检查的 live/provider 覆盖范围。手动发布 workflow 默认使用 `stable`;只有在你明确需要宽泛的 advisory provider/media 矩阵时才使用 `full`。
|
||||
|
||||
- `minimum` 保留最快的 OpenAI/核心发布关键通道。
|
||||
- `minimum` 保留最快的 OpenAI/核心发布关键检查通道。
|
||||
- `stable` 添加稳定的提供商/后端集合。
|
||||
- `full` 运行广泛的建议性提供商/媒体矩阵。
|
||||
- `full` 运行宽泛的 advisory provider/media 矩阵。
|
||||
|
||||
伞形流程会记录已调度的子运行 ID,最终的 `Verify full validation` 作业会重新检查当前子运行结论,并为每个子运行追加最慢作业表。如果某个子工作流被重新运行并变为绿色,只需重新运行父验证器作业即可刷新伞形结果和计时摘要。
|
||||
伞形流程会记录已分发的子运行 ID,最终的 `Verify full validation` 作业会重新检查当前子运行结论,并为每个子运行追加最慢作业表。如果某个子 workflow 被重跑并变绿,只需重跑父级验证器作业即可刷新伞形结果和耗时摘要。
|
||||
|
||||
恢复时,`Full Release Validation` 和 `OpenClaw Release Checks` 都接受 `rerun_group`。发布候选版本使用 `all`,仅正常的完整 CI 子流程使用 `ci`,仅插件预发布子流程使用 `plugin-prerelease`,每个发布子流程使用 `release-checks`,或者在伞形流程上使用更窄的组:`install-smoke`、`cross-os`、`live-e2e`、`package`、`qa`、`qa-parity`、`qa-live` 或 `npm-telegram`。这样可以在聚焦修复后,将失败发布环境的重新运行范围限制住。
|
||||
恢复时,`Full Release Validation` 和 `OpenClaw Release Checks` 都接受 `rerun_group`。对发布候选使用 `all`,仅对普通完整 CI 子项使用 `ci`,仅对插件预发布子项使用 `plugin-prerelease`,对每个发布子项使用 `release-checks`,或者在总控项上使用更窄的分组:`install-smoke`、`cross-os`、`live-e2e`、`package`、`qa`、`qa-parity`、`qa-live` 或 `npm-telegram`。这样可以在完成针对性修复后,将失败发布运行的重跑范围限制住。
|
||||
|
||||
`OpenClaw Release Checks` 使用受信任的工作流引用,将选定的引用解析一次为 `release-package-under-test` tarball,然后把该构件传给 live/E2E 发布路径 Docker 工作流和包验收分片。这样可以让各个发布环境中的包字节保持一致,并避免在多个子作业中重新打包同一个候选版本。
|
||||
`OpenClaw Release Checks` 使用受信任的工作流引用将所选引用解析一次为 `release-package-under-test` tarball,然后把该产物传递给 live/E2E 发布路径 Docker 工作流和包验收分片。这样可让各发布运行中的包字节保持一致,并避免在多个子任务中重复打包同一个候选。
|
||||
|
||||
对于 `ref=main` 和 `rerun_group=all` 的重复 `Full Release Validation` 运行会取代较旧的伞形流程。父监控器在父流程被取消时,会取消它已调度的任何子工作流,因此较新的 main 验证不会排在陈旧的两小时 release-check 运行后面。发布分支/标签验证和聚焦重新运行组会保持 `cancel-in-progress: false`。
|
||||
对于 `ref=main` 和 `rerun_group=all` 的重复 `Full Release Validation` 运行会取代较旧的总控项。父监控器会在父项被取消时取消它已经调度的任何子工作流,因此新的 main 验证不会卡在过期的两小时 release-check 运行后面。发布分支/标签验证和针对性重跑分组保留 `cancel-in-progress: false`。
|
||||
|
||||
## Live 和 E2E 分片
|
||||
|
||||
发布 live/E2E 子流程仍保留广泛的原生 `pnpm test:live` 覆盖,但它会通过 `scripts/test-live-shard.mjs` 以命名分片运行,而不是作为一个串行作业运行:
|
||||
发布 live/E2E 子项保留广泛的原生 `pnpm test:live` 覆盖,但它通过 `scripts/test-live-shard.mjs` 作为命名分片运行,而不是作为一个串行任务运行:
|
||||
|
||||
- `native-live-src-agents`
|
||||
- `native-live-src-gateway-core`
|
||||
- 提供商过滤的 `native-live-src-gateway-profiles` 作业
|
||||
- 按提供商过滤的 `native-live-src-gateway-profiles` 任务
|
||||
- `native-live-src-gateway-backends`
|
||||
- `native-live-test`
|
||||
- `native-live-extensions-a-k`
|
||||
@ -204,59 +204,59 @@ GitHub 工作流调度 ref 必须是分支或标签,不能是原始提交 SHA
|
||||
- `native-live-extensions-openai`
|
||||
- `native-live-extensions-o-z-other`
|
||||
- `native-live-extensions-xai`
|
||||
- 拆分后的媒体音频/视频分片,以及提供商过滤的音乐分片
|
||||
- 拆分的媒体音频/视频分片和按提供商过滤的音乐分片
|
||||
|
||||
这样既保持相同的文件覆盖范围,又让较慢的 live 提供商失败更容易重新运行和诊断。聚合的 `native-live-extensions-o-z`、`native-live-extensions-media` 和 `native-live-extensions-media-music` 分片名称仍可用于手动一次性重新运行。
|
||||
这样既保持相同的文件覆盖范围,又让较慢的 live 提供商失败更容易重跑和诊断。聚合的 `native-live-extensions-o-z`、`native-live-extensions-media` 和 `native-live-extensions-media-music` 分片名称仍可用于手动一次性重跑。
|
||||
|
||||
原生 live 媒体分片在 `ghcr.io/openclaw/openclaw-live-media-runner:ubuntu-24.04` 中运行,该镜像由 `Live Media Runner Image` 工作流构建。该镜像预装 `ffmpeg` 和 `ffprobe`;媒体作业只在设置前验证这些二进制文件。让 Docker 支持的 live 套件保持在普通 Blacksmith 运行器上运行,容器作业不适合启动嵌套 Docker 测试。
|
||||
原生 live 媒体分片在 `ghcr.io/openclaw/openclaw-live-media-runner:ubuntu-24.04` 中运行,该镜像由 `Live Media Runner Image` 工作流构建。该镜像预装了 `ffmpeg` 和 `ffprobe`;媒体任务只会在设置前验证这些二进制文件。将 Docker 支撑的 live 套件保留在普通 Blacksmith runner 上运行,容器任务不适合启动嵌套 Docker 测试。
|
||||
|
||||
Docker 支持的 live 模型/后端分片会为每个选定提交使用单独的共享 `ghcr.io/openclaw/openclaw-live-test:<sha>` 镜像。live 发布工作流会构建并推送该镜像一次,然后 Docker live 模型、按提供商分片的 Gateway 网关、CLI 后端、ACP bind 和 Codex harness 分片都会以 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行。Gateway 网关 Docker 分片在脚本层带有显式 `timeout` 上限,低于工作流作业超时,因此卡住的容器或清理路径会快速失败,而不是耗尽整个 release-check 预算。如果这些分片独立重建完整源 Docker 目标,则说明发布运行配置错误,并会在重复镜像构建上浪费实际耗时。
|
||||
Docker 支撑的 live 模型/后端分片为每个所选提交使用单独的共享 `ghcr.io/openclaw/openclaw-live-test:<sha>` 镜像。live 发布工作流会构建并推送该镜像一次,然后 Docker live 模型、按提供商分片的 Gateway 网关、CLI 后端、ACP 绑定和 Codex harness 分片会以 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行。Gateway 网关 Docker 分片带有明确的脚本级 `timeout` 上限,低于工作流任务超时,因此卡住的容器或清理路径会快速失败,而不是消耗完整的 release-check 预算。如果这些分片独立重建完整源 Docker 目标,则说明发布运行配置错误,并会在重复镜像构建上浪费实际时间。
|
||||
|
||||
## 包验收
|
||||
|
||||
当问题是“这个可安装的 OpenClaw 包作为产品是否可用?”时,使用 `Package Acceptance`。它不同于普通 CI:普通 CI 验证源代码树,而包验收会通过用户在安装或更新后实际使用的同一个 Docker E2E harness 验证单个 tarball。
|
||||
当问题是“这个可安装的 OpenClaw 包是否作为产品正常工作?”时,使用 `Package Acceptance`。它不同于普通 CI:普通 CI 验证源码树,而包验收会通过用户在安装或更新后实际使用的同一个 Docker E2E harness 验证单个 tarball。
|
||||
|
||||
### 作业
|
||||
### 任务
|
||||
|
||||
1. `resolve_package` 检出 `workflow_ref`,解析一个包候选项,写入 `.artifacts/docker-e2e-package/openclaw-current.tgz`,写入 `.artifacts/docker-e2e-package/package-candidate.json`,将两者作为 `package-under-test` 构件上传,并在 GitHub 步骤摘要中打印来源、工作流引用、包引用、版本、SHA-256 和配置文件。
|
||||
2. `docker_acceptance` 使用 `ref=workflow_ref` 和 `package_artifact_name=package-under-test` 调用 `openclaw-live-and-e2e-checks-reusable.yml`。可复用工作流会下载该构件,验证 tarball 清单,在需要时准备 package-digest Docker 镜像,并针对该包运行选定的 Docker 通道,而不是打包工作流检出内容。当某个配置文件选择多个目标 `docker_lanes` 时,可复用工作流会准备一次包和共享镜像,然后将这些通道扇出为带有唯一构件的并行目标 Docker 作业。
|
||||
3. `package_telegram` 可选择调用 `NPM Telegram Beta E2E`。当 `telegram_mode` 不是 `none` 时运行;如果 Package Acceptance 解析出了包,它会安装同一个 `package-under-test` 构件;独立 Telegram 调度仍可安装已发布的 npm 规范。
|
||||
4. 如果包解析、Docker 验收或可选 Telegram 通道失败,`summary` 会使工作流失败。
|
||||
1. `resolve_package` 检出 `workflow_ref`,解析一个包候选,写入 `.artifacts/docker-e2e-package/openclaw-current.tgz`,写入 `.artifacts/docker-e2e-package/package-candidate.json`,将两者作为 `package-under-test` 产物上传,并在 GitHub 步骤摘要中打印来源、工作流引用、包引用、版本、SHA-256 和配置文件。
|
||||
2. `docker_acceptance` 使用 `ref=workflow_ref` 和 `package_artifact_name=package-under-test` 调用 `openclaw-live-and-e2e-checks-reusable.yml`。可复用工作流会下载该产物,验证 tarball 清单,在需要时准备包摘要 Docker 镜像,并针对该包运行所选 Docker lane,而不是打包工作流检出内容。当某个配置文件选择多个定向 `docker_lanes` 时,可复用工作流会准备包和共享镜像一次,然后将这些 lane 扇出为并行的定向 Docker 任务,并使用唯一产物。
|
||||
3. `package_telegram` 可选调用 `NPM Telegram Beta E2E`。当 `telegram_mode` 不是 `none` 时它会运行,并在包验收解析出包时安装同一个 `package-under-test` 产物;独立 Telegram 调度仍可安装已发布的 npm 规格。
|
||||
4. `summary` 会在包解析、Docker 验收或可选 Telegram lane 失败时让工作流失败。
|
||||
|
||||
### 候选来源
|
||||
|
||||
- `source=npm` 只接受 `openclaw@beta`、`openclaw@latest`,或精确的 OpenClaw 发布版本,例如 `openclaw@2026.4.27-beta.2`。用它进行已发布 beta/稳定版验收。
|
||||
- `source=ref` 会打包受信任的 `package_ref` 分支、标签或完整提交 SHA。解析器会获取 OpenClaw 分支/标签,验证选定提交可从仓库分支历史或发布标签到达,在分离工作树中安装依赖,并用 `scripts/package-openclaw-for-docker.mjs` 打包。
|
||||
- `source=url` 下载 HTTPS `.tgz`;`package_sha256` 为必填。
|
||||
- `source=artifact` 从 `artifact_run_id` 和 `artifact_name` 下载一个 `.tgz`;`package_sha256` 可选,但对于外部共享的构件应提供。
|
||||
- `source=npm` 只接受 `openclaw@beta`、`openclaw@latest`,或精确的 OpenClaw 发布版本,例如 `openclaw@2026.4.27-beta.2`。将它用于已发布 beta/稳定版验收。
|
||||
- `source=ref` 会打包受信任的 `package_ref` 分支、标签或完整提交 SHA。解析器会获取 OpenClaw 分支/标签,验证所选提交可从仓库分支历史或发布标签到达,在分离 worktree 中安装依赖,并使用 `scripts/package-openclaw-for-docker.mjs` 打包。
|
||||
- `source=url` 下载 HTTPS `.tgz`;必须提供 `package_sha256`。
|
||||
- `source=artifact` 从 `artifact_run_id` 和 `artifact_name` 下载一个 `.tgz`;`package_sha256` 可选,但对于外部共享的产物应提供。
|
||||
|
||||
保持 `workflow_ref` 和 `package_ref` 分离。`workflow_ref` 是运行测试的受信任工作流/harness 代码。`package_ref` 是 `source=ref` 时会被打包的源提交。这样当前测试 harness 就能验证较旧的受信任源提交,而无需运行旧的工作流逻辑。
|
||||
保持 `workflow_ref` 和 `package_ref` 分离。`workflow_ref` 是运行测试的受信任工作流/harness 代码。`package_ref` 是 `source=ref` 时要打包的源提交。这样当前测试 harness 可以验证较旧的受信任源提交,而不运行旧工作流逻辑。
|
||||
|
||||
### 套件配置文件
|
||||
|
||||
- `smoke` — `npm-onboard-channel-agent`、`gateway-network`、`config-reload`
|
||||
- `package` — `npm-onboard-channel-agent`、`doctor-switch`、`update-channel-switch`、`upgrade-survivor`、`published-upgrade-survivor`、`plugins-offline`、`plugin-update`
|
||||
- `product` — `package` 加上 `mcp-channels`、`cron-mcp-cleanup`、`openai-web-search-minimal`、`openwebui`
|
||||
- `full` — 带 OpenWebUI 的完整 Docker 发布路径块
|
||||
- `full` — 带 OpenWebUI 的完整 Docker 发布路径分块
|
||||
- `custom` — 精确的 `docker_lanes`;当 `suite_profile=custom` 时必填
|
||||
|
||||
`package` 配置文件使用离线插件覆盖,因此已发布包验证不会受 live ClawHub 可用性限制。可选 Telegram 通道会在 `NPM Telegram Beta E2E` 中复用 `package-under-test` 构件,同时为独立调度保留已发布 npm 规范路径。
|
||||
`package` 配置文件使用离线插件覆盖,因此已发布包验证不会受 live ClawHub 可用性限制。可选 Telegram lane 会在 `NPM Telegram Beta E2E` 中复用 `package-under-test` 产物,同时保留已发布 npm 规格路径用于独立调度。
|
||||
|
||||
有关专门的更新和插件测试策略,包括本地命令、Docker 通道、Package Acceptance 输入、发布默认值和失败分诊,请参阅 [更新和插件测试](/zh-CN/help/testing-updates-plugins)。
|
||||
有关专用的更新和插件测试策略,包括本地命令、Docker lane、包验收输入、发布默认值和失败分诊,请参阅[更新和插件测试](/zh-CN/help/testing-updates-plugins)。
|
||||
|
||||
发布检查会使用 `source=artifact`、已准备好的发布包构件、`suite_profile=custom`、`docker_lanes='doctor-switch update-channel-switch upgrade-survivor published-upgrade-survivor plugins-offline plugin-update'`、`published_upgrade_survivor_baselines=release-history`、`published_upgrade_survivor_scenarios=reported-issues` 和 `telegram_mode=mock-openai` 调用 Package Acceptance。这样可以让包迁移、更新、过时插件依赖清理、离线插件、plugin-update 和 Telegram 证明都基于同一个已解析包 tarball。跨 OS 发布检查仍覆盖 OS 特定的新手引导、安装器和平台行为;包/更新产品验证应从 Package Acceptance 开始。`published-upgrade-survivor` Docker 通道每次运行验证一个已发布包基线。在 Package Acceptance 中,解析出的 `package-under-test` tarball 始终是候选项,`published_upgrade_survivor_baseline` 选择回退的已发布基线,默认值为 `openclaw@latest`;失败通道的重新运行命令会保留该基线。设置 `published_upgrade_survivor_baselines=release-history` 可将该通道扩展到去重后的历史矩阵:最新六个稳定版本、`2026.4.23`,以及 `2026-03-15` 之前的最新稳定版本。设置 `published_upgrade_survivor_scenarios=reported-issues` 可将相同基线扩展到按 issue 形态构造的 fixture,覆盖 Feishu 配置、保留的 bootstrap/persona 文件、波浪号日志路径和陈旧旧版插件依赖根。单独的 `Update Migration` 工作流在问题是穷尽式已发布更新清理,而不是普通 Full Release CI 广度时,会使用 `update-migration` Docker 通道及 `all-since-2026.4.23` 和 `plugin-deps-cleanup`。本地聚合运行可以用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECS` 传入精确包规范,用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC` 保持单个通道,例如 `openclaw@2026.4.15`,或设置 `OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS` 来使用场景矩阵。已发布通道会使用内置的 `openclaw config set` 命令配方配置基线,在 `summary.json` 中记录配方步骤,并在 Gateway 网关启动后探测 `/healthz`、`/readyz` 以及 RPC 状态。Windows 打包版和安装器全新安装通道还会验证已安装包能否从原始绝对 Windows 路径导入浏览器控制覆盖。OpenAI 跨 OS agent-turn smoke 在设置时默认使用 `OPENCLAW_CROSS_OS_OPENAI_MODEL`,否则使用 `openai/gpt-5.4`,因此安装和 Gateway 网关证明会停留在 GPT-5 测试模型上,同时避免 GPT-4.x 默认值。
|
||||
发布检查会使用 `source=artifact`、准备好的发布包产物、`suite_profile=custom`、`docker_lanes='doctor-switch update-channel-switch upgrade-survivor published-upgrade-survivor plugins-offline plugin-update'`、`published_upgrade_survivor_baselines=release-history`、`published_upgrade_survivor_scenarios=reported-issues` 和 `telegram_mode=mock-openai` 调用包验收。这样可让包迁移、更新、过期插件依赖清理、已配置插件安装修复、离线插件、插件更新和 Telegram 证明都基于同一个已解析包 tarball。跨 OS 发布检查仍覆盖 OS 特定的新手引导、安装器和平台行为;包/更新产品验证应从包验收开始。`published-upgrade-survivor` Docker lane 每次运行验证一个已发布包基线。在包验收中,解析出的 `package-under-test` tarball 始终是候选,而 `published_upgrade_survivor_baseline` 选择回退的已发布基线,默认值为 `openclaw@latest`;失败 lane 重跑命令会保留该基线。设置 `published_upgrade_survivor_baselines=release-history` 可将该 lane 扩展到一个去重历史矩阵:最新六个稳定版本、`2026.4.23`,以及 `2026-03-15` 之前的最新稳定版本。设置 `published_upgrade_survivor_scenarios=reported-issues` 可将相同基线扩展到按问题形态构造的 fixture,覆盖 Feishu 配置、保留的 bootstrap/persona 文件、已配置的 OpenClaw 插件安装、波浪号日志路径和过期旧版插件依赖根。单独的 `Update Migration` 工作流在问题是穷尽式已发布更新清理,而非普通完整发布 CI 广度时,会使用带 `all-since-2026.4.23` 和 `plugin-deps-cleanup` 的 `update-migration` Docker lane。本地聚合运行可以通过 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECS` 传入精确包规格,通过 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC` 保持单个 lane,例如 `openclaw@2026.4.15`,或设置 `OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS` 用于场景矩阵。已发布 lane 会使用内置的 `openclaw config set` 命令配方配置基线,在 `summary.json` 中记录配方步骤,并在 Gateway 网关启动后探测 `/healthz`、`/readyz` 以及 RPC Status。Windows 打包和安装器全新 lane 还会验证已安装包能从原始绝对 Windows 路径导入 browser-control override。OpenAI 跨 OS agent-turn 冒烟测试在设置时默认使用 `OPENCLAW_CROSS_OS_OPENAI_MODEL`,否则使用 `openai/gpt-5.4`,因此安装和 Gateway 网关证明会保持在 GPT-5 测试模型上,同时避免 GPT-4.x 默认值。
|
||||
|
||||
### 旧版兼容窗口
|
||||
|
||||
Package Acceptance 为已发布包提供有界的旧版兼容窗口。直到 `2026.4.25` 的包(包括 `2026.4.25-beta.*`)可以使用兼容路径:
|
||||
包验收为已经发布的包提供有界的旧版兼容窗口。直到 `2026.4.25` 的包,包括 `2026.4.25-beta.*`,可以使用兼容路径:
|
||||
|
||||
- `dist/postinstall-inventory.json` 中已知的私有 QA 条目可以指向 tarball 省略的文件;
|
||||
- 当包未暴露 `gateway install --wrapper` 标志时,`doctor-switch` 可以跳过持久化子用例;
|
||||
- `update-channel-switch` 可以从 tarball 派生的伪 git fixture 中剪除缺失的 `pnpm.patchedDependencies`,并可以记录缺失的持久化 `update.channel`;
|
||||
- 插件 smoke 可以读取旧版安装记录位置,或接受缺少 marketplace 安装记录持久化;
|
||||
- `plugin-update` 可以允许配置元数据迁移,同时仍要求安装记录和不重新安装行为保持不变。
|
||||
- 当包未暴露 `gateway install --wrapper` 标志时,`doctor-switch` 可以跳过 `gateway install --wrapper` 持久化子用例;
|
||||
- `update-channel-switch` 可以从 tarball 派生的假 git fixture 中移除缺失的 `pnpm.patchedDependencies`,并且可以记录缺失的持久化 `update.channel`;
|
||||
- 插件冒烟测试可以读取旧版安装记录位置,或接受缺失的 marketplace 安装记录持久化;
|
||||
- `plugin-update` 可以允许配置元数据迁移,同时仍要求安装记录和无重装行为保持不变。
|
||||
|
||||
已发布的 `2026.4.26` 包也可以对已经发布的本地构建元数据戳文件发出警告。更晚的包必须满足现代合约;相同条件会失败,而不是警告或跳过。
|
||||
已发布的 `2026.4.26` 包也可以对已经发布的本地构建元数据戳文件发出警告。后续包必须满足现代契约;相同条件会失败,而不是警告或跳过。
|
||||
|
||||
### 示例
|
||||
|
||||
@ -299,111 +299,111 @@ gh workflow run package-acceptance.yml \
|
||||
-f docker_lanes='install-e2e plugin-update'
|
||||
```
|
||||
|
||||
调试失败的包验收运行时,先从 `resolve_package` 摘要开始,确认包来源、版本和 SHA-256。然后检查 `docker_acceptance` 子运行及其 Docker 工件:`.artifacts/docker-tests/**/summary.json`、`failures.json`、lane 日志、阶段耗时和重新运行命令。优先重新运行失败的包 profile 或精确的 Docker lane,而不是重新运行完整发布验证。
|
||||
调试失败的包验收运行时,先查看 `resolve_package` 摘要,确认包来源、版本和 SHA-256。然后检查 `docker_acceptance` 子运行及其 Docker 工件:`.artifacts/docker-tests/**/summary.json`、`failures.json`、lane 日志、阶段耗时和重新运行命令。优先重新运行失败的包配置文件或精确 Docker lane,而不是重新运行完整发布验证。
|
||||
|
||||
## 安装冒烟测试
|
||||
|
||||
独立的 `Install Smoke` 工作流通过自己的 `preflight` 作业复用同一个范围脚本。它将冒烟覆盖拆分为 `run_fast_install_smoke` 和 `run_full_install_smoke`。
|
||||
|
||||
- **快速路径**会在 pull request 触及 Docker/包表面、内置插件包/清单变更,或 Docker 冒烟作业覆盖的核心插件/渠道/Gateway 网关/插件 SDK 表面时运行。仅源码的内置插件变更、仅测试编辑和仅文档编辑不会预留 Docker worker。快速路径会构建一次根 Dockerfile 镜像,检查 CLI,运行 agents delete shared-workspace CLI 冒烟测试,运行容器 gateway-network e2e,验证一个内置扩展构建参数,并在 240 秒的聚合命令超时内运行有界的内置插件 Docker profile(每个场景的 Docker 运行单独设置上限)。
|
||||
- **完整路径**为夜间计划运行、手动分发、workflow-call 发布检查,以及真正触及安装器/包/Docker 表面的 pull request 保留 QR 包安装和安装器 Docker/更新覆盖。在完整模式下,install-smoke 会准备或复用一个目标 SHA 的 GHCR 根 Dockerfile 冒烟镜像,然后将 QR 包安装、根 Dockerfile/Gateway 网关冒烟测试、安装器/更新冒烟测试,以及快速内置插件 Docker E2E 作为独立作业运行,这样安装器工作就不会排在根镜像冒烟测试后面等待。
|
||||
- **快速路径**会在拉取请求触及 Docker/包表面、内置插件包/清单变更,或 Docker 冒烟作业会覆盖的核心插件/渠道/Gateway 网关/插件 SDK 表面时运行。仅源代码的内置插件变更、仅测试编辑和仅文档编辑不会预留 Docker worker。快速路径会构建一次根 Dockerfile 镜像,检查 CLI,运行 agents 删除共享工作区 CLI 冒烟测试,运行容器 gateway-network e2e,验证一个内置扩展构建参数,并在 240 秒聚合命令超时内运行有界的内置插件 Docker 配置文件(每个场景的 Docker 运行单独设上限)。
|
||||
- **完整路径**为 nightly 定时运行、手动调度、workflow-call 发布检查,以及真正触及安装器/包/Docker 表面的拉取请求保留 QR 包安装和安装器 Docker/更新覆盖。在完整模式下,install-smoke 会准备或复用一个目标 SHA 的 GHCR 根 Dockerfile 冒烟镜像,然后将 QR 包安装、根 Dockerfile/Gateway 网关冒烟测试、安装器/更新冒烟测试,以及快速内置插件 Docker E2E 作为独立作业运行,这样安装器工作就不会排在根镜像冒烟测试后面等待。
|
||||
|
||||
`main` 推送(包括 merge commit)不会强制使用完整路径;当变更范围逻辑会在推送上请求完整覆盖时,工作流会保留快速 Docker 冒烟测试,并将完整安装冒烟测试留给夜间运行或发布验证。
|
||||
`main` 推送(包括合并提交)不会强制使用完整路径;当变更范围逻辑会在推送上请求完整覆盖时,工作流保留快速 Docker 冒烟测试,并将完整安装冒烟测试留给 nightly 或发布验证。
|
||||
|
||||
较慢的 Bun 全局安装 image-provider 冒烟测试由 `run_bun_global_install_smoke` 单独门控。它会在夜间计划和发布检查工作流中运行,手动 `Install Smoke` 分发也可以选择加入它,但 pull request 和 `main` 推送不会运行它。QR 和安装器 Docker 测试保留各自专注安装的 Dockerfile。
|
||||
较慢的 Bun 全局安装 image-provider 冒烟测试由 `run_bun_global_install_smoke` 单独控制。它会在 nightly 定时任务和发布检查工作流中运行,手动 `Install Smoke` 调度也可以选择加入它,但拉取请求和 `main` 推送不会运行它。QR 和安装器 Docker 测试保留它们各自面向安装的 Dockerfile。
|
||||
|
||||
## 本地 Docker E2E
|
||||
|
||||
`pnpm test:docker:all` 会预构建一个共享的 live-test 镜像,将 OpenClaw 打包一次为 npm tarball,并构建两个共享的 `scripts/e2e/Dockerfile` 镜像:
|
||||
`pnpm test:docker:all` 会预构建一个共享 live-test 镜像,将 OpenClaw 打包一次为 npm tarball,并构建两个共享的 `scripts/e2e/Dockerfile` 镜像:
|
||||
|
||||
- 一个用于安装器/更新/插件依赖 lane 的裸 Node/Git runner;
|
||||
- 一个功能镜像,将同一个 tarball 安装到 `/app`,用于普通功能 lane。
|
||||
- 一个将同一个 tarball 安装到 `/app` 中、用于普通功能 lane 的功能镜像。
|
||||
|
||||
Docker lane 定义位于 `scripts/lib/docker-e2e-scenarios.mjs`,规划器逻辑位于 `scripts/lib/docker-e2e-plan.mjs`,runner 只执行选中的计划。调度器通过 `OPENCLAW_DOCKER_E2E_BARE_IMAGE` 和 `OPENCLAW_DOCKER_E2E_FUNCTIONAL_IMAGE` 为每个 lane 选择镜像,然后使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行 lane。
|
||||
Docker lane 定义位于 `scripts/lib/docker-e2e-scenarios.mjs`,规划器逻辑位于 `scripts/lib/docker-e2e-plan.mjs`,runner 只执行所选计划。调度器通过 `OPENCLAW_DOCKER_E2E_BARE_IMAGE` 和 `OPENCLAW_DOCKER_E2E_FUNCTIONAL_IMAGE` 为每个 lane 选择镜像,然后以 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行 lane。
|
||||
|
||||
### 可调参数
|
||||
|
||||
| 变量 | 默认值 | 用途 |
|
||||
| -------------------------------------- | ------- | --------------------------------------------------------------------------------------------- |
|
||||
| `OPENCLAW_DOCKER_ALL_PARALLELISM` | 10 | 普通 lane 的主池 slot 数。 |
|
||||
| `OPENCLAW_DOCKER_ALL_TAIL_PARALLELISM` | 10 | provider 敏感的 tail-pool slot 数。 |
|
||||
| `OPENCLAW_DOCKER_ALL_LIVE_LIMIT` | 9 | 并发 live lane 上限,避免 provider 限流。 |
|
||||
| `OPENCLAW_DOCKER_ALL_PARALLELISM` | 10 | 普通 lane 的主池 slot 数量。 |
|
||||
| `OPENCLAW_DOCKER_ALL_TAIL_PARALLELISM` | 10 | 对提供商敏感的尾部池 slot 数量。 |
|
||||
| `OPENCLAW_DOCKER_ALL_LIVE_LIMIT` | 9 | 并发 live lane 上限,避免提供商限流。 |
|
||||
| `OPENCLAW_DOCKER_ALL_NPM_LIMIT` | 10 | 并发 npm install lane 上限。 |
|
||||
| `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT` | 7 | 并发多服务 lane 上限。 |
|
||||
| `OPENCLAW_DOCKER_ALL_START_STAGGER_MS` | 2000 | lane 启动之间的错峰时间,用于避免 Docker daemon 创建风暴;设为 `0` 表示不做错峰。 |
|
||||
| `OPENCLAW_DOCKER_ALL_LANE_TIMEOUT_MS` | 7200000 | 每个 lane 的兜底超时(120 分钟);选定的 live/tail lane 使用更严格的上限。 |
|
||||
| `OPENCLAW_DOCKER_ALL_DRY_RUN` | unset | `1` 会打印调度器计划而不运行 lane。 |
|
||||
| `OPENCLAW_DOCKER_ALL_LANES` | unset | 逗号分隔的精确 lane 列表;跳过清理冒烟测试,以便智能体复现单个失败 lane。 |
|
||||
| `OPENCLAW_DOCKER_ALL_LANE_TIMEOUT_MS` | 7200000 | 每个 lane 的兜底超时(120 分钟);所选 live/tail lane 使用更严格的上限。 |
|
||||
| `OPENCLAW_DOCKER_ALL_DRY_RUN` | 未设置 | `1` 会打印调度器计划而不运行 lane。 |
|
||||
| `OPENCLAW_DOCKER_ALL_LANES` | 未设置 | 逗号分隔的精确 lane 列表;跳过清理冒烟测试,以便智能体复现一个失败的 lane。 |
|
||||
|
||||
比有效上限更重的 lane 仍可从空池启动,然后独占运行,直到释放容量。本地聚合会预检 Docker,移除陈旧的 OpenClaw E2E 容器,发出活跃 lane 状态,持久化 lane 耗时以支持最长优先排序,并默认在第一次失败后停止调度新的池化 lane。
|
||||
比有效上限更重的 lane 仍可从空池启动,然后独占运行,直到释放容量。本地聚合会预检 Docker,移除陈旧的 OpenClaw E2E 容器,输出活动 lane 状态,持久化 lane 耗时以支持 longest-first 排序,并默认在首次失败后停止调度新的池化 lane。
|
||||
|
||||
### 可复用 live/E2E 工作流
|
||||
|
||||
可复用 live/E2E 工作流会询问 `scripts/test-docker-all.mjs --plan-json` 需要哪些包、镜像类型、live 镜像、lane 和凭据覆盖。随后 `scripts/docker-e2e.mjs` 会将该计划转换为 GitHub 输出和摘要。它会通过 `scripts/package-openclaw-for-docker.mjs` 打包 OpenClaw,下载当前运行的包工件,或从 `package_artifact_run_id` 下载包工件;验证 tarball 清单;当计划需要已安装包的 lane 时,通过 Blacksmith 的 Docker layer cache 构建并推送带有包摘要标签的裸/功能 GHCR Docker E2E 镜像;并复用提供的 `docker_e2e_bare_image`/`docker_e2e_functional_image` 输入或已有的包摘要镜像,而不是重新构建。Docker 镜像拉取会以每次尝试 180 秒的有界超时重试,因此卡住的 registry/cache 流会快速重试,而不是消耗大部分 CI 关键路径时间。
|
||||
可复用 live/E2E 工作流会询问 `scripts/test-docker-all.mjs --plan-json` 需要哪些包、镜像类型、live 镜像、lane 和凭证覆盖。随后 `scripts/docker-e2e.mjs` 将该计划转换为 GitHub 输出和摘要。它会通过 `scripts/package-openclaw-for-docker.mjs` 打包 OpenClaw,下载当前运行的包工件,或从 `package_artifact_run_id` 下载包工件;验证 tarball 清单;当计划需要已安装包的 lane 时,通过 Blacksmith 的 Docker 层缓存构建并推送带包摘要标签的裸/功能 GHCR Docker E2E 镜像;并在提供了 `docker_e2e_bare_image`/`docker_e2e_functional_image` 输入或已有包摘要镜像时复用它们,而不是重新构建。Docker 镜像拉取会以有界的每次 180 秒超时重试,因此卡住的 registry/cache 流会快速重试,而不会消耗 CI 关键路径的大部分时间。
|
||||
|
||||
### 发布路径分块
|
||||
|
||||
发布 Docker 覆盖会使用带有 `OPENCLAW_SKIP_DOCKER_BUILD=1` 的更小分块作业,这样每个分块只拉取它需要的镜像类型,并通过同一个加权调度器执行多个 lane:
|
||||
发布 Docker 覆盖使用较小的分块作业,并设置 `OPENCLAW_SKIP_DOCKER_BUILD=1`,因此每个分块只拉取它所需的镜像类型,并通过同一个加权调度器执行多个 lane:
|
||||
|
||||
- `OPENCLAW_DOCKER_ALL_PROFILE=release-path`
|
||||
- `OPENCLAW_DOCKER_ALL_CHUNK=core | package-update-openai | package-update-anthropic | package-update-core | plugins-runtime-plugins | plugins-runtime-services | plugins-runtime-install-a..h`
|
||||
|
||||
当前发布 Docker 分块为 `core`、`package-update-openai`、`package-update-anthropic`、`package-update-core`、`plugins-runtime-plugins`、`plugins-runtime-services`,以及 `plugins-runtime-install-a` 到 `plugins-runtime-install-h`。`plugins-runtime-core`、`plugins-runtime` 和 `plugins-integrations` 仍是聚合插件/运行时别名。`install-e2e` lane 别名仍是两个 provider 安装器 lane 的聚合手动重新运行别名。
|
||||
当前发布 Docker 分块包括 `core`、`package-update-openai`、`package-update-anthropic`、`package-update-core`、`plugins-runtime-plugins`、`plugins-runtime-services`,以及 `plugins-runtime-install-a` 到 `plugins-runtime-install-h`。`plugins-runtime-core`、`plugins-runtime` 和 `plugins-integrations` 仍作为聚合插件/运行时别名保留。`install-e2e` lane 别名仍是两个提供商安装器 lane 的聚合手动重新运行别名。
|
||||
|
||||
当完整 release-path 覆盖请求 OpenWebUI 时,它会并入 `plugins-runtime-services`,并且只为仅 OpenWebUI 的分发保留独立的 `openwebui` 分块。内置渠道更新 lane 会针对临时 npm 网络失败重试一次。
|
||||
当完整 release-path 覆盖请求 OpenWebUI 时,OpenWebUI 会并入 `plugins-runtime-services`,并且仅为 OpenWebUI-only 调度保留独立的 `openwebui` 分块。内置渠道更新 lane 会对瞬时 npm 网络失败重试一次。
|
||||
|
||||
每个分块都会上传 `.artifacts/docker-tests/`,其中包含 lane 日志、耗时、`summary.json`、`failures.json`、阶段耗时、调度器计划 JSON、慢 lane 表和每个 lane 的重新运行命令。工作流 `docker_lanes` 输入会用已准备的镜像运行选定 lane,而不是运行分块作业,这会将失败 lane 调试限定在一个有目标的 Docker 作业中,并为该运行准备、下载或复用包工件;如果选中的 lane 是 live Docker lane,则目标作业会为该重新运行在本地构建 live-test 镜像。生成的每 lane GitHub 重新运行命令会在这些值存在时包含 `package_artifact_run_id`、`package_artifact_name` 和已准备镜像输入,因此失败的 lane 可以复用失败运行中的精确包和镜像。
|
||||
每个分块都会上传 `.artifacts/docker-tests/`,其中包含 lane 日志、耗时、`summary.json`、`failures.json`、阶段耗时、调度器计划 JSON、慢 lane 表和每个 lane 的重新运行命令。工作流 `docker_lanes` 输入会针对已准备的镜像运行所选 lane,而不是运行分块作业,这会将失败 lane 调试限制在一个有目标的 Docker 作业内,并为该运行准备、下载或复用包工件;如果所选 lane 是 live Docker lane,目标作业会在本地为该重新运行构建 live-test 镜像。生成的每个 lane GitHub 重新运行命令会在这些值存在时包含 `package_artifact_run_id`、`package_artifact_name` 和已准备镜像输入,因此失败的 lane 可以复用失败运行中的精确包和镜像。
|
||||
|
||||
```bash
|
||||
pnpm test:docker:rerun <run-id> # download Docker artifacts and print combined/per-lane targeted rerun commands
|
||||
pnpm test:docker:timings <summary> # slow-lane and phase critical-path summaries
|
||||
pnpm test:docker:rerun <run-id> # 下载 Docker 工件并打印组合的/按 lane 的目标重新运行命令
|
||||
pnpm test:docker:timings <summary> # 慢 lane 和阶段关键路径摘要
|
||||
```
|
||||
|
||||
计划 live/E2E 工作流每天运行完整 release-path Docker 套件。
|
||||
定时 live/E2E 工作流每天运行完整 release-path Docker 套件。
|
||||
|
||||
## 插件预发布
|
||||
|
||||
`Plugin Prerelease` 是成本更高的产品/包覆盖,因此它是一个由 `Full Release Validation` 或显式 operator 分发的独立工作流。普通 pull request、`main` 推送和独立的手动 CI 分发都会关闭该套件。它将内置插件测试均衡分配到八个扩展 worker;这些扩展分片作业一次最多运行两个插件配置组,每组一个 Vitest worker,并使用更大的 Node heap,这样 import 密集的插件批次不会创建额外 CI 作业。仅发布的 Docker 预发布路径会以小组批量运行有目标的 Docker lane,避免为一到三分钟的作业预留几十个 runner。
|
||||
`Plugin Prerelease` 是成本更高的产品/包覆盖,因此它是由 `Full Release Validation` 或显式操作员调度的独立工作流。普通拉取请求、`main` 推送和独立的手动 CI 调度会关闭该套件。它会在八个扩展 worker 之间平衡内置插件测试;这些扩展分片作业每次最多运行两个插件配置组,每个组使用一个 Vitest worker 和更大的 Node heap,因此导入较重的插件批次不会创建额外 CI 作业。仅发布的 Docker 预发布路径会以小组批处理目标 Docker lane,避免为一到三分钟的作业预留几十个 runner。
|
||||
|
||||
## QA Lab
|
||||
|
||||
QA Lab 在主智能范围工作流之外有专用 CI lane。
|
||||
|
||||
- `Parity gate` 工作流在匹配的 PR 变更和手动分发时运行;它会构建私有 QA 运行时,并比较 mock GPT-5.5 和 Opus 4.6 agentic 包。
|
||||
- `QA-Lab - All Lanes` 工作流每晚在 `main` 上运行,也可手动分发;它会将 mock parity gate、live Matrix lane,以及 live Telegram 和 Discord lane 作为并行作业展开。Live 作业使用 `qa-live-shared` 环境,Telegram/Discord 使用 Convex 租约。
|
||||
- `Parity gate` 工作流会在匹配的 PR 变更和手动调度时运行;它会构建私有 QA 运行时,并比较 mock GPT-5.5 和 Opus 4.6 agentic pack。
|
||||
- `QA-Lab - All Lanes` 工作流会在 `main` 上 nightly 运行,并在手动调度时运行;它会将 mock parity gate、live Matrix lane,以及 live Telegram 和 Discord lane 作为并行作业扇出。live 作业使用 `qa-live-shared` 环境,Telegram/Discord 使用 Convex lease。
|
||||
|
||||
发布检查会使用确定性的 mock provider 和 mock-qualified 模型(`mock-openai/gpt-5.5` 和 `mock-openai/gpt-5.5-alt`)运行 Matrix 和 Telegram live 传输 lane,因此渠道契约与 live 模型延迟和普通 provider-plugin 启动隔离。live 传输 Gateway 网关会禁用记忆搜索,因为 QA parity 会单独覆盖记忆行为;provider 连接性由独立的 live 模型、原生 provider 和 Docker provider 套件覆盖。
|
||||
发布检查会使用确定性 mock 提供商和 mock-qualified 模型(`mock-openai/gpt-5.5` 和 `mock-openai/gpt-5.5-alt`)运行 Matrix 和 Telegram live 传输 lane,因此渠道契约与 live 模型延迟和普通提供商插件启动隔离。live 传输 Gateway 网关会禁用内存搜索,因为 QA parity 会单独覆盖内存行为;提供商连接性由独立的 live 模型、原生提供商和 Docker 提供商套件覆盖。
|
||||
|
||||
Matrix 在计划和发布门禁中使用 `--profile fast`,仅在检出的 CLI 支持时添加 `--fail-fast`。CLI 默认值和手动工作流输入仍为 `all`;手动 `matrix_profile=all` 分发始终将完整 Matrix 覆盖分片为 `transport`、`media`、`e2ee-smoke`、`e2ee-deep` 和 `e2ee-cli` 作业。
|
||||
Matrix 在定时和发布 gate 中使用 `--profile fast`,并且仅在检出的 CLI 支持时追加 `--fail-fast`。CLI 默认值和手动工作流输入仍为 `all`;手动 `matrix_profile=all` 调度始终会将完整 Matrix 覆盖分片为 `transport`、`media`、`e2ee-smoke`、`e2ee-deep` 和 `e2ee-cli` 作业。
|
||||
|
||||
`OpenClaw Release Checks` 还会在发布审批前运行发布关键的 QA Lab lane;其 QA parity gate 将候选包和基线包作为并行 lane 作业运行,然后将两个工件下载到一个小型报告作业中,用于最终 parity 比较。
|
||||
`OpenClaw Release Checks` 也会在发布批准前运行发布关键 QA Lab lane;它的 QA parity gate 会将候选 pack 和基线 pack 作为并行 lane 作业运行,然后将两个工件下载到一个小型报告作业中,用于最终 parity 比较。
|
||||
|
||||
不要将 PR 落地路径置于 `Parity gate` 之后,除非变更确实触及 QA 运行时、模型包 parity,或 parity 工作流拥有的表面。对于普通渠道、配置、文档或单元测试修复,将其视为可选信号,并遵循范围化的 CI/检查证据。
|
||||
不要把 PR 落地路径置于 `Parity gate` 之后,除非变更确实触及 QA 运行时、模型 pack parity,或 parity 工作流拥有的表面。对于普通渠道、配置、文档或单元测试修复,应将它视为可选信号,并遵循有范围的 CI/检查证据。
|
||||
|
||||
## CodeQL
|
||||
|
||||
`CodeQL` 工作流有意作为窄范围的第一轮安全扫描器,而不是完整仓库扫描。每日、手动和非草稿 pull request 防护运行会扫描 Actions 工作流代码以及最高风险的 JavaScript/TypeScript 表面,并使用高置信度安全查询,过滤到高/严重 `security-severity`。
|
||||
`CodeQL` 工作流有意作为窄范围的第一遍安全扫描器,而不是完整仓库扫描。每日、手动和非草稿拉取请求防护运行会扫描 Actions 工作流代码,以及风险最高的 JavaScript/TypeScript 表面,并使用筛选到高/严重 `security-severity` 的高置信度安全查询。
|
||||
|
||||
pull request 防护保持轻量:它只会因 `.github/actions`、`.github/codeql`、`.github/workflows`、`packages` 或 `src` 下的变更启动,并运行与计划工作流相同的高置信度安全矩阵。Android 和 macOS CodeQL 不在 PR 默认范围内。
|
||||
拉取请求防护保持轻量:它只会在 `.github/actions`、`.github/codeql`、`.github/workflows`、`packages` 或 `src` 下有变更时启动,并运行与定时工作流相同的高置信度安全矩阵。Android 和 macOS CodeQL 不在 PR 默认项中。
|
||||
|
||||
### 安全类别
|
||||
|
||||
| 类别 | 表面 |
|
||||
| 类别 | 覆盖面 |
|
||||
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `/codeql-security-high/core-auth-secrets` | 认证、密钥、沙箱、cron 和 Gateway 网关基线 |
|
||||
| `/codeql-security-high/channel-runtime-boundary` | 核心渠道实现契约,以及渠道插件运行时、Gateway 网关、插件 SDK、密钥、审计触点 |
|
||||
| `/codeql-security-high/network-ssrf-boundary` | 核心 SSRF、IP 解析、网络防护、web-fetch 和插件 SDK SSRF 策略表面 |
|
||||
| `/codeql-security-high/mcp-process-tool-boundary` | MCP 服务器、进程执行辅助工具、出站投递,以及智能体工具执行关卡 |
|
||||
| `/codeql-security-high/plugin-trust-boundary` | 插件安装、加载器、清单、注册表、包管理器安装、源码加载,以及插件 SDK 包契约信任表面 |
|
||||
| `/codeql-security-high/core-auth-secrets` | 认证、机密、沙箱、cron 和 Gateway 网关基线 |
|
||||
| `/codeql-security-high/channel-runtime-boundary` | 核心渠道实现契约,以及渠道插件运行时、Gateway 网关、插件 SDK、机密、审计触点 |
|
||||
| `/codeql-security-high/network-ssrf-boundary` | 核心 SSRF、IP 解析、网络防护、web-fetch 和插件 SDK SSRF 策略覆盖面 |
|
||||
| `/codeql-security-high/mcp-process-tool-boundary` | MCP 服务器、进程执行辅助函数、出站投递,以及智能体工具执行门禁 |
|
||||
| `/codeql-security-high/plugin-trust-boundary` | 插件安装、加载器、manifest、注册表、包管理器安装、源加载,以及插件 SDK 包契约信任覆盖面 |
|
||||
|
||||
### 平台特定安全分片
|
||||
|
||||
- `CodeQL Android Critical Security` — 定时 Android 安全分片。在工作流健全性检查接受的最小 Blacksmith Linux runner 上为 CodeQL 手动构建 Android 应用。上传到 `/codeql-critical-security/android`。
|
||||
- `CodeQL macOS Critical Security` — 每周/手动 macOS 安全分片。在 Blacksmith macOS 上为 CodeQL 手动构建 macOS 应用,从上传的 SARIF 中过滤掉依赖构建结果,并上传到 `/codeql-critical-security/macos`。它被排除在每日默认项之外,因为即使结果干净,macOS 构建也会主导运行时间。
|
||||
- `CodeQL Android Critical Security` — 定时 Android 安全分片。在工作流完整性检查接受的最小 Blacksmith Linux 运行器上,为 CodeQL 手动构建 Android 应用。上传到 `/codeql-critical-security/android` 下。
|
||||
- `CodeQL macOS Critical Security` — 每周/手动 macOS 安全分片。在 Blacksmith macOS 上为 CodeQL 手动构建 macOS 应用,从上传的 SARIF 中过滤掉依赖构建结果,并上传到 `/codeql-critical-security/macos` 下。它不包含在每日默认项中,因为即使干净,macOS 构建也会主导运行时间。
|
||||
|
||||
### 关键质量类别
|
||||
|
||||
`CodeQL Critical Quality` 是对应的非安全分片。它只在较小的 Blacksmith Linux runner 上,针对窄范围的高价值表面运行错误严重级别、非安全的 JavaScript/TypeScript 质量查询。它的拉取请求守卫有意小于定时配置:非草稿 PR 只会为智能体命令/模型/工具执行和回复分发代码、配置 schema/迁移/IO 代码、认证/密钥/沙箱/安全代码、核心渠道和内置渠道插件运行时、Gateway 网关协议/服务器方法、记忆运行时/SDK 胶水代码、MCP/进程/出站投递、提供商运行时/模型目录、会话诊断/投递队列、插件加载器、插件 SDK/包契约,或插件 SDK 回复运行时变更,运行对应的 `agent-runtime-boundary`、`config-boundary`、`core-auth-secrets`、`channel-runtime-boundary`、`gateway-runtime-boundary`、`memory-runtime-boundary`、`mcp-process-runtime-boundary`、`provider-runtime-boundary`、`session-diagnostics-boundary`、`plugin-boundary`、`plugin-sdk-package-contract` 和 `plugin-sdk-reply-runtime` 分片。CodeQL 配置和质量工作流变更会运行全部十二个 PR 质量分片。
|
||||
`CodeQL Critical Quality` 是对应的非安全分片。它只在较小的 Blacksmith Linux 运行器上,对狭窄的高价值覆盖面运行错误严重级别、非安全的 JavaScript/TypeScript 质量查询。它的拉取请求门禁刻意小于定时配置:非草稿 PR 只会针对智能体命令/模型/工具执行和回复分发代码、配置 schema/迁移/IO 代码、认证/机密/沙箱/安全代码、核心渠道和内置渠道插件运行时、Gateway 网关协议/服务器方法、记忆运行时/SDK 胶水、MCP/进程/出站投递、提供商运行时/模型目录、会话诊断/投递队列、插件加载器、插件 SDK/包契约或插件 SDK 回复运行时变更,运行匹配的 `agent-runtime-boundary`、`config-boundary`、`core-auth-secrets`、`channel-runtime-boundary`、`gateway-runtime-boundary`、`memory-runtime-boundary`、`mcp-process-runtime-boundary`、`provider-runtime-boundary`、`session-diagnostics-boundary`、`plugin-boundary`、`plugin-sdk-package-contract` 和 `plugin-sdk-reply-runtime` 分片。CodeQL 配置和质量工作流变更会运行全部十二个 PR 质量分片。
|
||||
|
||||
手动调度接受:
|
||||
|
||||
@ -411,40 +411,40 @@ pull request 防护保持轻量:它只会因 `.github/actions`、`.github/code
|
||||
profile=all|agent-runtime-boundary|config-boundary|core-auth-secrets|channel-runtime-boundary|gateway-runtime-boundary|memory-runtime-boundary|mcp-process-runtime-boundary|plugin-boundary|plugin-sdk-package-contract|plugin-sdk-reply-runtime|provider-runtime-boundary|session-diagnostics-boundary
|
||||
```
|
||||
|
||||
窄配置是用于单独运行一个质量分片的教学/迭代钩子。
|
||||
窄配置是用于隔离运行单个质量分片的教学/迭代钩子。
|
||||
|
||||
| 类别 | 表面 |
|
||||
| 类别 | 覆盖面 |
|
||||
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `/codeql-critical-quality/core-auth-secrets` | 认证、密钥、沙箱、cron 和 Gateway 网关安全边界代码 |
|
||||
| `/codeql-critical-quality/core-auth-secrets` | 认证、机密、沙箱、cron 和 Gateway 网关安全边界代码 |
|
||||
| `/codeql-critical-quality/config-boundary` | 配置 schema、迁移、规范化和 IO 契约 |
|
||||
| `/codeql-critical-quality/gateway-runtime-boundary` | Gateway 网关协议 schema 和服务器方法契约 |
|
||||
| `/codeql-critical-quality/channel-runtime-boundary` | 核心渠道和内置渠道插件实现契约 |
|
||||
| `/codeql-critical-quality/agent-runtime-boundary` | 命令执行、模型/提供商分发、自动回复分发和队列,以及 ACP 控制平面运行时契约 |
|
||||
| `/codeql-critical-quality/mcp-process-runtime-boundary` | MCP 服务器和工具桥、进程监督辅助工具,以及出站投递契约 |
|
||||
| `/codeql-critical-quality/memory-runtime-boundary` | 记忆主机 SDK、记忆运行时门面、记忆插件 SDK 别名、记忆运行时激活胶水代码,以及记忆 Doctor 命令 |
|
||||
| `/codeql-critical-quality/session-diagnostics-boundary` | 回复队列内部机制、会话投递队列、出站会话绑定/投递辅助工具、诊断事件/日志包表面,以及会话 Doctor CLI 契约 |
|
||||
| `/codeql-critical-quality/plugin-sdk-reply-runtime` | 插件 SDK 入站回复分发、回复载荷/分块/运行时辅助工具、渠道回复选项、投递队列,以及会话/线程绑定辅助工具 |
|
||||
| `/codeql-critical-quality/provider-runtime-boundary` | 模型目录规范化、提供商认证和设备发现、提供商运行时注册、提供商默认值/目录,以及 Web/搜索/抓取/嵌入注册表 |
|
||||
| `/codeql-critical-quality/mcp-process-runtime-boundary` | MCP 服务器和工具桥接、进程监督辅助函数,以及出站投递契约 |
|
||||
| `/codeql-critical-quality/memory-runtime-boundary` | 记忆宿主 SDK、记忆运行时门面、记忆插件 SDK 别名、记忆运行时激活胶水,以及记忆 Doctor 命令 |
|
||||
| `/codeql-critical-quality/session-diagnostics-boundary` | 回复队列内部机制、会话投递队列、出站会话绑定/投递辅助函数、诊断事件/日志包覆盖面,以及会话 Doctor CLI 契约 |
|
||||
| `/codeql-critical-quality/plugin-sdk-reply-runtime` | 插件 SDK 入站回复分发、回复载荷/分块/运行时辅助函数、渠道回复选项、投递队列,以及会话/线程绑定辅助函数 |
|
||||
| `/codeql-critical-quality/provider-runtime-boundary` | 模型目录规范化、提供商认证和设备发现、提供商运行时注册、提供商默认值/目录,以及 web/search/fetch/embedding 注册表 |
|
||||
| `/codeql-critical-quality/ui-control-plane` | 控制 UI 引导、本地持久化、Gateway 网关控制流,以及任务控制平面运行时契约 |
|
||||
| `/codeql-critical-quality/web-media-runtime-boundary` | 核心 Web 抓取/搜索、媒体 IO、媒体理解、图像生成,以及媒体生成运行时契约 |
|
||||
| `/codeql-critical-quality/plugin-boundary` | 加载器、注册表、公开表面,以及插件 SDK 入口点契约 |
|
||||
| `/codeql-critical-quality/plugin-sdk-package-contract` | 已发布包侧插件 SDK 源码和插件包契约辅助工具 |
|
||||
| `/codeql-critical-quality/web-media-runtime-boundary` | 核心 web 获取/搜索、媒体 IO、媒体理解、图像生成和媒体生成运行时契约 |
|
||||
| `/codeql-critical-quality/plugin-boundary` | 加载器、注册表、公开覆盖面和插件 SDK 入口点契约 |
|
||||
| `/codeql-critical-quality/plugin-sdk-package-contract` | 已发布包侧插件 SDK 源码和插件包契约辅助函数 |
|
||||
|
||||
质量与安全保持分离,这样质量发现就可以被定时运行、衡量、禁用或扩展,而不会遮蔽安全信号。Swift、Python 和内置插件的 CodeQL 扩展,只有在窄配置具备稳定运行时间和信号之后,才应作为有范围或分片的后续工作重新加入。
|
||||
质量与安全保持分离,这样质量发现就可以被调度、度量、禁用或扩展,而不会掩盖安全信号。Swift、Python 和内置插件 CodeQL 扩展应只在窄配置具备稳定运行时间和信号后,作为有范围或分片的后续工作加回。
|
||||
|
||||
## 维护工作流
|
||||
|
||||
### Docs Agent
|
||||
|
||||
`Docs Agent` 工作流是一个事件驱动的 Codex 维护通道,用于让现有文档与最近落地的变更保持一致。它没有纯定时计划:`main` 上一次成功的非机器人 push CI 运行可以触发它,也可以通过手动调度直接运行。工作流运行触发时,如果 `main` 已经推进,或过去一小时内已创建另一个未跳过的 Docs Agent 运行,则会跳过。运行时,它会审查从上一个未跳过的 Docs Agent 源 SHA 到当前 `main` 的提交范围,因此一次每小时运行可以覆盖自上次文档检查以来累积的所有 main 变更。
|
||||
`Docs Agent` 工作流是事件驱动的 Codex 维护通道,用于让现有文档与最近落地的变更保持一致。它没有纯定时计划:`main` 上成功的非机器人 push CI 运行可以触发它,手动调度也可以直接运行它。当 `main` 已经前进,或最近一小时内已创建另一个未跳过的 Docs Agent 运行时,工作流运行触发会跳过。运行时,它会审查从上一个未跳过的 Docs Agent 源 SHA 到当前 `main` 的提交范围,因此一次每小时运行可以覆盖自上次文档处理以来累积的所有 main 变更。
|
||||
|
||||
### Test Performance Agent
|
||||
|
||||
`Test Performance Agent` 工作流是一个事件驱动的 Codex 维护通道,用于慢测试。它没有纯定时计划:`main` 上一次成功的非机器人 push CI 运行可以触发它,但如果另一个工作流运行触发当天(UTC)已经运行或正在运行,它会跳过。手动调度会绕过该每日活动关卡。该通道会构建完整套件分组的 Vitest 性能报告,让 Codex 只做小型、保留覆盖率的测试性能修复,而不是广泛重构,然后重新运行完整套件报告,并拒绝会降低通过基线测试数量的变更。如果基线存在失败测试,Codex 只能修复明显失败项,并且智能体之后的完整套件报告必须通过,之后才会提交任何内容。当 `main` 在机器人推送落地前推进时,该通道会 rebase 已验证的补丁,重新运行 `pnpm check:changed`,并重试推送;存在冲突的过期补丁会被跳过。它使用 GitHub 托管的 Ubuntu,因此 Codex action 可以保持与 docs agent 相同的 drop-sudo 安全姿态。
|
||||
`Test Performance Agent` 工作流是事件驱动的 Codex 维护通道,用于处理慢测试。它没有纯定时计划:`main` 上成功的非机器人 push CI 运行可以触发它,但如果当天 UTC 已经有另一个工作流运行触发执行过或正在执行,它会跳过。手动调度会绕过该每日活动门禁。该通道构建全套分组 Vitest 性能报告,让 Codex 只进行小型且保持覆盖率的测试性能修复,而不是大范围重构,然后重新运行全套报告,并拒绝会降低通过基线测试数量的变更。如果基线存在失败测试,Codex 只能修复明显失败,并且在提交任何内容前,智能体之后的全套报告必须通过。当 `main` 在机器人 push 落地前前进时,该通道会 rebase 已验证的补丁,重新运行 `pnpm check:changed`,并重试 push;冲突的过期补丁会被跳过。它使用 GitHub 托管的 Ubuntu,因此 Codex action 可以保持与文档智能体相同的 drop-sudo 安全姿态。
|
||||
|
||||
### 合并后的重复 PR
|
||||
|
||||
`Duplicate PRs After Merge` 工作流是供维护者使用的手动工作流,用于落地后的重复项清理。它默认 dry-run,且仅在 `apply=true` 时关闭明确列出的 PR。在变更 GitHub 之前,它会验证已落地 PR 已合并,并且每个重复项要么有共享的引用 issue,要么有重叠的变更 hunk。
|
||||
`Duplicate PRs After Merge` 工作流是手动维护者工作流,用于落地后的重复项清理。它默认是 dry-run,只有在 `apply=true` 时才关闭明确列出的 PR。在修改 GitHub 前,它会验证已落地的 PR 已合并,并验证每个重复项要么共享引用的问题,要么存在重叠的变更 hunks。
|
||||
|
||||
```bash
|
||||
gh workflow run duplicate-after-merge.yml \
|
||||
@ -453,29 +453,29 @@ gh workflow run duplicate-after-merge.yml \
|
||||
-f apply=true
|
||||
```
|
||||
|
||||
## 本地检查关卡和变更路由
|
||||
## 本地检查门禁和变更路由
|
||||
|
||||
本地变更通道逻辑位于 `scripts/changed-lanes.mjs`,并由 `scripts/check-changed.mjs` 执行。该本地检查关卡对架构边界的要求比广泛的 CI 平台范围更严格:
|
||||
本地变更通道逻辑位于 `scripts/changed-lanes.mjs`,并由 `scripts/check-changed.mjs` 执行。该本地检查门禁在架构边界上比宽泛的 CI 平台范围更严格:
|
||||
|
||||
- 核心生产变更会运行核心生产和核心测试类型检查,以及核心 lint/守卫;
|
||||
- 仅核心测试变更只运行核心测试类型检查,以及核心 lint;
|
||||
- 核心生产变更会运行核心生产和核心测试类型检查,以及核心 lint/guards;
|
||||
- 仅核心测试变更只会运行核心测试类型检查,以及核心 lint;
|
||||
- 插件生产变更会运行插件生产和插件测试类型检查,以及插件 lint;
|
||||
- 仅插件测试变更会运行插件测试类型检查,以及插件 lint;
|
||||
- 公开插件 SDK 或插件契约变更会扩展到插件类型检查,因为插件依赖这些核心契约(Vitest 插件扫描仍然是显式测试工作);
|
||||
- 仅发布元数据的版本提升会运行定向版本/配置/根依赖检查;
|
||||
- 未知根目录/配置变更会保守失败到所有检查通道。
|
||||
- 公共插件 SDK 或插件契约变更会扩展到插件类型检查,因为插件依赖这些核心契约(Vitest 插件扫测仍是显式测试工作);
|
||||
- 仅发布元数据版本 bump 会运行有针对性的版本/配置/根依赖检查;
|
||||
- 未知根目录/配置变更会故障安全地进入所有检查通道。
|
||||
|
||||
本地变更测试路由位于 `scripts/test-projects.test-support.mjs`,并且有意比 `check:changed` 更低成本:直接测试编辑会运行它们自身,源码编辑优先使用显式映射,然后是同级测试和导入图依赖项。共享群组房间投递配置是显式映射之一:对群组可见回复配置、源回复投递模式或消息工具系统提示词的变更,会路由到核心回复测试以及 Discord 和 Slack 投递回归测试,这样共享默认值变更会在第一次 PR 推送之前失败。只有当变更在 harness 范围内足够广,以至于低成本映射集合不是可信代理时,才使用 `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`。
|
||||
本地变更测试路由位于 `scripts/test-projects.test-support.mjs`,并且有意比 `check:changed` 更便宜:直接测试编辑会运行自身,源码编辑优先使用显式映射,然后是同级测试和导入图依赖项。共享 group-room 投递配置是显式映射之一:对群组可见回复配置、源回复投递模式或 message-tool 系统提示词的变更,会经过核心回复测试以及 Discord 和 Slack 投递回归测试,这样共享默认值变更会在第一次 PR push 前失败。只有当变更范围足够覆盖整个 harness,使便宜的映射集合无法作为可信代理时,才使用 `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`。
|
||||
|
||||
## Testbox 验证
|
||||
|
||||
从仓库根目录运行 Testbox,并优先为广泛证明使用新预热的 box。在把慢关卡花费到一个被复用、已过期或刚报告了异常大同步的 box 上之前,先在该 box 内运行 `pnpm testbox:sanity`。
|
||||
从仓库根目录运行 Testbox,并且对于宽泛证明,优先使用新的已预热 box。在一个被复用、已过期,或刚刚报告异常大同步的 box 上花费慢门禁时间前,先在 box 内运行 `pnpm testbox:sanity`。
|
||||
|
||||
当必需的根文件(例如 `pnpm-lock.yaml`)消失,或 `git status --short` 显示至少 200 个已跟踪删除项时,健全性检查会快速失败。这通常意味着远程同步状态不是 PR 的可信副本;应停止该 box 并预热一个新的,而不是调试产品测试失败。对于有意进行大量删除的 PR,为该健全性运行设置 `OPENCLAW_TESTBOX_ALLOW_MASS_DELETIONS=1`。
|
||||
当 `pnpm-lock.yaml` 等必需根文件消失,或 `git status --short` 显示至少 200 个已跟踪删除时,完整性检查会快速失败。这通常意味着远程同步状态不是 PR 的可信副本;停止该 box 并预热一个新的 box,而不是调试产品测试失败。对于有意的大量删除 PR,请为该完整性检查运行设置 `OPENCLAW_TESTBOX_ALLOW_MASS_DELETIONS=1`。
|
||||
|
||||
`pnpm testbox:run` 还会终止本地 Blacksmith CLI 调用:如果它停留在同步阶段超过五分钟且没有同步后输出。设置 `OPENCLAW_TESTBOX_SYNC_TIMEOUT_MS=0` 可禁用该保护,或者为异常大的本地 diff 使用更大的毫秒值。
|
||||
`pnpm testbox:run` 还会终止停留在同步阶段超过五分钟且没有同步后输出的本地 Blacksmith CLI 调用。设置 `OPENCLAW_TESTBOX_SYNC_TIMEOUT_MS=0` 可禁用该保护,或为异常大的本地 diff 使用更大的毫秒值。
|
||||
|
||||
Crabbox 是仓库自有的第二条远程 box 路径,用于在 Blacksmith 不可用,或更适合使用自有云容量时提供 Linux 验证。预热一个 box,通过项目工作流完成初始化,然后通过 Crabbox CLI 运行命令:
|
||||
Crabbox 是仓库自有的第二条远程机器路径,用于在 Blacksmith 不可用或更适合使用自有云容量时提供 Linux 验证。先预热一台机器,通过项目工作流初始化它,然后通过 Crabbox CLI 运行命令:
|
||||
|
||||
```bash
|
||||
pnpm crabbox:warmup -- --idle-timeout 90m
|
||||
@ -484,9 +484,9 @@ pnpm crabbox:run -- --id <cbx_id> --shell "OPENCLAW_TESTBOX=1 pnpm check:changed
|
||||
pnpm crabbox:stop -- <cbx_id>
|
||||
```
|
||||
|
||||
`.crabbox.yaml` 负责提供商、同步和 GitHub Actions 初始化默认值。它会排除本地 `.git`,这样已初始化的 Actions checkout 会保留自己的远程 Git 元数据,而不是同步维护者本地的远程配置和对象存储;它还会排除绝不应传输的本地运行时/构建产物。`.github/workflows/crabbox-hydrate.yml` 负责 checkout、Node/pnpm 设置、`origin/main` 获取,以及后续 `crabbox run --id <cbx_id>` 命令会读取的非 secret 环境交接。
|
||||
`.crabbox.yaml` 负责提供商、同步和 GitHub Actions 初始化默认值。它会排除本地 `.git`,这样已初始化的 Actions 检出会保留自己的远程 Git 元数据,而不是同步维护者本地的远程仓库和对象存储;它还会排除绝不应传输的本地运行时/构建产物。`.github/workflows/crabbox-hydrate.yml` 负责检出、Node/pnpm 设置、`origin/main` 拉取,以及非机密环境的交接,后续 `crabbox run --id <cbx_id>` 命令会读取这些环境。
|
||||
|
||||
## 相关内容
|
||||
## 相关
|
||||
|
||||
- [安装概览](/zh-CN/install)
|
||||
- [开发渠道](/zh-CN/install/development-channels)
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
---
|
||||
read_when:
|
||||
- 你遇到连接/凭证问题,并想要引导式修复
|
||||
- 你更新后想做一次完整性检查
|
||||
- 你遇到连接/身份验证问题,并想要引导式修复
|
||||
- 你已更新并想做一次基本检查
|
||||
summary: '`openclaw doctor` 的 CLI 参考(健康检查 + 引导式修复)'
|
||||
title: Doctor
|
||||
x-i18n:
|
||||
generated_at: "2026-05-02T03:33:33Z"
|
||||
generated_at: "2026-05-02T15:57:27Z"
|
||||
model: gpt-5.5
|
||||
provider: openai
|
||||
source_hash: e861fa105737088eafa55815faa1a37ccd61e154e8dbe811cf4b988bc1c571e5
|
||||
source_hash: 90da8ffd705cd517fb90367164cc6af3e551befcec15c91746aa1e1e39454f09
|
||||
source_path: cli/doctor.md
|
||||
workflow: 16
|
||||
---
|
||||
@ -17,7 +17,7 @@ x-i18n:
|
||||
|
||||
用于 Gateway 网关和渠道的健康检查 + 快速修复。
|
||||
|
||||
相关:
|
||||
相关内容:
|
||||
|
||||
- 故障排除:[故障排除](/zh-CN/gateway/troubleshooting)
|
||||
- 安全审计:[安全](/zh-CN/gateway/security)
|
||||
@ -41,36 +41,36 @@ openclaw doctor --generate-gateway-token
|
||||
- `--force`:应用激进修复,包括在需要时覆盖自定义服务配置
|
||||
- `--non-interactive`:无提示运行;仅执行安全迁移和非服务修复
|
||||
- `--generate-gateway-token`:生成并配置 Gateway 网关令牌
|
||||
- `--deep`:扫描系统服务,查找额外的 Gateway 网关安装
|
||||
- `--deep`:扫描系统服务中额外安装的 Gateway 网关
|
||||
|
||||
注意事项:
|
||||
|
||||
- 交互式提示(例如钥匙串/OAuth 修复)仅在 stdin 是 TTY 且**未**设置 `--non-interactive` 时运行。无头运行(cron、Telegram、无终端)会跳过提示。
|
||||
- 性能:非交互式 `doctor` 运行会跳过预先加载插件,因此无头健康检查能保持快速。交互式会话在检查需要插件贡献时仍会完整加载插件。
|
||||
- `--fix`(`--repair` 的别名)会将备份写入 `~/.openclaw/openclaw.json.bak`,并删除未知配置键名,同时列出每一项删除。
|
||||
- `doctor --fix --non-interactive` 会报告缺失或过期的 Gateway 网关服务定义,但不会在更新修复模式之外安装或重写它们。缺少服务时运行 `openclaw gateway install`;当你有意要替换启动器时,运行 `openclaw gateway install --force`。
|
||||
- 状态完整性检查现在会检测会话目录中的孤立转录文件。将它们归档为 `.deleted.<timestamp>` 需要交互式确认;`--fix`、`--yes` 和无头运行会让它们保留原位。
|
||||
- Doctor 还会扫描 `~/.openclaw/cron/jobs.json`(或 `cron.store`)中的旧版 cron 作业结构,并且可以在调度器必须在运行时自动规范化它们之前就地重写。
|
||||
- 交互式提示(例如 keychain/OAuth 修复)仅在 stdin 是 TTY 且**未**设置 `--non-interactive` 时运行。无头运行(cron、Telegram、无终端)会跳过提示。
|
||||
- 性能:非交互式 `doctor` 运行会跳过预先加载插件,因此无头健康检查能保持快速。交互式会话在检查需要插件参与时仍会完整加载插件。
|
||||
- `--fix`(`--repair` 的别名)会将备份写入 `~/.openclaw/openclaw.json.bak`,并删除未知配置键名,同时列出每项删除。
|
||||
- `doctor --fix --non-interactive` 会报告缺失或过期的 Gateway 网关服务定义,但在更新修复模式之外不会安装或重写它们。对于缺失的服务,运行 `openclaw gateway install`;如果你明确想替换启动器,运行 `openclaw gateway install --force`。
|
||||
- 状态完整性检查现在会检测会话目录中的孤立转录文件。将它们归档为 `.deleted.<timestamp>` 需要交互式确认;`--fix`、`--yes` 和无头运行会将它们保留在原处。
|
||||
- Doctor 还会扫描 `~/.openclaw/cron/jobs.json`(或 `cron.store`)中的旧版 cron 任务形态,并可在调度器必须在运行时自动规范化它们之前就地重写它们。
|
||||
- 在 Linux 上,当用户的 crontab 仍运行旧版 `~/.openclaw/bin/ensure-whatsapp.sh` 时,Doctor 会发出警告;该脚本已不再维护,并且当 cron 缺少 systemd 用户总线环境时,可能记录虚假的 WhatsApp Gateway 网关中断。
|
||||
- Doctor 会清理旧版 OpenClaw 创建的旧版插件依赖暂存状态。它还会在注册表能够解析已配置的可下载插件时,修复缺失的插件。
|
||||
- 当插件设备发现状态正常时,Doctor 会通过从 `plugins.allow`/`plugins.entries` 中移除缺失的插件 ID,并移除匹配的悬空渠道配置、Heartbeat 目标和渠道模型覆盖,来修复过期插件配置。
|
||||
- Doctor 会通过禁用受影响的 `plugins.entries.<id>` 条目并移除其无效的 `config` 载荷,来隔离无效插件配置。Gateway 网关启动时本来就只会跳过这个坏插件,因此其他插件和渠道可以继续运行。
|
||||
- 当另一个 supervisor 拥有 Gateway 网关生命周期时,设置 `OPENCLAW_SERVICE_REPAIR_POLICY=external`。Doctor 仍会报告 Gateway 网关/服务健康状况并应用非服务修复,但会跳过服务安装/启动/重启/bootstrap 和旧版服务清理。
|
||||
- 在 Linux 上,Doctor 会忽略非活动的额外类 Gateway 网关 systemd 单元,并且在修复期间不会重写正在运行的 systemd Gateway 网关服务的命令/入口点元数据。当你有意要替换活动启动器时,请先停止服务,或使用 `openclaw gateway install --force`。
|
||||
- Doctor 会将旧版扁平 Talk 配置(`talk.voiceId`、`talk.modelId` 及相关项)自动迁移到 `talk.provider` + `talk.providers.<provider>`。
|
||||
- Doctor 会清理由旧版 OpenClaw 创建的旧版插件依赖暂存状态。当注册表可以解析缺失的已配置可下载插件时,它也会修复这些插件;2026.5.2 的 Doctor 执行还会在将配置标记为该版本已触碰之前,自动安装旧配置已在使用的可下载插件。
|
||||
- Doctor 通过从 `plugins.allow`/`plugins.entries` 中删除缺失的插件 ID 来修复过期插件配置,并在插件发现健康时同时删除匹配的悬空渠道配置、Heartbeat 目标和渠道模型覆盖。
|
||||
- Doctor 通过禁用受影响的 `plugins.entries.<id>` 条目并移除其无效的 `config` 载荷来隔离无效插件配置。Gateway 网关启动时本来就只会跳过该坏插件,因此其他插件和渠道可以继续运行。
|
||||
- 当另一个监督进程拥有 Gateway 网关生命周期时,设置 `OPENCLAW_SERVICE_REPAIR_POLICY=external`。Doctor 仍会报告 Gateway 网关/服务健康状态并应用非服务修复,但会跳过服务安装/启动/重启/bootstrap 以及旧版服务清理。
|
||||
- 在 Linux 上,Doctor 会忽略处于非活动状态的额外 Gateway 网关式 systemd 单元,并且在修复期间不会为正在运行的 systemd Gateway 网关服务重写命令/入口点元数据。如果你明确想替换活动启动器,请先停止服务,或使用 `openclaw gateway install --force`。
|
||||
- Doctor 会将旧版扁平 Talk 配置(`talk.voiceId`、`talk.modelId` 及相关配置)自动迁移到 `talk.provider` + `talk.providers.<provider>`。
|
||||
- 当唯一差异是对象键顺序时,重复运行 `doctor --fix` 不再报告/应用 Talk 规范化。
|
||||
- Doctor 包含记忆搜索就绪性检查,并且可以在缺少嵌入凭证时建议运行 `openclaw configure --section model`。
|
||||
- 当未配置命令所有者时,Doctor 会发出警告。命令所有者是被允许运行仅限所有者命令并批准危险操作的人类操作员账号。私信配对只允许某人与机器人对话;如果你在首个所有者 bootstrap 存在之前批准过某个发送者,请显式设置 `commands.ownerAllowFrom`。
|
||||
- 当配置了 Codex 模式智能体,并且操作员的 Codex home 中存在个人 Codex CLI 资产时,Doctor 会发出警告。本地 Codex 应用服务器启动使用隔离的每智能体 home,因此请使用 `openclaw migrate codex --dry-run` 来清点应有意提升的资产。
|
||||
- 如果启用了沙箱模式但 Docker 不可用,Doctor 会报告带有修复建议(`install Docker` 或 `openclaw config set agents.defaults.sandbox.mode off`)的高信号警告。
|
||||
- 如果 `gateway.auth.token`/`gateway.auth.password` 由 SecretRef 管理,并且在当前命令路径中不可用,Doctor 会报告只读警告,并且不会写入明文回退凭证。
|
||||
- 如果在修复路径中检查渠道 SecretRef 失败,Doctor 会继续运行并报告警告,而不是提前退出。
|
||||
- 状态目录迁移后,当已启用的默认 Telegram 或 Discord 账号依赖环境回退,且 `TELEGRAM_BOT_TOKEN` 或 `DISCORD_BOT_TOKEN` 对 Doctor 进程不可用时,Doctor 会发出警告。
|
||||
- Doctor 包含记忆搜索就绪检查,并可在缺少嵌入凭证时推荐 `openclaw configure --section model`。
|
||||
- 当未配置命令所有者时,Doctor 会发出警告。命令所有者是被允许运行仅所有者命令并批准危险操作的人类操作员账号。私信配对只允许某人与 bot 对话;如果你在首个所有者 bootstrap 存在之前批准过发送者,请显式设置 `commands.ownerAllowFrom`。
|
||||
- 当已配置 Codex 模式智能体且操作员的 Codex 主目录中存在个人 Codex CLI 资产时,Doctor 会发出警告。本地 Codex app-server 启动会使用隔离的按智能体划分的主目录,因此请使用 `openclaw migrate codex --dry-run` 盘点应有意提升的资产。
|
||||
- 如果启用了沙箱模式但 Docker 不可用,Doctor 会报告一个高信号警告并附带补救方式(`install Docker` 或 `openclaw config set agents.defaults.sandbox.mode off`)。
|
||||
- 如果 `gateway.auth.token`/`gateway.auth.password` 由 SecretRef 管理且在当前命令路径中不可用,Doctor 会报告只读警告,并且不会写入明文回退凭证。
|
||||
- 如果在修复路径中检查渠道 SecretRef 失败,Doctor 会继续执行并报告警告,而不是提前退出。
|
||||
- 状态目录迁移后,当已启用的默认 Telegram 或 Discord 账号依赖环境回退,而 `TELEGRAM_BOT_TOKEN` 或 `DISCORD_BOT_TOKEN` 对 Doctor 进程不可用时,Doctor 会发出警告。
|
||||
- Telegram `allowFrom` 用户名自动解析(`doctor --fix`)需要当前命令路径中有可解析的 Telegram 令牌。如果令牌检查不可用,Doctor 会报告警告并跳过该轮自动解析。
|
||||
|
||||
## macOS:`launchctl` 环境变量覆盖
|
||||
## macOS:`launchctl` 环境覆盖
|
||||
|
||||
如果你之前运行过 `launchctl setenv OPENCLAW_GATEWAY_TOKEN ...`(或 `...PASSWORD`),该值会覆盖你的配置文件,并可能导致持续的“未授权”错误。
|
||||
如果你之前运行过 `launchctl setenv OPENCLAW_GATEWAY_TOKEN ...`(或 `...PASSWORD`),该值会覆盖你的配置文件,并可能导致持续的“unauthorized”错误。
|
||||
|
||||
```bash
|
||||
launchctl getenv OPENCLAW_GATEWAY_TOKEN
|
||||
@ -80,7 +80,7 @@ launchctl unsetenv OPENCLAW_GATEWAY_TOKEN
|
||||
launchctl unsetenv OPENCLAW_GATEWAY_PASSWORD
|
||||
```
|
||||
|
||||
## 相关
|
||||
## 相关内容
|
||||
|
||||
- [CLI 参考](/zh-CN/cli)
|
||||
- [Gateway 网关 doctor](/zh-CN/gateway/doctor)
|
||||
- [Gateway 网关 Doctor](/zh-CN/gateway/doctor)
|
||||
|
||||
@ -6,15 +6,15 @@ sidebarTitle: Doctor
|
||||
summary: Doctor 命令:健康检查、配置迁移和修复步骤
|
||||
title: Doctor
|
||||
x-i18n:
|
||||
generated_at: "2026-05-02T11:07:11Z"
|
||||
generated_at: "2026-05-02T15:57:25Z"
|
||||
model: gpt-5.5
|
||||
provider: openai
|
||||
source_hash: d306099cda1d7f6079ab94ce8bd4a716b8ccf9ab3637e14743c8a1c83db35ca6
|
||||
source_hash: 1e8150c43662402a4dfe6eb89a804d1de3a73ad8a78f783fd0506e5976c2761f
|
||||
source_path: gateway/doctor.md
|
||||
workflow: 16
|
||||
---
|
||||
|
||||
`openclaw doctor` 是 OpenClaw 的修复 + 迁移工具。它会修复过期配置/状态、检查健康状况,并提供可执行的修复步骤。
|
||||
`openclaw doctor` 是 OpenClaw 的修复 + 迁移工具。它会修复过期的配置/状态、检查健康状况,并提供可执行的修复步骤。
|
||||
|
||||
## 快速开始
|
||||
|
||||
@ -30,7 +30,7 @@ openclaw doctor
|
||||
openclaw doctor --yes
|
||||
```
|
||||
|
||||
不提示而接受默认值(包括适用时的重启/服务/沙箱修复步骤)。
|
||||
不提示直接接受默认值(包括适用时的重启/服务/沙箱修复步骤)。
|
||||
|
||||
</Tab>
|
||||
<Tab title="--repair">
|
||||
@ -38,7 +38,7 @@ openclaw doctor
|
||||
openclaw doctor --repair
|
||||
```
|
||||
|
||||
不提示而应用推荐修复(在安全情况下执行修复 + 重启)。
|
||||
不提示直接应用推荐的修复(在安全时执行修复 + 重启)。
|
||||
|
||||
</Tab>
|
||||
<Tab title="--repair --force">
|
||||
@ -62,7 +62,7 @@ openclaw doctor
|
||||
openclaw doctor --deep
|
||||
```
|
||||
|
||||
扫描系统服务以查找额外的 Gateway 网关安装(launchd/systemd/schtasks)。
|
||||
扫描系统服务,查找额外的 Gateway 网关安装(launchd/systemd/schtasks)。
|
||||
|
||||
</Tab>
|
||||
</Tabs>
|
||||
@ -76,62 +76,62 @@ cat ~/.openclaw/openclaw.json
|
||||
## 它会做什么(摘要)
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Health, UI, and updates">
|
||||
<Accordion title="健康、UI 和更新">
|
||||
- 对 git 安装执行可选的预检更新(仅交互模式)。
|
||||
- UI 协议新鲜度检查(当协议 schema 更新时重建控制 UI)。
|
||||
- UI 协议新鲜度检查(当协议 schema 更新时重建 Control UI)。
|
||||
- 健康检查 + 重启提示。
|
||||
- Skills 状态摘要(eligible/missing/blocked)和插件状态。
|
||||
- Skills 状态摘要(符合条件/缺失/被阻止)和插件状态。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="Config and migrations">
|
||||
- 对旧版值执行配置规范化。
|
||||
- 将 Talk 配置从旧版扁平 `talk.*` 字段迁移到 `talk.provider` + `talk.providers.<provider>`。
|
||||
- 检查旧版 Chrome 扩展配置的浏览器迁移,以及 Chrome MCP 就绪状态。
|
||||
- OpenCode 提供商覆盖警告(`models.providers.opencode` / `models.providers.opencode-go`)。
|
||||
<Accordion title="配置和迁移">
|
||||
- 旧版值的配置规范化。
|
||||
- 将旧版扁平 `talk.*` 字段中的 Talk 配置迁移到 `talk.provider` + `talk.providers.<provider>`。
|
||||
- 针对旧版 Chrome 扩展配置和 Chrome MCP 就绪状态的浏览器迁移检查。
|
||||
- OpenCode provider 覆盖警告(`models.providers.opencode` / `models.providers.opencode-go`)。
|
||||
- Codex OAuth 遮蔽警告(`models.providers.openai-codex`)。
|
||||
- OpenAI Codex OAuth 配置文件的 OAuth TLS 前置条件检查。
|
||||
- 当 `plugins.allow` 有限制但工具策略仍要求通配符或插件自有工具时,给出插件/工具允许列表警告。
|
||||
- 旧版磁盘状态迁移(会话/agent 目录/WhatsApp 凭证)。
|
||||
- 旧版插件 manifest 合同键迁移(`speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders`、`webSearchProviders` → `contracts`)。
|
||||
- 旧版 cron 存储迁移(`jobId`、`schedule.cron`、顶层 delivery/payload 字段、payload `provider`、简单的 `notify: true` webhook 回退任务)。
|
||||
- 将旧版 agent 运行时策略迁移到 `agents.defaults.agentRuntime` 和 `agents.list[].agentRuntime`。
|
||||
- 启用插件时清理过期插件配置;当 `plugins.enabled=false` 时,过期插件引用会被视为惰性的隔离配置并保留。
|
||||
- OpenAI Codex OAuth profile 的 OAuth TLS 前置条件检查。
|
||||
- 当 `plugins.allow` 具有限制性但工具策略仍请求通配符或插件拥有的工具时,发出插件/工具 allowlist 警告。
|
||||
- 旧版磁盘状态迁移(会话/agent 目录/WhatsApp 认证)。
|
||||
- 旧版插件 manifest 合约键迁移(`speechProviders`, `realtimeTranscriptionProviders`, `realtimeVoiceProviders`, `mediaUnderstandingProviders`, `imageGenerationProviders`, `videoGenerationProviders`, `webFetchProviders`, `webSearchProviders` → `contracts`)。
|
||||
- 旧版 cron 存储迁移(`jobId`, `schedule.cron`, 顶层 delivery/payload 字段、payload `provider`、简单 `notify: true` webhook fallback jobs)。
|
||||
- 旧版 agent 运行时策略迁移到 `agents.defaults.agentRuntime` 和 `agents.list[].agentRuntime`。
|
||||
- 启用插件时清理过期插件配置;当 `plugins.enabled=false` 时,过期插件引用会被视为惰性的 containment 配置并保留。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="State and integrity">
|
||||
- 检查会话锁文件并清理过期锁。
|
||||
- 修复受影响的 2026.4.24 构建创建的重复 prompt-rewrite 分支会话记录。
|
||||
- 检测卡住的 subagent 重启恢复 tombstone,并支持通过 `--fix` 清除过期的已中止恢复标记,避免启动时继续将子进程视为重启已中止。
|
||||
- 状态完整性和权限检查(会话、转录记录、状态目录)。
|
||||
- 本地运行时执行配置文件权限检查(chmod 600)。
|
||||
- 模型凭证健康检查:检查 OAuth 过期时间,可以刷新即将过期的令牌,并报告 auth-profile 冷却/禁用状态。
|
||||
- 检测额外工作区目录(`~/openclaw`)。
|
||||
<Accordion title="状态和完整性">
|
||||
- 会话锁文件检查和过期锁清理。
|
||||
- 修复受影响的 2026.4.24 构建创建的重复 prompt-rewrite 分支的会话 transcript。
|
||||
- 检测卡住的 subagent 重启恢复 tombstone,并支持使用 `--fix` 清除过期的 aborted recovery 标志,避免启动时继续将 child 视为 restart-aborted。
|
||||
- 状态完整性和权限检查(会话、transcripts、状态目录)。
|
||||
- 本地运行时检查配置文件权限(chmod 600)。
|
||||
- 模型认证健康状况:检查 OAuth 过期时间、可刷新即将过期的 token,并报告 auth-profile 冷却/禁用状态。
|
||||
- 额外工作区目录检测(`~/openclaw`)。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="Gateway, services, and supervisors">
|
||||
<Accordion title="Gateway 网关、服务和 supervisors">
|
||||
- 启用沙箱隔离时修复沙箱镜像。
|
||||
- 旧版服务迁移和额外 Gateway 网关检测。
|
||||
- Matrix 渠道旧版状态迁移(在 `--fix` / `--repair` 模式下)。
|
||||
- Matrix 渠道旧版状态迁移(在 `--fix` / `--repair` 模式中)。
|
||||
- Gateway 网关运行时检查(服务已安装但未运行;缓存的 launchd label)。
|
||||
- 渠道状态警告(从正在运行的 Gateway 网关探测)。
|
||||
- supervisor 配置审计(launchd/systemd/schtasks),可选择修复。
|
||||
- 清理 Gateway 网关服务的嵌入式代理环境,这些服务在安装或更新期间捕获了 shell `HTTP_PROXY` / `HTTPS_PROXY` / `NO_PROXY` 值。
|
||||
- Gateway 网关运行时最佳实践检查(Node 与 Bun、版本管理器路径)。
|
||||
- Supervisor 配置审计(launchd/systemd/schtasks),支持可选修复。
|
||||
- 清理 Gateway 网关服务中在安装或更新期间捕获的 shell `HTTP_PROXY` / `HTTPS_PROXY` / `NO_PROXY` 值所产生的嵌入式代理环境。
|
||||
- Gateway 网关运行时最佳实践检查(Node vs Bun、version-manager 路径)。
|
||||
- Gateway 网关端口冲突诊断(默认 `18789`)。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="Auth, security, and pairing">
|
||||
- 对开放私信策略给出安全警告。
|
||||
- 对本地令牌模式执行 Gateway 网关凭证检查(当没有令牌来源时提供令牌生成;不会覆盖令牌 SecretRef 配置)。
|
||||
- 检测设备配对问题(待处理的首次配对请求、待处理的角色/范围升级、过期本地 device-token 缓存漂移,以及 paired-record 凭证漂移)。
|
||||
<Accordion title="认证、安全和配对">
|
||||
- 开放私信策略的安全警告。
|
||||
- 针对本地 token 模式的 Gateway 网关认证检查(没有 token 来源时提供 token 生成;不会覆盖 token SecretRef 配置)。
|
||||
- 设备配对问题检测(待处理的首次配对请求、待处理的角色/范围升级、过期的本地 device-token 缓存漂移,以及 paired-record 认证漂移)。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="Workspace and shell">
|
||||
<Accordion title="工作区和 shell">
|
||||
- Linux 上的 systemd linger 检查。
|
||||
- 工作区引导文件大小检查(上下文文件截断/接近限制警告)。
|
||||
- shell 补全状态检查和自动安装/升级。
|
||||
- 记忆搜索 embedding 提供商就绪检查(本地模型、远程 API key 或 QMD 二进制文件)。
|
||||
- 源码安装检查(pnpm 工作区不匹配、缺少 UI 资源、缺少 tsx 二进制文件)。
|
||||
- 工作区 bootstrap 文件大小检查(针对上下文文件的截断/接近限制警告)。
|
||||
- Shell 补全状态检查和自动安装/升级。
|
||||
- Memory 搜索 embedding 提供商就绪检查(本地模型、远程 API key 或 QMD binary)。
|
||||
- 源码安装检查(pnpm workspace 不匹配、缺少 UI assets、缺少 tsx binary)。
|
||||
- 写入更新后的配置 + 向导元数据。
|
||||
|
||||
</Accordion>
|
||||
@ -139,52 +139,52 @@ cat ~/.openclaw/openclaw.json
|
||||
|
||||
## Dreams UI 回填和重置
|
||||
|
||||
控制 UI 的 Dreams 场景包含用于 grounded dreaming 工作流的 **回填**、**重置** 和 **清除 Grounded** 操作。这些操作使用 Gateway 网关 doctor 风格的 RPC 方法,但它们**不**属于 `openclaw doctor` CLI 修复/迁移。
|
||||
Control UI Dreams 场景包含 **Backfill**、**Reset** 和 **Clear Grounded** 操作,用于 grounded dreaming 工作流。这些操作使用 Gateway 网关 doctor 风格的 RPC 方法,但它们**不是** `openclaw doctor` CLI 修复/迁移的一部分。
|
||||
|
||||
它们会做什么:
|
||||
|
||||
- **回填**会扫描活动工作区中的历史 `memory/YYYY-MM-DD.md` 文件,运行 grounded REM diary pass,并将可逆回填条目写入 `DREAMS.md`。
|
||||
- **重置**只会从 `DREAMS.md` 中移除这些已标记的回填 diary 条目。
|
||||
- **清除 Grounded**只会移除来自历史 replay、且尚未积累实时 recall 或 daily support 的暂存 grounded-only 短期条目。
|
||||
- **Backfill** 会扫描活动工作区中的历史 `memory/YYYY-MM-DD.md` 文件,运行 grounded REM diary pass,并将可逆的回填条目写入 `DREAMS.md`。
|
||||
- **Reset** 只会从 `DREAMS.md` 中移除那些带标记的回填 diary 条目。
|
||||
- **Clear Grounded** 只会移除来自历史重放、且尚未积累实时召回或日常支持的 staged grounded-only 短期条目。
|
||||
|
||||
它们本身**不会**做什么:
|
||||
|
||||
- 它们不会编辑 `MEMORY.md`
|
||||
- 它们不会运行完整的 Doctor 迁移
|
||||
- 它们不会自动将 grounded candidates 暂存到实时短期 promotion store,除非你先显式运行暂存 CLI 路径
|
||||
- 它们不会运行完整的 doctor 迁移
|
||||
- 除非你先显式运行 staged CLI 路径,否则它们不会自动将 grounded candidates stage 到 live short-term promotion store
|
||||
|
||||
如果你想让 grounded 历史 replay 影响正常的深度 promotion lane,请改用 CLI 流程:
|
||||
如果你想让 grounded 历史重放影响正常的 deep promotion lane,请改用 CLI 流程:
|
||||
|
||||
```bash
|
||||
openclaw memory rem-backfill --path ./memory --stage-short-term
|
||||
```
|
||||
|
||||
这样会将 grounded durable candidates 暂存到短期 Dreaming 存储中,同时让 `DREAMS.md` 保持为审核界面。
|
||||
这会将 grounded durable candidates stage 到 short-term dreaming store,同时将 `DREAMS.md` 保留为 review surface。
|
||||
|
||||
## 详细行为和设计依据
|
||||
## 详细行为和原理
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="0. Optional update (git installs)">
|
||||
如果这是 git checkout,并且 Doctor 正在交互式运行,它会在运行 Doctor 之前询问是否更新(fetch/rebase/build)。
|
||||
<Accordion title="0. 可选更新(git 安装)">
|
||||
如果这是一个 git checkout 且 doctor 正在交互式运行,它会在运行 doctor 前提供更新选项(fetch/rebase/build)。
|
||||
</Accordion>
|
||||
<Accordion title="1. Config normalization">
|
||||
如果配置包含旧版值形状(例如没有渠道特定覆盖的 `messages.ackReaction`),Doctor 会将它们规范化到当前 schema。
|
||||
<Accordion title="1. 配置规范化">
|
||||
如果配置包含旧版值形状(例如没有特定渠道覆盖的 `messages.ackReaction`),doctor 会将其规范化为当前 schema。
|
||||
|
||||
这包括旧版 Talk 扁平字段。当前公开 Talk 配置是 `talk.provider` + `talk.providers.<provider>`。Doctor 会将旧的 `talk.voiceId` / `talk.voiceAliases` / `talk.modelId` / `talk.outputFormat` / `talk.apiKey` 形状重写到提供商映射中。
|
||||
这包括旧版 Talk 扁平字段。当前公开的 Talk 配置是 `talk.provider` + `talk.providers.<provider>`。Doctor 会将旧的 `talk.voiceId` / `talk.voiceAliases` / `talk.modelId` / `talk.outputFormat` / `talk.apiKey` 形状重写到提供商映射中。
|
||||
|
||||
当 `plugins.allow` 非空且工具策略使用通配符或插件自有工具条目时,Doctor 也会发出警告。`tools.allow: ["*"]` 只匹配实际加载的插件中的工具;它不会绕过排他性的插件允许列表。
|
||||
当 `plugins.allow` 非空且工具策略使用通配符或插件拥有的工具条目时,Doctor 也会发出警告。`tools.allow: ["*"]` 只匹配来自实际加载插件的工具;它不会绕过独占的插件 allowlist。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="2. Legacy config key migrations">
|
||||
<Accordion title="2. 旧版配置键迁移">
|
||||
当配置包含已弃用键时,其他命令会拒绝运行,并要求你运行 `openclaw doctor`。
|
||||
|
||||
Doctor 会:
|
||||
Doctor 将会:
|
||||
|
||||
- 说明发现了哪些旧版键。
|
||||
- 显示它应用的迁移。
|
||||
- 使用更新后的 schema 重写 `~/.openclaw/openclaw.json`。
|
||||
|
||||
Gateway 网关在启动时检测到旧版配置格式时,也会自动运行 Doctor 迁移,因此过期配置无需人工干预即可修复。Cron 任务存储迁移由 `openclaw doctor --fix` 处理。
|
||||
Gateway 网关在启动时检测到旧版配置格式时,也会自动运行 doctor 迁移,因此过期配置无需人工介入即可修复。Cron job store 迁移由 `openclaw doctor --fix` 处理。
|
||||
|
||||
当前迁移:
|
||||
|
||||
@ -209,25 +209,24 @@ openclaw memory rem-backfill --path ./memory --stage-short-term
|
||||
- `plugins.entries.voice-call.config.streaming.sttProvider` → `plugins.entries.voice-call.config.streaming.provider`
|
||||
- `plugins.entries.voice-call.config.streaming.openaiApiKey|sttModel|silenceDurationMs|vadThreshold` → `plugins.entries.voice-call.config.streaming.providers.openai.*`
|
||||
- `bindings[].match.accountID` → `bindings[].match.accountId`
|
||||
- 对于具有命名 `accounts` 但仍残留单账号顶层渠道值的渠道,将这些账号作用域的值移动到为该渠道选定的提升账号中(多数渠道使用 `accounts.default`;Matrix 可以保留现有匹配的命名/默认目标)
|
||||
- 对于带有命名 `accounts` 但仍残留单账号顶层渠道值的渠道,将这些账号范围的值移动到该渠道选定提升的账号中(大多数渠道为 `accounts.default`;Matrix 可以保留现有匹配的命名/默认目标)
|
||||
- `identity` → `agents.list[].identity`
|
||||
- `agent.*` → `agents.defaults` + `tools.*`(工具/提权/执行/沙箱/子智能体)
|
||||
- `agent.*` → `agents.defaults` + `tools.*`(工具/提升权限/执行/沙箱/子智能体)
|
||||
- `agent.model`/`allowedModels`/`modelAliases`/`modelFallbacks`/`imageModelFallbacks` → `agents.defaults.models` + `agents.defaults.model.primary/fallbacks` + `agents.defaults.imageModel.primary/fallbacks`
|
||||
- 移除 `agents.defaults.llm`;为较慢的提供商/模型超时使用 `models.providers.<id>.timeoutSeconds`
|
||||
- 移除 `agents.defaults.llm`;对慢速提供商/模型超时使用 `models.providers.<id>.timeoutSeconds`
|
||||
- `browser.ssrfPolicy.allowPrivateNetwork` → `browser.ssrfPolicy.dangerouslyAllowPrivateNetwork`
|
||||
- `browser.profiles.*.driver: "extension"` → `"existing-session"`
|
||||
- 移除 `browser.relayBindHost`(旧版扩展中继设置)
|
||||
- 旧版 `models.providers.*.api: "openai"` → `"openai-completions"`(Gateway 网关启动时也会跳过 `api` 设置为未来或未知枚举值的提供商,而不是失败关闭)
|
||||
- 旧版 `models.providers.*.api: "openai"` → `"openai-completions"`(Gateway 网关启动时也会跳过 `api` 设置为未来或未知枚举值的提供商,而不是封闭失败)
|
||||
|
||||
Doctor 警告还包括多账号渠道的账号默认值指导:
|
||||
Doctor 警告还会包含多账号渠道的账号默认值指导:
|
||||
|
||||
- 如果配置了两个或更多 `channels.<channel>.accounts` 条目,却没有配置 `channels.<channel>.defaultAccount` 或 `accounts.default`,Doctor 会警告后备路由可能选中意外账号。
|
||||
- 如果 `channels.<channel>.defaultAccount` 设置为未知账号 ID,Doctor 会发出警告并列出已配置的账号 ID。
|
||||
- 如果配置了两个或更多 `channels.<channel>.accounts` 条目,但没有配置 `channels.<channel>.defaultAccount` 或 `accounts.default`,Doctor 会警告回退路由可能选择意外账号。
|
||||
- 如果 `channels.<channel>.defaultAccount` 设置为未知账号 ID,Doctor 会警告并列出已配置的账号 ID。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="2b. OpenCode 提供商覆盖">
|
||||
如果你手动添加了 `models.providers.opencode`、`opencode-zen` 或 `opencode-go`,它会覆盖来自 `@mariozechner/pi-ai` 的内置 OpenCode 目录。这可能会迫使模型使用错误的 API,或将费用清零。Doctor 会发出警告,以便你移除该覆盖并恢复按模型的 API 路由和费用。
|
||||
|
||||
如果你手动添加了 `models.providers.opencode`、`opencode-zen` 或 `opencode-go`,它会覆盖来自 `@mariozechner/pi-ai` 的内置 OpenCode 目录。这可能会强制模型走错误的 API,或将费用清零。Doctor 会发出警告,这样你就可以移除覆盖并恢复按模型分配的 API 路由 + 费用。
|
||||
</Accordion>
|
||||
<Accordion title="2c. 浏览器迁移和 Chrome MCP 就绪状态">
|
||||
如果你的浏览器配置仍指向已移除的 Chrome 扩展路径,Doctor 会将其规范化为当前主机本地的 Chrome MCP 附加模型:
|
||||
@ -237,41 +236,39 @@ openclaw memory rem-backfill --path ./memory --stage-short-term
|
||||
|
||||
当你使用 `defaultProfile: "user"` 或已配置的 `existing-session` 配置文件时,Doctor 还会审计主机本地的 Chrome MCP 路径:
|
||||
|
||||
- 检查默认自动连接配置文件所在的同一主机上是否已安装 Google Chrome
|
||||
- 检查默认自动连接配置文件所在的同一主机上是否安装了 Google Chrome
|
||||
- 检查检测到的 Chrome 版本,并在低于 Chrome 144 时发出警告
|
||||
- 提醒你在浏览器检查页面中启用远程调试(例如 `chrome://inspect/#remote-debugging`、`brave://inspect/#remote-debugging` 或 `edge://inspect/#remote-debugging`)
|
||||
|
||||
Doctor 无法替你启用 Chrome 侧的设置。主机本地 Chrome MCP 仍然需要:
|
||||
Doctor 无法替你启用 Chrome 端设置。主机本地 Chrome MCP 仍然要求:
|
||||
|
||||
- Gateway 网关/节点主机上有基于 Chromium 的 144+ 浏览器
|
||||
- Gateway 网关/节点主机上有基于 Chromium 的浏览器 144+
|
||||
- 浏览器在本地运行
|
||||
- 该浏览器已启用远程调试
|
||||
- 在浏览器中批准第一次附加同意提示
|
||||
- 该浏览器中已启用远程调试
|
||||
- 批准浏览器中的首次附加同意提示
|
||||
|
||||
这里的就绪状态只涉及本地附加前置条件。Existing-session 会保留当前 Chrome MCP 路由限制;`responsebody`、PDF 导出、下载拦截和批量操作等高级路由仍需要托管浏览器或原始 CDP 配置文件。
|
||||
这里的就绪状态只涉及本地附加前提条件。Existing-session 会保留当前 Chrome MCP 路由限制;`responsebody`、PDF 导出、下载拦截和批量操作等高级路由仍需要托管浏览器或原始 CDP 配置文件。
|
||||
|
||||
此检查**不**适用于 Docker、沙箱、远程浏览器或其他无头流程。这些流程会继续使用原始 CDP。
|
||||
此检查**不**适用于 Docker、沙箱、远程浏览器或其他无头流程。它们会继续使用原始 CDP。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="2d. OAuth TLS 前置条件">
|
||||
配置 OpenAI Codex OAuth 配置文件后,Doctor 会探测 OpenAI 授权端点,以验证本地 Node/OpenSSL TLS 栈能否验证证书链。如果探测因证书错误而失败(例如 `UNABLE_TO_GET_ISSUER_CERT_LOCALLY`、证书过期或自签名证书),Doctor 会打印平台特定的修复指导。在使用 Homebrew Node 的 macOS 上,修复通常是 `brew postinstall ca-certificates`。使用 `--deep` 时,即使 Gateway 网关健康,也会运行该探测。
|
||||
|
||||
<Accordion title="2d. OAuth TLS 前提条件">
|
||||
配置 OpenAI Codex OAuth 配置文件时,Doctor 会探测 OpenAI 授权端点,以验证本地 Node/OpenSSL TLS 栈是否可以验证证书链。如果探测因证书错误失败(例如 `UNABLE_TO_GET_ISSUER_CERT_LOCALLY`、过期证书或自签名证书),Doctor 会打印平台特定的修复指导。在使用 Homebrew Node 的 macOS 上,修复通常是 `brew postinstall ca-certificates`。使用 `--deep` 时,即使 Gateway 网关健康,探测也会运行。
|
||||
</Accordion>
|
||||
<Accordion title="2e. Codex OAuth 提供商覆盖">
|
||||
如果你以前在 `models.providers.openai-codex` 下添加了旧版 OpenAI 传输设置,它们可能会遮蔽较新版本会自动使用的内置 Codex OAuth 提供商路径。当 Doctor 看到这些旧传输设置与 Codex OAuth 同时存在时,会发出警告,以便你移除或重写过期的传输覆盖,并恢复内置路由/后备行为。仍支持自定义代理和仅标头覆盖,并且不会触发此警告。
|
||||
|
||||
如果你之前在 `models.providers.openai-codex` 下添加过旧版 OpenAI 传输设置,它们可能会遮蔽新版会自动使用的内置 Codex OAuth 提供商路径。Doctor 在发现这些旧传输设置与 Codex OAuth 并存时会发出警告,这样你就可以移除或重写过期的传输覆盖,并恢复内置路由/回退行为。仍然支持自定义代理和仅标头覆盖,且不会触发此警告。
|
||||
</Accordion>
|
||||
<Accordion title="2f. Codex 插件路由警告">
|
||||
启用内置 Codex 插件时,Doctor 还会检查 `openai-codex/*` 主模型引用是否仍通过默认 PI runner 解析。当你希望通过 PI 使用 Codex OAuth/订阅身份验证时,这种组合是有效的,但它很容易与原生 Codex 应用服务器 harness 混淆。Doctor 会发出警告,并指向明确的应用服务器形态:`openai/*` 加 `agentRuntime.id: "codex"` 或 `OPENCLAW_AGENT_RUNTIME=codex`。
|
||||
启用内置 Codex 插件时,Doctor 还会检查 `openai-codex/*` 主模型引用是否仍通过默认 PI 运行器解析。当你希望通过 PI 使用 Codex OAuth/订阅凭证时,这种组合是有效的,但它很容易与原生 Codex app-server harness 混淆。Doctor 会发出警告,并指向明确的 app-server 形态:`openai/*` 加 `agentRuntime.id: "codex"` 或 `OPENCLAW_AGENT_RUNTIME=codex`。
|
||||
|
||||
Doctor 不会自动修复此项,因为两种路由都有效:
|
||||
Doctor 不会自动修复这一点,因为两种路由都是有效的:
|
||||
|
||||
- `openai-codex/*` + PI 表示“通过普通 OpenClaw runner 使用 Codex OAuth/订阅身份验证”。
|
||||
- `openai/*` + `agentRuntime.id: "codex"` 表示“通过原生 Codex 应用服务器运行嵌入式回合”。
|
||||
- `openai-codex/*` + PI 表示“通过普通 OpenClaw 运行器使用 Codex OAuth/订阅凭证”。
|
||||
- `openai/*` + `agentRuntime.id: "codex"` 表示“通过原生 Codex app-server 运行嵌入式轮次”。
|
||||
- `/codex ...` 表示“从聊天中控制或绑定原生 Codex 对话”。
|
||||
- `/acp ...` 或 `runtime: "acp"` 表示“使用外部 ACP/acpx 适配器”。
|
||||
|
||||
如果出现该警告,请选择你本来想使用的路由并手动编辑配置。当 PI Codex OAuth 是有意配置时,保留该警告不变。
|
||||
如果出现警告,请选择你原本想要的路由并手动编辑配置。当 PI Codex OAuth 是有意配置时,请保持警告原样。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="3. 旧版状态迁移(磁盘布局)">
|
||||
@ -281,221 +278,220 @@ openclaw memory rem-backfill --path ./memory --stage-short-term
|
||||
- 从 `~/.openclaw/sessions/` 到 `~/.openclaw/agents/<agentId>/sessions/`
|
||||
- 智能体目录:
|
||||
- 从 `~/.openclaw/agent/` 到 `~/.openclaw/agents/<agentId>/agent/`
|
||||
- WhatsApp 身份验证状态(Baileys):
|
||||
- WhatsApp 凭证状态(Baileys):
|
||||
- 从旧版 `~/.openclaw/credentials/*.json`(`oauth.json` 除外)
|
||||
- 到 `~/.openclaw/credentials/whatsapp/<accountId>/...`(默认账号 ID:`default`)
|
||||
|
||||
这些迁移是尽力而为且幂等的;当 Doctor 将任何旧版文件夹作为备份留下时,会发出警告。Gateway 网关/CLI 也会在启动时自动迁移旧版会话和智能体目录,以便历史记录/身份验证/模型进入每智能体路径,而无需手动运行 Doctor。WhatsApp 身份验证有意仅通过 `openclaw doctor` 迁移。现在,对话提供商/提供商映射规范化会按结构相等进行比较,因此仅键顺序不同的差异不再触发重复的空操作 `doctor --fix` 更改。
|
||||
这些迁移是尽力而为且幂等的;当 Doctor 将任何旧版文件夹保留为备份时,会发出警告。Gateway 网关/CLI 在启动时也会自动迁移旧版会话 + 智能体目录,因此历史记录/凭证/模型会落到按智能体划分的路径中,而不需要手动运行 Doctor。WhatsApp 凭证特意只通过 `openclaw doctor` 迁移。Talk 提供商/提供商映射规范化现在会按结构相等进行比较,因此仅键顺序不同的差异不再触发重复的无操作 `doctor --fix` 更改。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="3a. 旧版插件清单迁移">
|
||||
Doctor 会扫描所有已安装插件清单,查找已弃用的顶层能力键(`speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders`、`webSearchProviders`)。找到后,它会提供将这些键移动到 `contracts` 对象并就地重写清单文件的操作。此迁移是幂等的;如果 `contracts` 键已经具有相同值,则会移除旧版键,而不会重复数据。
|
||||
|
||||
Doctor 会扫描所有已安装插件清单,查找已弃用的顶层能力键(`speechProviders`、`realtimeTranscriptionProviders`、`realtimeVoiceProviders`、`mediaUnderstandingProviders`、`imageGenerationProviders`、`videoGenerationProviders`、`webFetchProviders`、`webSearchProviders`)。发现后,它会提供将它们移动到 `contracts` 对象并就地重写清单文件的操作。此迁移是幂等的;如果 `contracts` 键已经具有相同的值,旧版键会被移除,而不会重复数据。
|
||||
</Accordion>
|
||||
<Accordion title="3b. 旧版 cron 存储迁移">
|
||||
Doctor 还会检查 cron 作业存储(默认是 `~/.openclaw/cron/jobs.json`,或覆盖后的 `cron.store`),查找调度器出于兼容性仍接受的旧作业形态。
|
||||
Doctor 还会检查 cron 作业存储(默认是 `~/.openclaw/cron/jobs.json`,覆盖时为 `cron.store`)中是否存在调度器为兼容性仍接受的旧作业形态。
|
||||
|
||||
当前 cron 清理包括:
|
||||
|
||||
- `jobId` → `id`
|
||||
- `schedule.cron` → `schedule.expr`
|
||||
- 顶层载荷字段(`message`、`model`、`thinking`、...)→ `payload`
|
||||
- 顶层投递字段(`deliver`、`channel`、`to`、`provider`、...)→ `delivery`
|
||||
- 载荷 `provider` 投递别名 → 显式 `delivery.channel`
|
||||
- 简单旧版 `notify: true` webhook 后备作业 → 显式 `delivery.mode="webhook"`,并设置 `delivery.to=cron.webhook`
|
||||
- 顶层 payload 字段(`message`、`model`、`thinking` 等)→ `payload`
|
||||
- 顶层 delivery 字段(`deliver`、`channel`、`to`、`provider` 等)→ `delivery`
|
||||
- payload `provider` 投递别名 → 显式 `delivery.channel`
|
||||
- 简单旧版 `notify: true` webhook 回退作业 → 显式 `delivery.mode="webhook"` 并设置 `delivery.to=cron.webhook`
|
||||
|
||||
Doctor 只有在不改变行为的情况下,才会自动迁移 `notify: true` 作业。如果某个作业将旧版通知后备与现有非 webhook 投递模式组合使用,Doctor 会发出警告,并将该作业留待手动审查。
|
||||
Doctor 只会在不改变行为的情况下自动迁移 `notify: true` 作业。如果某个作业将旧版通知回退与现有的非 webhook 投递模式组合使用,Doctor 会发出警告,并将该作业留给人工审查。
|
||||
|
||||
在 Linux 上,当用户的 crontab 仍调用旧版 `~/.openclaw/bin/ensure-whatsapp.sh` 时,Doctor 也会发出警告。该主机本地脚本不由当前 OpenClaw 维护,并且当 cron 无法访问 systemd 用户总线时,可能会向 `~/.openclaw/logs/whatsapp-health.log` 写入错误的 `Gateway inactive` 消息。使用 `crontab -e` 移除过期的 crontab 条目;当前健康检查请使用 `openclaw channels status --probe`、`openclaw doctor` 和 `openclaw gateway status`。
|
||||
在 Linux 上,如果用户的 crontab 仍调用旧版 `~/.openclaw/bin/ensure-whatsapp.sh`,Doctor 也会发出警告。当前 OpenClaw 不维护这个主机本地脚本,并且当 cron 无法访问 systemd 用户总线时,它可能会向 `~/.openclaw/logs/whatsapp-health.log` 写入错误的 `Gateway inactive` 消息。使用 `crontab -e` 移除过期的 crontab 条目;使用 `openclaw channels status --probe`、`openclaw doctor` 和 `openclaw gateway status` 进行当前健康检查。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="3c. 会话锁清理">
|
||||
Doctor 会扫描每个智能体会话目录,查找陈旧的写入锁文件,即会话异常退出后留下的文件。对于找到的每个锁文件,它会报告:路径、PID、PID 是否仍然存活、锁的年龄,以及它是否被视为陈旧(PID 已死或超过 30 分钟)。在 `--fix` / `--repair` 模式下,它会自动移除陈旧锁文件;否则会打印一条说明,并指示你使用 `--fix` 重新运行。
|
||||
Doctor 会扫描每个智能体会话目录,查找过期的写入锁文件,即会话异常退出后遗留下来的文件。对于找到的每个锁文件,它会报告:路径、PID、PID 是否仍然存活、锁的存在时长,以及是否被视为过期(PID 已死亡或超过 30 分钟)。在 `--fix` / `--repair` 模式下,它会自动移除过期锁文件;否则会打印说明,并指示你使用 `--fix` 重新运行。
|
||||
</Accordion>
|
||||
<Accordion title="3d. 会话转录分支修复">
|
||||
Doctor 会扫描智能体会话 JSONL 文件,查找由 2026.4.24 提示词转录重写错误创建的重复分支形态:一个包含 OpenClaw 内部运行时上下文的废弃用户轮次,以及一个包含相同可见用户提示词的活跃同级分支。在 `--fix` / `--repair` 模式下,Doctor 会在原文件旁备份每个受影响文件,并将转录重写到活跃分支,使 Gateway 网关历史记录和记忆读取器不再看到重复轮次。
|
||||
Doctor 会扫描智能体会话 JSONL 文件,查找由 2026.4.24 提示词转录重写 bug 创建的重复分支形态:一个带有 OpenClaw 内部运行时上下文的废弃用户轮次,加上一个包含相同可见用户提示词的活跃同级分支。在 `--fix` / `--repair` 模式下,Doctor 会在原文件旁备份每个受影响文件,并将转录重写为活跃分支,这样 Gateway 网关历史记录和记忆读取器就不会再看到重复轮次。
|
||||
</Accordion>
|
||||
<Accordion title="4. 状态完整性检查(会话持久化、路由和安全)">
|
||||
状态目录是运行层面的核心。如果它消失,你会丢失会话、凭证、日志和配置(除非你在其他地方有备份)。
|
||||
状态目录是运行中的中枢。如果它消失,你会丢失会话、凭证、日志和配置(除非你在其他地方有备份)。
|
||||
|
||||
Doctor 检查:
|
||||
Doctor 会检查:
|
||||
|
||||
- **状态目录缺失**:警告灾难性状态丢失,提示重新创建目录,并提醒你它无法恢复缺失的数据。
|
||||
- **状态目录权限**:验证可写性;提供修复权限选项(在检测到所有者/组不匹配时发出 `chown` 提示)。
|
||||
- **macOS 云同步状态目录**:当状态解析到 iCloud Drive(`~/Library/Mobile Documents/com~apple~CloudDocs/...`)或 `~/Library/CloudStorage/...` 下时发出警告,因为同步支持的路径可能导致更慢的 I/O 和锁/同步竞争。
|
||||
- **Linux SD 或 eMMC 状态目录**:当状态解析到 `mmcblk*` 挂载源时发出警告,因为 SD 或 eMMC 支持的随机 I/O 在会话和凭证写入下可能更慢且磨损更快。
|
||||
- **状态目录权限**:验证是否可写;提供修复权限的选项(检测到所有者/组不匹配时会发出 `chown` 提示)。
|
||||
- **macOS 云同步状态目录**:当状态解析到 iCloud Drive(`~/Library/Mobile Documents/com~apple~CloudDocs/...`)或 `~/Library/CloudStorage/...` 下时发出警告,因为由同步支持的路径可能导致更慢的 I/O 以及锁/同步竞态。
|
||||
- **Linux SD 或 eMMC 状态目录**:当状态解析到 `mmcblk*` 挂载源时发出警告,因为基于 SD 或 eMMC 的随机 I/O 在会话和凭证写入下可能更慢且磨损更快。
|
||||
- **会话目录缺失**:`sessions/` 和会话存储目录是持久化历史记录并避免 `ENOENT` 崩溃所必需的。
|
||||
- **转录不匹配**:当最近的会话条目缺少转录文件时发出警告。
|
||||
- **主会话“1 行 JSONL”**:当主转录只有一行时标记(历史记录没有累积)。
|
||||
- **多个状态目录**:当多个 `~/.openclaw` 文件夹存在于各个主目录中,或 `OPENCLAW_STATE_DIR` 指向别处时发出警告(历史记录可能在多个安装之间分裂)。
|
||||
- **远程模式提醒**:如果 `gateway.mode=remote`,Doctor 会提醒你在远程主机上运行它(状态位于那里)。
|
||||
- **配置文件权限**:如果 `~/.openclaw/openclaw.json` 可被组/全局读取,则发出警告,并提供收紧到 `600` 的选项。
|
||||
- **主会话“1 行 JSONL”**:当主转录只有一行时标记(历史记录未在累积)。
|
||||
- **多个状态目录**:当多个主目录中存在多个 `~/.openclaw` 文件夹,或 `OPENCLAW_STATE_DIR` 指向其他位置时发出警告(历史记录可能在不同安装之间分裂)。
|
||||
- **远程模式提醒**:如果 `gateway.mode=remote`,Doctor 会提醒你在远程主机上运行它(状态存放在那里)。
|
||||
- **配置文件权限**:如果 `~/.openclaw/openclaw.json` 可被组/所有人读取,则发出警告,并提供收紧到 `600` 的选项。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="5. 模型认证健康(OAuth 过期)">
|
||||
Doctor 会检查认证存储中的 OAuth 配置文件,在令牌即将过期/已过期时发出警告,并在安全时刷新它们。如果 Anthropic OAuth/令牌配置文件已陈旧,它会建议使用 Anthropic API key 或 Anthropic 设置令牌路径。刷新提示只会在交互式运行(TTY)时出现;`--non-interactive` 会跳过刷新尝试。
|
||||
<Accordion title="5. 模型认证健康状况(OAuth 过期)">
|
||||
Doctor 会检查认证存储中的 OAuth 配置文件,在令牌即将过期或已过期时发出警告,并在安全时刷新它们。如果 Anthropic OAuth/令牌配置文件已过期,它会建议使用 Anthropic API key 或 Anthropic 设置令牌路径。刷新提示只会在交互式运行(TTY)时出现;`--non-interactive` 会跳过刷新尝试。
|
||||
|
||||
当 OAuth 刷新永久失败时(例如 `refresh_token_reused`、`invalid_grant`,或提供商要求你重新登录),Doctor 会报告需要重新认证,并打印要运行的确切 `openclaw models auth login --provider ...` 命令。
|
||||
|
||||
Doctor 还会报告因以下原因暂时不可用的认证配置文件:
|
||||
|
||||
- 短冷却时间(速率限制/超时/认证失败)
|
||||
- 较长禁用时间(账单/额度失败)
|
||||
- 短暂冷却(速率限制/超时/认证失败)
|
||||
- 较长时间禁用(账单/额度失败)
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="6. 钩子模型验证">
|
||||
<Accordion title="6. Hooks 模型验证">
|
||||
如果设置了 `hooks.gmail.model`,Doctor 会根据目录和允许列表验证模型引用,并在它无法解析或被禁止时发出警告。
|
||||
</Accordion>
|
||||
<Accordion title="7. 沙箱镜像修复">
|
||||
启用沙箱隔离时,Doctor 会检查 Docker 镜像,并在当前镜像缺失时提供构建或切换到旧名称的选项。
|
||||
启用沙箱隔离时,Doctor 会检查 Docker 镜像,并在当前镜像缺失时提供构建或切换到旧版名称的选项。
|
||||
</Accordion>
|
||||
<Accordion title="7b. 插件安装清理">
|
||||
Doctor 会在 `openclaw doctor --fix` / `openclaw doctor --repair` 模式下移除旧版 OpenClaw 生成的插件依赖暂存状态。这涵盖陈旧的生成依赖根目录、旧安装阶段目录,以及早期内置插件依赖修复代码留下的包本地残留。
|
||||
Doctor 会在 `openclaw doctor --fix` / `openclaw doctor --repair` 模式下移除旧版 OpenClaw 生成的插件依赖暂存状态。这包括过期的生成依赖根目录、旧安装阶段目录,以及早期内置插件依赖修复代码留下的包本地残留。
|
||||
|
||||
当配置引用了可下载插件但本地插件注册表找不到它们时,Doctor 也可以重新安装已配置的可下载插件。Gateway 网关启动和配置重载不会运行包管理器;插件安装仍然是显式的 Doctor/安装/更新工作。
|
||||
当配置引用了可下载插件,但本地插件注册表找不到它们时,Doctor 也可以重新安装已配置的可下载插件。对于 2026.5.2 内置插件外部化,Doctor 会自动安装现有配置已经使用的可下载插件,然后依赖 `meta.lastTouchedVersion` 使该发布处理只运行一次。Gateway 网关启动和配置重新加载不会运行包管理器;插件安装仍然是显式的 Doctor/安装/更新工作。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="8. Gateway 网关服务迁移和清理提示">
|
||||
Doctor 会检测旧版 Gateway 网关服务(launchd/systemd/schtasks),并提供移除它们以及使用当前 Gateway 网关端口安装 OpenClaw 服务的选项。它还可以扫描额外的类似 Gateway 网关服务并打印清理提示。带配置文件名称的 OpenClaw Gateway 网关服务被视为一等服务,不会被标记为“额外”。
|
||||
Doctor 会检测旧版 Gateway 网关服务(launchd/systemd/schtasks),并提供移除它们以及使用当前 Gateway 网关端口安装 OpenClaw 服务的选项。它还可以扫描额外的类似 Gateway 网关的服务并打印清理提示。以配置文件命名的 OpenClaw Gateway 网关服务被视为一等服务,不会被标记为“额外”。
|
||||
|
||||
在 Linux 上,如果用户级 Gateway 网关服务缺失但存在系统级 OpenClaw Gateway 网关服务,Doctor 不会自动安装第二个用户级服务。使用 `openclaw gateway status --deep` 或 `openclaw doctor --deep` 检查,然后移除重复项,或在系统监督器拥有 Gateway 网关生命周期时设置 `OPENCLAW_SERVICE_REPAIR_POLICY=external`。
|
||||
在 Linux 上,如果缺少用户级 Gateway 网关服务,但存在系统级 OpenClaw Gateway 网关服务,Doctor 不会自动安装第二个用户级服务。使用 `openclaw gateway status --deep` 或 `openclaw doctor --deep` 检查,然后移除重复项;如果 Gateway 网关生命周期由系统监督器管理,则设置 `OPENCLAW_SERVICE_REPAIR_POLICY=external`。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="8b. 启动 Matrix 迁移">
|
||||
当 Matrix 渠道账号有待处理或可操作的旧版状态迁移时,Doctor(在 `--fix` / `--repair` 模式下)会创建迁移前快照,然后运行尽力而为的迁移步骤:旧版 Matrix 状态迁移和旧版加密状态准备。这两个步骤都不是致命的;错误会被记录,启动会继续。在只读模式(不带 `--fix` 的 `openclaw doctor`)下,此检查会被完全跳过。
|
||||
<Accordion title="8b. 启动时 Matrix 迁移">
|
||||
当 Matrix 渠道账户存在待处理或可操作的旧版状态迁移时,Doctor(在 `--fix` / `--repair` 模式下)会创建迁移前快照,然后运行尽力而为的迁移步骤:旧版 Matrix 状态迁移和旧版加密状态准备。这两个步骤都是非致命的;错误会被记录,启动会继续。在只读模式(不带 `--fix` 的 `openclaw doctor`)下,此检查会被完全跳过。
|
||||
</Accordion>
|
||||
<Accordion title="8c. 设备配对和认证漂移">
|
||||
Doctor 现在会在常规健康检查中检查设备配对状态。
|
||||
Doctor 现在会将设备配对状态作为正常健康检查的一部分进行检查。
|
||||
|
||||
它会报告:
|
||||
|
||||
- 待处理的首次配对请求
|
||||
- 已配对设备的待处理角色升级
|
||||
- 已配对设备的待处理作用域升级
|
||||
- 已配对设备待处理的角色升级
|
||||
- 已配对设备待处理的范围升级
|
||||
- 设备 ID 仍然匹配但设备身份不再匹配已批准记录的公钥不匹配修复
|
||||
- 已配对记录缺少已批准角色的活跃令牌
|
||||
- 作用域漂移到已批准配对基线之外的已配对令牌
|
||||
- 当前机器的本地缓存设备令牌条目早于 Gateway 网关侧令牌轮换,或携带陈旧作用域元数据
|
||||
- 已配对记录缺少已批准角色的有效令牌
|
||||
- 已配对令牌的范围偏离已批准的配对基线
|
||||
- 当前机器上的本地缓存设备令牌条目早于 Gateway 网关侧令牌轮换,或带有过时的范围元数据
|
||||
|
||||
Doctor 不会自动批准配对请求,也不会自动轮换设备令牌。它会改为打印确切的下一步:
|
||||
Doctor 不会自动批准配对请求或自动轮换设备令牌。它会改为打印确切的后续步骤:
|
||||
|
||||
- 使用 `openclaw devices list` 检查待处理请求
|
||||
- 使用 `openclaw devices approve <requestId>` 批准确切请求
|
||||
- 使用 `openclaw devices rotate --device <deviceId> --role <role>` 轮换新令牌
|
||||
- 使用 `openclaw devices remove <deviceId>` 移除并重新批准陈旧记录
|
||||
- 使用 `openclaw devices remove <deviceId>` 移除并重新批准过时记录
|
||||
|
||||
这弥补了常见的“已经配对但仍然收到需要配对提示”的缺口:Doctor 现在会区分首次配对、待处理的角色/作用域升级,以及陈旧的令牌/设备身份漂移。
|
||||
这填补了常见的“已配对但仍提示需要配对”漏洞:Doctor 现在会区分首次配对、待处理的角色/范围升级,以及过时令牌/设备身份漂移。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="9. 安全警告">
|
||||
当提供商在没有允许列表的情况下对私信开放,或策略以危险方式配置时,Doctor 会发出警告。
|
||||
当提供商在没有允许列表的情况下向私信开放,或策略以危险方式配置时,Doctor 会发出警告。
|
||||
</Accordion>
|
||||
<Accordion title="10. systemd linger(Linux)">
|
||||
如果作为 systemd 用户服务运行,Doctor 会确保已启用 linger,使 Gateway 网关在登出后仍保持运行。
|
||||
如果作为 systemd 用户服务运行,Doctor 会确保已启用 linger,这样 Gateway 网关在登出后仍保持运行。
|
||||
</Accordion>
|
||||
<Accordion title="11. 工作区状态(Skills、插件和旧版目录)">
|
||||
Doctor 会打印默认智能体的工作区状态摘要:
|
||||
|
||||
- **Skills 状态**:统计符合条件、缺少要求和被允许列表阻止的 Skills。
|
||||
- **Skills 状态**:统计符合条件、缺少要求以及被允许列表阻止的 Skills。
|
||||
- **旧版工作区目录**:当 `~/openclaw` 或其他旧版工作区目录与当前工作区并存时发出警告。
|
||||
- **插件状态**:统计已启用/已禁用/出错的插件;列出任何错误的插件 ID;报告捆绑插件能力。
|
||||
- **插件状态**:统计已启用/已禁用/出错的插件;列出任何错误对应的插件 ID;报告捆绑插件能力。
|
||||
- **插件兼容性警告**:标记与当前运行时存在兼容性问题的插件。
|
||||
- **插件诊断**:呈现插件注册表在加载时发出的任何警告或错误。
|
||||
- **插件诊断**:显示插件注册表在加载时发出的任何警告或错误。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="11b. 引导文件大小">
|
||||
Doctor 会检查工作区引导文件(例如 `AGENTS.md`、`CLAUDE.md` 或其他注入的上下文文件)是否接近或超过配置的字符预算。它会报告每个文件的原始字符数与注入字符数、截断百分比、截断原因(`max/file` 或 `max/total`),以及总注入字符数占总预算的比例。当文件被截断或接近限制时,Doctor 会打印用于调整 `agents.defaults.bootstrapMaxChars` 和 `agents.defaults.bootstrapTotalMaxChars` 的提示。
|
||||
<Accordion title="11b. Bootstrap 文件大小">
|
||||
Doctor 会检查工作区 bootstrap 文件(例如 `AGENTS.md`、`CLAUDE.md` 或其他注入的上下文文件)是否接近或超过配置的字符预算。它会报告每个文件的原始字符数与注入字符数、截断百分比、截断原因(`max/file` 或 `max/total`),以及总注入字符数占总预算的比例。当文件被截断或接近限制时,Doctor 会打印用于调整 `agents.defaults.bootstrapMaxChars` 和 `agents.defaults.bootstrapTotalMaxChars` 的提示。
|
||||
</Accordion>
|
||||
<Accordion title="11d. 陈旧渠道插件清理">
|
||||
当 `openclaw doctor --fix` 移除缺失的渠道插件时,它还会移除引用该插件的悬挂渠道作用域配置:`channels.<id>` 条目、命名该渠道的 Heartbeat 目标,以及 `agents.*.models["<channel>/*"]` 覆盖项。这会防止渠道运行时已消失但配置仍要求 Gateway 网关绑定到它而导致的 Gateway 网关启动循环。
|
||||
<Accordion title="11d. 清理过时渠道插件">
|
||||
当 `openclaw doctor --fix` 移除缺失的渠道插件时,它也会移除引用该插件的悬空渠道作用域配置:`channels.<id>` 条目、命名该渠道的 Heartbeat 目标,以及 `agents.*.models["<channel>/*"]` 覆盖项。这可以防止渠道运行时已不存在但配置仍要求 Gateway 网关绑定到它而导致的 Gateway 网关启动循环。
|
||||
</Accordion>
|
||||
<Accordion title="11c. Shell 补全">
|
||||
Doctor 会检查当前 Shell(zsh、bash、fish 或 PowerShell)是否安装了 Tab 补全:
|
||||
Doctor 会检查当前 shell(zsh、bash、fish 或 PowerShell)是否已安装 Tab 补全:
|
||||
|
||||
- 如果 Shell 配置文件使用较慢的动态补全模式(`source <(openclaw completion ...)`),Doctor 会将其升级为更快的缓存文件变体。
|
||||
- 如果 shell 配置文件使用慢速动态补全模式(`source <(openclaw completion ...)`),Doctor 会将其升级为更快的缓存文件变体。
|
||||
- 如果补全已在配置文件中配置但缓存文件缺失,Doctor 会自动重新生成缓存。
|
||||
- 如果完全没有配置补全,Doctor 会提示安装它(仅交互模式;使用 `--non-interactive` 时跳过)。
|
||||
- 如果完全未配置补全,Doctor 会提示安装它(仅交互模式;使用 `--non-interactive` 时跳过)。
|
||||
|
||||
运行 `openclaw completion --write-state` 可手动重新生成缓存。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="12. Gateway 网关认证检查(本地令牌)">
|
||||
Doctor 会检查本地 Gateway 网关令牌认证就绪状态。
|
||||
<Accordion title="12. Gateway 网关身份验证检查(本地令牌)">
|
||||
Doctor 会检查本地 Gateway 网关令牌身份验证就绪状态。
|
||||
|
||||
- 如果令牌模式需要令牌但不存在令牌来源,Doctor 会提供生成一个令牌的选项。
|
||||
- 如果令牌模式需要令牌且没有令牌来源,Doctor 会提议生成一个。
|
||||
- 如果 `gateway.auth.token` 由 SecretRef 管理但不可用,Doctor 会发出警告,并且不会用明文覆盖它。
|
||||
- `openclaw doctor --generate-gateway-token` 只会在未配置令牌 SecretRef 时强制生成。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="12b. 感知只读 SecretRef 的修复">
|
||||
某些修复流程需要检查已配置的凭证,同时不削弱运行时快速失败行为。
|
||||
<Accordion title="12b. 支持只读 SecretRef 的修复">
|
||||
某些修复流程需要检查已配置凭证,同时不削弱运行时快速失败行为。
|
||||
|
||||
- `openclaw doctor --fix` 现在会使用与 Status 系列命令相同的只读 SecretRef 摘要模型来进行有针对性的配置修复。
|
||||
- `openclaw doctor --fix` 现在针对定向配置修复,使用与 Status 系列命令相同的只读 SecretRef 摘要模型。
|
||||
- 示例:Telegram `allowFrom` / `groupAllowFrom` `@username` 修复会在可用时尝试使用已配置的机器人凭证。
|
||||
- 如果 Telegram 机器人令牌通过 SecretRef 配置,但在当前命令路径中不可用,Doctor 会报告凭证已配置但不可用,并跳过自动解析,而不是崩溃或误报令牌缺失。
|
||||
- 如果 Telegram 机器人令牌通过 SecretRef 配置,但在当前命令路径中不可用,Doctor 会报告该凭证已配置但不可用,并跳过自动解析,而不是崩溃或误报令牌缺失。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="13. Gateway 网关健康检查 + 重启">
|
||||
Doctor 会运行健康检查,并在 Gateway 网关看起来不健康时提供重启选项。
|
||||
Doctor 会运行健康检查,并在 Gateway 网关看起来不健康时提出重启建议。
|
||||
</Accordion>
|
||||
<Accordion title="13b. 记忆搜索就绪状态">
|
||||
Doctor 会检查已配置的记忆搜索嵌入提供商是否已为默认智能体准备就绪。行为取决于已配置的后端和提供商:
|
||||
Doctor 会检查已配置的记忆搜索嵌入提供商是否已为默认智能体就绪。其行为取决于已配置的后端和提供商:
|
||||
|
||||
- **QMD 后端**:探测 `qmd` 二进制文件是否可用且可启动。如果不可用,会打印修复指导,包括 npm 包和手动二进制路径选项。
|
||||
- **显式本地提供商**:检查本地模型文件或可识别的远程/可下载模型 URL。如果缺失,建议切换到远程提供商。
|
||||
- **显式远程提供商**(`openai`、`voyage` 等):验证环境或凭证存储中是否存在 API key。如果缺失,会打印可操作的修复提示。
|
||||
- **自动提供商**:先检查本地模型可用性,然后按自动选择顺序尝试每个远程提供商。
|
||||
- **QMD 后端**:探测 `qmd` 二进制文件是否可用且可启动。如果不可用,则打印修复指导,包括 npm 包和手动二进制路径选项。
|
||||
- **显式本地提供商**:检查本地模型文件或可识别的远程/可下载模型 URL。如果缺失,则建议切换到远程提供商。
|
||||
- **显式远程提供商**(`openai`、`voyage` 等):验证环境或认证存储中是否存在 API key。如果缺失,则打印可操作的修复提示。
|
||||
- **自动提供商**:先检查本地模型可用性,然后按自动选择顺序逐一尝试各个远程提供商。
|
||||
|
||||
当缓存的 Gateway 网关探测结果可用时(检查时 Gateway 网关健康),Doctor 会将该结果与 CLI 可见配置交叉比对,并指出任何差异。Doctor 不会在默认路径上启动新的嵌入 ping;如果你想进行实时提供商检查,请使用深度记忆 Status 命令。
|
||||
当缓存的 Gateway 网关探测结果可用时(Gateway 网关在检查时是健康的),Doctor 会将其结果与 CLI 可见的配置交叉比对,并指出任何差异。Doctor 不会在默认路径上启动新的嵌入 ping;如果你想要实时提供商检查,请使用深度记忆 Status 命令。
|
||||
|
||||
使用 `openclaw memory status --deep` 在运行时验证嵌入就绪状态。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="14. 渠道 Status 警告">
|
||||
如果 Gateway 网关健康,Doctor 会运行渠道 Status 探测,并报告警告和建议的修复方法。
|
||||
如果 Gateway 网关健康,Doctor 会运行渠道 Status 探测,并报告警告及建议的修复方法。
|
||||
</Accordion>
|
||||
<Accordion title="15. Supervisor 配置审计 + 修复">
|
||||
Doctor 会检查已安装的 supervisor 配置(launchd/systemd/schtasks),查找缺失或过时的默认值(例如 systemd network-online 依赖和重启延迟)。发现不匹配时,它会建议更新,并可以将服务文件/任务重写为当前默认值。
|
||||
<Accordion title="15. 监督器配置审计 + 修复">
|
||||
Doctor 会检查已安装的监督器配置(launchd/systemd/schtasks)是否缺失默认值或默认值已过时(例如 systemd network-online 依赖和重启延迟)。当发现不匹配时,它会建议更新,并且可以将服务文件/任务重写为当前默认值。
|
||||
|
||||
注意:
|
||||
|
||||
- `openclaw doctor` 会在重写 supervisor 配置前提示。
|
||||
- `openclaw doctor --yes` 接受默认修复提示。
|
||||
- `openclaw doctor --repair` 无提示地应用建议的修复。
|
||||
- `openclaw doctor --repair --force` 覆盖自定义 supervisor 配置。
|
||||
- `OPENCLAW_SERVICE_REPAIR_POLICY=external` 会让 Doctor 对 Gateway 网关服务生命周期保持只读。它仍会报告服务健康状态并运行非服务修复,但会跳过服务安装/启动/重启/bootstrap、supervisor 配置重写和旧版服务清理,因为外部 supervisor 拥有该生命周期。
|
||||
- 在 Linux 上,当匹配的 systemd Gateway 网关单元处于活动状态时,Doctor 不会重写命令/入口点元数据。它还会在重复服务扫描期间忽略非活动的非旧版额外类 Gateway 网关单元,这样配套服务文件就不会产生清理噪声。
|
||||
- 如果令牌认证需要令牌且 `gateway.auth.token` 由 SecretRef 管理,Doctor 服务安装/修复会验证 SecretRef,但不会将解析后的明文令牌值持久化到 supervisor 服务环境元数据中。
|
||||
- Doctor 会检测旧版 LaunchAgent、systemd 或 Windows Scheduled Task 安装以内联方式嵌入的托管 `.env`/SecretRef 支持的服务环境值,并重写服务元数据,让这些值从运行时来源加载,而不是从 supervisor 定义加载。
|
||||
- `openclaw doctor` 会在重写监督器配置前提示。
|
||||
- `openclaw doctor --yes` 会接受默认修复提示。
|
||||
- `openclaw doctor --repair` 会在不提示的情况下应用推荐修复。
|
||||
- `openclaw doctor --repair --force` 会覆盖自定义监督器配置。
|
||||
- `OPENCLAW_SERVICE_REPAIR_POLICY=external` 会让 Doctor 对 Gateway 网关服务生命周期保持只读。它仍会报告服务健康状态并运行非服务修复,但会跳过服务安装/启动/重启/引导、监督器配置重写以及旧版服务清理,因为外部监督器拥有该生命周期。
|
||||
- 在 Linux 上,当匹配的 systemd Gateway 网关单元处于活动状态时,Doctor 不会重写命令/入口点元数据。它还会在重复服务扫描期间忽略非活动的非旧版额外 Gateway 网关类单元,这样配套服务文件不会产生清理噪音。
|
||||
- 如果令牌认证需要令牌,且 `gateway.auth.token` 由 SecretRef 管理,Doctor 服务安装/修复会验证 SecretRef,但不会将解析后的明文令牌值持久化到监督器服务环境元数据中。
|
||||
- Doctor 会检测旧版 LaunchAgent、systemd 或 Windows Scheduled Task 安装曾内联嵌入的托管 `.env`/SecretRef 支持的服务环境值,并重写服务元数据,使这些值从运行时源加载,而不是从监督器定义加载。
|
||||
- Doctor 会检测服务命令是否在 `gateway.port` 变更后仍固定旧的 `--port`,并将服务元数据重写为当前端口。
|
||||
- 如果令牌认证需要令牌且配置的令牌 SecretRef 未解析,Doctor 会阻止安装/修复路径,并给出可操作的指导。
|
||||
- 如果同时配置了 `gateway.auth.token` 和 `gateway.auth.password`,且未设置 `gateway.auth.mode`,Doctor 会阻止安装/修复,直到显式设置模式。
|
||||
- 对于 Linux user-systemd 单元,Doctor 令牌漂移检查现在会在比较服务认证元数据时同时包含 `Environment=` 和 `EnvironmentFile=` 来源。
|
||||
- 当配置最后由较新版本写入时,Doctor 服务修复会拒绝用较旧的 OpenClaw 二进制文件重写、停止或重启 Gateway 网关服务。参见 [Gateway 网关故障排除](/zh-CN/gateway/troubleshooting#split-brain-installs-and-newer-config-guard)。
|
||||
- 如果令牌认证需要令牌,且已配置的令牌 SecretRef 未解析,Doctor 会阻止安装/修复路径,并给出可操作的指导。
|
||||
- 如果同时配置了 `gateway.auth.token` 和 `gateway.auth.password`,且 `gateway.auth.mode` 未设置,Doctor 会阻止安装/修复,直到显式设置模式。
|
||||
- 对于 Linux 用户 systemd 单元,Doctor 令牌漂移检查现在会在比较服务认证元数据时同时包含 `Environment=` 和 `EnvironmentFile=` 源。
|
||||
- 当配置最后由较新版本写入时,Doctor 服务修复会拒绝从旧版 OpenClaw 二进制文件重写、停止或重启 Gateway 网关服务。请参阅 [Gateway 网关故障排除](/zh-CN/gateway/troubleshooting#split-brain-installs-and-newer-config-guard)。
|
||||
- 你始终可以通过 `openclaw gateway install --force` 强制完整重写。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="16. Gateway 网关运行时 + 端口诊断">
|
||||
Doctor 会检查服务运行时(PID、上次退出状态),并在服务已安装但实际未运行时发出警告。它还会检查 Gateway 网关端口(默认 `18789`)上的端口冲突,并报告可能原因(Gateway 网关已运行、SSH 隧道)。
|
||||
Doctor 会检查服务运行时(PID、上次退出 Status),并在服务已安装但实际未运行时发出警告。它还会检查 Gateway 网关端口(默认 `18789`)上的端口冲突,并报告可能原因(Gateway 网关已在运行、SSH 隧道)。
|
||||
</Accordion>
|
||||
<Accordion title="17. Gateway 网关运行时最佳实践">
|
||||
当 Gateway 网关服务运行在 Bun 或版本管理的 Node 路径(`nvm`、`fnm`、`volta`、`asdf` 等)上时,Doctor 会发出警告。WhatsApp + Telegram 渠道需要 Node,而版本管理器路径可能在升级后失效,因为服务不会加载你的 shell init。Doctor 会在可用时提供迁移到系统 Node 安装的选项(Homebrew/apt/choco)。
|
||||
当 Gateway 网关服务运行在 Bun 或版本管理的 Node 路径(`nvm`、`fnm`、`volta`、`asdf` 等)上时,Doctor 会发出警告。WhatsApp + Telegram 渠道需要 Node,而版本管理器路径在升级后可能会失效,因为服务不会加载你的 shell 初始化脚本。当系统 Node 安装可用时(Homebrew/apt/choco),Doctor 会提出迁移到系统 Node 安装。
|
||||
|
||||
新安装或修复的 macOS LaunchAgent 会使用规范的系统 PATH(`/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin`),而不是复制交互式 shell PATH,因此 Volta、asdf、fnm、pnpm 和其他版本管理器目录不会改变 Node 子进程解析到的内容。Linux 服务仍会保留显式环境根目录(`NVM_DIR`、`FNM_DIR`、`VOLTA_HOME`、`ASDF_DATA_DIR`、`BUN_INSTALL`、`PNPM_HOME`)和稳定的用户 bin 目录,但推测出的版本管理器回退目录只有在磁盘上存在时才会写入服务 PATH。
|
||||
新安装或已修复的 macOS LaunchAgent 会使用规范的系统 PATH(`/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin`),而不是复制交互式 shell PATH,因此 Volta、asdf、fnm、pnpm 和其他版本管理器目录不会改变 Node 子进程解析到的内容。Linux 服务仍会保留显式环境根(`NVM_DIR`、`FNM_DIR`、`VOLTA_HOME`、`ASDF_DATA_DIR`、`BUN_INSTALL`、`PNPM_HOME`)以及稳定的用户 bin 目录,但猜测得到的版本管理器回退目录只有在这些目录实际存在于磁盘上时,才会写入服务 PATH。
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="18. 配置写入 + 向导元数据">
|
||||
Doctor 会持久化任何配置变更,并标记向导元数据以记录 Doctor 运行。
|
||||
</Accordion>
|
||||
<Accordion title="19. 工作区提示(备份 + 记忆系统)">
|
||||
当缺少工作区记忆系统时,Doctor 会建议添加;如果工作区尚未纳入 git,它会打印备份提示。
|
||||
当缺少工作区记忆系统时,Doctor 会提出建议;如果工作区尚未纳入 git,则会打印备份提示。
|
||||
|
||||
有关工作区结构和 git 备份的完整指南,请参阅 [/concepts/agent-workspace](/zh-CN/concepts/agent-workspace)(建议使用私有 GitHub 或 GitLab)。
|
||||
请参阅 [/concepts/agent-workspace](/zh-CN/concepts/agent-workspace),获取工作区结构和 git 备份的完整指南(推荐使用私有 GitHub 或 GitLab)。
|
||||
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## 相关内容
|
||||
## 相关
|
||||
|
||||
- [Gateway 网关运行手册](/zh-CN/gateway)
|
||||
- [Gateway 网关故障排除](/zh-CN/gateway/troubleshooting)
|
||||
|
||||
@ -1,34 +1,34 @@
|
||||
---
|
||||
read_when:
|
||||
- 更改 OpenClaw 更新、Doctor、包验收或插件安装行为
|
||||
- 准备或批准发布候选版本
|
||||
- 调试包更新、插件依赖清理或插件安装回归问题
|
||||
- 准备或批准发布候选版
|
||||
- 排查软件包更新、插件依赖清理或插件安装回归问题
|
||||
sidebarTitle: Update and plugin tests
|
||||
summary: OpenClaw 如何验证更新路径、包迁移和插件安装/更新行为
|
||||
summary: OpenClaw 如何验证更新路径、包迁移以及插件安装/更新行为
|
||||
title: 更新和插件测试
|
||||
x-i18n:
|
||||
generated_at: "2026-05-02T02:01:44Z"
|
||||
generated_at: "2026-05-02T15:57:40Z"
|
||||
model: gpt-5.5
|
||||
provider: openai
|
||||
source_hash: b1999106b52d2539a6ee0fd7cd88ebb3515c8726e080d4031d7bf421fb99de36
|
||||
source_hash: 7843767a4acca25ceea62633faa5f4bec954bebf7cc4eeb9f3b0b990313ff946
|
||||
source_path: help/testing-updates-plugins.md
|
||||
workflow: 16
|
||||
---
|
||||
|
||||
这是更新和插件验证的专用检查清单。目标很简单:证明可安装包可以更新真实用户状态,通过 `doctor` 修复过时的遗留状态,并且仍能从受支持来源安装、加载、更新和卸载插件。
|
||||
这是更新和插件验证的专用清单。目标很简单:证明可安装的软件包可以更新真实用户状态,通过 `doctor` 修复过时的旧版状态,并且仍然可以从受支持的来源安装、加载、更新和卸载插件。
|
||||
|
||||
如需更完整的测试运行器映射,请参阅 [测试](/zh-CN/help/testing)。如需实时提供商密钥和涉及网络的套件,请参阅 [实时测试](/zh-CN/help/testing-live)。
|
||||
更完整的测试运行器地图见 [测试](/zh-CN/help/testing)。实时提供商密钥和会接触网络的测试套件见 [实时测试](/zh-CN/help/testing-live)。
|
||||
|
||||
## 我们保护什么
|
||||
## 我们保护的内容
|
||||
|
||||
更新和插件测试保护以下契约:
|
||||
更新和插件测试保护这些契约:
|
||||
|
||||
- 包 tarball 是完整的,包含有效的 `dist/postinstall-inventory.json`,并且不依赖未打包的仓库文件。
|
||||
- 用户可以从较旧的已发布包迁移到候选包,而不会丢失配置、智能体、会话、工作区、插件允许列表或渠道配置。
|
||||
- `openclaw doctor --fix --non-interactive` 负责遗留清理和修复路径。启动流程不应为过时的插件状态增加隐藏的兼容性迁移。
|
||||
- 插件安装可从本地目录、git 仓库、npm 包和 ClawHub 注册表路径工作。
|
||||
- 插件 npm 依赖会安装到托管 npm 根目录,在信任前接受扫描,并在卸载时通过 npm 移除,因此提升的依赖不会残留。
|
||||
- 当没有变化时,插件更新保持稳定:安装记录、解析后的来源、已安装依赖布局和启用状态都保持不变。
|
||||
- 软件包 tarball 是完整的,包含有效的 `dist/postinstall-inventory.json`,并且不依赖未打包的仓库文件。
|
||||
- 用户可以从较旧的已发布软件包迁移到候选软件包,而不会丢失配置、智能体、会话、工作区、插件允许列表或渠道配置。
|
||||
- `openclaw doctor --fix --non-interactive` 负责旧版清理和修复路径。启动过程不应为过时的插件状态增加隐藏的兼容迁移。
|
||||
- 插件可以从本地目录、git 仓库、npm 软件包和 ClawHub 注册表路径安装。
|
||||
- 插件 npm 依赖安装在托管 npm root 中,在信任前会被扫描,并且卸载时通过 npm 移除,以免提升安装的依赖残留。
|
||||
- 当没有任何变化时,插件更新保持稳定:安装记录、解析后的来源、已安装依赖布局和启用状态都保持不变。
|
||||
|
||||
## 开发期间的本地证明
|
||||
|
||||
@ -40,25 +40,25 @@ pnpm check:changed
|
||||
pnpm test:changed
|
||||
```
|
||||
|
||||
对于插件安装、卸载、依赖或包清单变更,还要运行覆盖已编辑接缝的聚焦测试:
|
||||
对于插件安装、卸载、依赖或软件包清单变更,还要运行覆盖已编辑接缝的聚焦测试:
|
||||
|
||||
```bash
|
||||
pnpm test src/plugins/uninstall.test.ts src/infra/package-dist-inventory.test.ts test/scripts/package-acceptance-workflow.test.ts
|
||||
```
|
||||
|
||||
在任何包 Docker 跑道消费 tarball 之前,先证明包制品:
|
||||
在任何软件包 Docker lane 使用 tarball 之前,先证明软件包工件:
|
||||
|
||||
```bash
|
||||
pnpm release:check
|
||||
```
|
||||
|
||||
`release:check` 会运行配置/文档/API 漂移检查,写入包 dist 清单,运行 `npm pack --dry-run`,拒绝禁止打包的文件,将 tarball 安装到临时前缀,运行 postinstall,并对内置渠道入口点进行冒烟测试。
|
||||
`release:check` 会运行配置/文档/API 漂移检查,写入软件包 dist 清单,运行 `npm pack --dry-run`,拒绝禁止打包的文件,将 tarball 安装到临时前缀中,运行 postinstall,并对内置渠道入口点做冒烟测试。
|
||||
|
||||
## Docker 跑道
|
||||
## Docker lanes
|
||||
|
||||
Docker 跑道是产品级证明。它们在 Linux 容器内安装或更新真实包,并通过 CLI 命令、Gateway 网关启动、HTTP 探测、RPC 状态和文件系统状态断言行为。
|
||||
Docker lanes 是产品级证明。它们会在 Linux 容器内安装或更新真实软件包,并通过 CLI 命令、Gateway 网关启动、HTTP 探针、RPC 状态和文件系统状态断言行为。
|
||||
|
||||
迭代时使用聚焦跑道:
|
||||
迭代时使用聚焦 lanes:
|
||||
|
||||
```bash
|
||||
pnpm test:docker:plugins
|
||||
@ -68,15 +68,15 @@ pnpm test:docker:published-upgrade-survivor
|
||||
pnpm test:docker:update-migration
|
||||
```
|
||||
|
||||
重要跑道:
|
||||
重要 lanes:
|
||||
|
||||
- `test:docker:plugins` 验证插件安装冒烟、本地文件夹安装、本地文件夹更新跳过行为、带预安装依赖的本地文件夹、`file:` 包安装、带 CLI 执行的 git 安装、git 移动引用更新、带提升传递依赖的 npm 注册表安装、npm 更新空操作、本地 ClawHub fixture 安装和更新空操作、marketplace 更新行为,以及 Claude bundle 启用/检查。设置 `OPENCLAW_PLUGINS_E2E_CLAWHUB=0` 可让 ClawHub 区块保持密封/离线。
|
||||
- `test:docker:plugin-update` 验证未变化的已安装插件在 `openclaw plugins update` 期间不会重新安装或丢失安装元数据。
|
||||
- `test:docker:upgrade-survivor` 在脏的旧用户 fixture 上安装候选 tarball,运行包更新加非交互式 doctor,然后启动 local loopback Gateway 网关并检查状态保留。
|
||||
- `test:docker:published-upgrade-survivor` 先安装已发布基线,通过内置的 `openclaw config set` 配方配置它,将它更新到候选 tarball,运行 doctor,检查遗留清理,启动 Gateway 网关,并探测 `/healthz`、`/readyz` 和 RPC 状态。
|
||||
- `test:docker:update-migration` 是清理密集型的已发布更新跑道。它从已配置的 Discord/Telegram 风格用户状态开始,运行基线 doctor,让已配置的插件依赖有机会实体化,为已配置的打包插件播种遗留插件依赖残留,更新到候选 tarball,并要求更新后的 doctor 移除遗留依赖根目录。
|
||||
- `test:docker:plugins` 验证插件安装冒烟、本地文件夹安装、本地文件夹更新跳过行为、带预安装依赖的本地文件夹、`file:` 软件包安装、带 CLI 执行的 git 安装、git 移动引用更新、带提升安装的传递依赖的 npm 注册表安装、npm 更新空操作、本地 ClawHub fixture 安装和更新空操作、marketplace 更新行为,以及 Claude-bundle 启用/检查。设置 `OPENCLAW_PLUGINS_E2E_CLAWHUB=0` 可让 ClawHub 代码块保持 hermetic/离线。
|
||||
- `test:docker:plugin-update` 验证未变化的已安装插件在 `openclaw plugins update` 期间不会重新安装,也不会丢失安装元数据。
|
||||
- `test:docker:upgrade-survivor` 将候选 tarball 安装到脏的旧用户 fixture 上,运行软件包更新和非交互式 doctor,然后启动 loopback Gateway 网关并检查状态保留。
|
||||
- `test:docker:published-upgrade-survivor` 会先安装一个已发布基线,通过内置的 `openclaw config set` 配方配置它,将其更新到候选 tarball,运行 doctor,检查旧版清理,启动 Gateway 网关,并探测 `/healthz`、`/readyz` 和 RPC 状态。
|
||||
- `test:docker:update-migration` 是清理密集型的已发布更新 lane。它从已配置的 Discord/Telegram 风格用户状态开始,运行基线 doctor,让已配置插件依赖有机会实体化,为已配置的打包插件播种旧版插件依赖残留,更新到候选 tarball,并要求更新后的 doctor 移除旧版依赖 root。
|
||||
|
||||
有用的已发布升级 survivor 变体:
|
||||
有用的已发布升级幸存者变体:
|
||||
|
||||
```bash
|
||||
OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC=openclaw@2026.4.23 \
|
||||
@ -88,9 +88,9 @@ OPENCLAW_UPGRADE_SURVIVOR_SCENARIO=bootstrap-persona \
|
||||
pnpm test:docker:published-upgrade-survivor
|
||||
```
|
||||
|
||||
可用场景包括 `base`、`feishu-channel`、`bootstrap-persona`、`plugin-deps-cleanup`、`tilde-log-path` 和 `versioned-runtime-deps`。在聚合运行中,`OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS=reported-issues` 会展开为所有已报告的问题形态场景。
|
||||
可用场景包括 `base`、`feishu-channel`、`bootstrap-persona`、`plugin-deps-cleanup`、`configured-plugin-installs`、`tilde-log-path` 和 `versioned-runtime-deps`。在聚合运行中,`OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS=reported-issues` 会展开为所有已报告问题形状的场景,包括已配置插件安装迁移。
|
||||
|
||||
完整更新迁移有意与 Full Release CI 分离。当发布问题是“从 2026.4.23 起的每个已发布稳定版本是否都能更新到此候选版本并清理插件依赖残留?”时,请使用手动 `Update Migration` 工作流:
|
||||
完整更新迁移有意与 Full Release CI 分开。当发布问题是“从 2026.4.23 开始的每个已发布稳定版本是否都能更新到此候选版本并清理插件依赖残留?”时,使用手动 `Update Migration` workflow:
|
||||
|
||||
```bash
|
||||
gh workflow run update-migration.yml \
|
||||
@ -103,22 +103,22 @@ gh workflow run update-migration.yml \
|
||||
|
||||
## Package Acceptance
|
||||
|
||||
Package Acceptance 是 GitHub 原生包门禁。它将一个候选包解析为 `package-under-test` tarball,记录版本和 SHA-256,然后针对该确切 tarball 运行可复用 Docker E2E 跑道。工作流 harness ref 与包来源 ref 分离,因此当前测试逻辑可以验证较旧的受信任发布。
|
||||
Package Acceptance 是 GitHub 原生的软件包关卡。它会将一个候选软件包解析为 `package-under-test` tarball,记录版本和 SHA-256,然后针对该精确 tarball 运行可复用的 Docker E2E lanes。workflow harness 引用与软件包来源引用分离,因此当前测试逻辑可以验证较旧的受信任发布版本。
|
||||
|
||||
候选来源:
|
||||
|
||||
- `source=npm`:验证 `openclaw@beta`、`openclaw@latest` 或确切的已发布版本。
|
||||
- `source=ref`:使用所选当前 harness 打包受信任分支、标签或提交。
|
||||
- `source=url`:验证带必需 `package_sha256` 的 HTTPS tarball。
|
||||
- `source=npm`:验证 `openclaw@beta`、`openclaw@latest` 或精确的已发布版本。
|
||||
- `source=ref`:用选定的当前 harness 打包受信任分支、标签或提交。
|
||||
- `source=url`:验证 HTTPS tarball,并要求提供 `package_sha256`。
|
||||
- `source=artifact`:复用另一个 Actions 运行上传的 tarball。
|
||||
|
||||
发布检查会使用 package/update/plugin 集调用 Package Acceptance:
|
||||
发布检查会使用软件包/更新/插件集合调用 Package Acceptance:
|
||||
|
||||
```text
|
||||
doctor-switch update-channel-switch upgrade-survivor published-upgrade-survivor plugins-offline plugin-update
|
||||
```
|
||||
|
||||
它们还会传递:
|
||||
它们还会传入:
|
||||
|
||||
```text
|
||||
published_upgrade_survivor_baselines=release-history
|
||||
@ -126,11 +126,11 @@ published_upgrade_survivor_scenarios=reported-issues
|
||||
telegram_mode=mock-openai
|
||||
```
|
||||
|
||||
这会让包迁移、更新渠道切换、过时插件依赖清理、离线插件覆盖、插件更新行为和 Telegram 包 QA 使用同一个已解析制品。
|
||||
这会让软件包迁移、更新渠道切换、过时插件依赖清理、离线插件覆盖、插件更新行为和 Telegram 软件包 QA 都基于同一个已解析工件运行。
|
||||
|
||||
`release-history` 是有边界的发布检查样本:最新六个稳定版本、`2026.4.23`,以及一个更早的日期前锚点。对于详尽的已发布更新迁移覆盖,请在单独的 Update Migration 工作流中使用 `all-since-2026.4.23`,而不是 Full Release CI。
|
||||
`release-history` 是一个有界发布检查样本:最新六个稳定版本、`2026.4.23`,以及一个更早的日期前锚点。对于穷尽式已发布更新迁移覆盖,请在单独的 Update Migration workflow 中使用 `all-since-2026.4.23`,而不是 Full Release CI。
|
||||
|
||||
在发布前验证候选版本时,手动运行包 profile:
|
||||
在发布前验证候选版本时,手动运行软件包配置:
|
||||
|
||||
```bash
|
||||
gh workflow run package-acceptance.yml \
|
||||
@ -144,49 +144,49 @@ gh workflow run package-acceptance.yml \
|
||||
-f telegram_mode=mock-openai
|
||||
```
|
||||
|
||||
当发布问题包含 MCP 渠道、cron/subagent 清理、OpenAI Web 搜索或 OpenWebUI 时,使用 `suite_profile=product`。仅在需要完整 Docker 发布路径覆盖时使用 `suite_profile=full`。
|
||||
当发布问题包含 MCP 渠道、cron/subagent 清理、OpenAI Web 搜索或 OpenWebUI 时,使用 `suite_profile=product`。只有在需要完整 Docker 发布路径覆盖时才使用 `suite_profile=full`。
|
||||
|
||||
## 发布默认值
|
||||
|
||||
对于候选发布版本,默认证明栈是:
|
||||
|
||||
1. `pnpm check:changed` 和 `pnpm test:changed`,用于源码级回归。
|
||||
2. `pnpm release:check`,用于包制品完整性。
|
||||
3. Package Acceptance `package` profile 或发布检查自定义包跑道,用于安装/更新/插件契约。
|
||||
4. 跨 OS 发布检查,用于 OS 特定安装器、新手引导和平台行为。
|
||||
5. 仅当变更表面触及提供商或托管服务行为时运行 live 套件。
|
||||
1. `pnpm check:changed` 和 `pnpm test:changed`,用于源代码级回归。
|
||||
2. `pnpm release:check`,用于软件包工件完整性。
|
||||
3. Package Acceptance `package` 配置,或发布检查自定义软件包 lanes,用于安装/更新/插件契约。
|
||||
4. 跨 OS 发布检查,用于特定 OS 的安装器、新手引导和平台行为。
|
||||
5. 只有当变更表面触及提供商或托管服务行为时,才运行实时测试套件。
|
||||
|
||||
在维护者机器上,宽门禁和 Docker/包产品证明应在 Testbox 中运行,除非明确在做本地证明。
|
||||
在维护者机器上,宽范围关卡和 Docker/软件包产品证明应在 Testbox 中运行,除非明确是在做本地证明。
|
||||
|
||||
## 遗留兼容性
|
||||
## 旧版兼容性
|
||||
|
||||
兼容性宽容范围很窄且有时间限制:
|
||||
兼容性宽容是窄范围且有时间限制的:
|
||||
|
||||
- 到 `2026.4.25` 为止的包,包括 `2026.4.25-beta.*`,可以在 Package Acceptance 中容忍已经发布的包元数据缺口。
|
||||
- 已发布的 `2026.4.26` 包可能会对已经发布的本地构建元数据戳文件发出警告。
|
||||
- 后续包必须满足现代契约。同样的缺口会失败,而不是警告或跳过。
|
||||
- 直到 `2026.4.25` 的软件包,包括 `2026.4.25-beta.*`,可以在 Package Acceptance 中容忍已经发布的软件包元数据缺口。
|
||||
- 已发布的 `2026.4.26` 软件包可以对已经发布的本地构建元数据戳记文件发出警告。
|
||||
- 之后的软件包必须满足现代契约。同样的缺口会失败,而不是警告或跳过。
|
||||
|
||||
不要为这些旧形态添加新的启动迁移。添加或扩展 doctor 修复,然后用 `upgrade-survivor` 或 `published-upgrade-survivor` 证明它。
|
||||
不要为这些旧形状添加新的启动迁移。添加或扩展 doctor 修复,然后用 `upgrade-survivor` 或 `published-upgrade-survivor` 证明它。
|
||||
|
||||
## 添加覆盖
|
||||
|
||||
更改更新或插件行为时,在能够因正确原因失败的最低层添加覆盖:
|
||||
|
||||
- 纯路径或元数据逻辑:源码旁的单元测试。
|
||||
- 包清单或已打包文件行为:`package-dist-inventory` 或 tarball 检查器测试。
|
||||
- CLI 安装/更新行为:Docker 跑道断言或 fixture。
|
||||
- 纯路径或元数据逻辑:源代码旁边的单元测试。
|
||||
- 软件包清单或已打包文件行为:`package-dist-inventory` 或 tarball 检查器测试。
|
||||
- CLI 安装/更新行为:Docker lane 断言或 fixture。
|
||||
- 已发布版本迁移行为:`published-upgrade-survivor` 场景。
|
||||
- 注册表/包来源行为:`test:docker:plugins` fixture 或 ClawHub fixture 服务器。
|
||||
- 依赖布局或清理行为:同时断言运行时执行和文件系统边界。npm 依赖可能被提升到托管 npm 根目录下,因此测试应证明该根目录会被扫描/清理,而不是假设存在包本地的 `node_modules` 树。
|
||||
- 注册表/软件包来源行为:`test:docker:plugins` fixture 或 ClawHub fixture 服务器。
|
||||
- 依赖布局或清理行为:同时断言运行时执行和文件系统边界。npm 依赖可能提升安装到托管 npm root 下,因此测试应证明该 root 被扫描/清理,而不是假设存在软件包本地 `node_modules` 树。
|
||||
|
||||
默认保持新的 Docker fixture 密封。使用本地 fixture 注册表和假包,除非测试重点是实时注册表行为。
|
||||
新的 Docker fixtures 默认保持 hermetic。除非测试重点就是实时注册表行为,否则使用本地 fixture 注册表和假软件包。
|
||||
|
||||
## 失败分诊
|
||||
|
||||
从制品身份开始:
|
||||
从工件身份开始:
|
||||
|
||||
- Package Acceptance `resolve_package` 摘要:来源、版本、SHA-256 和制品名称。
|
||||
- Docker 制品:`.artifacts/docker-tests/**/summary.json`、`failures.json`、跑道日志和重跑命令。
|
||||
- Upgrade survivor 摘要:`.artifacts/upgrade-survivor/summary.json`,包括基线版本、候选版本、场景、阶段耗时和配方步骤。
|
||||
- Package Acceptance `resolve_package` 摘要:来源、版本、SHA-256 和工件名称。
|
||||
- Docker 工件:`.artifacts/docker-tests/**/summary.json`、`failures.json`、lane 日志和重跑命令。
|
||||
- 升级幸存者摘要:`.artifacts/upgrade-survivor/summary.json`,包括基线版本、候选版本、场景、阶段耗时和配方步骤。
|
||||
|
||||
优先使用同一个包制品重跑失败的确切跑道,而不是重跑整个发布总括流程。
|
||||
优先使用相同的软件包工件重跑失败的精确 lane,而不是重跑整个发布总括。
|
||||
|
||||
@ -1,167 +1,148 @@
|
||||
---
|
||||
read_when:
|
||||
- 在本地或 CI 中运行测试
|
||||
- 添加针对模型/提供商缺陷的回归测试
|
||||
- 为模型/提供商缺陷添加回归测试
|
||||
- 调试 Gateway 网关 + 智能体行为
|
||||
summary: 测试工具包:单元/端到端/实时套件、Docker 运行器,以及每个测试覆盖的内容
|
||||
summary: 测试工具包:unit/e2e/live 套件、Docker 运行器,以及每项测试涵盖的内容
|
||||
title: 测试
|
||||
x-i18n:
|
||||
generated_at: "2026-05-02T15:53:11Z"
|
||||
generated_at: "2026-05-02T15:57:34Z"
|
||||
model: gpt-5.5
|
||||
provider: openai
|
||||
source_hash: eae3bda71caeb2c2ea8842c940897dc79e4e99be6c337967be41e557b44a41fc
|
||||
source_hash: 217ee866c7e5043c20c09c677e8717e3c8fb836d9016ae3391ecf9058393b2d9
|
||||
source_path: help/testing.md
|
||||
workflow: 16
|
||||
---
|
||||
|
||||
OpenClaw 有三个 Vitest 测试套件(单元/集成、e2e、live)和一小组
|
||||
Docker 运行器。本文档是“我们如何测试”的指南:
|
||||
OpenClaw 有三个 Vitest 测试套件(单元/集成、e2e、live)和一小组 Docker 运行器。本文档是一份“我们如何测试”指南:
|
||||
|
||||
- 每个套件覆盖什么(以及它刻意 _不_ 覆盖什么)。
|
||||
- 常见工作流(本地、推送前、调试)要运行哪些命令。
|
||||
- 每个测试套件覆盖什么(以及有意 _不_ 覆盖什么)。
|
||||
- 常见工作流(本地、推送前、调试)应运行哪些命令。
|
||||
- live 测试如何发现凭证并选择模型/提供商。
|
||||
- 如何为真实世界的模型/提供商问题添加回归测试。
|
||||
|
||||
<Note>
|
||||
**QA 栈(qa-lab、qa-channel、live 传输通道)** 单独记录:
|
||||
**QA 栈(qa-lab、qa-channel、live 传输通道)**单独文档说明:
|
||||
|
||||
- [QA overview](/zh-CN/concepts/qa-e2e-automation) — 架构、命令界面、场景编写。
|
||||
- [Matrix QA](/zh-CN/concepts/qa-matrix) — `pnpm openclaw qa matrix` 的参考。
|
||||
- [QA channel](/zh-CN/channels/qa-channel) — 由仓库支持的场景使用的合成传输插件。
|
||||
- [QA channel](/zh-CN/channels/qa-channel) — 仓库支持场景使用的合成传输插件。
|
||||
|
||||
本页涵盖常规测试套件以及 Docker/Parallels 运行器的运行方式。下面的 QA 专用运行器部分([QA-specific runners](#qa-specific-runners))列出了具体的 `qa` 调用,并指回上面的参考资料。
|
||||
本页面介绍如何运行常规测试套件以及 Docker/Parallels 运行器。下面的 QA 专用运行器部分([QA 专用运行器](#qa-specific-runners))列出具体的 `qa` 调用,并指回上面的参考资料。
|
||||
</Note>
|
||||
|
||||
## 快速开始
|
||||
|
||||
大多数时候:
|
||||
多数时候:
|
||||
|
||||
- 完整门禁(推送前预期运行):`pnpm build && pnpm check && pnpm check:test-types && pnpm test`
|
||||
- 在资源充足的机器上更快运行本地完整套件:`pnpm test:max`
|
||||
- 直接 Vitest 监视循环:`pnpm test:watch`
|
||||
- 直接文件定位现在也会路由 extension/channel 路径:`pnpm test extensions/discord/src/monitor/message-handler.preflight.test.ts`
|
||||
- 当你在迭代单个失败时,优先使用定向运行。
|
||||
- 在资源充足的机器上更快运行本地完整测试套件:`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`
|
||||
- E2E 测试套件:`pnpm test:e2e`
|
||||
|
||||
调试真实提供商/模型时(需要真实凭证):
|
||||
|
||||
- live 套件(模型 + Gateway 网关工具/图片探测):`pnpm test:live`
|
||||
- Live 测试套件(模型 + Gateway 网关工具/图像探针):`pnpm test:live`
|
||||
- 静默定位一个 live 文件:`pnpm test:live -- src/agents/models.profiles.live.test.ts`
|
||||
- 运行时性能报告:派发 `OpenClaw Performance`,并设置
|
||||
`live_gpt54=true` 来进行一次真实的 `openai/gpt-5.4` 智能体轮次,或设置
|
||||
`deep_profile=true` 来生成 Kova CPU/堆/跟踪工件。每日定时运行会在配置
|
||||
`CLAWGRIT_REPORTS_TOKEN` 时,将 mock-provider、deep-profile 和 GPT 5.4 通道工件发布到
|
||||
- 运行时性能报告:分发 `OpenClaw Performance`,使用
|
||||
`live_gpt54=true` 运行一次真实 `openai/gpt-5.4` 智能体回合,或使用
|
||||
`deep_profile=true` 生成 Kova CPU/堆/跟踪工件。配置 `CLAWGRIT_REPORTS_TOKEN` 后,每日计划运行会将 mock-provider、deep-profile 和 GPT 5.4 通道工件发布到
|
||||
`openclaw/clawgrit-reports`。
|
||||
- Docker live 模型扫描:`pnpm test:docker:live-models`
|
||||
- 每个选中的模型现在会运行一个文本轮次,以及一个小型的文件读取风格探测。
|
||||
元数据声明支持 `image` 输入的模型还会运行一个小型图片轮次。
|
||||
- 每个选中的模型现在会运行一个文本回合和一个小型文件读取式探针。
|
||||
元数据声明支持 `image` 输入的模型还会运行一个小型图像回合。
|
||||
在隔离提供商失败时,可用 `OPENCLAW_LIVE_MODEL_FILE_PROBE=0` 或
|
||||
`OPENCLAW_LIVE_MODEL_IMAGE_PROBE=0` 禁用额外探测。
|
||||
- CI 覆盖范围:每日 `OpenClaw Scheduled Live And E2E Checks` 和手动
|
||||
`OpenClaw Release Checks` 都会调用可复用 live/E2E 工作流,并设置
|
||||
`include_live_suites: true`,其中包含按提供商分片的独立 Docker live 模型
|
||||
矩阵作业。
|
||||
- 对于聚焦的 CI 重跑,派发 `OpenClaw Live And E2E Checks (Reusable)`,
|
||||
`OPENCLAW_LIVE_MODEL_IMAGE_PROBE=0` 禁用额外探针。
|
||||
- CI 覆盖:每日 `OpenClaw Scheduled Live And E2E Checks` 和手动
|
||||
`OpenClaw Release Checks` 都会以 `include_live_suites: true` 调用可复用 live/E2E 工作流,其中包含按提供商分片的独立 Docker live 模型矩阵作业。
|
||||
- 对于聚焦的 CI 重跑,分发 `OpenClaw Live And E2E Checks (Reusable)`,
|
||||
并设置 `include_live_suites: true` 和 `live_models_only: true`。
|
||||
- 将新的高信号提供商密钥添加到 `scripts/ci-hydrate-live-auth.sh`,
|
||||
以及 `.github/workflows/openclaw-live-and-e2e-checks-reusable.yml` 和它的
|
||||
定时/发布调用方。
|
||||
- 将新的高信号提供商 secret 添加到 `scripts/ci-hydrate-live-auth.sh`,
|
||||
以及 `.github/workflows/openclaw-live-and-e2e-checks-reusable.yml` 和其
|
||||
scheduled/release 调用方。
|
||||
- 原生 Codex 绑定聊天冒烟测试:`pnpm test:docker:live-codex-bind`
|
||||
- 针对 Codex app-server 路径运行 Docker live 通道,使用 `/codex bind` 绑定一个合成
|
||||
- 针对 Codex app-server 路径运行 Docker live 通道,绑定一个带 `/codex bind` 的合成
|
||||
Slack 私信,执行 `/codex fast` 和
|
||||
`/codex permissions`,然后验证一条普通回复和一个图片附件
|
||||
通过原生插件绑定而不是 ACP 路由。
|
||||
`/codex permissions`,然后验证普通回复和图像附件通过原生插件绑定路由,而不是 ACP。
|
||||
- Codex app-server harness 冒烟测试:`pnpm test:docker:live-codex-harness`
|
||||
- 通过插件拥有的 Codex app-server harness 运行 Gateway 网关智能体轮次,
|
||||
验证 `/codex status` 和 `/codex models`,并默认执行图片、
|
||||
cron MCP、子智能体和 Guardian 探测。在隔离其他 Codex
|
||||
app-server 失败时,可用
|
||||
`OPENCLAW_LIVE_CODEX_HARNESS_SUBAGENT_PROBE=0` 禁用子智能体探测。对于聚焦的子智能体检查,禁用其他探测:
|
||||
- 通过插件拥有的 Codex app-server harness 运行 Gateway 网关智能体回合,
|
||||
验证 `/codex status` 和 `/codex models`,并默认执行图像、cron MCP、子智能体和 Guardian 探针。在隔离其他 Codex app-server 失败时,使用
|
||||
`OPENCLAW_LIVE_CODEX_HARNESS_SUBAGENT_PROBE=0` 禁用子智能体探针。若要进行聚焦的子智能体检查,请禁用其他探针:
|
||||
`OPENCLAW_LIVE_CODEX_HARNESS_IMAGE_PROBE=0 OPENCLAW_LIVE_CODEX_HARNESS_MCP_PROBE=0 OPENCLAW_LIVE_CODEX_HARNESS_GUARDIAN_PROBE=0 OPENCLAW_LIVE_CODEX_HARNESS_SUBAGENT_PROBE=1 pnpm test:docker:live-codex-harness`。
|
||||
除非设置
|
||||
`OPENCLAW_LIVE_CODEX_HARNESS_SUBAGENT_ONLY=0`,否则它会在子智能体探测后退出。
|
||||
除非设置 `OPENCLAW_LIVE_CODEX_HARNESS_SUBAGENT_ONLY=0`,否则它会在子智能体探针之后退出。
|
||||
- Crestodian 救援命令冒烟测试:`pnpm test:live:crestodian-rescue-channel`
|
||||
- 可选的双保险检查,用于消息渠道救援命令
|
||||
界面。它会执行 `/crestodian status`、排队一个持久模型
|
||||
变更、回复 `/crestodian yes`,并验证审计/配置写入路径。
|
||||
- Crestodian 规划器 Docker 冒烟测试:`pnpm test:docker:crestodian-planner`
|
||||
- 在无配置容器中运行 Crestodian,并在 `PATH`
|
||||
上放置一个假的 Claude CLI,验证模糊规划器回退会转换为经过审计的类型化
|
||||
配置写入。
|
||||
- 对消息渠道救援命令界面的可选双保险检查。
|
||||
它会执行 `/crestodian status`,排队一个持久模型变更,回复 `/crestodian yes`,并验证审计/配置写入路径。
|
||||
- Crestodian planner Docker 冒烟测试:`pnpm test:docker:crestodian-planner`
|
||||
- 在一个无配置容器中运行 Crestodian,`PATH` 上有假的 Claude CLI,并验证模糊 planner fallback 会转换为已审计的类型化配置写入。
|
||||
- Crestodian 首次运行 Docker 冒烟测试:`pnpm test:docker:crestodian-first-run`
|
||||
- 从空的 OpenClaw 状态目录启动,将裸 `openclaw` 路由到
|
||||
- 从空的 OpenClaw 状态目录开始,将裸 `openclaw` 路由到
|
||||
Crestodian,应用设置/模型/智能体/Discord 插件 + SecretRef 写入,
|
||||
验证配置,并验证审计条目。相同的 Ring 0 设置路径也由 QA Lab 中的
|
||||
验证配置并验证审计条目。同一 Ring 0 设置路径也由 QA Lab 中的
|
||||
`pnpm openclaw qa suite --scenario crestodian-ring-zero-setup` 覆盖。
|
||||
- Moonshot/Kimi 成本冒烟测试:设置 `MOONSHOT_API_KEY` 后,运行
|
||||
`openclaw models list --provider moonshot --json`,然后针对
|
||||
`moonshot/kimi-k2.6` 运行一个隔离的
|
||||
`openclaw agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json`。
|
||||
验证 JSON 报告 Moonshot/K2.6,并且助手转录记录存储规范化后的 `usage.cost`。
|
||||
`openclaw models list --provider moonshot --json`,然后运行一个隔离的
|
||||
`openclaw agent --local --session-id live-kimi-cost --message 'Reply exactly: KIMI_LIVE_OK' --thinking off --json`
|
||||
目标为 `moonshot/kimi-k2.6`。验证 JSON 报告 Moonshot/K2.6,并且 assistant transcript 存储了规范化的 `usage.cost`。
|
||||
|
||||
<Tip>
|
||||
当你只需要一个失败用例时,优先通过下面描述的 allowlist 环境变量缩小 live 测试范围。
|
||||
当你只需要一个失败用例时,优先通过下文所述的 allowlist 环境变量缩小 live 测试范围。
|
||||
</Tip>
|
||||
|
||||
## QA 专用运行器
|
||||
|
||||
当你需要 QA-lab 真实度时,这些命令与主测试套件并列使用:
|
||||
当你需要 QA-lab 的真实感时,这些命令与主测试套件并列使用:
|
||||
|
||||
CI 在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上运行,也可通过手动派发使用 mock 提供商运行。`QA-Lab - All Lanes` 每晚在
|
||||
`main` 上运行,也可通过手动派发运行,并将 mock parity gate、live Matrix 通道、
|
||||
Convex 管理的 live Telegram 通道和 Convex 管理的 live Discord 通道作为
|
||||
并行作业。定时 QA 和发布检查会显式传递 Matrix `--profile fast`,
|
||||
而 Matrix CLI 和手动工作流输入默认值仍为
|
||||
`all`;手动派发可以将 `all` 分片为 `transport`、`media`、`e2ee-smoke`、
|
||||
`e2ee-deep` 和 `e2ee-cli` 作业。`OpenClaw Release Checks` 会在发布批准前运行 parity 以及
|
||||
fast Matrix 和 Telegram 通道,并使用
|
||||
`mock-openai/gpt-5.5` 进行发布传输检查,从而保持确定性
|
||||
并避免普通提供商插件启动。这些 live 传输 Gateway 网关会禁用
|
||||
记忆搜索;记忆行为仍由 QA parity 套件覆盖。
|
||||
CI 会在专用工作流中运行 QA Lab。`Parity gate` 会在匹配的 PR 上运行,也会通过手动分发配合 mock 提供商运行。`QA-Lab - All Lanes` 每晚在
|
||||
`main` 上运行,也可通过手动分发运行,并将 mock parity gate、live Matrix 通道、Convex 管理的 live Telegram 通道和 Convex 管理的 live Discord 通道作为并行作业运行。计划 QA 和发布检查会显式传递 Matrix `--profile fast`,而 Matrix CLI 和手动工作流输入的默认值仍为
|
||||
`all`;手动分发可以将 `all` 分片为 `transport`、`media`、`e2ee-smoke`、
|
||||
`e2ee-deep` 和 `e2ee-cli` 作业。`OpenClaw Release Checks` 会在发布批准前运行 parity,以及 fast Matrix 和 Telegram 通道,发布传输检查使用
|
||||
`mock-openai/gpt-5.5`,以保持确定性并避开常规提供商插件启动。这些 live 传输 Gateway 网关会禁用记忆搜索;记忆行为仍由 QA parity 测试套件覆盖。
|
||||
|
||||
完整发布 live media 分片使用
|
||||
完整发布 live 媒体分片使用
|
||||
`ghcr.io/openclaw/openclaw-live-media-runner:ubuntu-24.04`,其中已经包含
|
||||
`ffmpeg` 和 `ffprobe`。Docker live 模型/后端分片使用共享的
|
||||
`ghcr.io/openclaw/openclaw-live-test:<sha>` 镜像,该镜像会为每个选定的
|
||||
提交构建一次,然后用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 拉取它,而不是在每个分片中重新构建。
|
||||
`ghcr.io/openclaw/openclaw-live-test:<sha>` 镜像,该镜像会为每个选中的提交构建一次,然后用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 拉取,而不是在每个分片内部重新构建。
|
||||
|
||||
- `pnpm openclaw qa suite`
|
||||
- 直接在主机上运行由仓库支持的 QA 场景。
|
||||
- 默认通过隔离的 Gateway 网关 worker 并行运行多个选定场景。`qa-channel` 默认并发数为 4(受选定场景数量限制)。使用 `--concurrency <count>` 调整 worker 数量,或使用 `--concurrency 1` 运行较旧的串行通道。
|
||||
- 当任何场景失败时以非零状态退出。当你想要保留产物但不想要失败退出码时,使用 `--allow-failures`。
|
||||
- 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。`aimock` 会启动一个本地 AIMock 支持的提供商服务器,用于实验性夹具和协议模拟覆盖,同时不会替换具备场景感知能力的 `mock-openai` 通道。
|
||||
- 默认使用隔离的 Gateway 网关 worker 并行运行多个选定场景。`qa-channel` 默认并发数为 4(受选定场景数量限制)。使用 `--concurrency <count>` 调整 worker 数量,或使用 `--concurrency 1` 进入旧版串行通道。
|
||||
- 任一场景失败时以非零状态退出。当你想获取构件但不想要失败退出代码时,使用 `--allow-failures`。
|
||||
- 支持提供商模式 `live-frontier`、`mock-openai` 和 `aimock`。`aimock` 会启动一个本地 AIMock 支持的提供商服务器,用于实验性 fixture 和协议模拟覆盖,同时不会替代具备场景感知能力的 `mock-openai` 通道。
|
||||
- `pnpm test:gateway:cpu-scenarios`
|
||||
- 运行 Gateway 网关启动基准测试以及一个小型模拟 QA Lab 场景包(`channel-chat-baseline`、`memory-failure-fallback`、`gateway-restart-inflight-run`),并在 `.artifacts/gateway-cpu-scenarios/` 下写入合并后的 CPU 观察摘要。
|
||||
- 默认只标记持续性高 CPU 观察结果(`--cpu-core-warn` 加 `--hot-wall-warn-ms`),因此短暂的启动突增会作为指标记录,而不会看起来像持续数分钟的 Gateway 网关占满回归。
|
||||
- 使用构建好的 `dist` 产物;当检出目录还没有最新运行时输出时,先运行构建。
|
||||
- 运行 Gateway 网关启动基准测试,以及一组小型模拟 QA Lab 场景包(`channel-chat-baseline`、`memory-failure-fallback`、`gateway-restart-inflight-run`),并在 `.artifacts/gateway-cpu-scenarios/` 下写入合并后的 CPU 观测摘要。
|
||||
- 默认仅标记持续的高 CPU 观测(`--cpu-core-warn` 加 `--hot-wall-warn-ms`),因此短暂的启动突增会被记录为指标,而不会看起来像持续数分钟的 Gateway 网关占满回归问题。
|
||||
- 使用已构建的 `dist` 构件;当检出内容尚无新鲜运行时输出时,请先运行构建。
|
||||
- `pnpm openclaw qa suite --runner multipass`
|
||||
- 在一次性 Multipass Linux VM 内运行同一套 QA。
|
||||
- 在一次性 Multipass Linux VM 内运行相同的 QA 套件。
|
||||
- 保持与主机上 `qa suite` 相同的场景选择行为。
|
||||
- 复用与 `qa suite` 相同的提供商/模型选择标志。
|
||||
- 实时运行会转发对 guest 实用的受支持 QA 凭证输入:基于环境变量的提供商密钥、QA 实时提供商配置路径,以及存在时的 `CODEX_HOME`。
|
||||
- 输出目录必须保留在仓库根目录下,这样 guest 才能通过挂载的工作区写回。
|
||||
- 在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告、摘要以及 Multipass 日志。
|
||||
- Live 运行会转发对 guest 实用的受支持 QA 凭证输入:基于环境变量的提供商密钥、QA live 提供商配置路径,以及存在时的 `CODEX_HOME`。
|
||||
- 输出目录必须保留在仓库根目录下,以便 guest 通过挂载的工作区写回。
|
||||
- 在 `.artifacts/qa-e2e/...` 下写入常规 QA 报告和摘要以及 Multipass 日志。
|
||||
- `pnpm qa:lab:up`
|
||||
- 启动 Docker 支持的 QA 站点,用于操作员式 QA 工作。
|
||||
- 启动由 Docker 支持的 QA 站点,用于操作员风格的 QA 工作。
|
||||
- `pnpm test:docker:npm-onboard-channel-agent`
|
||||
- 从当前检出构建 npm tarball,在 Docker 中全局安装它,运行非交互式 OpenAI API 密钥新手引导,默认配置 Telegram,验证打包后的插件运行时可在无启动依赖修复的情况下加载,运行 Doctor,并针对一个模拟的 OpenAI 端点运行一次本地智能体轮次。
|
||||
- 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 通过 Discord 运行同一打包安装通道。
|
||||
- 从当前检出内容构建 npm tarball,在 Docker 中全局安装它,运行非交互式 OpenAI API key 新手引导,默认配置 Telegram,验证打包后的插件运行时可在没有启动依赖修复的情况下加载,运行 Doctor,并针对模拟的 OpenAI 端点运行一次本地智能体回合。
|
||||
- 使用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 可使用 Discord 运行相同的打包安装通道。
|
||||
- `pnpm test:docker:session-runtime-context`
|
||||
- 为嵌入式运行时上下文转录运行一个确定性的已构建应用 Docker 冒烟测试。它会验证隐藏的 OpenClaw 运行时上下文作为非显示自定义消息持久化,而不是泄漏到可见的用户轮次中,然后植入一个受影响的损坏会话 JSONL,并验证 `openclaw doctor --fix` 会将其重写到当前活跃分支并创建备份。
|
||||
- 为嵌入式运行时上下文 transcript 运行确定性的已构建应用 Docker smoke。它会验证隐藏的 OpenClaw 运行时上下文作为非显示自定义消息被持久化,而不是泄漏到可见的用户回合中,然后注入一个受影响的损坏会话 JSONL,并验证 `openclaw doctor --fix` 会用备份将其重写到活动分支。
|
||||
- `pnpm test:docker:npm-telegram-live`
|
||||
- 在 Docker 中安装一个 OpenClaw 包候选版本,运行已安装包的新手引导,通过已安装的 CLI 配置 Telegram,然后复用实时 Telegram QA 通道,并将该已安装包作为被测系统 Gateway 网关。
|
||||
- 默认值为 `OPENCLAW_NPM_TELEGRAM_PACKAGE_SPEC=openclaw@beta`;设置 `OPENCLAW_NPM_TELEGRAM_PACKAGE_TGZ=/path/to/openclaw-current.tgz` 或 `OPENCLAW_CURRENT_PACKAGE_TGZ` 可测试已解析的本地 tarball,而不是从 registry 安装。
|
||||
- 使用与 `pnpm openclaw qa telegram` 相同的 Telegram 环境变量凭据或 Convex 凭据来源。对于 CI/发布自动化,设置 `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_SOURCE=convex`,再加上 `OPENCLAW_QA_CONVEX_SITE_URL` 和角色密钥。如果 CI 中存在 `OPENCLAW_QA_CONVEX_SITE_URL` 和 Convex 角色密钥,Docker 包装器会自动选择 Convex。
|
||||
- `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_ROLE=ci|maintainer` 仅针对该通道覆盖共享的 `OPENCLAW_QA_CREDENTIAL_ROLE`。
|
||||
- GitHub Actions 将该通道作为手动维护者工作流 `NPM Telegram Beta E2E` 暴露。它不会在合并时运行。该工作流使用 `qa-live-shared` 环境和 Convex CI 凭据租约。
|
||||
- GitHub Actions 还暴露 `Package Acceptance`,用于针对一个候选包进行旁路产品验证。它接受可信 ref、已发布的 npm spec、HTTPS tarball URL 加 SHA-256,或来自另一次运行的 tarball 产物,将标准化后的 `openclaw-current.tgz` 上传为 `package-under-test`,然后使用冒烟、包、产品、完整或自定义通道配置文件运行现有 Docker E2E 调度器。设置 `telegram_mode=mock-openai` 或 `live-frontier` 可让 Telegram QA 工作流针对同一个 `package-under-test` 产物运行。
|
||||
- 最新 beta 产品验证:
|
||||
- 在 Docker 中安装一个 OpenClaw 包候选版本,运行已安装包的新手引导,通过已安装的 CLI 配置 Telegram,然后复用 live Telegram QA 通道,并将该已安装包作为 SUT Gateway 网关。
|
||||
- 默认值为 `OPENCLAW_NPM_TELEGRAM_PACKAGE_SPEC=openclaw@beta`;设置 `OPENCLAW_NPM_TELEGRAM_PACKAGE_TGZ=/path/to/openclaw-current.tgz` 或 `OPENCLAW_CURRENT_PACKAGE_TGZ`,即可测试已解析的本地 tarball,而不是从注册表安装。
|
||||
- 使用与 `pnpm openclaw qa telegram` 相同的 Telegram 环境变量凭据或 Convex 凭据来源。对于 CI/发布自动化,请设置 `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_SOURCE=convex`,以及 `OPENCLAW_QA_CONVEX_SITE_URL` 和角色密钥。如果 `OPENCLAW_QA_CONVEX_SITE_URL` 和一个 Convex 角色密钥存在于 CI 中,Docker 包装器会自动选择 Convex。
|
||||
- `OPENCLAW_NPM_TELEGRAM_CREDENTIAL_ROLE=ci|maintainer` 仅为此通道覆盖共享的 `OPENCLAW_QA_CREDENTIAL_ROLE`。
|
||||
- GitHub Actions 将此通道公开为手动维护者 workflow `NPM Telegram Beta E2E`。它不会在合并时运行。该 workflow 使用 `qa-live-shared` 环境和 Convex CI 凭据租约。
|
||||
- GitHub Actions 还公开了 `Package Acceptance`,用于针对一个候选包进行旁路产品证明。它接受受信任的 ref、已发布的 npm spec、HTTPS tarball URL 加 SHA-256,或来自另一运行的 tarball artifact,上传规范化的 `openclaw-current.tgz` 作为 `package-under-test`,然后使用 smoke、package、product、full 或 custom 通道 profile 运行现有 Docker E2E 调度器。设置 `telegram_mode=mock-openai` 或 `live-frontier`,可针对同一个 `package-under-test` 构件运行 Telegram QA workflow。
|
||||
- 最新 beta 产品证明:
|
||||
|
||||
```bash
|
||||
gh workflow run package-acceptance.yml --ref main \
|
||||
@ -171,7 +152,7 @@ gh workflow run package-acceptance.yml --ref main \
|
||||
-f telegram_mode=mock-openai
|
||||
```
|
||||
|
||||
- 精确 tarball URL 验证需要摘要:
|
||||
- 精确 tarball URL 证明需要摘要:
|
||||
|
||||
```bash
|
||||
gh workflow run package-acceptance.yml --ref main \
|
||||
@ -181,7 +162,7 @@ gh workflow run package-acceptance.yml --ref main \
|
||||
-f suite_profile=package
|
||||
```
|
||||
|
||||
- 产物验证会从另一次 Actions 运行下载 tarball 产物:
|
||||
- 构件证明会从另一个 Actions 运行下载 tarball artifact:
|
||||
|
||||
```bash
|
||||
gh workflow run package-acceptance.yml --ref main \
|
||||
@ -192,44 +173,44 @@ gh workflow run package-acceptance.yml --ref main \
|
||||
```
|
||||
|
||||
- `pnpm test:docker:plugins`
|
||||
- 在 Docker 中打包并安装当前 OpenClaw 构建,启动已配置 OpenAI 的 Gateway 网关,然后通过配置编辑启用内置渠道/插件。
|
||||
- 验证设置发现会让未配置的可下载插件保持缺失,第一次配置后的 Doctor 修复会显式安装每个缺失的可下载插件,并且第二次重启不会运行隐藏依赖修复。
|
||||
- 还会安装一个已知较旧的 npm 基线,在运行 `openclaw update --tag <candidate>` 之前启用 Telegram,并验证候选版本的更新后 Doctor 会清理遗留插件依赖残留,而不需要 harness 侧 postinstall 修复。
|
||||
- 在 Docker 中打包并安装当前 OpenClaw 构建,启动配置了 OpenAI 的 Gateway 网关,然后通过配置编辑启用内置渠道/插件。
|
||||
- 验证设置发现会让未配置的可下载插件保持缺席,第一次配置后的 Doctor 修复会显式安装每个缺失的可下载插件,并且第二次重启不会运行隐藏依赖修复。
|
||||
- 还会安装一个已知较旧的 npm 基线,在运行 `openclaw update --tag <candidate>` 前启用 Telegram,并验证候选版本的更新后 Doctor 会清理旧版插件依赖残留,而无需 harness 侧 postinstall 修复。
|
||||
- `pnpm test:parallels:npm-update`
|
||||
- 跨 Parallels guest 运行原生打包安装更新冒烟测试。每个选定平台会先安装请求的基线包,然后在同一个 guest 中运行已安装的 `openclaw update` 命令,并验证已安装版本、更新状态、Gateway 网关就绪性,以及一次本地智能体轮次。
|
||||
- 迭代单个 guest 时使用 `--platform macos`、`--platform windows` 或 `--platform linux`。使用 `--json` 获取摘要产物路径和每个通道的状态。
|
||||
- OpenAI 通道默认使用 `openai/gpt-5.5` 进行实时智能体轮次验证。若有意验证另一个 OpenAI 模型,请传入 `--model <provider/model>` 或设置 `OPENCLAW_PARALLELS_OPENAI_MODEL`。
|
||||
- 将长时间本地运行包裹在主机超时中,这样 Parallels 传输卡顿就不会消耗剩余的测试窗口:
|
||||
- 跨 Parallels guest 运行原生打包安装更新 smoke。每个选定平台会先安装请求的基线包,然后在同一个 guest 中运行已安装的 `openclaw update` 命令,并验证已安装版本、更新状态、Gateway 网关就绪性,以及一次本地智能体回合。
|
||||
- 在迭代单个 guest 时使用 `--platform macos`、`--platform windows` 或 `--platform linux`。使用 `--json` 获取摘要构件路径和每个通道的状态。
|
||||
- OpenAI 通道默认使用 `openai/gpt-5.5` 进行 live 智能体回合证明。若要有意验证另一个 OpenAI 模型,请传入 `--model <provider/model>` 或设置 `OPENCLAW_PARALLELS_OPENAI_MODEL`。
|
||||
- 用主机超时包装长时间本地运行,避免 Parallels 传输停滞耗尽剩余测试窗口:
|
||||
|
||||
```bash
|
||||
timeout --foreground 150m pnpm test:parallels:npm-update -- --json
|
||||
timeout --foreground 90m pnpm test:parallels:npm-update -- --platform windows --json
|
||||
```
|
||||
|
||||
- 该脚本会在 `/tmp/openclaw-parallels-npm-update.*` 下写入嵌套通道日志。在假设外层包装器挂起之前,先检查 `windows-update.log`、`macos-update.log` 或 `linux-update.log`。
|
||||
- 在冷 guest 上,Windows 更新可能会在更新后 Doctor 和包更新工作中花费 10 到 15 分钟;只要嵌套 npm 调试日志在推进,这仍然是健康状态。
|
||||
- 不要将此聚合包装器与单独的 Parallels macOS、Windows 或 Linux 冒烟通道并行运行。它们共享 VM 状态,可能会在快照恢复、包服务或 guest Gateway 网关状态上发生冲突。
|
||||
- 更新后验证会运行常规内置插件表面,因为语音、图像生成和媒体理解等能力 facade 会通过内置运行时 API 加载,即使智能体轮次本身只检查一个简单文本响应。
|
||||
- 该脚本会在 `/tmp/openclaw-parallels-npm-update.*` 下写入嵌套通道日志。在假定外层包装器挂起之前,请检查 `windows-update.log`、`macos-update.log` 或 `linux-update.log`。
|
||||
- 在冷 guest 上,Windows 更新可能在更新后 Doctor 和包更新工作中花费 10 到 15 分钟;只要嵌套的 npm debug 日志仍在推进,这仍然是健康状态。
|
||||
- 不要将此聚合包装器与单独的 Parallels macOS、Windows 或 Linux smoke 通道并行运行。它们共享 VM 状态,可能在快照恢复、包服务或 guest Gateway 网关状态上发生冲突。
|
||||
- 更新后证明会运行常规内置插件表面,因为 speech、图像生成和媒体理解等能力 facade 会通过内置运行时 API 加载,即使智能体回合本身只检查简单文本响应。
|
||||
|
||||
- `pnpm openclaw qa aimock`
|
||||
- 仅启动本地 AIMock 提供商服务器,用于直接协议冒烟测试。
|
||||
- 仅启动本地 AIMock 提供商服务器,用于直接协议 smoke 测试。
|
||||
- `pnpm openclaw qa matrix`
|
||||
- 针对一次性 Docker 支持的 Tuwunel homeserver 运行 Matrix 实时 QA 通道。仅限源码检出目录——打包安装不会随附 `qa-lab`。
|
||||
- 完整 CLI、配置文件/场景目录、环境变量和产物布局:[Matrix QA](/zh-CN/concepts/qa-matrix)。
|
||||
- 针对一次性 Docker 支持的 Tuwunel homeserver 运行 Matrix live QA 通道。仅限源代码检出,打包安装不会随附 `qa-lab`。
|
||||
- 完整 CLI、profile/场景目录、环境变量和构件布局:[Matrix QA](/zh-CN/concepts/qa-matrix)。
|
||||
- `pnpm openclaw qa telegram`
|
||||
- 使用来自环境变量的驱动程序和被测系统 bot token,针对真实私有群组运行 Telegram 实时 QA 通道。
|
||||
- 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。群组 id 必须是数字形式的 Telegram 聊天 id。
|
||||
- 支持 `--credential-source convex` 以使用共享池化凭据。默认使用环境变量模式,或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 以选择池化租约。
|
||||
- 当任何场景失败时以非零状态退出。当你想要保留产物但不想要失败退出码时,使用 `--allow-failures`。
|
||||
- 需要同一私有群组中的两个不同 bot,且被测系统 bot 需暴露 Telegram 用户名。
|
||||
- 为获得稳定的 bot 到 bot 观察效果,请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode,并确保驱动 bot 可以观察群组 bot 流量。
|
||||
- 在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 产物。回复场景包含从驱动发送请求到观察到被测系统回复的 RTT。
|
||||
- 使用来自环境变量的 driver 和 SUT bot token,针对真实私有群组运行 Telegram live QA 通道。
|
||||
- 需要 `OPENCLAW_QA_TELEGRAM_GROUP_ID`、`OPENCLAW_QA_TELEGRAM_DRIVER_BOT_TOKEN` 和 `OPENCLAW_QA_TELEGRAM_SUT_BOT_TOKEN`。群组 id 必须是数字 Telegram chat id。
|
||||
- 支持 `--credential-source convex` 以使用共享池化凭据。默认使用环境变量模式,或设置 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex` 选择加入池化租约。
|
||||
- 任一场景失败时以非零状态退出。当你想获取构件但不想要失败退出代码时,使用 `--allow-failures`。
|
||||
- 需要同一私有群组中的两个不同 bot,且 SUT bot 需要暴露 Telegram username。
|
||||
- 为获得稳定的 bot 间观测,请在 `@BotFather` 中为两个 bot 启用 Bot-to-Bot Communication Mode,并确保 driver bot 可以观测群组 bot 流量。
|
||||
- 在 `.artifacts/qa-e2e/...` 下写入 Telegram QA 报告、摘要和 observed-messages 构件。回复场景包含从 driver 发送请求到观测到 SUT 回复的 RTT。
|
||||
|
||||
实时传输通道共享一个标准契约,避免新传输发生漂移;每个通道的覆盖矩阵位于 [QA overview → 实时传输覆盖范围](/zh-CN/concepts/qa-e2e-automation#live-transport-coverage)。`qa-channel` 是广泛的合成套件,不属于该矩阵。
|
||||
Live 传输通道共享一个标准契约,因此新传输不会漂移;每个通道的覆盖矩阵位于 [QA overview → Live transport coverage](/zh-CN/concepts/qa-e2e-automation#live-transport-coverage)。`qa-channel` 是广泛的合成套件,不属于该矩阵。
|
||||
|
||||
### 通过 Convex 共享 Telegram 凭据(v1)
|
||||
|
||||
为 `openclaw qa telegram` 启用 `--credential-source convex`(或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`)时,QA lab 会从 Convex 支持的池中获取独占租约,在通道运行期间对该租约发送 Heartbeat,并在关闭时释放租约。
|
||||
当为 `openclaw qa telegram` 启用 `--credential-source convex`(或 `OPENCLAW_QA_CREDENTIAL_SOURCE=convex`)时,QA lab 会从 Convex 支持的池中获取独占租约,在通道运行期间为该租约发送 Heartbeat,并在关闭时释放租约。
|
||||
|
||||
参考 Convex 项目脚手架:
|
||||
|
||||
@ -243,7 +224,7 @@ gh workflow run package-acceptance.yml --ref main \
|
||||
- `OPENCLAW_QA_CONVEX_SECRET_CI` 用于 `ci`
|
||||
- 凭据角色选择:
|
||||
- CLI:`--credential-role maintainer|ci`
|
||||
- 环境变量默认值:`OPENCLAW_QA_CREDENTIAL_ROLE`(在 CI 中默认为 `ci`,其他情况下默认为 `maintainer`)
|
||||
- 环境变量默认值:`OPENCLAW_QA_CREDENTIAL_ROLE`(在 CI 中默认为 `ci`,否则默认为 `maintainer`)
|
||||
|
||||
可选环境变量:
|
||||
|
||||
@ -252,14 +233,14 @@ gh workflow run package-acceptance.yml --ref main \
|
||||
- `OPENCLAW_QA_CREDENTIAL_ACQUIRE_TIMEOUT_MS`(默认 `90000`)
|
||||
- `OPENCLAW_QA_CREDENTIAL_HTTP_TIMEOUT_MS`(默认 `15000`)
|
||||
- `OPENCLAW_QA_CONVEX_ENDPOINT_PREFIX`(默认 `/qa-credentials/v1`)
|
||||
- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`(可选跟踪 id)
|
||||
- `OPENCLAW_QA_ALLOW_INSECURE_HTTP=1` 允许用于仅本地开发的 loopback `http://` Convex URL。
|
||||
- `OPENCLAW_QA_CREDENTIAL_OWNER_ID`(可选 trace id)
|
||||
- `OPENCLAW_QA_ALLOW_INSECURE_HTTP=1` 允许仅用于本地开发的 loopback `http://` Convex URL。
|
||||
|
||||
正常运行中,`OPENCLAW_QA_CONVEX_SITE_URL` 应使用 `https://`。
|
||||
`OPENCLAW_QA_CONVEX_SITE_URL` 在常规操作中应使用 `https://`。
|
||||
|
||||
维护者管理员命令(池 add/remove/list)明确需要 `OPENCLAW_QA_CONVEX_SECRET_MAINTAINER`。
|
||||
|
||||
维护者 CLI 辅助命令:
|
||||
维护者 CLI helper:
|
||||
|
||||
```bash
|
||||
pnpm openclaw qa credentials doctor
|
||||
@ -268,7 +249,7 @@ pnpm openclaw qa credentials list --kind telegram
|
||||
pnpm openclaw qa credentials remove --credential-id <credential-id>
|
||||
```
|
||||
|
||||
实时运行前使用 `doctor` 检查 Convex 站点 URL、broker 密钥、端点前缀、HTTP 超时,以及 admin/list 可达性,且不会打印密钥值。在脚本和 CI 工具中使用 `--json` 获取机器可读输出。
|
||||
在 live 运行前使用 `doctor` 检查 Convex site URL、broker 密钥、端点前缀、HTTP 超时和 admin/list 可达性,且不会打印密钥值。在脚本和 CI 工具中使用 `--json` 获取机器可读输出。
|
||||
|
||||
默认端点契约(`OPENCLAW_QA_CONVEX_SITE_URL` + `/qa-credentials/v1`):
|
||||
|
||||
@ -288,7 +269,7 @@ pnpm openclaw qa credentials remove --credential-id <credential-id>
|
||||
- `POST /admin/remove`(仅限维护者密钥)
|
||||
- 请求:`{ credentialId, actorId }`
|
||||
- 成功:`{ status: "ok", changed, credential }`
|
||||
- 活跃租约保护:`{ status: "error", code: "LEASE_ACTIVE", ... }`
|
||||
- 活动租约保护:`{ status: "error", code: "LEASE_ACTIVE", ... }`
|
||||
- `POST /admin/list`(仅限维护者密钥)
|
||||
- 请求:`{ kind?, status?, includePayload?, limit? }`
|
||||
- 成功:`{ status: "ok", credentials, count }`
|
||||
@ -296,63 +277,61 @@ pnpm openclaw qa credentials remove --credential-id <credential-id>
|
||||
Telegram 类型的载荷形状:
|
||||
|
||||
- `{ groupId: string, driverToken: string, sutToken: string }`
|
||||
- `groupId` 必须是数字形式的 Telegram 聊天 ID 字符串。
|
||||
- `admin/add` 会对 `kind: "telegram"` 校验此形状,并拒绝格式错误的载荷。
|
||||
- `groupId` 必须是数字形式的 Telegram chat id 字符串。
|
||||
- `admin/add` 会针对 `kind: "telegram"` 验证此形状,并拒绝格式错误的载荷。
|
||||
|
||||
### 向 QA 添加渠道
|
||||
|
||||
新渠道适配器的架构和场景辅助函数名称位于 [QA overview → 添加渠道](/zh-CN/concepts/qa-e2e-automation#adding-a-channel)。最低要求:在共享的 `qa-lab` 主机衔接层上实现传输运行器,在插件清单中声明 `qaRunners`,挂载为 `openclaw qa <runner>`,并在 `qa/scenarios/` 下编写场景。
|
||||
新渠道适配器的架构和场景辅助程序名称位于 [QA overview → 添加渠道](/zh-CN/concepts/qa-e2e-automation#adding-a-channel)。最低要求:在共享 `qa-lab` 主机接缝上实现传输运行器,在插件清单中声明 `qaRunners`,挂载为 `openclaw qa <runner>`,并在 `qa/scenarios/` 下编写场景。
|
||||
|
||||
## 测试套件(在哪里运行什么)
|
||||
|
||||
可以把这些套件理解为“现实程度递增”(同时不稳定性/成本也递增):
|
||||
可以把这些套件看作“现实程度递增”(同时不稳定性/成本也递增):
|
||||
|
||||
### 单元 / 集成(默认)
|
||||
|
||||
- 命令:`pnpm test`
|
||||
- 配置:未定向运行使用 `vitest.full-*.config.ts` 分片集,并且可能会将多项目分片展开为每项目配置,以便并行调度
|
||||
- 配置:无目标运行使用 `vitest.full-*.config.ts` 分片集,并可能将多项目分片展开为按项目的配置,以便并行调度
|
||||
- 文件:`src/**/*.test.ts`、`packages/**/*.test.ts` 和 `test/**/*.test.ts` 下的核心/单元清单;UI 单元测试在专用的 `unit-ui` 分片中运行
|
||||
- 范围:
|
||||
- 纯单元测试
|
||||
- 进程内集成测试(Gateway 网关认证、路由、工具、解析、配置)
|
||||
- 已知 bug 的确定性回归测试
|
||||
- 针对已知 bug 的确定性回归测试
|
||||
- 预期:
|
||||
- 在 CI 中运行
|
||||
- 不需要真实密钥
|
||||
- 应该快速且稳定
|
||||
- 解析器和公共表面加载器测试必须使用生成的微型插件夹具证明广义 `api.js` 和
|
||||
`runtime-api.js` 回退行为,而不是使用真实内置插件源 API。真实插件 API 加载应属于
|
||||
插件自有的契约/集成套件。
|
||||
- 应当快速且稳定
|
||||
- 解析器和公开表面加载器测试必须使用生成的微型插件夹具来证明宽泛的 `api.js` 和
|
||||
`runtime-api.js` 回退行为,而不是使用真实内置插件源 API。真实插件 API 加载应放在
|
||||
插件自有的契约/集成套件中。
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="项目、分片和作用域通道">
|
||||
<Accordion title="项目、分片和作用域化通道">
|
||||
|
||||
- 未定向的 `pnpm test` 会运行十二个更小的分片配置(`core-unit-fast`、`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 路径展开为便宜的作用域通道:直接测试编辑、同级 `*.test.ts` 文件、明确源映射,以及本地导入图依赖项。配置/设置/package 编辑不会广泛运行测试,除非你明确使用 `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`。
|
||||
- `pnpm check:changed` 是窄范围工作的常规智能本地检查门禁。它会将差异分类为核心、核心测试、插件、插件测试、应用、文档、发布元数据、实时 Docker 工具和工具链,然后运行匹配的类型检查、lint 和保护命令。它不会运行 Vitest 测试;如需测试证明,请调用 `pnpm test:changed` 或明确的 `pnpm test <target>`。仅发布元数据的版本提升会运行定向版本/配置/根依赖检查,并带有一个保护项,用于拒绝顶层版本字段之外的 package 变更。
|
||||
- 实时 Docker ACP harness 编辑会运行聚焦检查:实时 Docker 认证脚本的 shell 语法和实时 Docker 调度器空跑。仅当差异局限于 `scripts["test:docker:live-*"]` 时,才会包含 `package.json` 变更;依赖、导出、版本和其他 package 表面编辑仍使用更广的保护项。
|
||||
- 来自智能体、命令、插件、auto-reply 辅助函数、`plugin-sdk` 和类似纯工具区域的轻导入单元测试会通过 `unit-fast` 通道路由,该通道会跳过 `test/setup-openclaw-runtime.ts`;有状态/运行时较重的文件仍留在现有通道上。
|
||||
- 选定的 `plugin-sdk` 和 `commands` 辅助源文件也会将 changed-mode 运行映射到这些轻量通道中的明确同级测试,因此辅助函数编辑可以避免重新运行该目录的完整重型套件。
|
||||
- `auto-reply` 为顶层核心辅助函数、顶层 `reply.*` 集成测试,以及 `src/auto-reply/reply/**` 子树提供了专用桶。CI 还会进一步把 reply 子树拆分为 agent-runner、dispatch 和 commands/state-routing 分片,避免某个导入较重的桶独占完整 Node 尾部耗时。
|
||||
- 常规 PR/main CI 会有意跳过插件批量扫描和仅发布使用的 `agentic-plugins` 分片。完整发布验证会为发布候选版本上的这些插件/扩展较重套件分派单独的 `Plugin Prerelease` 子工作流。
|
||||
- 无目标 `pnpm test` 会运行十二个较小的分片配置(`core-unit-fast`、`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` 默认会把变更的 git 路径展开为低成本的作用域化通道:直接测试编辑、同级 `*.test.ts` 文件、显式源映射,以及本地导入图依赖项。配置/设置/包编辑不会广泛运行测试,除非你显式使用 `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`。
|
||||
- `pnpm check:changed` 是窄范围工作的常规智能本地检查门禁。它会将 diff 分类为核心、核心测试、插件、插件测试、应用、文档、发布元数据、实时 Docker 工具和工具链,然后运行匹配的类型检查、lint 和保护命令。它不运行 Vitest 测试;需要测试证明时调用 `pnpm test:changed` 或显式 `pnpm test <target>`。仅发布元数据的版本提升会运行定向版本/配置/根依赖检查,并带有保护,拒绝顶层版本字段之外的包变更。
|
||||
- 实时 Docker ACP harness 编辑会运行聚焦检查:实时 Docker 认证脚本的 shell 语法,以及实时 Docker 调度器空运行。只有当 diff 限于 `scripts["test:docker:live-*"]` 时才包含 `package.json` 变更;依赖、导出、版本和其他包表面编辑仍使用更宽泛的保护。
|
||||
- 来自 agents、commands、plugins、auto-reply helpers、`plugin-sdk` 以及类似纯工具区域的轻导入单元测试会路由到 `unit-fast` 通道,该通道会跳过 `test/setup-openclaw-runtime.ts`;有状态/运行时较重的文件仍保留在现有通道上。
|
||||
- 选定的 `plugin-sdk` 和 `commands` 辅助源文件也会把变更模式运行映射到这些轻量通道中的显式同级测试,因此辅助程序编辑可以避免为该目录重新运行完整的重型套件。
|
||||
- `auto-reply` 为顶层核心辅助程序、顶层 `reply.*` 集成测试和 `src/auto-reply/reply/**` 子树设置了专用桶。CI 还会将 reply 子树进一步拆分为 agent-runner、dispatch 和 commands/state-routing 分片,避免某个导入繁重的桶独占完整的 Node 尾部时间。
|
||||
- 常规 PR/main CI 有意跳过插件批量扫描和仅发布使用的 `agentic-plugins` 分片。完整发布验证会为发布候选上的这些插件/插件繁重套件调度单独的 `Plugin Prerelease` 子工作流。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="嵌入式运行器覆盖率">
|
||||
<Accordion title="嵌入式运行器覆盖">
|
||||
|
||||
- 当你变更消息工具发现输入或压缩运行时
|
||||
- 当你更改消息工具发现输入或压缩运行时
|
||||
上下文时,请保留两个层级的覆盖。
|
||||
- 为纯路由和规范化
|
||||
边界添加聚焦的辅助函数回归测试。
|
||||
- 为纯路由和规范化边界添加聚焦辅助回归测试。
|
||||
- 保持嵌入式运行器集成套件健康:
|
||||
`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` 路径;仅辅助程序测试不足以替代这些集成路径。
|
||||
|
||||
</Accordion>
|
||||
|
||||
@ -361,63 +340,62 @@ Telegram 类型的载荷形状:
|
||||
- 基础 Vitest 配置默认使用 `threads`。
|
||||
- 共享 Vitest 配置固定 `isolate: false`,并在根项目、e2e 和实时配置中使用
|
||||
非隔离运行器。
|
||||
- 根 UI 通道保留其 `jsdom` 设置和优化器,但也运行在
|
||||
共享非隔离运行器上。
|
||||
- 每个 `pnpm test` 分片都会从共享 Vitest 配置继承相同的 `threads` + `isolate: false`
|
||||
- 根 UI 通道保留其 `jsdom` 设置和优化器,但同样运行在
|
||||
共享的非隔离运行器上。
|
||||
- 每个 `pnpm test` 分片都从共享 Vitest 配置继承相同的 `threads` + `isolate: false`
|
||||
默认值。
|
||||
- `scripts/run-vitest.mjs` 默认会为 Vitest 子 Node
|
||||
进程添加 `--no-maglev`,以减少大型本地运行期间的 V8 编译抖动。
|
||||
设置 `OPENCLAW_VITEST_ENABLE_MAGLEV=1` 可与原版 V8
|
||||
行为对比。
|
||||
行为进行比较。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="快速本地迭代">
|
||||
|
||||
- `pnpm changed:lanes` 会显示差异触发哪些架构通道。
|
||||
- 预提交钩子只做格式化。它会重新暂存格式化后的文件,
|
||||
不会运行 lint、类型检查或测试。
|
||||
- 当你需要智能本地检查门禁时,在交接或推送前明确运行 `pnpm check:changed`。
|
||||
- `pnpm test:changed` 默认会通过便宜的作用域通道路由。仅当智能体
|
||||
判断 harness、配置、package 或契约编辑确实需要更广的
|
||||
- `pnpm changed:lanes` 会显示 diff 触发哪些架构通道。
|
||||
- pre-commit 钩子仅执行格式化。它会重新暂存已格式化文件,并且
|
||||
不运行 lint、类型检查或测试。
|
||||
- 当你需要智能本地检查门禁时,在交接或推送前显式运行 `pnpm check:changed`。
|
||||
- `pnpm test:changed` 默认通过低成本作用域化通道路由。只有当智能体
|
||||
判定 harness、配置、包或契约编辑确实需要更广泛的
|
||||
Vitest 覆盖时,才使用 `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`。
|
||||
- `pnpm test:max` 和 `pnpm test:changed:max` 保持相同的路由
|
||||
行为,只是 worker 上限更高。
|
||||
- 本地 worker 自动扩缩有意保守,并且在主机平均负载已经很高时会回退,
|
||||
- `pnpm test:max` 和 `pnpm test:changed:max` 保持相同路由
|
||||
行为,只是使用更高的 worker 上限。
|
||||
- 本地 worker 自动缩放有意保持保守,并在主机负载平均值已经很高时回退,
|
||||
因此多个并发
|
||||
Vitest 运行默认会造成更少影响。
|
||||
- 基础 Vitest 配置将项目/配置文件标记为
|
||||
`forceRerunTriggers`,因此当测试
|
||||
接线变更时,changed-mode 重跑仍保持正确。
|
||||
- 配置会在受支持的
|
||||
主机上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`;如果你想为直接性能分析使用
|
||||
一个明确的缓存位置,请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。
|
||||
Vitest 运行默认造成的影响更小。
|
||||
- 基础 Vitest 配置会将项目/配置文件标记为
|
||||
`forceRerunTriggers`,这样当测试
|
||||
接线发生变化时,变更模式重跑仍保持正确。
|
||||
- 配置会在受支持主机上保持启用 `OPENCLAW_VITEST_FS_MODULE_CACHE`;
|
||||
如果你想为直接性能分析使用一个显式缓存位置,请设置 `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/abs/path`。
|
||||
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="性能调试">
|
||||
|
||||
- `pnpm test:perf:imports` 会启用 Vitest 导入耗时报告以及
|
||||
导入分解输出。
|
||||
- `pnpm test:perf:imports:changed` 会将同一性能分析视图限制到
|
||||
导入拆解输出。
|
||||
- `pnpm test:perf:imports:changed` 会将相同的性能分析视图限定到
|
||||
自 `origin/main` 以来变更的文件。
|
||||
- 分片计时数据会写入 `.artifacts/vitest-shard-timings.json`。
|
||||
整配置运行使用配置路径作为键;include-pattern CI
|
||||
分片会追加分片名称,因此可以单独跟踪过滤后的分片。
|
||||
- 当某个热点测试仍然把大部分时间花在启动导入上时,
|
||||
请把重型依赖放在窄范围本地 `*.runtime.ts` 衔接层后面,并
|
||||
直接 mock 该衔接层,而不是仅仅为了通过 `vi.mock(...)`
|
||||
传递它们就深度导入运行时辅助函数。
|
||||
- `pnpm test:perf:changed:bench -- --ref <git-ref>` 会对比已提交
|
||||
差异中路由后的 `test:changed` 和原生根项目路径,
|
||||
并打印墙钟时间以及 macOS 最大 RSS。
|
||||
- `pnpm test:perf:changed:bench -- --worktree` 会对当前
|
||||
脏工作树进行基准测试,方法是将变更文件列表通过
|
||||
`scripts/test-projects.mjs` 和根 Vitest 配置路由。
|
||||
全配置运行使用配置路径作为键;include-pattern CI
|
||||
分片会追加分片名称,以便单独跟踪过滤后的分片。
|
||||
- 当某个热点测试仍把大部分时间花在启动导入上时,
|
||||
将重型依赖放在窄范围本地 `*.runtime.ts` 接缝之后,并
|
||||
直接 mock 该接缝,而不是深度导入运行时辅助程序
|
||||
只是为了把它们传给 `vi.mock(...)`。
|
||||
- `pnpm test:perf:changed:bench -- --ref <git-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+heap profile。
|
||||
Vitest/Vite 启动和转换开销写入主线程 CPU 配置文件。
|
||||
- `pnpm test:perf:profile:runner` 会在禁用文件并行的情况下,为
|
||||
单元套件写入 runner CPU+heap 配置文件。
|
||||
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
@ -425,15 +403,15 @@ Telegram 类型的载荷形状:
|
||||
### 稳定性(Gateway 网关)
|
||||
|
||||
- 命令:`pnpm test:stability:gateway`
|
||||
- 配置:`vitest.gateway.config.ts`,强制为一个 worker
|
||||
- 配置:`vitest.gateway.config.ts`,强制使用一个 worker
|
||||
- 范围:
|
||||
- 启动一个真实的 loopback Gateway 网关,并默认启用诊断
|
||||
- 通过诊断事件路径驱动合成 Gateway 网关消息、记忆和大载荷抖动
|
||||
- 通过诊断事件路径驱动合成 Gateway 网关消息、记忆和大载荷流转
|
||||
- 通过 Gateway 网关 WS RPC 查询 `diagnostics.stability`
|
||||
- 覆盖诊断稳定性包持久化辅助函数
|
||||
- 断言记录器保持有界、合成 RSS 样本保持在压力预算内,并且每会话队列深度回落到零
|
||||
- 覆盖诊断稳定性包持久化辅助程序
|
||||
- 断言记录器保持有界、合成 RSS 样本保持低于压力预算,并且每个会话的队列深度回落为零
|
||||
- 预期:
|
||||
- CI 安全且不需要密钥
|
||||
- CI 安全且无需密钥
|
||||
- 用于稳定性回归跟进的窄通道,不是完整 Gateway 网关套件的替代品
|
||||
|
||||
### E2E(Gateway 网关冒烟)
|
||||
@ -442,7 +420,7 @@ Telegram 类型的载荷形状:
|
||||
- 配置:`vitest.e2e.config.ts`
|
||||
- 文件:`src/**/*.e2e.test.ts`、`test/**/*.e2e.test.ts`,以及 `extensions/` 下的内置插件 E2E 测试
|
||||
- 运行时默认值:
|
||||
- 使用 Vitest `threads` 和 `isolate: false`,与仓库其余部分一致。
|
||||
- 使用 Vitest `threads` 且 `isolate: false`,与仓库其余部分一致。
|
||||
- 使用自适应 worker(CI:最多 2 个,本地:默认 1 个)。
|
||||
- 默认以静默模式运行,以减少控制台 I/O 开销。
|
||||
- 有用的覆盖项:
|
||||
@ -450,11 +428,11 @@ Telegram 类型的载荷形状:
|
||||
- `OPENCLAW_E2E_VERBOSE=1` 用于重新启用详细控制台输出。
|
||||
- 范围:
|
||||
- 多实例 Gateway 网关端到端行为
|
||||
- WebSocket/HTTP 表面、节点配对和更重的网络行为
|
||||
- WebSocket/HTTP 表面、节点配对和更重的网络功能
|
||||
- 预期:
|
||||
- 在 CI 中运行(当流水线中启用时)
|
||||
- 在 CI 中运行(当流水线启用时)
|
||||
- 不需要真实密钥
|
||||
- 比单元测试有更多活动部件(可能更慢)
|
||||
- 比单元测试有更多移动部件(可能更慢)
|
||||
|
||||
### E2E:OpenShell 后端冒烟
|
||||
|
||||
@ -463,190 +441,161 @@ Telegram 类型的载荷形状:
|
||||
- 范围:
|
||||
- 通过 Docker 在主机上启动一个隔离的 OpenShell Gateway 网关
|
||||
- 从临时本地 Dockerfile 创建一个沙箱
|
||||
- 通过真实的 `sandbox ssh-config` + SSH exec 运行 OpenClaw 的 OpenShell 后端
|
||||
- 通过沙箱 fs 桥验证远程规范化文件系统行为
|
||||
- 通过真实的 `sandbox ssh-config` + SSH exec 演练 OpenClaw 的 OpenShell 后端
|
||||
- 通过沙箱 fs bridge 验证远程规范化文件系统行为
|
||||
- 预期:
|
||||
- 仅按需启用;不是默认 `pnpm test:e2e` 运行的一部分
|
||||
- 需要本地 `openshell` CLI 和可用的 Docker 守护进程
|
||||
- 仅限选择加入;不是默认 `pnpm test:e2e` 运行的一部分
|
||||
- 需要本地 `openshell` CLI 以及可工作的 Docker daemon
|
||||
- 使用隔离的 `HOME` / `XDG_CONFIG_HOME`,然后销毁测试 Gateway 网关和沙箱
|
||||
- 实用覆盖项:
|
||||
- `OPENCLAW_E2E_OPENSHELL=1`,用于在手动运行更广的 e2e 套件时启用该测试
|
||||
- `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`,用于指向非默认 CLI 二进制文件或包装脚本
|
||||
- 有用的覆盖项:
|
||||
- `OPENCLAW_E2E_OPENSHELL=1`,在手动运行更广泛的 e2e 套件时启用该测试
|
||||
- `OPENCLAW_E2E_OPENSHELL_COMMAND=/path/to/openshell`,指向非默认的 CLI 二进制文件或包装脚本
|
||||
|
||||
### 实时(真实提供商 + 真实模型)
|
||||
### Live(真实提供商 + 真实模型)
|
||||
|
||||
- 命令:`pnpm test:live`
|
||||
- 配置:`vitest.live.config.ts`
|
||||
- 文件:`src/**/*.live.test.ts`、`test/**/*.live.test.ts`,以及 `extensions/` 下内置插件的实时测试
|
||||
- 默认:由 `pnpm test:live` **启用**(设置 `OPENCLAW_LIVE_TEST=1`)
|
||||
- 文件:`src/**/*.live.test.ts`、`test/**/*.live.test.ts`,以及 `extensions/` 下的内置插件 live 测试
|
||||
- 默认值:通过 `pnpm test:live` **启用**(设置 `OPENCLAW_LIVE_TEST=1`)
|
||||
- 范围:
|
||||
- “这个提供商/模型在 _今天_ 使用真实凭证时是否实际可用?”
|
||||
- 捕获提供商格式变化、工具调用差异、认证问题和速率限制行为
|
||||
- 捕获提供商格式变更、工具调用差异、认证问题和速率限制行为
|
||||
- 预期:
|
||||
- 设计上不保证 CI 稳定(真实网络、真实提供商策略、配额、故障)
|
||||
- 按设计不保证 CI 稳定(真实网络、真实提供商策略、配额、故障)
|
||||
- 会产生费用 / 使用速率限制额度
|
||||
- 优先运行收窄后的子集,而不是“一切”
|
||||
- 实时运行会加载 `~/.profile`,以获取缺失的 API 密钥。
|
||||
- 默认情况下,实时运行仍会隔离 `HOME`,并将配置/认证材料复制到临时测试主目录中,因此单元测试夹具无法修改你的真实 `~/.openclaw`。
|
||||
- 仅在你有意需要实时测试使用真实主目录时,才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。
|
||||
- `pnpm test:live` 现在默认使用更安静的模式:它保留 `[live] ...` 进度输出,但抑制额外的 `~/.profile` 提示,并静音 Gateway 网关引导日志/Bonjour 杂音。如果你想恢复完整启动日志,请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。
|
||||
- API 密钥轮换(提供商特定):用逗号/分号格式设置 `*_API_KEYS`,或设置 `*_API_KEY_1`、`*_API_KEY_2`(例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`),也可以通过 `OPENCLAW_LIVE_*_KEY` 设置单次实时覆盖;测试会在收到速率限制响应时重试。
|
||||
- 优先运行缩小范围的子集,而不是“全部”
|
||||
- Live 运行会 source `~/.profile`,以获取缺失的 API key。
|
||||
- 默认情况下,live 运行仍会隔离 `HOME`,并将配置/认证材料复制到临时测试主目录,这样单元测试 fixture 就无法修改你的真实 `~/.openclaw`。
|
||||
- 只有在你有意需要 live 测试使用真实主目录时,才设置 `OPENCLAW_LIVE_USE_REAL_HOME=1`。
|
||||
- `pnpm test:live` 现在默认使用更安静的模式:它保留 `[live] ...` 进度输出,但抑制额外的 `~/.profile` 提示,并静音 Gateway 网关 bootstrap 日志/Bonjour 噪声。如果你想恢复完整启动日志,请设置 `OPENCLAW_LIVE_TEST_QUIET=0`。
|
||||
- API key 轮换(特定于提供商):使用逗号/分号格式设置 `*_API_KEYS`,或设置 `*_API_KEY_1`、`*_API_KEY_2`(例如 `OPENAI_API_KEYS`、`ANTHROPIC_API_KEYS`、`GEMINI_API_KEYS`),也可以通过 `OPENCLAW_LIVE_*_KEY` 按 live 运行覆盖;测试会在收到速率限制响应时重试。
|
||||
- 进度/Heartbeat 输出:
|
||||
- 实时套件现在会向 stderr 输出进度行,因此即使 Vitest 控制台捕获较安静,长时间的提供商调用也能看到活动状态。
|
||||
- `vitest.live.config.ts` 会禁用 Vitest 控制台拦截,因此在实时运行期间,提供商/Gateway 网关进度行会立即流式输出。
|
||||
- 用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型 Heartbeat。
|
||||
- 用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关/探测 Heartbeat。
|
||||
- Live 套件现在会向 stderr 发出进度行,因此即使 Vitest 控制台捕获较安静,长时间的提供商调用也会显示为活跃状态。
|
||||
- `vitest.live.config.ts` 会禁用 Vitest 控制台拦截,因此提供商/Gateway 网关进度行会在 live 运行期间立即流式输出。
|
||||
- 使用 `OPENCLAW_LIVE_HEARTBEAT_MS` 调整直接模型 Heartbeat。
|
||||
- 使用 `OPENCLAW_LIVE_GATEWAY_HEARTBEAT_MS` 调整 Gateway 网关/探测 Heartbeat。
|
||||
|
||||
## 我应该运行哪个套件?
|
||||
|
||||
使用这个决策表:
|
||||
使用此决策表:
|
||||
|
||||
- 编辑逻辑/测试:运行 `pnpm test`(如果改动很多,也运行 `pnpm test:coverage`)
|
||||
- 编辑逻辑/测试:运行 `pnpm test`(如果你改动很多,也运行 `pnpm test:coverage`)
|
||||
- 触及 Gateway 网关网络 / WS 协议 / 配对:添加 `pnpm test:e2e`
|
||||
- 调试“我的 bot 挂了” / 提供商特定失败 / 工具调用:运行收窄后的 `pnpm test:live`
|
||||
- 调试“我的 bot 挂了” / 特定提供商失败 / 工具调用:运行缩小范围的 `pnpm test:live`
|
||||
|
||||
## 实时(触网)测试
|
||||
## Live(触网)测试
|
||||
|
||||
有关实时模型矩阵、CLI 后端冒烟测试、ACP 冒烟测试、Codex 应用服务器
|
||||
harness,以及所有媒体提供商实时测试(Deepgram、BytePlus、ComfyUI、图像、
|
||||
音乐、视频、媒体 harness)以及实时运行的凭证处理,请参阅
|
||||
[测试实时套件](/zh-CN/help/testing-live)。有关专用更新和
|
||||
插件验证检查清单,请参阅
|
||||
关于 live 模型矩阵、CLI 后端 smoke、ACP smoke、Codex app-server
|
||||
harness,以及所有媒体提供商 live 测试(Deepgram、BytePlus、ComfyUI、image、
|
||||
music、video、media harness)——再加上 live 运行的凭证处理——请参阅
|
||||
[Testing live suites](/zh-CN/help/testing-live)。关于专用的更新和
|
||||
插件验证清单,请参阅
|
||||
[更新和插件测试](/zh-CN/help/testing-updates-plugins)。
|
||||
|
||||
## Docker 运行器(可选的“在 Linux 中可用”检查)
|
||||
|
||||
这些 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 扫描保持可行:
|
||||
- Live 模型运行器:`test:docker:live-models` 和 `test:docker:live-gateway` 只会在仓库 Docker 镜像内运行各自匹配的 profile-key live 文件(`src/agents/models.profiles.live.test.ts` 和 `src/gateway/gateway-models.profiles.live.test.ts`),挂载你的本地配置目录和工作区(如果已挂载,也会 source `~/.profile`)。匹配的本地入口点是 `test:live:models-profiles` 和 `test:live:gateway-profiles`。
|
||||
- Docker live 运行器默认使用较小的 smoke 上限,使完整 Docker sweep 保持可行:
|
||||
`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 镜像,通过 `scripts/package-openclaw-for-docker.mjs` 将 OpenClaw 打包一次为 npm tarball,然后构建/复用两个 `scripts/e2e/Dockerfile` 镜像。裸镜像只是用于安装/更新/插件依赖通道的 Node/Git 运行器;这些通道会挂载预构建 tarball。功能镜像会将同一个 tarball 安装到 `/app`,用于已构建应用的功能通道。Docker 通道定义位于 `scripts/lib/docker-e2e-scenarios.mjs`;规划器逻辑位于 `scripts/lib/docker-e2e-plan.mjs`;`scripts/test-docker-all.mjs` 执行选定计划。聚合器使用加权本地调度器:`OPENCLAW_DOCKER_ALL_PARALLELISM` 控制进程槽位,而资源上限会防止繁重的实时、npm-install 和多服务通道同时全部启动。如果单个通道比当前上限更重,调度器仍可在池为空时启动它,并让它独占运行,直到再次有容量可用。默认值为 10 个槽位、`OPENCLAW_DOCKER_ALL_LIVE_LIMIT=9`、`OPENCLAW_DOCKER_ALL_NPM_LIMIT=10` 和 `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7`;仅在 Docker 主机有更多余量时,才调整 `OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT` 或 `OPENCLAW_DOCKER_ALL_DOCKER_LIMIT`。运行器默认执行 Docker 预检,移除陈旧的 OpenClaw E2E 容器,每 30 秒打印状态,将成功通道计时存储在 `.artifacts/docker-tests/lane-timings.json`,并在后续运行中使用这些计时优先启动更长的通道。使用 `OPENCLAW_DOCKER_ALL_DRY_RUN=1` 可在不构建或运行 Docker 的情况下打印加权通道清单,或使用 `node scripts/test-docker-all.mjs --plan-json` 打印所选通道、包/镜像需求和凭证的 CI 计划。
|
||||
- `Package Acceptance` 是 GitHub 原生的包门禁,用于检查“这个可安装 tarball 作为产品是否可用?”它会从 `source=npm`、`source=ref`、`source=url` 或 `source=artifact` 解析一个候选包,将其上传为 `package-under-test`,然后针对该精确 tarball 运行可复用 Docker E2E 通道,而不是重新打包所选 ref。Profile 按覆盖广度排序:`smoke`、`package`、`product` 和 `full`。有关包/更新/插件契约、已发布升级幸存者矩阵、发布默认值和失败分诊,请参阅[更新和插件测试](/zh-CN/help/testing-updates-plugins)。
|
||||
- 构建和发布检查会在 tsdown 之后运行 `scripts/check-cli-bootstrap-imports.mjs`。该守卫会从 `dist/entry.js` 和 `dist/cli/run-main.js` 遍历静态构建图,并在命令分派前的启动导入了 Commander、prompt UI、undici 或日志等包依赖时失败;它还会确保打包后的 Gateway 网关运行 chunk 保持在预算内,并拒绝静态导入已知的冷 Gateway 网关路径。打包 CLI 冒烟测试还覆盖根帮助、onboard 帮助、doctor 帮助、Status、配置 schema 和模型列表命令。
|
||||
- Package Acceptance 旧版兼容性上限为 `2026.4.25`(包括 `2026.4.25-beta.*`)。在该截止点之前,harness 仅容忍已发布包的元数据缺口:省略的私有 QA 清单条目、缺失的 `gateway install --wrapper`、tarball 派生 git 夹具中缺失的补丁文件、缺失的持久化 `update.channel`、旧版插件安装记录位置、缺失的 marketplace 安装记录持久化,以及 `plugins update` 期间的配置元数据迁移。对于 `2026.4.25` 之后的包,这些路径都是严格失败。
|
||||
- 容器冒烟运行器:`test:docker:openwebui`、`test:docker:onboard`、`test:docker:npm-onboard-channel-agent`、`test:docker:update-channel-switch`、`test:docker:upgrade-survivor`、`test:docker:published-upgrade-survivor`、`test:docker:session-runtime-context`、`test:docker:agents-delete-shared-workspace`、`test:docker:gateway-network`、`test:docker:browser-cdp-snapshot`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools`、`test:docker:cron-mcp-cleanup`、`test:docker:plugins`、`test:docker:plugin-update` 和 `test:docker:config-reload` 会启动一个或多个真实容器,并验证更高层级的集成路径。
|
||||
`OPENCLAW_LIVE_GATEWAY_MODEL_TIMEOUT_MS=90000`。只有在你明确想要更大的详尽扫描时,才覆盖这些环境变量。
|
||||
- `test:docker:all` 通过 `test:docker:live-build` 构建一次 live Docker 镜像,通过 `scripts/package-openclaw-for-docker.mjs` 将 OpenClaw 打包一次为 npm tarball,然后构建/复用两个 `scripts/e2e/Dockerfile` 镜像。裸镜像只是用于安装/更新/插件依赖 lane 的 Node/Git 运行器;这些 lane 会挂载预构建的 tarball。功能镜像会将同一个 tarball 安装到 `/app`,用于构建后应用功能 lane。Docker lane 定义位于 `scripts/lib/docker-e2e-scenarios.mjs`;规划器逻辑位于 `scripts/lib/docker-e2e-plan.mjs`;`scripts/test-docker-all.mjs` 执行选定的计划。聚合运行使用加权本地调度器:`OPENCLAW_DOCKER_ALL_PARALLELISM` 控制进程 slot,而资源上限会避免重型 live、npm 安装和多服务 lane 同时全部启动。如果单个 lane 比活动上限更重,调度器仍可在池为空时启动它,然后让它单独运行,直到容量再次可用。默认值是 10 个 slot、`OPENCLAW_DOCKER_ALL_LIVE_LIMIT=9`、`OPENCLAW_DOCKER_ALL_NPM_LIMIT=10` 和 `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7`;只有当 Docker 主机有更多余量时,才调整 `OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT` 或 `OPENCLAW_DOCKER_ALL_DOCKER_LIMIT`。运行器默认执行 Docker preflight,移除过期的 OpenClaw E2E 容器,每 30 秒打印一次 Status,将成功 lane 的耗时存储在 `.artifacts/docker-tests/lane-timings.json`,并在后续运行中使用这些耗时优先启动更长的 lane。使用 `OPENCLAW_DOCKER_ALL_DRY_RUN=1` 打印加权 lane 清单而不构建或运行 Docker,或使用 `node scripts/test-docker-all.mjs --plan-json` 打印所选 lane、package/image 需求和凭证的 CI 计划。
|
||||
- `Package Acceptance` 是 GitHub 原生的 package gate,用于验证“这个可安装 tarball 是否能作为产品工作?”它会从 `source=npm`、`source=ref`、`source=url` 或 `source=artifact` 解析一个候选 package,将其上传为 `package-under-test`,然后针对该精确 tarball 运行可复用的 Docker E2E lane,而不是重新打包所选 ref。Profile 按广度排序:`smoke`、`package`、`product` 和 `full`。关于 package/update/plugin contract、已发布升级 survivor 矩阵、发布默认值和失败分诊,请参阅[更新和插件测试](/zh-CN/help/testing-updates-plugins)。
|
||||
- 构建和发布检查会在 tsdown 之后运行 `scripts/check-cli-bootstrap-imports.mjs`。该 guard 会从 `dist/entry.js` 和 `dist/cli/run-main.js` 遍历静态构建图,并在命令分发前的启动阶段导入 Commander、prompt UI、undici 或日志等 package 依赖时失败;它还会让内置 Gateway 网关 run chunk 保持在预算内,并拒绝静态导入已知的冷 Gateway 网关路径。打包后的 CLI smoke 还覆盖 root help、onboard help、doctor help、Status、配置 schema 和一个模型列表命令。
|
||||
- Package Acceptance 旧版兼容性封顶于 `2026.4.25`(包括 `2026.4.25-beta.*`)。在该截止点之前,harness 只容忍已发布 package 的元数据缺口:省略的私有 QA inventory 条目、缺失的 `gateway install --wrapper`、tarball 派生 git fixture 中缺失的 patch 文件、缺失的持久化 `update.channel`、旧版插件 install-record 位置、缺失的 marketplace install-record 持久化,以及 `plugins update` 期间的配置元数据迁移。对于 `2026.4.25` 之后的 package,这些路径都是严格失败。
|
||||
- 容器 smoke 运行器:`test:docker:openwebui`、`test:docker:onboard`、`test:docker:npm-onboard-channel-agent`、`test:docker:update-channel-switch`、`test:docker:upgrade-survivor`、`test:docker:published-upgrade-survivor`、`test:docker:session-runtime-context`、`test:docker:agents-delete-shared-workspace`、`test:docker:gateway-network`、`test:docker:browser-cdp-snapshot`、`test:docker:mcp-channels`、`test:docker:pi-bundle-mcp-tools`、`test:docker:cron-mcp-cleanup`、`test:docker:plugins`、`test:docker:plugin-update` 和 `test:docker:config-reload` 会启动一个或多个真实容器,并验证更高层的集成路径。
|
||||
|
||||
实时模型 Docker 运行器还只会绑定挂载所需的 CLI 认证主目录(或在运行未收窄时挂载所有受支持的主目录),然后在运行前将它们复制到容器主目录中,这样外部 CLI OAuth 就能刷新令牌,而不会修改主机认证存储:
|
||||
Live 模型 Docker 运行器还只会 bind-mount 所需的 CLI auth home(或者在运行未缩小时挂载所有受支持的 auth home),然后在运行前将它们复制到容器主目录中,这样外部 CLI OAuth 可以刷新 token,而不会修改主机 auth 存储:
|
||||
|
||||
- 直接模型:`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`;默认覆盖 Claude、Codex 和 Gemini,并通过 `pnpm test:docker:live-acp-bind:droid` 和 `pnpm test:docker:live-acp-bind:opencode` 严格覆盖 Droid/OpenCode)
|
||||
- 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`)
|
||||
- 可观测性烟测:`pnpm qa:otel:smoke` 是私有 QA 源码签出通道。它有意不属于包 Docker 发布通道,因为 npm tarball 会省略 QA Lab。
|
||||
- Open WebUI 实时烟测:`pnpm test:docker:openwebui`(脚本:`scripts/e2e/openwebui-docker.sh`)
|
||||
- ACP 绑定冒烟测试:`pnpm test:docker:live-acp-bind`(脚本:`scripts/test-live-acp-bind-docker.sh`;默认覆盖 Claude、Codex 和 Gemini,并通过 `pnpm test:docker:live-acp-bind:droid` 和 `pnpm test:docker:live-acp-bind:opencode` 严格覆盖 Droid/OpenCode)
|
||||
- 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 网关 + dev 智能体:`pnpm test:docker:live-gateway`(脚本:`scripts/test-live-gateway-models-docker.sh`)
|
||||
- 可观测性冒烟测试:`pnpm qa:otel:smoke` 是私有 QA 源码检出检查通道。它有意不属于包 Docker 发布通道,因为 npm tarball 会省略 QA Lab。
|
||||
- Open WebUI 实时冒烟测试:`pnpm test:docker:openwebui`(脚本:`scripts/e2e/openwebui-docker.sh`)
|
||||
- 新手引导向导(TTY,完整脚手架):`pnpm test:docker:onboard`(脚本:`scripts/e2e/onboard-docker.sh`)
|
||||
- Npm tarball 新手引导/渠道/智能体烟测:`pnpm test:docker:npm-onboard-channel-agent` 会在 Docker 中全局安装打包后的 OpenClaw tarball,通过 env-ref 新手引导配置 OpenAI,并默认配置 Telegram,运行 Doctor,然后运行一次模拟的 OpenAI 智能体回合。用 `OPENCLAW_CURRENT_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball,用 `OPENCLAW_NPM_ONBOARD_HOST_BUILD=0` 跳过宿主机重建,或用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 切换渠道。
|
||||
- 更新渠道切换烟测:`pnpm test:docker:update-channel-switch` 会在 Docker 中全局安装打包后的 OpenClaw tarball,从包 `stable` 切换到 git `dev`,验证持久化的渠道和插件更新后工作正常,然后切回包 `stable` 并检查更新 Status。
|
||||
- 升级幸存者烟测:`pnpm test:docker:upgrade-survivor` 会把打包后的 OpenClaw tarball 安装到一个脏的旧用户 fixture 上,其中包含智能体、渠道配置、插件允许列表、过期的插件依赖状态,以及现有工作区/会话文件。它会在没有实时提供商或渠道密钥的情况下运行包更新和非交互式 Doctor,然后启动一个 loopback Gateway 网关,并检查配置/状态保留以及启动/Status 预算。
|
||||
- 已发布版本升级幸存者烟测:`pnpm test:docker:published-upgrade-survivor` 默认安装 `openclaw@latest`,播种真实的现有用户文件,用内置命令配方配置该基线,验证生成的配置,将该已发布安装更新到候选 tarball,运行非交互式 Doctor,写入 `.artifacts/upgrade-survivor/summary.json`,然后启动一个 loopback Gateway 网关,并检查已配置意图、状态保留、启动、`/healthz`、`/readyz` 和 RPC Status 预算。用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC` 覆盖一个基线,用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECS` 让聚合调度器展开精确基线,并用 `OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS` 展开 issue 形状的 fixture,例如 `reported-issues`;Package Acceptance 将这些暴露为 `published_upgrade_survivor_baseline`、`published_upgrade_survivor_baselines` 和 `published_upgrade_survivor_scenarios`。
|
||||
- 会话运行时上下文烟测:`pnpm test:docker:session-runtime-context` 会验证隐藏运行时上下文转录持久化,以及 Doctor 对受影响重复 prompt-rewrite 分支的修复。
|
||||
- Bun 全局安装烟测:`bash scripts/e2e/bun-global-install-smoke.sh` 会打包当前树,在隔离 home 中用 `bun install -g` 安装,并验证 `openclaw infer image providers --json` 返回内置图像提供商而不是挂起。用 `OPENCLAW_BUN_GLOBAL_SMOKE_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball,用 `OPENCLAW_BUN_GLOBAL_SMOKE_HOST_BUILD=0` 跳过宿主机构建,或用 `OPENCLAW_BUN_GLOBAL_SMOKE_DIST_IMAGE=openclaw-dockerfile-smoke:local` 从已构建的 Docker 镜像复制 `dist/`。
|
||||
- 安装器 Docker 烟测:`bash scripts/test-install-sh-docker.sh` 会在其 root、update 和 direct-npm 容器之间共享一个 npm 缓存。Update 烟测默认使用 npm `latest` 作为稳定基线,然后升级到候选 tarball。本地可用 `OPENCLAW_INSTALL_SMOKE_UPDATE_BASELINE=2026.4.22` 覆盖,或在 GitHub 上使用 Install Smoke 工作流的 `update_baseline_version` 输入覆盖。非 root 安装器检查会保留隔离的 npm 缓存,因此 root 拥有的缓存条目不会掩盖用户本地安装行为。设置 `OPENCLAW_INSTALL_SMOKE_NPM_CACHE_DIR=/path/to/cache` 可在本地重跑之间复用 root/update/direct-npm 缓存。
|
||||
- Install Smoke CI 会用 `OPENCLAW_INSTALL_SMOKE_SKIP_NPM_GLOBAL=1` 跳过重复的 direct-npm 全局更新;需要覆盖直接 `npm install -g` 时,在本地不带该环境变量运行脚本。
|
||||
- 智能体删除共享工作区 CLI 烟测:`pnpm test:docker:agents-delete-shared-workspace`(脚本:`scripts/e2e/agents-delete-shared-workspace-docker.sh`)默认构建根 Dockerfile 镜像,在隔离容器 home 中播种两个智能体和一个工作区,运行 `agents delete --json`,并验证有效 JSON 以及保留工作区行为。用 `OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_IMAGE=openclaw-dockerfile-smoke:local OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_SKIP_BUILD=1` 复用 install-smoke 镜像。
|
||||
- Gateway 网关网络(两个容器,WS 认证 + 健康检查):`pnpm test:docker:gateway-network`(脚本:`scripts/e2e/gateway-network-docker.sh`)
|
||||
- 浏览器 CDP 快照烟测:`pnpm test:docker:browser-cdp-snapshot`(脚本:`scripts/e2e/browser-cdp-snapshot-docker.sh`)会构建源码 E2E 镜像加 Chromium 层,用原始 CDP 启动 Chromium,运行 `browser doctor --deep`,并验证 CDP 角色快照覆盖链接 URL、光标提升的可点击项、iframe ref 和 frame 元数据。
|
||||
- OpenAI Responses web_search 最小 reasoning 回归:`pnpm test:docker:openai-web-search-minimal`(脚本:`scripts/e2e/openai-web-search-minimal-docker.sh`)会通过 Gateway 网关运行模拟的 OpenAI 服务器,验证 `web_search` 将 `reasoning.effort` 从 `minimal` 提升到 `low`,然后强制提供商 schema 拒绝,并检查原始详情出现在 Gateway 网关日志中。
|
||||
- MCP 渠道桥接(已播种 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 烟测):`pnpm test:docker:mcp-channels`(脚本:`scripts/e2e/mcp-channels-docker.sh`)
|
||||
- Pi bundle MCP 工具(真实 stdio MCP 服务器 + 嵌入式 Pi profile 允许/拒绝烟测):`pnpm test:docker:pi-bundle-mcp-tools`(脚本:`scripts/e2e/pi-bundle-mcp-tools-docker.sh`)
|
||||
- Cron/subagent MCP 清理(真实 Gateway 网关 + 在隔离 cron 和一次性 subagent 运行后清理 stdio MCP 子进程):`pnpm test:docker:cron-mcp-cleanup`(脚本:`scripts/e2e/cron-mcp-cleanup-docker.sh`)
|
||||
- 插件(对本地路径、`file:`、带提升依赖的 npm registry、git moving refs、ClawHub kitchen-sink、marketplace 更新,以及 Claude-bundle 启用/检查的安装/更新烟测):`pnpm test:docker:plugins`(脚本:`scripts/e2e/plugins-docker.sh`)
|
||||
设置 `OPENCLAW_PLUGINS_E2E_CLAWHUB=0` 可跳过 ClawHub 块,或用 `OPENCLAW_PLUGINS_E2E_CLAWHUB_SPEC` 和 `OPENCLAW_PLUGINS_E2E_CLAWHUB_ID` 覆盖默认的 kitchen-sink 包/运行时组合。如果没有 `OPENCLAW_CLAWHUB_URL`/`CLAWHUB_URL`,测试会使用 hermetic 本地 ClawHub fixture 服务器。
|
||||
- 插件更新不变烟测:`pnpm test:docker:plugin-update`(脚本:`scripts/e2e/plugin-update-unchanged-docker.sh`)
|
||||
- 配置重载元数据烟测:`pnpm test:docker:config-reload`(脚本:`scripts/e2e/config-reload-source-docker.sh`)
|
||||
- 插件:`pnpm test:docker:plugins` 覆盖对本地路径、`file:`、带提升依赖的 npm registry、git moving refs、ClawHub fixture、marketplace 更新,以及 Claude-bundle 启用/检查的安装/更新烟测。`pnpm test:docker:plugin-update` 覆盖已安装插件的不变更新行为。
|
||||
- Npm tarball 新手引导/渠道/智能体冒烟测试:`pnpm test:docker:npm-onboard-channel-agent` 会在 Docker 中全局安装打包好的 OpenClaw tarball,通过 env-ref 新手引导配置 OpenAI,并默认配置 Telegram,运行 Doctor,然后运行一次模拟的 OpenAI 智能体轮次。使用 `OPENCLAW_CURRENT_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball,用 `OPENCLAW_NPM_ONBOARD_HOST_BUILD=0` 跳过主机重建,或用 `OPENCLAW_NPM_ONBOARD_CHANNEL=discord` 切换渠道。
|
||||
- 更新渠道切换冒烟测试:`pnpm test:docker:update-channel-switch` 会在 Docker 中全局安装打包好的 OpenClaw tarball,从包 `stable` 切换到 git `dev`,验证持久化的渠道和插件更新后工作正常,然后切回包 `stable` 并检查更新 Status。
|
||||
- 升级幸存者冒烟测试:`pnpm test:docker:upgrade-survivor` 会把打包好的 OpenClaw tarball 安装到带有智能体、渠道配置、插件 allowlist、过时插件依赖状态以及现有工作区/会话文件的脏旧用户夹具上。它会在没有实时提供商或渠道密钥的情况下运行包更新和非交互式 Doctor,然后启动回环 Gateway 网关,并检查配置/状态保留以及启动/Status 预算。
|
||||
- 已发布升级幸存者冒烟测试:`pnpm test:docker:published-upgrade-survivor` 默认安装 `openclaw@latest`,播种真实的现有用户文件,用内置命令配方配置该基线,验证生成的配置,把该已发布安装更新到候选 tarball,运行非交互式 Doctor,写入 `.artifacts/upgrade-survivor/summary.json`,然后启动回环 Gateway 网关,并检查已配置意图、状态保留、启动、`/healthz`、`/readyz` 和 RPC Status 预算。用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC` 覆盖一个基线,用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECS` 让聚合调度器展开精确基线,并用 `OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS` 展开 issue 形状的夹具,例如 `reported-issues`;reported-issues 集包含 `configured-plugin-installs`,用于自动修复外部 OpenClaw 插件安装。Package Acceptance 将这些暴露为 `published_upgrade_survivor_baseline`、`published_upgrade_survivor_baselines` 和 `published_upgrade_survivor_scenarios`。
|
||||
- 会话运行时上下文冒烟测试:`pnpm test:docker:session-runtime-context` 会验证隐藏运行时上下文 transcript 持久化,以及 Doctor 对受影响的重复 prompt-rewrite 分支的修复。
|
||||
- Bun 全局安装冒烟测试:`bash scripts/e2e/bun-global-install-smoke.sh` 会打包当前树,在隔离 home 中用 `bun install -g` 安装,并验证 `openclaw infer image providers --json` 返回内置图像提供商而不是挂起。用 `OPENCLAW_BUN_GLOBAL_SMOKE_PACKAGE_TGZ=/path/to/openclaw-*.tgz` 复用预构建 tarball,用 `OPENCLAW_BUN_GLOBAL_SMOKE_HOST_BUILD=0` 跳过主机构建,或用 `OPENCLAW_BUN_GLOBAL_SMOKE_DIST_IMAGE=openclaw-dockerfile-smoke:local` 从已构建 Docker 镜像复制 `dist/`。
|
||||
- 安装器 Docker 冒烟测试:`bash scripts/test-install-sh-docker.sh` 会在其 root、update 和 direct-npm 容器之间共享一个 npm 缓存。更新冒烟测试默认以 npm `latest` 作为稳定基线,然后升级到候选 tarball。本地可用 `OPENCLAW_INSTALL_SMOKE_UPDATE_BASELINE=2026.4.22` 覆盖,或在 GitHub 上用 Install Smoke workflow 的 `update_baseline_version` 输入覆盖。非 root 安装器检查会保留隔离的 npm 缓存,使 root 拥有的缓存条目不会掩盖用户本地安装行为。设置 `OPENCLAW_INSTALL_SMOKE_NPM_CACHE_DIR=/path/to/cache` 可在本地重复运行之间复用 root/update/direct-npm 缓存。
|
||||
- Install Smoke CI 用 `OPENCLAW_INSTALL_SMOKE_SKIP_NPM_GLOBAL=1` 跳过重复的 direct-npm 全局更新;需要直接 `npm install -g` 覆盖时,在本地运行脚本且不带该环境变量。
|
||||
- 智能体删除共享工作区 CLI 冒烟测试:`pnpm test:docker:agents-delete-shared-workspace`(脚本:`scripts/e2e/agents-delete-shared-workspace-docker.sh`)默认构建根 Dockerfile 镜像,在隔离容器 home 中播种两个拥有同一个工作区的智能体,运行 `agents delete --json`,并验证有效 JSON 以及工作区保留行为。用 `OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_IMAGE=openclaw-dockerfile-smoke:local OPENCLAW_AGENTS_DELETE_SHARED_WORKSPACE_E2E_SKIP_BUILD=1` 复用 install-smoke 镜像。
|
||||
- Gateway 网关网络(两个容器,WS auth + health):`pnpm test:docker:gateway-network`(脚本:`scripts/e2e/gateway-network-docker.sh`)
|
||||
- 浏览器 CDP 快照冒烟测试:`pnpm test:docker:browser-cdp-snapshot`(脚本:`scripts/e2e/browser-cdp-snapshot-docker.sh`)构建源 E2E 镜像和 Chromium 层,使用原始 CDP 启动 Chromium,运行 `browser doctor --deep`,并验证 CDP role 快照覆盖链接 URL、光标提升的可点击元素、iframe refs 和 frame 元数据。
|
||||
- OpenAI Responses web_search minimal reasoning 回归:`pnpm test:docker:openai-web-search-minimal`(脚本:`scripts/e2e/openai-web-search-minimal-docker.sh`)通过 Gateway 网关运行模拟 OpenAI 服务器,验证 `web_search` 会把 `reasoning.effort` 从 `minimal` 提升到 `low`,然后强制提供商 schema 拒绝并检查原始详细信息出现在 Gateway 网关日志中。
|
||||
- MCP 渠道桥接(已播种 Gateway 网关 + stdio bridge + 原始 Claude notification-frame 冒烟测试):`pnpm test:docker:mcp-channels`(脚本:`scripts/e2e/mcp-channels-docker.sh`)
|
||||
- Pi bundle MCP 工具(真实 stdio MCP 服务器 + 嵌入式 Pi profile allow/deny 冒烟测试):`pnpm test:docker:pi-bundle-mcp-tools`(脚本:`scripts/e2e/pi-bundle-mcp-tools-docker.sh`)
|
||||
- Cron/subagent MCP 清理(真实 Gateway 网关 + 在隔离 cron 和一次性 subagent 运行后拆除 stdio MCP 子进程):`pnpm test:docker:cron-mcp-cleanup`(脚本:`scripts/e2e/cron-mcp-cleanup-docker.sh`)
|
||||
- 插件(覆盖本地路径、`file:`、带提升依赖的 npm registry、git moving refs、ClawHub kitchen-sink、marketplace 更新以及 Claude-bundle 启用/检查的安装/更新冒烟测试):`pnpm test:docker:plugins`(脚本:`scripts/e2e/plugins-docker.sh`)
|
||||
设置 `OPENCLAW_PLUGINS_E2E_CLAWHUB=0` 可跳过 ClawHub 区块,或用 `OPENCLAW_PLUGINS_E2E_CLAWHUB_SPEC` 和 `OPENCLAW_PLUGINS_E2E_CLAWHUB_ID` 覆盖默认 kitchen-sink package/runtime 对。没有 `OPENCLAW_CLAWHUB_URL`/`CLAWHUB_URL` 时,测试会使用封闭的本地 ClawHub 夹具服务器。
|
||||
- 插件未变化更新冒烟测试:`pnpm test:docker:plugin-update`(脚本:`scripts/e2e/plugin-update-unchanged-docker.sh`)
|
||||
- 配置重载元数据冒烟测试:`pnpm test:docker:config-reload`(脚本:`scripts/e2e/config-reload-source-docker.sh`)
|
||||
- 插件:`pnpm test:docker:plugins` 覆盖本地路径、`file:`、带提升依赖的 npm registry、git moving refs、ClawHub 夹具、marketplace 更新以及 Claude-bundle 启用/检查的安装/更新冒烟测试。`pnpm test:docker:plugin-update` 覆盖已安装插件的未变化更新行为。
|
||||
|
||||
如需手动预构建并复用共享功能镜像:
|
||||
要手动预构建并复用共享功能镜像:
|
||||
|
||||
```bash
|
||||
OPENCLAW_DOCKER_E2E_IMAGE=openclaw-docker-e2e-functional:local pnpm test:docker:e2e-build
|
||||
OPENCLAW_DOCKER_E2E_IMAGE=openclaw-docker-e2e-functional:local OPENCLAW_SKIP_DOCKER_BUILD=1 pnpm test:docker:mcp-channels
|
||||
```
|
||||
|
||||
设置后,套件专用镜像覆盖项(例如 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE`)仍会优先生效。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时,如果本地尚不存在,脚本会拉取它。QR 和安装器 Docker 测试保留自己的 Dockerfile,因为它们验证的是包/安装行为,而不是共享的已构建应用运行时。
|
||||
设置了 `OPENCLAW_GATEWAY_NETWORK_E2E_IMAGE` 等套件专用镜像覆盖项时,它们仍然优先。当 `OPENCLAW_SKIP_DOCKER_BUILD=1` 指向远程共享镜像时,如果本地尚不存在,脚本会拉取该镜像。QR 和安装器 Docker 测试保留自己的 Dockerfile,因为它们验证的是包/安装行为,而不是共享的已构建应用运行时。
|
||||
|
||||
live 模型 Docker 运行器还会以只读方式绑定挂载当前检出,并
|
||||
将其暂存到容器内的临时工作目录。这能让运行时镜像保持精简,
|
||||
同时仍然针对你的确切本地源代码/配置运行 Vitest。
|
||||
暂存步骤会跳过大型本地专用缓存和应用构建输出,例如
|
||||
`.pnpm-store`、`.worktrees`、`__openclaw_vitest__`,以及应用本地的 `.build` 或
|
||||
Gradle 输出目录,这样 Docker live 运行就不会花费数分钟复制
|
||||
特定于机器的工件。
|
||||
它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`,这样 Gateway 网关 live 探针就不会在
|
||||
容器内启动真实的 Telegram/Discord 等渠道 worker。
|
||||
`test:docker:live-models` 仍会运行 `pnpm test:live`,因此当你需要从该 Docker lane
|
||||
缩小或排除 Gateway 网关 live 覆盖范围时,也要传入
|
||||
`OPENCLAW_LIVE_GATEWAY_*`。
|
||||
`test:docker:openwebui` 是更高层级的兼容性冒烟测试:它会启动一个
|
||||
启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器,
|
||||
再启动一个固定版本的 Open WebUI 容器连接到该 Gateway 网关,通过
|
||||
Open WebUI 登录,验证 `/api/models` 暴露 `openclaw/default`,然后通过
|
||||
Open WebUI 的 `/api/chat/completions` 代理发送真实聊天请求。
|
||||
首次运行可能会明显更慢,因为 Docker 可能需要拉取
|
||||
Open WebUI 镜像,且 Open WebUI 可能需要完成自己的冷启动设置。
|
||||
此 lane 需要可用的 live 模型密钥,而 `OPENCLAW_PROFILE_FILE`
|
||||
(默认是 `~/.profile`)是在 Docker 化运行中提供它的主要方式。
|
||||
成功运行会打印一个小型 JSON payload,例如 `{ "ok": true, "model":
|
||||
"openclaw/default", ... }`。
|
||||
`test:docker:mcp-channels` 是有意设计为确定性的,并且不需要真实的
|
||||
Telegram、Discord 或 iMessage 账户。它会启动一个已播种的 Gateway 网关
|
||||
容器,启动第二个容器并在其中生成 `openclaw mcp serve`,然后
|
||||
验证路由后的对话发现、transcript 读取、附件元数据、
|
||||
live 事件队列行为、出站发送路由,以及通过真实 stdio MCP bridge 发送的 Claude 风格渠道 +
|
||||
权限通知。通知检查会直接检查原始 stdio MCP frame,因此该冒烟测试验证的是
|
||||
bridge 实际发出的内容,而不只是某个特定客户端 SDK 恰好暴露的内容。
|
||||
`test:docker:pi-bundle-mcp-tools` 是确定性的,并且不需要 live
|
||||
模型密钥。它会构建仓库 Docker 镜像,在容器内启动一个真实的 stdio MCP 探针服务器,
|
||||
通过嵌入式 Pi bundle MCP 运行时实例化该服务器,
|
||||
执行工具,然后验证 `coding` 和 `messaging` 会保留
|
||||
`bundle-mcp` 工具,而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会过滤它们。
|
||||
`test:docker:cron-mcp-cleanup` 是确定性的,并且不需要 live 模型
|
||||
密钥。它会启动一个带有真实 stdio MCP 探针服务器的已播种 Gateway 网关,运行一个
|
||||
隔离的 cron turn 和一个 `/subagents spawn` 一次性子 turn,然后验证
|
||||
MCP 子进程会在每次运行后退出。
|
||||
实时模型 Docker runner 还会只读 bind-mount 当前检出,并在容器内把它暂存到临时 workdir。这样可以保持运行时镜像精简,同时仍然针对你的精确本地源码/配置运行 Vitest。暂存步骤会跳过大型本地专用缓存和应用构建输出,例如 `.pnpm-store`、`.worktrees`、`__openclaw_vitest__`,以及应用本地 `.build` 或 Gradle 输出目录,因此 Docker 实时运行不会花几分钟复制机器特定产物。
|
||||
它们还会设置 `OPENCLAW_SKIP_CHANNELS=1`,这样 Gateway 网关实时探针就不会在容器内启动真实的 Telegram/Discord 等渠道 worker。
|
||||
`test:docker:live-models` 仍然运行 `pnpm test:live`,因此当你需要从该 Docker 通道缩小或排除 Gateway 网关实时覆盖时,也要传入 `OPENCLAW_LIVE_GATEWAY_*`。
|
||||
`test:docker:openwebui` 是更高层的兼容性冒烟测试:它启动一个启用了 OpenAI 兼容 HTTP 端点的 OpenClaw Gateway 网关容器,启动一个固定版本的 Open WebUI 容器并连接到该 Gateway 网关,通过 Open WebUI 登录,验证 `/api/models` 暴露 `openclaw/default`,然后通过 Open WebUI 的 `/api/chat/completions` 代理发送真实聊天请求。
|
||||
第一次运行可能明显更慢,因为 Docker 可能需要拉取 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`,然后通过真实 stdio MCP bridge 验证路由式对话发现、transcript 读取、附件元数据、实时事件队列行为、出站发送路由,以及 Claude 风格渠道 + 权限通知。通知检查会直接检查原始 stdio MCP frame,因此该冒烟测试验证的是 bridge 实际发出的内容,而不只是某个特定客户端 SDK 恰好暴露的内容。
|
||||
`test:docker:pi-bundle-mcp-tools` 是确定性的,不需要实时模型密钥。它构建仓库 Docker 镜像,在容器内启动一个真实 stdio MCP 探针服务器,通过嵌入式 Pi bundle MCP 运行时物化该服务器,执行工具,然后验证 `coding` 和 `messaging` 保留 `bundle-mcp` 工具,而 `minimal` 和 `tools.deny: ["bundle-mcp"]` 会过滤它们。
|
||||
`test:docker:cron-mcp-cleanup` 是确定性的,不需要实时模型密钥。它启动一个带真实 stdio MCP 探针服务器的已播种 Gateway 网关,运行一个隔离 cron 轮次和一个 `/subagents spawn` 一次性子轮次,然后验证 MCP 子进程在每次运行后退出。
|
||||
|
||||
手动 ACP 自然语言 thread 冒烟测试(不在 CI 中):
|
||||
手动 ACP 自然语言线程冒烟测试(非 CI):
|
||||
|
||||
- `bun scripts/dev/discord-acp-plain-language-smoke.ts --channel <discord-channel-id> ...`
|
||||
- 保留此脚本用于回归/调试工作流。ACP thread 路由验证可能再次需要它,因此不要删除它。
|
||||
- 保留此脚本用于回归/调试工作流。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_PROFILE_ENV_ONLY=1` 仅验证从 `OPENCLAW_PROFILE_FILE` 加载的环境变量,使用临时配置/工作区目录且不挂载外部 CLI 认证
|
||||
- `OPENCLAW_DOCKER_CLI_TOOLS_DIR=...`(默认:`~/.cache/openclaw/docker-cli-tools`)挂载到 `/home/node/.npm-global`,用于 Docker 内缓存的 CLI 安装
|
||||
- `$HOME` 下的外部 CLI 认证目录/文件会以只读方式挂载到 `/host-auth...` 下,然后在测试开始前复制到 `/home/node/...`
|
||||
- `OPENCLAW_DOCKER_PROFILE_ENV_ONLY=1` 用于仅验证来自 `OPENCLAW_PROFILE_FILE` 的环境变量,使用临时配置/工作区目录,且不挂载外部 CLI 凭证
|
||||
- `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_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭据来自配置文件存储(而不是环境)
|
||||
- `OPENCLAW_SKIP_DOCKER_BUILD=1` 用于在无需重新构建的重复运行中复用现有 `openclaw:local-live` 镜像
|
||||
- `OPENCLAW_LIVE_REQUIRE_PROFILE_KEYS=1` 用于确保凭证来自配置文件存储区(而不是环境变量)
|
||||
- `OPENCLAW_OPENWEBUI_MODEL=...` 用于选择 Gateway 网关为 Open WebUI 冒烟测试公开的模型
|
||||
- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试使用的随机值检查提示词
|
||||
- `OPENCLAW_OPENWEBUI_PROMPT=...` 用于覆盖 Open WebUI 冒烟测试使用的 nonce 检查提示词
|
||||
- `OPENWEBUI_IMAGE=...` 用于覆盖固定的 Open WebUI 镜像标签
|
||||
|
||||
## 文档完整性检查
|
||||
|
||||
文档编辑后运行文档检查:`pnpm check:docs`。
|
||||
当你也需要页内标题检查时,运行完整的 Mintlify 锚点验证:`pnpm docs:check-links:anchors`。
|
||||
当你还需要页内标题检查时,运行完整的 Mintlify 锚点验证:`pnpm docs:check-links:anchors`。
|
||||
|
||||
## 离线回归(CI 安全)
|
||||
|
||||
这些是不使用真实提供商的“真实流水线”回归:
|
||||
|
||||
- Gateway 网关工具调用(模拟 OpenAI,真实 Gateway 网关 + Agent loop):`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 网关向导(WS `wizard.start`/`wizard.next`,写入配置 + 强制凭证):`src/gateway/gateway.test.ts`(用例:"runs wizard over ws and writes auth token config")
|
||||
|
||||
## 智能体可靠性评估(Skills)
|
||||
|
||||
@ -655,25 +604,21 @@ MCP 子进程会在每次运行后退出。
|
||||
- 通过真实 Gateway 网关 + Agent loop 进行模拟工具调用(`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 在提示词中列出时,智能体是否会选择正确的 Skill(或避开无关的 Skill)?
|
||||
- **合规:**智能体是否会在使用前读取 `SKILL.md` 并遵循必需的步骤/参数?
|
||||
- **工作流契约:**断言工具顺序、会话历史延续和沙箱边界的多轮场景。
|
||||
|
||||
未来评估应优先保持确定性:
|
||||
|
||||
- 一个使用模拟提供商的场景运行器,用于断言工具调用 + 顺序、skill 文件读取和会话接线。
|
||||
- 一小套聚焦 skill 的场景(使用与避免、门控、提示注入)。
|
||||
- 可选的实时评估(选择加入、由环境变量门控)仅在 CI 安全套件就位后再添加。
|
||||
- 使用模拟提供商的场景运行器,用于断言工具调用 + 顺序、Skill 文件读取和会话接线。
|
||||
- 一组面向 Skill 的小型场景(使用与避免、门控、提示注入)。
|
||||
- 可选的实时评估(选择加入,通过环境变量门控)仅在 CI 安全套件就位后再添加。
|
||||
|
||||
## 契约测试(插件和渠道结构)
|
||||
## 契约测试(插件和渠道形状)
|
||||
|
||||
契约测试会验证每个已注册的插件和渠道是否符合其
|
||||
接口契约。它们会遍历所有已发现的插件,并运行一组
|
||||
结构和行为断言。默认的 `pnpm test` 单元测试通道会有意
|
||||
跳过这些共享边界和冒烟测试文件;当你触碰共享渠道或提供商表面时,
|
||||
请显式运行契约命令。
|
||||
契约测试会验证每个已注册插件和渠道都符合其接口契约。它们会遍历所有发现的插件,并运行一组形状和行为断言。默认的 `pnpm test` 单元测试通道会有意跳过这些共享边界和冒烟文件;当你触及共享渠道或提供商表面时,请显式运行契约命令。
|
||||
|
||||
### 命令
|
||||
|
||||
@ -685,56 +630,56 @@ Skills 仍然缺失的内容(见 [Skills](/zh-CN/tools/skills)):
|
||||
|
||||
位于 `src/channels/plugins/contracts/*.contract.test.ts`:
|
||||
|
||||
- **plugin** - 基本插件结构(id、名称、能力)
|
||||
- **plugin** - 基本插件形状(id、name、capabilities)
|
||||
- **setup** - 设置向导契约
|
||||
- **session-binding** - 会话绑定行为
|
||||
- **outbound-payload** - 消息载荷结构
|
||||
- **inbound** - 入站消息处理
|
||||
- **actions** - 渠道操作处理器
|
||||
- **threading** - 线程 ID 处理
|
||||
- **directory** - 目录/成员名单 API
|
||||
- **directory** - 目录/名册 API
|
||||
- **group-policy** - 群组策略强制执行
|
||||
|
||||
### 提供商 Status 契约
|
||||
### 提供商状态契约
|
||||
|
||||
位于 `src/plugins/contracts/*.contract.test.ts`。
|
||||
|
||||
- **status** - 渠道 Status 探测
|
||||
- **registry** - 插件注册表结构
|
||||
- **status** - 渠道状态探测
|
||||
- **registry** - 插件注册表形状
|
||||
|
||||
### 提供商契约
|
||||
|
||||
位于 `src/plugins/contracts/*.contract.test.ts`:
|
||||
|
||||
- **auth** - 认证流程契约
|
||||
- **auth-choice** - 认证选择/选取
|
||||
- **auth** - 凭证流程契约
|
||||
- **auth-choice** - 凭证选择/选取
|
||||
- **catalog** - 模型目录 API
|
||||
- **discovery** - 插件设备发现
|
||||
- **discovery** - 插件发现
|
||||
- **loader** - 插件加载
|
||||
- **runtime** - 提供商运行时
|
||||
- **shape** - 插件结构/接口
|
||||
- **shape** - 插件形状/接口
|
||||
- **wizard** - 设置向导
|
||||
|
||||
### 何时运行
|
||||
|
||||
- 更改 plugin-sdk 导出或子路径后
|
||||
- 添加或修改渠道或提供商插件后
|
||||
- 重构插件注册或设备发现后
|
||||
- 更改插件 SDK 导出或子路径之后
|
||||
- 添加或修改渠道或提供商插件之后
|
||||
- 重构插件注册或发现之后
|
||||
|
||||
契约测试会在 CI 中运行,不需要真实 API key。
|
||||
契约测试在 CI 中运行,且不需要真实 API 密钥。
|
||||
|
||||
## 添加回归(指南)
|
||||
|
||||
当你修复在实时测试中发现的提供商/模型问题时:
|
||||
当你修复实时环境中发现的提供商/模型问题时:
|
||||
|
||||
- 如果可能,添加 CI 安全回归(模拟/桩提供商,或捕获精确的请求结构转换)
|
||||
- 如果它本质上只能实时测试(速率限制、认证策略),请保持实时测试范围狭窄,并通过环境变量选择加入
|
||||
- 优先针对能捕获该 bug 的最小层:
|
||||
- 提供商请求转换/重放 bug → 直接的模型测试
|
||||
- Gateway 网关会话/历史/工具流水线 bug → Gateway 网关实时冒烟测试或 CI 安全的 Gateway 网关模拟测试
|
||||
- 尽可能添加 CI 安全回归(模拟/桩提供商,或捕获确切的请求形状转换)
|
||||
- 如果问题本质上只能实时测试(速率限制、凭证策略),请让实时测试保持窄范围,并通过环境变量选择加入
|
||||
- 优先定位能捕获该 bug 的最小层级:
|
||||
- 提供商请求转换/重放 bug → 直接模型测试
|
||||
- Gateway 网关会话/历史/工具流水线 bug → 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/exec-secret-ref-id-parity.test.ts` 会从注册表元数据(`listSecretTargetRegistryEntries()`)为每个 SecretRef 类派生一个抽样目标,然后断言包含遍历段的执行 id 会被拒绝。
|
||||
- 如果你在 `src/secrets/target-registry-data.ts` 中添加新的 `includeInPlan` SecretRef 目标族,请更新该测试中的 `classifyTargetClass`。该测试会在未分类目标 id 上有意失败,这样新类就无法被静默跳过。
|
||||
|
||||
## 相关
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
---
|
||||
read_when:
|
||||
- 运行或修复测试
|
||||
summary: 如何在本地运行测试(vitest),以及何时使用 force/coverage 模式
|
||||
summary: 如何在本地运行测试(vitest)以及何时使用 force/coverage 模式
|
||||
title: 测试
|
||||
x-i18n:
|
||||
generated_at: "2026-05-02T02:01:30Z"
|
||||
generated_at: "2026-05-02T15:57:31Z"
|
||||
model: gpt-5.5
|
||||
provider: openai
|
||||
source_hash: 1100eb4c5990de1a56c8fd65c6152318316232414078cdaad122d4525bf27fee
|
||||
source_hash: c1e4aec3c056619467bbf51549699cd0387ebb16576e88f91587aab3f382c6c1
|
||||
source_path: reference/test.md
|
||||
workflow: 16
|
||||
---
|
||||
@ -15,49 +15,49 @@ x-i18n:
|
||||
- 完整测试工具包(套件、live、Docker):[测试](/zh-CN/help/testing)
|
||||
- 更新和插件包验证:[更新和插件测试](/zh-CN/help/testing-updates-plugins)
|
||||
|
||||
- `pnpm test:force`:终止任何占用默认控制端口的残留 Gateway 网关进程,然后使用隔离的 Gateway 网关端口运行完整 Vitest 套件,避免服务器测试与正在运行的实例冲突。当先前的 Gateway 网关运行导致端口 18789 被占用时使用此命令。
|
||||
- `pnpm test:coverage`:使用 V8 覆盖率运行单元套件(通过 `vitest.unit.config.ts`)。这是已加载文件的单元覆盖率门禁,不是整个仓库的全文件覆盖率。阈值为行/函数/语句 70%,分支 55%。由于 `coverage.all` 为 false,该门禁衡量单元覆盖率套件加载的文件,而不是把每个拆分通道源文件都视为未覆盖。
|
||||
- `pnpm test:coverage:changed`:仅对自 `origin/main` 以来更改的文件运行单元覆盖率。
|
||||
- `pnpm test:changed`:低成本智能变更测试运行。它会根据直接测试编辑、同级 `*.test.ts` 文件、显式源码映射和本地导入图运行精确目标。宽泛/配置/package 变更会被跳过,除非它们映射到精确测试。
|
||||
- `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`:显式宽泛变更测试运行。当测试 harness/配置/package 编辑应回退到 Vitest 更宽泛的变更测试行为时使用。
|
||||
- `pnpm changed:lanes`:显示相对于 `origin/main` 的 diff 触发的架构通道。
|
||||
- `pnpm check:changed`:针对相对于 `origin/main` 的 diff 运行智能变更检查门禁。它会为受影响的架构通道运行 typecheck、lint 和保护命令,但不会运行 Vitest 测试。使用 `pnpm test:changed` 或显式 `pnpm test <target>` 获取测试证明。
|
||||
- `pnpm test`:将显式文件/目录目标通过作用域化 Vitest 通道路由。无目标运行使用固定分片组,并展开到叶子配置以进行本地并行执行;扩展组始终展开到逐扩展分片配置,而不是一个巨大的根项目进程。
|
||||
- 测试包装器运行结束时会带有简短的 `[test] passed|failed|skipped ... in ...` 摘要。Vitest 自己的耗时行保留为逐分片详情。
|
||||
- `pnpm test:force`: 终止任何仍占用默认控制端口的 Gateway 网关进程,然后使用隔离的 Gateway 网关端口运行完整 Vitest 套件,避免服务器测试与正在运行的实例冲突。当此前一次 Gateway 网关运行占用了端口 18789 时使用此命令。
|
||||
- `pnpm test:coverage`: 使用 V8 覆盖率运行单元套件(通过 `vitest.unit.config.ts`)。这是已加载文件的单元覆盖率门禁,不是整个仓库的全文件覆盖率。阈值为 70% 行数/函数/语句和 55% 分支。由于 `coverage.all` 为 false,该门禁会衡量单元覆盖率套件加载的文件,而不是把每个拆分车道的源文件都视为未覆盖。
|
||||
- `pnpm test:coverage:changed`: 仅对自 `origin/main` 以来变更的文件运行单元覆盖率。
|
||||
- `pnpm test:changed`: 低成本的智能变更测试运行。它会根据直接测试编辑、同级 `*.test.ts` 文件、显式源码映射和本地导入图运行精确目标。宽泛的配置/包变更会被跳过,除非它们映射到精确测试。
|
||||
- `OPENCLAW_TEST_CHANGED_BROAD=1 pnpm test:changed`: 显式的宽泛变更测试运行。当测试 harness/配置/包编辑应回退到 Vitest 更宽泛的变更测试行为时使用它。
|
||||
- `pnpm changed:lanes`: 显示相对 `origin/main` 的 diff 触发的架构车道。
|
||||
- `pnpm check:changed`: 为相对 `origin/main` 的 diff 运行智能变更检查门禁。它会为受影响的架构车道运行类型检查、lint 和 guard 命令,但不会运行 Vitest 测试。测试证明请使用 `pnpm test:changed` 或显式的 `pnpm test <target>`。
|
||||
- `pnpm test`: 将显式文件/目录目标路由到有作用域的 Vitest 车道。未指定目标的运行会使用固定分片组,并展开为叶级配置以便本地并行执行;插件组始终展开为按插件划分的分片配置,而不是一个巨大的根项目进程。
|
||||
- 测试包装器运行结束时会有一条简短的 `[test] passed|failed|skipped ... in ...` 摘要。Vitest 自己的耗时行保留为按分片的细节。
|
||||
- 共享 OpenClaw 测试状态:当测试需要隔离的 `HOME`、`OPENCLAW_STATE_DIR`、`OPENCLAW_CONFIG_PATH`、配置 fixture、工作区、智能体目录或 auth-profile 存储时,在 Vitest 中使用 `src/test-utils/openclaw-test-state.ts`。
|
||||
- 进程 E2E 辅助工具:当 Vitest 进程级 E2E 测试需要把运行中的 Gateway 网关、CLI 环境、日志捕获和清理集中到一处时,使用 `test/helpers/openclaw-test-instance.ts`。
|
||||
- Docker/Bash E2E 辅助工具:source `scripts/lib/docker-e2e-image.sh` 的通道可以把 `docker_e2e_test_state_shell_b64 <label> <scenario>` 传入容器,并用 `scripts/lib/openclaw-e2e-instance.sh` 解码;多 home 脚本可以传入 `docker_e2e_test_state_function_b64`,并在每个流程中调用 `openclaw_test_state_create <label> <scenario>`。更底层的调用方可以使用 `scripts/lib/openclaw-test-state.mjs shell --label <name> --scenario <name>` 获取容器内 shell 片段,或使用 `node scripts/lib/openclaw-test-state.mjs -- create --label <name> --scenario <name> --env-file <path> --json` 获取可 source 的宿主机环境文件。`create` 前的 `--` 会阻止较新的 Node 运行时把 `--env-file` 当作 Node 标志。启动 Gateway 网关的 Docker/Bash 通道可以在容器内 source `scripts/lib/openclaw-e2e-instance.sh`,用于入口点解析、模拟 OpenAI 启动、Gateway 网关前台/后台启动、就绪探测、状态环境导出、日志转储和进程清理。
|
||||
- 完整、扩展和 include-pattern 分片运行会更新 `.artifacts/vitest-shard-timings.json` 中的本地耗时数据;后续全配置运行会使用这些耗时来平衡慢分片和快分片。Include-pattern CI 分片会把分片名称追加到耗时键,这会保留过滤分片耗时的可见性,而不替换全配置耗时数据。设置 `OPENCLAW_TEST_PROJECTS_TIMINGS=0` 可忽略本地耗时产物。
|
||||
- 选定的 `plugin-sdk` 和 `commands` 测试文件现在会通过专用轻量通道路由,这些通道只保留 `test/setup.ts`,而运行时较重的用例仍保留在现有通道上。
|
||||
- 带同级测试的源文件会先映射到该同级测试,然后再回退到更宽的目录 glob。`src/channels/plugins/contracts/test-helpers`、`src/plugin-sdk/test-helpers` 和 `src/plugins/contracts` 下的辅助工具编辑会使用本地导入图运行导入它们的测试;当依赖路径精确时,不会宽泛运行每个分片。
|
||||
- `auto-reply` 现在也拆分为三个专用配置(`core`、`top-level`、`reply`),因此回复 harness 不会压过更轻量的顶层状态/token/辅助工具测试。
|
||||
- 基础 Vitest 配置现在默认使用 `pool: "threads"` 和 `isolate: false`,并在整个仓库配置中启用共享非隔离 runner。
|
||||
- 进程 E2E helper:当 Vitest 进程级 E2E 测试需要在一处处理运行中的 Gateway 网关、CLI 环境、日志捕获和清理时,使用 `test/helpers/openclaw-test-instance.ts`。
|
||||
- Docker/Bash E2E helper:source `scripts/lib/docker-e2e-image.sh` 的车道可以把 `docker_e2e_test_state_shell_b64 <label> <scenario>` 传入容器,并用 `scripts/lib/openclaw-e2e-instance.sh` 解码;多 home 脚本可以传入 `docker_e2e_test_state_function_b64`,并在每条流程中调用 `openclaw_test_state_create <label> <scenario>`。更底层的调用方可以使用 `scripts/lib/openclaw-test-state.mjs shell --label <name> --scenario <name>` 获取容器内 shell 片段,或使用 `node scripts/lib/openclaw-test-state.mjs -- create --label <name> --scenario <name> --env-file <path> --json` 获取可 source 的主机环境文件。`create` 前的 `--` 可避免较新的 Node 运行时把 `--env-file` 当作 Node 标志。启动 Gateway 网关的 Docker/Bash 车道可以在容器内 source `scripts/lib/openclaw-e2e-instance.sh`,用于入口点解析、模拟 OpenAI 启动、Gateway 网关前台/后台启动、就绪探针、状态环境导出、日志转储和进程清理。
|
||||
- 完整、插件和 include-pattern 分片运行会更新 `.artifacts/vitest-shard-timings.json` 中的本地计时数据;后续 whole-config 运行会使用这些计时来平衡慢分片和快分片。Include-pattern CI 分片会把分片名称追加到计时键中,这样既能保留筛选后分片的计时可见性,又不会替换 whole-config 计时数据。设置 `OPENCLAW_TEST_PROJECTS_TIMINGS=0` 可忽略本地计时工件。
|
||||
- 选定的 `plugin-sdk` 和 `commands` 测试文件现在会路由到专用轻量车道,这些车道只保留 `test/setup.ts`,而运行时较重的用例仍留在现有车道上。
|
||||
- 带有同级测试的源文件会先映射到该同级测试,然后再回退到更宽的目录 glob。`src/channels/plugins/contracts/test-helpers`、`src/plugin-sdk/test-helpers` 和 `src/plugins/contracts` 下的 helper 编辑会使用本地导入图运行导入它们的测试,而不是在依赖路径精确时宽泛运行每个分片。
|
||||
- `auto-reply` 现在也拆分为三个专用配置(`core`、`top-level`、`reply`),这样 reply harness 不会主导更轻量的顶层状态/token/helper 测试。
|
||||
- 基础 Vitest 配置现在默认使用 `pool: "threads"` 和 `isolate: false`,并在仓库配置中启用共享的非隔离 runner。
|
||||
- `pnpm test:channels` 运行 `vitest.channels.config.ts`。
|
||||
- `pnpm test:extensions` 和 `pnpm test extensions` 运行所有扩展/插件分片。重型渠道插件、浏览器插件和 OpenAI 作为专用分片运行;其他插件组保持批处理。使用 `pnpm test extensions/<id>` 运行一个内置插件通道。
|
||||
- `pnpm test:perf:imports`:启用 Vitest 导入耗时 + 导入分解报告,同时仍对显式文件/目录目标使用作用域化通道路由。
|
||||
- `pnpm test:perf:imports:changed`:相同的导入剖析,但仅针对自 `origin/main` 以来更改的文件。
|
||||
- `pnpm test:perf:changed:bench -- --ref <git-ref>`:针对同一已提交 git diff,对路由后的变更模式路径与原生根项目运行进行基准测试。
|
||||
- `pnpm test:perf:changed:bench -- --worktree`:在无需先提交的情况下,对当前 worktree 变更集进行基准测试。
|
||||
- `pnpm test:perf:profile:main`:为 Vitest 主线程写入 CPU profile(`.artifacts/vitest-main-profile`)。
|
||||
- `pnpm test:perf:profile:runner`:为单元 runner 写入 CPU + heap profiles(`.artifacts/vitest-runner-profile`)。
|
||||
- `pnpm test:perf:groups --full-suite --allow-failures --output .artifacts/test-perf/baseline-before.json`:串行运行每个完整套件 Vitest 叶子配置,并写入分组耗时数据以及逐配置 JSON/日志产物。Test Performance Agent 在尝试修复慢测试之前使用它作为基线。
|
||||
- `pnpm test:perf:groups:compare .artifacts/test-perf/baseline-before.json .artifacts/test-perf/after-agent.json`:在性能相关变更之后比较分组报告。
|
||||
- `pnpm test:extensions` 和 `pnpm test extensions` 运行所有扩展/插件分片。重型渠道插件、浏览器插件和 OpenAI 会作为专用分片运行;其他插件组保持批处理。对单个内置插件车道使用 `pnpm test extensions/<id>`。
|
||||
- `pnpm test:perf:imports`: 启用 Vitest 导入耗时 + 导入细分报告,同时仍对显式文件/目录目标使用有作用域的车道路由。
|
||||
- `pnpm test:perf:imports:changed`: 相同的导入分析,但仅针对自 `origin/main` 以来变更的文件。
|
||||
- `pnpm test:perf:changed:bench -- --ref <git-ref>` 会针对同一已提交 git diff,将已路由的 changed-mode 路径与原生根项目运行进行基准比较。
|
||||
- `pnpm test:perf:changed:bench -- --worktree` 会在无需先提交的情况下,对当前工作区变更集进行基准测试。
|
||||
- `pnpm test:perf:profile:main`: 为 Vitest 主线程写入 CPU profile(`.artifacts/vitest-main-profile`)。
|
||||
- `pnpm test:perf:profile:runner`: 为单元 runner 写入 CPU + heap profile(`.artifacts/vitest-runner-profile`)。
|
||||
- `pnpm test:perf:groups --full-suite --allow-failures --output .artifacts/test-perf/baseline-before.json`: 串行运行每个 full-suite Vitest 叶级配置,并写入分组耗时数据以及按配置的 JSON/日志工件。Test Performance Agent 会在尝试修复慢测试前将其用作基线。
|
||||
- `pnpm test:perf:groups:compare .artifacts/test-perf/baseline-before.json .artifacts/test-perf/after-agent.json`: 在面向性能的变更后比较分组报告。
|
||||
- Gateway 网关集成:通过 `OPENCLAW_TEST_INCLUDE_GATEWAY=1 pnpm test` 或 `pnpm test:gateway` 选择启用。
|
||||
- `pnpm test:e2e`:运行 Gateway 网关端到端 smoke tests(多实例 WS/HTTP/node 配对)。默认在 `vitest.e2e.config.ts` 中使用 `threads` + `isolate: false` 和自适应 workers;用 `OPENCLAW_E2E_WORKERS=<n>` 调整,并设置 `OPENCLAW_E2E_VERBOSE=1` 输出详细日志。
|
||||
- `pnpm test:live`:运行提供商 live tests(minimax/zai)。需要 API key 和 `LIVE=1`(或提供商专用 `*_LIVE_TEST=1`)才会解除跳过。
|
||||
- `pnpm test:docker:all`:构建共享 live-test 镜像,将 OpenClaw 一次性打包为 npm tarball,构建/复用一个裸 Node/Git runner 镜像,以及一个把该 tarball 安装到 `/app` 的功能镜像,然后通过加权调度器使用 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行 Docker smoke 通道。裸镜像(`OPENCLAW_DOCKER_E2E_BARE_IMAGE`)用于安装器/更新/插件依赖通道;这些通道挂载预构建 tarball,而不是使用复制的仓库源码。功能镜像(`OPENCLAW_DOCKER_E2E_FUNCTIONAL_IMAGE`)用于普通的已构建应用功能通道。`scripts/package-openclaw-for-docker.mjs` 是唯一的本地/CI package 打包器,会在 Docker 消费前验证 tarball 和 `dist/postinstall-inventory.json`。Docker 通道定义位于 `scripts/lib/docker-e2e-scenarios.mjs`;规划器逻辑位于 `scripts/lib/docker-e2e-plan.mjs`;`scripts/test-docker-all.mjs` 执行选定计划。`node scripts/test-docker-all.mjs --plan-json` 会输出由调度器拥有的 CI 计划,包含选定通道、镜像类型、package/live-image 需求、状态场景和凭证检查,而不构建或运行 Docker。`OPENCLAW_DOCKER_ALL_PARALLELISM=<n>` 控制进程槽位,默认 10;`OPENCLAW_DOCKER_ALL_TAIL_PARALLELISM=<n>` 控制提供商敏感的尾部池,默认 10。重型通道上限默认是 `OPENCLAW_DOCKER_ALL_LIVE_LIMIT=9`、`OPENCLAW_DOCKER_ALL_NPM_LIMIT=10` 和 `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7`;提供商上限默认通过 `OPENCLAW_DOCKER_ALL_LIVE_CLAUDE_LIMIT=4`、`OPENCLAW_DOCKER_ALL_LIVE_CODEX_LIMIT=4` 和 `OPENCLAW_DOCKER_ALL_LIVE_GEMINI_LIMIT=4` 为每个提供商设置一个重型通道。更大的宿主机可使用 `OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT` 或 `OPENCLAW_DOCKER_ALL_DOCKER_LIMIT`。如果某个通道在低并行宿主机上超过有效权重或资源上限,它仍可从空池启动,并会独占运行,直到释放容量。默认通道启动错开 2 秒,以避免本地 Docker daemon create 风暴;可用 `OPENCLAW_DOCKER_ALL_START_STAGGER_MS=<ms>` 覆盖。runner 默认预检 Docker,清理陈旧 OpenClaw E2E 容器,每 30 秒输出活动通道状态,在兼容通道之间共享提供商 CLI 工具缓存,默认对临时 live-provider 失败重试一次(`OPENCLAW_DOCKER_ALL_LIVE_RETRIES=<n>`),并把通道耗时存储到 `.artifacts/docker-tests/lane-timings.json`,供后续运行按最长优先排序。使用 `OPENCLAW_DOCKER_ALL_DRY_RUN=1` 打印通道清单而不运行 Docker,使用 `OPENCLAW_DOCKER_ALL_STATUS_INTERVAL_MS=<ms>` 调整状态输出,或使用 `OPENCLAW_DOCKER_ALL_TIMINGS=0` 禁用耗时复用。使用 `OPENCLAW_DOCKER_ALL_LIVE_MODE=skip` 仅运行确定性/本地通道,或使用 `OPENCLAW_DOCKER_ALL_LIVE_MODE=only` 仅运行 live-provider 通道;package 别名是 `pnpm test:docker:local:all` 和 `pnpm test:docker:live:all`。Live-only 模式会把主 live 通道和尾部 live 通道合并到一个最长优先池中,让提供商桶可以一起装入 Claude、Codex 和 Gemini 工作。除非设置 `OPENCLAW_DOCKER_ALL_FAIL_FAST=0`,runner 会在首次失败后停止调度新的池化通道;每个通道都有 120 分钟的后备超时,可用 `OPENCLAW_DOCKER_ALL_LANE_TIMEOUT_MS` 覆盖;选定 live/tail 通道使用更紧的逐通道上限。CLI backend Docker 设置命令有自己的超时,通过 `OPENCLAW_LIVE_CLI_BACKEND_SETUP_TIMEOUT_SECONDS` 控制(默认 180)。逐通道日志、`summary.json`、`failures.json` 和阶段耗时会写入 `.artifacts/docker-tests/<run-id>/` 下;使用 `pnpm test:docker:timings <summary.json>` 检查慢通道,使用 `pnpm test:docker:rerun <run-id|summary.json|failures.json>` 打印低成本定向重跑命令。
|
||||
- `pnpm test:docker:browser-cdp-snapshot`:构建一个 Chromium 支持的源码 E2E 容器,启动原始 CDP 和隔离的 Gateway 网关,运行 `browser doctor --deep`,并验证 CDP 角色快照包含链接 URL、光标提升的可点击项、iframe 引用和 frame 元数据。
|
||||
- CLI backend live Docker 探针可以作为聚焦通道运行,例如 `pnpm test:docker:live-cli-backend:codex`、`pnpm test:docker:live-cli-backend:codex:resume` 或 `pnpm test:docker:live-cli-backend:codex:mcp`。Claude 和 Gemini 有对应的 `:resume` 和 `:mcp` 别名。
|
||||
- `pnpm test:docker:openwebui`:启动 Docker 化的 OpenClaw + Open WebUI,通过 Open WebUI 登录,检查 `/api/models`,然后通过 `/api/chat/completions` 运行真实代理聊天。需要可用的 live 模型 key(例如 `~/.profile` 中的 OpenAI),会拉取外部 Open WebUI 镜像,并且不预期像普通单元/e2e 套件一样在 CI 中稳定。
|
||||
- `pnpm test:docker:mcp-channels`:启动带种子的 Gateway 网关容器和第二个客户端容器,后者会生成 `openclaw mcp serve`,然后验证路由会话发现、transcript 读取、附件元数据、live event queue 行为、出站发送路由,以及通过真实 stdio bridge 的 Claude 风格渠道 + 权限通知。Claude 通知断言会直接读取原始 stdio MCP frames,因此 smoke 反映 bridge 实际发出的内容。
|
||||
- `pnpm test:docker:upgrade-survivor`:将打包的 OpenClaw tarball 安装到一个脏的旧用户 fixture 之上,在没有实时提供商或渠道密钥的情况下运行软件包更新和非交互式 Doctor,然后启动一个回环 Gateway 网关,并检查智能体、渠道配置、插件允许列表、工作区/会话文件、过期的旧版插件依赖状态、启动流程和 RPC Status 是否保留。
|
||||
- `pnpm test:docker:published-upgrade-survivor`:默认安装 `openclaw@latest`,在没有实时提供商或渠道密钥的情况下播种真实的既有用户文件,用内置的 `openclaw config set` 命令配方配置该基线,将该已发布安装更新到打包的 OpenClaw tarball,运行非交互式 Doctor,写入 `.artifacts/upgrade-survivor/summary.json`,然后启动一个回环 Gateway 网关,并检查已配置的 intent、工作区/会话文件、过期插件配置和旧版依赖状态、启动流程、`/healthz`、`/readyz` 以及 RPC Status 是否保留或被干净修复。可用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC` 覆盖一个基线,用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECS` 扩展精确矩阵,或用 `OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS=reported-issues` 添加场景 fixture;Package Acceptance 将这些暴露为 `published_upgrade_survivor_baseline`、`published_upgrade_survivor_baselines` 和 `published_upgrade_survivor_scenarios`。
|
||||
- `pnpm test:docker:update-migration`:在清理负载较重的 `plugin-deps-cleanup` 场景中运行已发布升级保留检查 harness,默认从 `openclaw@2026.4.23` 开始。独立的“更新迁移”工作流使用 `baselines=all-since-2026.4.23` 扩展此 lane,因此从 `.23` 开始的每个稳定已发布软件包都会更新到候选版本,并在 Full Release CI 之外证明已配置插件的依赖清理。
|
||||
- `pnpm test:docker:plugins`:为本地路径、`file:`、带提升依赖的 npm registry 软件包、git 移动引用、ClawHub fixture、marketplace 更新以及 Claude 捆绑包启用/检查运行安装/更新冒烟测试。
|
||||
- `pnpm test:e2e`: 运行 Gateway 网关端到端 smoke 测试(多实例 WS/HTTP/node 配对)。默认使用 `threads` + `isolate: false`,并在 `vitest.e2e.config.ts` 中使用自适应 worker;用 `OPENCLAW_E2E_WORKERS=<n>` 调整,并设置 `OPENCLAW_E2E_VERBOSE=1` 以输出详细日志。
|
||||
- `pnpm test:live`: 运行提供商 live 测试(minimax/zai)。需要 API key 和 `LIVE=1`(或提供商特定的 `*_LIVE_TEST=1`)才能取消跳过。
|
||||
- `pnpm test:docker:all`: 构建共享 live-test 镜像,将 OpenClaw 作为 npm tarball 打包一次,构建/复用一个裸 Node/Git runner 镜像以及一个把该 tarball 安装到 `/app` 的功能镜像,然后通过加权调度器以 `OPENCLAW_SKIP_DOCKER_BUILD=1` 运行 Docker smoke 车道。裸镜像(`OPENCLAW_DOCKER_E2E_BARE_IMAGE`)用于安装器/更新/插件依赖车道;这些车道会挂载预构建 tarball,而不是使用复制的仓库源码。功能镜像(`OPENCLAW_DOCKER_E2E_FUNCTIONAL_IMAGE`)用于普通的已构建应用功能车道。`scripts/package-openclaw-for-docker.mjs` 是唯一的本地/CI 包打包器,会在 Docker 使用前验证 tarball 和 `dist/postinstall-inventory.json`。Docker 车道定义位于 `scripts/lib/docker-e2e-scenarios.mjs`;规划器逻辑位于 `scripts/lib/docker-e2e-plan.mjs`;`scripts/test-docker-all.mjs` 执行选定计划。`node scripts/test-docker-all.mjs --plan-json` 会输出由调度器拥有的 CI 计划,其中包含选定车道、镜像种类、包/live-image 需求、状态场景和凭据检查,而不会构建或运行 Docker。`OPENCLAW_DOCKER_ALL_PARALLELISM=<n>` 控制进程槽位,默认值为 10;`OPENCLAW_DOCKER_ALL_TAIL_PARALLELISM=<n>` 控制对提供商敏感的尾部池,默认值为 10。重型车道上限默认是 `OPENCLAW_DOCKER_ALL_LIVE_LIMIT=9`、`OPENCLAW_DOCKER_ALL_NPM_LIMIT=10` 和 `OPENCLAW_DOCKER_ALL_SERVICE_LIMIT=7`;提供商上限默认通过 `OPENCLAW_DOCKER_ALL_LIVE_CLAUDE_LIMIT=4`、`OPENCLAW_DOCKER_ALL_LIVE_CODEX_LIMIT=4` 和 `OPENCLAW_DOCKER_ALL_LIVE_GEMINI_LIMIT=4` 为每个提供商设置一个重型车道。更大的主机可使用 `OPENCLAW_DOCKER_ALL_WEIGHT_LIMIT` 或 `OPENCLAW_DOCKER_ALL_DOCKER_LIMIT`。如果某个车道在低并行度主机上超过有效权重或资源上限,它仍可从空池启动,并会独占运行直到释放容量。车道启动默认错开 2 秒,以避免本地 Docker daemon 出现创建风暴;可用 `OPENCLAW_DOCKER_ALL_START_STAGGER_MS=<ms>` 覆盖。runner 默认会预检 Docker、清理陈旧的 OpenClaw E2E 容器、每 30 秒输出活跃车道状态、在兼容车道之间共享提供商 CLI 工具缓存、默认对瞬时 live-provider 故障重试一次(`OPENCLAW_DOCKER_ALL_LIVE_RETRIES=<n>`),并把车道计时存储到 `.artifacts/docker-tests/lane-timings.json`,供后续运行按最长优先排序。使用 `OPENCLAW_DOCKER_ALL_DRY_RUN=1` 可打印车道清单而不运行 Docker,使用 `OPENCLAW_DOCKER_ALL_STATUS_INTERVAL_MS=<ms>` 可调整状态输出,或使用 `OPENCLAW_DOCKER_ALL_TIMINGS=0` 禁用计时复用。使用 `OPENCLAW_DOCKER_ALL_LIVE_MODE=skip` 仅运行确定性/本地车道,或使用 `OPENCLAW_DOCKER_ALL_LIVE_MODE=only` 仅运行 live-provider 车道;包别名为 `pnpm test:docker:local:all` 和 `pnpm test:docker:live:all`。Live-only 模式会把主 live 车道和尾部 live 车道合并为一个最长优先池,让提供商桶可以把 Claude、Codex 和 Gemini 工作一起打包。除非设置 `OPENCLAW_DOCKER_ALL_FAIL_FAST=0`,runner 会在第一次失败后停止调度新的池化车道;每个车道都有 120 分钟的兜底超时,可用 `OPENCLAW_DOCKER_ALL_LANE_TIMEOUT_MS` 覆盖;选定的 live/tail 车道使用更严格的按车道上限。CLI 后端 Docker 设置命令有自己的超时,通过 `OPENCLAW_LIVE_CLI_BACKEND_SETUP_TIMEOUT_SECONDS` 配置(默认 180)。按车道的日志、`summary.json`、`failures.json` 和阶段计时会写入 `.artifacts/docker-tests/<run-id>/` 下;使用 `pnpm test:docker:timings <summary.json>` 查看慢车道,并使用 `pnpm test:docker:rerun <run-id|summary.json|failures.json>` 打印低成本的定向重跑命令。
|
||||
- `pnpm test:docker:browser-cdp-snapshot`: 构建基于 Chromium 的源码 E2E 容器,启动原始 CDP 和隔离的 Gateway 网关,运行 `browser doctor --deep`,并验证 CDP role 快照包含链接 URL、光标提升的可点击项、iframe 引用和 frame 元数据。
|
||||
- CLI 后端 live Docker 探针可以作为聚焦车道运行,例如 `pnpm test:docker:live-cli-backend:codex`、`pnpm test:docker:live-cli-backend:codex:resume` 或 `pnpm test:docker:live-cli-backend:codex:mcp`。Claude 和 Gemini 有对应的 `:resume` 和 `:mcp` 别名。
|
||||
- `pnpm test:docker:openwebui`: 启动 Docker 化的 OpenClaw + Open WebUI,通过 Open WebUI 登录,检查 `/api/models`,然后通过 `/api/chat/completions` 运行一次真实的代理聊天。需要可用的 live 模型 key(例如 `~/.profile` 中的 OpenAI),会拉取外部 Open WebUI 镜像,并且不预期像普通 unit/e2e 套件那样具有 CI 稳定性。
|
||||
- `pnpm test:docker:mcp-channels`: 启动一个已注入种子的 Gateway 网关容器和第二个会生成 `openclaw mcp serve` 的客户端容器,然后验证路由式会话发现、transcript 读取、附件元数据、live event queue 行为、出站发送路由,以及通过真实 stdio bridge 传递的 Claude 风格渠道 + 权限通知。Claude 通知断言会直接读取原始 stdio MCP frame,因此该 smoke 反映 bridge 实际发出的内容。
|
||||
- `pnpm test:docker:upgrade-survivor`:将打包的 OpenClaw tar 包安装到带有脏状态的老用户 fixture 上,在没有实时提供商或渠道密钥的情况下运行包更新和非交互式 Doctor,然后启动回环 Gateway 网关,并检查智能体、渠道配置、插件允许列表、工作区/会话文件、过时的旧版插件依赖状态、启动和 RPC 状态是否保留。
|
||||
- `pnpm test:docker:published-upgrade-survivor`:默认安装 `openclaw@latest`,在没有实时提供商或渠道密钥的情况下写入真实的既有用户文件,使用内置的 `openclaw config set` 命令配方配置该基线,将这个已发布安装更新到打包的 OpenClaw tar 包,运行非交互式 Doctor,写入 `.artifacts/upgrade-survivor/summary.json`,然后启动回环 Gateway 网关,并检查已配置的意图、工作区/会话文件、过时的插件配置和旧版依赖状态、启动、`/healthz`、`/readyz` 以及 RPC 状态是否保留或干净修复。使用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPEC` 覆盖一个基线,使用 `OPENCLAW_UPGRADE_SURVIVOR_BASELINE_SPECS` 扩展精确矩阵,或使用 `OPENCLAW_UPGRADE_SURVIVOR_SCENARIOS=reported-issues` 添加场景 fixture;reported-issues 集包含 `configured-plugin-installs`,用于验证已配置的外部 OpenClaw 插件会在升级期间自动安装。Package Acceptance 将这些公开为 `published_upgrade_survivor_baseline`、`published_upgrade_survivor_baselines` 和 `published_upgrade_survivor_scenarios`。
|
||||
- `pnpm test:docker:update-migration`:在清理工作较重的 `plugin-deps-cleanup` 场景中运行已发布升级 survivor harness,默认从 `openclaw@2026.4.23` 开始。单独的 `Update Migration` 工作流使用 `baselines=all-since-2026.4.23` 扩展此通道,使 `.23` 以来的每个稳定已发布包都更新到候选版本,并在 Full Release CI 之外证明已配置插件的依赖清理。
|
||||
- `pnpm test:docker:plugins`:对本地路径、`file:`、带提升依赖的 npm registry 包、git 移动 ref、ClawHub fixture、marketplace 更新,以及 Claude-bundle 启用/检查运行安装/更新 smoke。
|
||||
|
||||
## 本地 PR 门禁
|
||||
|
||||
对于本地 PR 合并/门禁检查,运行:
|
||||
对于本地 PR 合入/门禁检查,运行:
|
||||
|
||||
- `pnpm check:changed`
|
||||
- `pnpm check`
|
||||
@ -66,7 +66,7 @@ x-i18n:
|
||||
- `pnpm test`
|
||||
- `pnpm check:docs`
|
||||
|
||||
如果 `pnpm test` 在负载较高的主机上偶发失败,先重新运行一次,再将其视为回归问题,然后用 `pnpm test <path/to/test>` 隔离定位。对于内存受限的主机,使用:
|
||||
如果 `pnpm test` 在负载较高的主机上出现不稳定失败,先重跑一次再将其视为回归,然后用 `pnpm test <path/to/test>` 隔离问题。对于内存受限的主机,使用:
|
||||
|
||||
- `OPENCLAW_VITEST_MAX_WORKERS=1 pnpm test`
|
||||
- `OPENCLAW_VITEST_FS_MODULE_CACHE_PATH=/tmp/openclaw-vitest-cache pnpm test:changed`
|
||||
@ -79,7 +79,7 @@ x-i18n:
|
||||
|
||||
- `source ~/.profile && pnpm tsx scripts/bench-model.ts --runs 10`
|
||||
- 可选环境变量:`MINIMAX_API_KEY`、`MINIMAX_BASE_URL`、`MINIMAX_MODEL`、`ANTHROPIC_API_KEY`
|
||||
- 默认提示词:“只回复一个单词:ok。不要使用标点或额外文本。”
|
||||
- 默认 prompt:“只回复一个单词:ok。不要标点或额外文本。”
|
||||
|
||||
上次运行(2025-12-31,20 次运行):
|
||||
|
||||
@ -114,12 +114,12 @@ x-i18n:
|
||||
- `real`:`health`、`status`、`status --json`、`sessions`、`sessions --json`、`tasks --json`、`tasks list --json`、`tasks audit --json`、`agents list --json`、`gateway status`、`gateway status --json`、`gateway health --json`、`config get gateway.port`
|
||||
- `all`:两个预设
|
||||
|
||||
输出包含每个命令的 `sampleCount`、平均值、p50、p95、最小/最大值、退出码/信号分布,以及最大 RSS 摘要。可选的 `--cpu-prof-dir` / `--heap-prof-dir` 会为每次运行写入 V8 profile,因此计时和 profile 捕获会使用同一个 harness。
|
||||
输出包含每个命令的 `sampleCount`、平均值、p50、p95、最小/最大值、退出码/信号分布,以及最大 RSS 摘要。可选的 `--cpu-prof-dir` / `--heap-prof-dir` 会为每次运行写入 V8 配置文件,因此计时和配置文件采集使用同一套 harness。
|
||||
|
||||
保存输出约定:
|
||||
已保存输出约定:
|
||||
|
||||
- `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:smoke` 将目标 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`
|
||||
|
||||
签入的 fixture:
|
||||
@ -130,25 +130,25 @@ x-i18n:
|
||||
|
||||
## 新手引导 E2E(Docker)
|
||||
|
||||
Docker 是可选的;只有容器化新手引导冒烟测试需要它。
|
||||
Docker 是可选的;仅容器化新手引导 smoke 测试需要它。
|
||||
|
||||
在干净的 Linux 容器中的完整冷启动流程:
|
||||
在干净 Linux 容器中的完整冷启动流程:
|
||||
|
||||
```bash
|
||||
scripts/e2e/onboard-docker.sh
|
||||
```
|
||||
|
||||
此脚本通过伪 TTY 驱动交互式向导,验证配置/工作区/会话文件,然后启动 Gateway 网关并运行 `openclaw health`。
|
||||
此脚本通过伪 tty 驱动交互式向导,验证配置/工作区/会话文件,然后启动 Gateway 网关并运行 `openclaw health`。
|
||||
|
||||
## QR 导入冒烟测试(Docker)
|
||||
## QR 导入 smoke(Docker)
|
||||
|
||||
确保维护中的 QR 运行时 helper 能在受支持的 Docker Node 运行时下加载(默认 Node 24,兼容 Node 22):
|
||||
确保维护中的 QR 运行时 helper 可在支持的 Docker Node 运行时下加载(默认 Node 24,兼容 Node 22):
|
||||
|
||||
```bash
|
||||
pnpm test:docker:qr
|
||||
```
|
||||
|
||||
## 相关内容
|
||||
## 相关
|
||||
|
||||
- [测试](/zh-CN/help/testing)
|
||||
- [实时测试](/zh-CN/help/testing-live)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user