本文档定义 claude-code 项目的测试规范、当前覆盖状态和改进计划。
| 项 | 选型 |
|---|---|
| 测试框架 | bun:test |
| 断言/Mock | bun:test 内置 |
| 覆盖率 | bun test --coverage |
| CI | GitHub Actions,push/PR 到 main 自动运行 |
本项目采用 单元测试 + 集成测试 两层结构,不做 E2E 或快照测试。
- 单元测试 — 纯函数、工具类、解析器。文件就近放置于
src/**/__tests__/。 - 集成测试 — 多模块协作流程。集中于
tests/integration/。
src/
├── utils/__tests__/ # 纯函数单元测试
├── tools/<Tool>/__tests__/ # Tool 单元测试
├── services/mcp/__tests__/ # MCP 单元测试
├── utils/permissions/__tests__/
├── utils/model/__tests__/
├── utils/settings/__tests__/
├── utils/shell/__tests__/
├── utils/git/__tests__/
└── __tests__/ # 顶层模块测试 (Tool.ts, tools.ts)
tests/
├── integration/ # 集成测试(尚未创建)
├── mocks/ # 共享 mock/fixture(尚未创建)
└── helpers/ # 测试辅助函数
- 测试文件:
<module>.test.ts - 命名风格:
describe("functionName")+test("行为描述"),英文 - 编写原则:Arrange-Act-Assert、单一职责、独立性、边界覆盖
更新日期:2026-04-02 | 1623 tests, 84 files, 0 fail, 851ms
每个测试文件按断言深度、边界覆盖、mock 质量、测试独立性综合评定:
| 等级 | 含义 |
|---|---|
| GOOD | 断言精确(exact match),边界充分,结构清晰 |
| ACCEPTABLE | 正常路径覆盖完整,部分边界或断言可加强 |
| WEAK | 存在明显缺陷:断言过弱、重要边界缺失、或有脆弱性风险 |
| 文件 | Tests | 评分 | 覆盖范围 | 主要不足 |
|---|---|---|---|---|
src/__tests__/Tool.test.ts |
20 | GOOD | buildTool, toolMatchesName, findToolByName, filterToolProgressMessages | — |
src/__tests__/tools.test.ts |
9 | ACCEPTABLE | parseToolPreset, filterToolsByDenyRules | 预设覆盖仅测 "default";有冗余用例 |
src/tools/FileEditTool/__tests__/utils.test.ts |
22 | ACCEPTABLE | normalizeQuotes, applyEditToFile, preserveQuoteStyle | findActualString 断言过弱(not.toBeNull);preserveQuoteStyle 仅 2 用例 |
src/tools/shared/__tests__/gitOperationTracking.test.ts |
20 | ACCEPTABLE | parseGitCommitId, detectGitOperation | 6 个 GH PR action 全覆盖;缺 trackGitOperations 测试(需 mock analytics) |
src/tools/BashTool/__tests__/destructiveCommandWarning.test.ts |
21 | ACCEPTABLE | git/rm/SQL/k8s/terraform 危险模式 | safe commands 4 断言合一;缺少 rm -rf /、DROP DATABASE、管道命令 |
src/tools/BashTool/__tests__/commandSemantics.test.ts |
10 | ACCEPTABLE | grep/diff/test/rg/find 退出码语义 | mock splitCommand_DEPRECATED 与实现可能分歧;覆盖可更全面 |
Utils 纯函数(19 文件):
| 文件 | Tests | 评分 | 覆盖范围 | 主要不足 |
|---|---|---|---|---|
utils/__tests__/array.test.ts |
12 | GOOD | intersperse, count, uniq | — |
utils/__tests__/set.test.ts |
11 | GOOD | difference, intersects, every, union | — |
utils/__tests__/xml.test.ts |
9 | GOOD | escapeXml, escapeXmlAttr | 缺 null/undefined 输入测试 |
utils/__tests__/hash.test.ts |
12 | ACCEPTABLE | djb2Hash, hashContent, hashPair | hashContent/hashPair 无已知答案断言(仅测确定性) |
utils/__tests__/stringUtils.test.ts |
30 | GOOD | 10 个函数全覆盖,含 Unicode 边界 | — |
utils/__tests__/semver.test.ts |
16 | ACCEPTABLE | gt/gte/lt/lte/satisfies/order | 缺 pre-release、tilde range、畸形版本串 |
utils/__tests__/uuid.test.ts |
6 | ACCEPTABLE | validateUuid | 大写测试仅 not.toBeNull,未验证标准化输出 |
utils/__tests__/format.test.ts |
27 | GOOD | formatFileSize, formatDuration, formatNumber, formatTokens, formatRelativeTime | 全部 toBe 精确匹配,含 billions/weeks/days 边界 |
utils/__tests__/frontmatterParser.test.ts |
22 | GOOD | parseFrontmatter, splitPathInFrontmatter, parsePositiveIntFromFrontmatter | — |
utils/__tests__/file.test.ts |
13 | ACCEPTABLE | convertLeadingTabsToSpaces, addLineNumbers, stripLineNumberPrefix | addLineNumbers 仅 toContain;缺 Windows 路径分隔符测试 |
utils/__tests__/glob.test.ts |
6 | ACCEPTABLE | extractGlobBaseDirectory | 缺绝对路径、根 /、Windows 路径 |
utils/__tests__/diff.test.ts |
8 | ACCEPTABLE | adjustHunkLineNumbers, getPatchFromContents | getPatchFromContents 仅检查结构,未验证 diff 内容正确性 |
utils/__tests__/json.test.ts |
15 | GOOD | safeParseJSON, parseJSONL, addItemToJSONCArray | — |
utils/__tests__/truncate.test.ts |
18 | ACCEPTABLE | truncateToWidth, wrapText, truncatePathMiddle | 缺 CJK/emoji/wide-char 测试(这是宽度感知实现的核心场景) |
utils/__tests__/path.test.ts |
15 | ACCEPTABLE | containsPathTraversal, normalizePathForConfigKey | 仅覆盖 2/5+ 导出函数 |
utils/__tests__/tokens.test.ts |
18 | GOOD | getTokenCountFromUsage, doesMostRecentAssistantMessageExceed200k 等 | — |
utils/__tests__/stream.test.ts |
15 | GOOD | Stream<T> enqueue/read/drain/next/done/error/for-await | — |
utils/__tests__/abortController.test.ts |
13 | GOOD | createAbortController/createChildAbortController 父子传播 | — |
utils/__tests__/bufferedWriter.test.ts |
10 | GOOD | createBufferedWriter 立即/缓冲/flush/overflow | — |
utils/__tests__/gitDiff.test.ts |
25 | GOOD | parseGitNumstat/parseGitDiff/parseShortstat 纯解析 | — |
utils/__tests__/sliceAnsi.test.ts |
13 | GOOD | sliceAnsi ANSI 感知切片 + undoAnsiCodes | — |
utils/__tests__/treeify.test.ts |
13 | ACCEPTABLE | treeify 扁平/嵌套/循环引用 | 缺深度嵌套性能测试 |
utils/__tests__/words.test.ts |
11 | GOOD | slug 格式 (adjective-verb-noun)、唯一性 | — |
Context 构建(3 文件):
| 文件 | Tests | 评分 | 覆盖范围 | 主要不足 |
|---|---|---|---|---|
utils/__tests__/claudemd.test.ts |
14 | ACCEPTABLE | stripHtmlComments, isMemoryFilePath, getLargeMemoryFiles | 仅测 3 个辅助函数,核心发现/加载/@include 指令/memoization 未覆盖 |
utils/__tests__/systemPrompt.test.ts |
8 | GOOD | buildEffectiveSystemPrompt | — |
__tests__/history.test.ts |
26 | GOOD | parseReferences/expandPastedTextRefs/formatPastedTextRef 等 5 个函数 | — |
| 文件 | Tests | 评分 | 覆盖范围 | 主要不足 |
|---|---|---|---|---|
permissions/__tests__/permissionRuleParser.test.ts |
16 | GOOD | escape/unescape 规则,roundtrip 完整性 | — |
permissions/__tests__/permissions.test.ts |
12 | ACCEPTABLE | getDenyRuleForTool, getAskRuleForTool, filterDeniedAgents | as any cast;缺 MCP tool deny 测试 |
permissions/__tests__/shellRuleMatching.test.ts |
19 | GOOD | 通配符、转义、正则特殊字符 | — |
permissions/__tests__/PermissionMode.test.ts |
22 | ACCEPTABLE | permissionModeFromString, isExternalPermissionMode 等 | isExternalPermissionMode ant false 路径已覆盖;缺 bubble 模式独立测试 |
permissions/__tests__/dangerousPatterns.test.ts |
7 | WEAK | CROSS_PLATFORM_CODE_EXEC, DANGEROUS_BASH_PATTERNS | 纯数据 smoke test,无行为测试;不验证数组无重复 |
model/__tests__/aliases.test.ts |
15 | ACCEPTABLE | isModelAlias, isModelFamilyAlias | 缺 null/undefined/空串输入 |
model/__tests__/model.test.ts |
13 | ACCEPTABLE | firstPartyNameToCanonical | 缺空串、非标准日期后缀 |
model/__tests__/providers.test.ts |
9 | ACCEPTABLE | getAPIProvider, isFirstPartyAnthropicBaseUrl | originalEnv 声明未使用;env 恢复不完整 |
utils/__tests__/messages.test.ts |
36 | GOOD | createAssistantMessage, createUserMessage, extractTag 等 16 个 describe | normalizeMessages 仅检查长度未验证内容 |
Tool 子模块(8 文件):
| 文件 | Tests | 评分 | 覆盖范围 | 主要不足 |
|---|---|---|---|---|
tools/PowerShellTool/__tests__/powershellSecurity.test.ts |
24 | GOOD | AST 安全检测:Invoke-Expression/iex/encoded/dynamic/download/COM | — |
tools/PowerShellTool/__tests__/commandSemantics.test.ts |
21 | GOOD | grep/rg/findstr/robocopy 退出码、pipeline last-segment | — |
tools/PowerShellTool/__tests__/destructiveCommandWarning.test.ts |
38 | GOOD | Remove-Item/Format-Volume/Clear-Disk/git/SQL/COMPUTER/alias 全覆盖 | — |
tools/PowerShellTool/__tests__/gitSafety.test.ts |
29 | GOOD | .git 路径检测/NTFS 短名/反斜杠/引号/反引号转义 | — |
tools/LSPTool/__tests__/formatters.test.ts |
18 | GOOD | 全部 8 个 format 函数 null/empty/valid 输入 | — |
tools/LSPTool/__tests__/schemas.test.ts |
13 | GOOD | isValidLSPOperation 类型守卫 9 种操作 + 无效/空/大小写 | — |
tools/WebFetchTool/__tests__/preapproved.test.ts |
18 | GOOD | isPreapprovedHost 精确/路径作用域/子路径/大小写/子域名 | — |
tools/WebFetchTool/__tests__/urlValidation.test.ts |
18 | GOOD | validateURL/isPermittedRedirect 本地重实现(避免重依赖链) | — |
| 文件 | Tests | 评分 | 覆盖范围 | 主要不足 |
|---|---|---|---|---|
utils/__tests__/cron.test.ts |
31 | GOOD | parseCronExpression, computeNextCronRun, cronToHuman | 缺月边界、闰年 |
utils/__tests__/git.test.ts |
15 | ACCEPTABLE | normalizeGitRemoteUrl (SSH/HTTPS/ssh://) | 缺 git://、file://、端口号 |
settings/__tests__/config.test.ts |
38 | GOOD | SettingsSchema, type guards, validateSettingsFileContent, formatZodError | 缺 DeniedMcpServerEntrySchema |
| 文件 | Tests | 评分 | 备注 |
|---|---|---|---|
utils/__tests__/errors.test.ts |
33 | GOOD | — |
utils/__tests__/envUtils.test.ts |
33 | GOOD | env 保存/恢复规范 |
utils/__tests__/effort.test.ts |
30 | GOOD | 5 个 mock 模块,边界完整 |
utils/__tests__/argumentSubstitution.test.ts |
22 | ACCEPTABLE | 缺转义引号、越界索引 |
utils/__tests__/sanitization.test.ts |
14 | ACCEPTABLE | — |
utils/__tests__/sleep.test.ts |
14 | GOOD | 时间相关测试,margin 充足 |
utils/__tests__/CircularBuffer.test.ts |
11 | ACCEPTABLE | 缺 capacity=1、空 buffer getRecent |
utils/__tests__/memoize.test.ts |
18 | GOOD | 缓存 hit/stale/LRU 全覆盖 |
utils/__tests__/tokenBudget.test.ts |
21 | GOOD | — |
utils/__tests__/displayTags.test.ts |
17 | GOOD | — |
utils/__tests__/taggedId.test.ts |
10 | GOOD | — |
utils/__tests__/controlMessageCompat.test.ts |
15 | GOOD | — |
utils/__tests__/gitConfigParser.test.ts |
21 | GOOD | — |
utils/__tests__/windowsPaths.test.ts |
19 | GOOD | 双向 round-trip 测试 |
utils/__tests__/envExpansion.test.ts |
15 | GOOD | — |
utils/__tests__/formatBriefTimestamp.test.ts |
10 | GOOD | 固定 now 时间戳,确定性 |
utils/__tests__/notebook.test.ts |
9 | ACCEPTABLE | 合并断言偏弱 |
utils/__tests__/hyperlink.test.ts |
10 | ACCEPTABLE | 空串测试行为注释混乱 |
utils/__tests__/zodToJsonSchema.test.ts |
9 | WEAK | object 属性仅 toBeDefined 未验证类型;optional 字段未验证 absence |
utils/__tests__/objectGroupBy.test.ts |
5 | ACCEPTABLE | 极简,缺 undefined key 测试 |
utils/__tests__/contentArray.test.ts |
6 | ACCEPTABLE | 缺混合 tool_result+text 交替 |
utils/__tests__/slashCommandParsing.test.ts |
8 | GOOD | — |
utils/__tests__/groupToolUses.test.ts |
10 | GOOD | — |
utils/__tests__/shell/__tests__/outputLimits.test.ts |
7 | ACCEPTABLE | — |
utils/__tests__/envValidation.test.ts |
12 | GOOD | validateBoundedIntEnvVar |
utils/git/__tests__/gitConfigParser.test.ts |
20 | GOOD | — |
services/mcp/__tests__/mcpStringUtils.test.ts |
16 | GOOD | — |
services/mcp/__tests__/normalization.test.ts |
10 | GOOD | — |
| 等级 | 文件数 | 占比 |
|---|---|---|
| GOOD | 46 | 55% |
| ACCEPTABLE | 32 | 38% |
| WEAK | 6 | 7% |
以下文件的部分测试使用 toContain 或 not.toBeNull 检查结果,当实现返回包含目标子串的任何字符串时测试仍通过,无法检测格式错误:
| 文件 | 受影响函数 | 建议 |
|---|---|---|
file.test.ts |
addLineNumbers | 断言完整输出格式 |
diff.test.ts |
getPatchFromContents | 验证 hunk 内容正确性 |
notebook.test.ts |
mapNotebookCellsToToolResult | 验证合并后内容 |
uuid.test.ts |
validateUuid (uppercase) | 断言标准化后的精确值 |
Spec 定义的三个集成测试均未创建:
| 计划 | 状态 | 依赖 |
|---|---|---|
tests/integration/tool-chain.test.ts |
未创建 | 需 mock tools.ts 完整注册链 |
tests/integration/context-build.test.ts |
未创建 | 需 mock context.ts 重依赖链 |
tests/integration/message-pipeline.test.ts |
未创建 | 需 mock API 层 |
tests/mocks/ 目录也不存在,无共享 mock/fixture 基础设施。
| 问题 | 影响文件 | 说明 |
|---|---|---|
| 未 mock 重依赖 | gitOperationTracking.test.ts |
trackGitOperations 调用 analytics/bootstrap,测试仅覆盖 detectGitOperation(无副作用) |
| env 恢复不完整 | providers.test.ts |
仅删除已知 key,新增 env var 会导致测试泄漏 |
| 文件 | 函数 | 问题 |
|---|---|---|
envValidation.test.ts |
parsed > 0 和 parsed <= upperLimit,不强制 parsed >= defaultValue,为设计意图 |
| 模块 | 问题 |
|---|---|
Bun.JSONL.parseChunk |
畸形行时无限挂起(Bun 1.3.10 bug) |
context.ts 核心逻辑 |
依赖 bootstrap/state + git + 50+ 模块,mock 不可行 |
tools.ts (getAllBaseTools) |
导入链过重 |
spawnMultiAgent.ts |
50+ 依赖 |
messages.ts 部分函数 |
依赖 getFeatureValue_CACHED_MAY_BE_STALE |
UI 组件 (screens/, components/) |
需 Ink 渲染测试环境 |
通过 mock.module() + await import() 解锁重依赖模块:
| 被 Mock 模块 | 解锁的测试 |
|---|---|
src/utils/log.ts |
json, tokens, FileEditTool/utils, permissions, memoize, PermissionMode |
src/services/tokenEstimation.ts |
tokens |
src/utils/slowOperations.ts |
tokens, permissions, memoize, PermissionMode |
src/utils/debug.ts |
envValidation, outputLimits |
src/utils/bash/commands.ts |
commandSemantics |
src/utils/thinking.js |
effort |
src/utils/settings/settings.js |
effort |
src/utils/auth.js |
effort |
src/services/analytics/growthbook.js |
effort, tokenBudget |
src/utils/powershell/dangerousCmdlets.js |
powershellSecurity |
src/utils/cwd.js |
gitSafety |
src/utils/powershell/parser.js |
gitSafety |
src/utils/stringUtils.js |
LSP formatters |
figures |
treeify |
约束:mock.module() 必须在每个测试文件内联调用,不能从共享 helper 导入。
更新日期:2026-04-02 | 1623 tests, 84 files, 0 fail, 851ms
| 计划 | 状态 | 新增测试 | 说明 |
|---|---|---|---|
| Plan 12 — Mock 可靠性 | 已完成 | +9 | PermissionMode ant false 路径、providers env 快照恢复 |
| Plan 10 — WEAK 修复 | 已完成 | +15 | format 断言精确化、envValidation 修正、zodToJsonSchema/destructors/notebook 加固 |
| Plan 13 — CJK/Emoji | 已完成 | +17 | truncate CJK/emoji 宽度感知测试 |
| Plan 11 — ACCEPTABLE 加强 | 已完成 | +62 | diff/uuid/hash/semver/path/claudemd/fileEdit/providers/messages 等 15 文件 |
| Plan 14 — 集成测试 | 已完成 | +43 | 搭建 tests/mocks/ + tool-chain/context-build/message-pipeline/cli-arguments |
| Plan 15 — CLI + 覆盖率 | 已完成 | +11 | Commander.js 参数解析、覆盖率基线 |
| Phase 16 — 零依赖纯函数 | 已完成 | +126 | stream/abortController/bufferedWriter/gitDiff/history/sliceAnsi/treeify/words 8 文件 |
| Phase 17 — 工具子模块 | 已完成 | +179 | PowerShell 安全/语义/破坏性/gitSafety + LSP 格式化/schema + WebFetch 预批准/URL 8 文件 |
| Phase 18 — WEAK 修复 | 已完成 | +20 | format 精确匹配、envValidation 边界、PermissionMode 补强、gitOperationTracking PR actions |
| 指标 | 数值 |
|---|---|
| 总测试数 | 1623 |
| 测试文件数 | 84 |
| 失败数 | 0 |
| 断言数 | 2516 |
| 运行耗时 | ~851ms |
| Tool.ts 行覆盖率 | 100% |
| 整体行覆盖率 | ~33%(Bun coverage 限制:mock.module 模式下的模块不报告) |
注意:Bun
--coverage仅报告测试 import 链中直接加载的文件。使用mock.module()+await import()模式的源文件(大多数src/utils/纯函数)不显示在覆盖率报告中。实际测试覆盖率高于报告值。
| 模块 | 原因 |
|---|---|
query.ts / QueryEngine.ts |
核心循环,需完整集成环境 |
services/api/claude.ts |
需 mock SDK 流式响应 |
spawnMultiAgent.ts |
50+ 依赖 |
modelCost.ts |
依赖 bootstrap/state + analytics |
mcp/dateTimeParser.ts |
调用 Haiku API |
screens/ / components/ |
需 Ink 渲染测试 |