跳转到主要内容
failproofai 包含两套测试套件:单元测试(快速、使用 mock)和端到端测试(真实子进程调用)。

运行测试

# 单次运行所有单元测试
bun run test:run

# 以监听模式运行单元测试
bun run test

# 运行 E2E 测试(需要提前配置——见下文)
bun run test:e2e

# 仅进行类型检查,不编译
bunx tsc --noEmit

# 代码检查
bun run lint

单元测试

单元测试位于 __tests__/ 目录下,使用 Vitest 并配合 jsdom 运行。
__tests__/
  hooks/
    builtin-policies.test.ts      # 各内置策略的逻辑测试
    hooks-config.test.ts          # 配置加载与作用域合并
    policy-evaluator.test.ts      # 参数注入与求值顺序
    custom-hooks-registry.test.ts # globalThis 注册表的 add/get/clear 操作
    custom-hooks-loader.test.ts   # ESM 加载器、传递依赖导入及错误处理
    manager.test.ts               # install/remove/list 操作
  components/
    sessions-list.test.tsx        # Session 列表组件
    project-list.test.tsx         # 项目列表组件
    ...
  lib/
    logger.test.ts
    paths.test.ts
    date-filters.test.ts
    telemetry.test.ts
    ...
  actions/
    get-hooks-config.test.ts
    get-hook-activity.test.ts
    ...
  contexts/
    ThemeContext.test.tsx
    AutoRefreshContext.test.tsx

编写策略单元测试

import { describe, it, expect, beforeEach } from "vitest";
import { getBuiltinPolicies } from "../../src/hooks/builtin-policies";
import { allow, deny } from "../../src/hooks/policy-types";

describe("block-sudo", () => {
  const policy = getBuiltinPolicies().find((p) => p.name === "block-sudo")!;

  it("denies sudo commands", () => {
    const ctx = {
      eventType: "PreToolUse" as const,
      payload: {},
      toolName: "Bash",
      toolInput: { command: "sudo apt install nodejs" },
      params: { allowPatterns: [] },
    };
    expect(policy.fn(ctx)).toEqual(deny("sudo command blocked by failproofai"));
  });

  it("allows non-sudo commands", () => {
    const ctx = {
      eventType: "PreToolUse" as const,
      payload: {},
      toolName: "Bash",
      toolInput: { command: "ls -la" },
      params: { allowPatterns: [] },
    };
    expect(policy.fn(ctx)).toEqual(allow());
  });

  it("allows patterns in allowPatterns", () => {
    const ctx = {
      eventType: "PreToolUse" as const,
      payload: {},
      toolName: "Bash",
      toolInput: { command: "sudo systemctl status nginx" },
      params: { allowPatterns: ["sudo systemctl status"] },
    };
    expect(policy.fn(ctx)).toEqual(allow());
  });
});

端到端测试

E2E 测试将真实的 failproofai 二进制文件作为子进程调用,将 JSON 载荷通过 stdin 传入,并对 stdout 输出和退出码进行断言。这覆盖了 Claude Code 使用的完整集成路径。

配置

E2E 测试直接从仓库源码运行二进制文件。在首次运行前,需要构建自定义 hook 文件在导入 'failproofai' 时所使用的 CJS 包:
bun build src/index.ts --outdir dist --target node --format cjs
然后运行测试:
bun run test:e2e
每当修改公共 hook API(src/hooks/custom-hooks-registry.tssrc/hooks/policy-helpers.tssrc/hooks/policy-types.ts)时,需要重新构建 dist/

E2E 测试结构

__tests__/e2e/
  helpers/
    hook-runner.ts      # 启动二进制进程,传入载荷 JSON,捕获退出码、stdout 和 stderr
    fixture-env.ts      # 每个测试独立的临时目录与配置文件
    payloads.ts         # 针对各事件类型的 Claude 标准载荷工厂函数
  hooks/
    builtin-policies.e2e.test.ts   # 使用真实子进程测试每个内置策略
    custom-hooks.e2e.test.ts       # 自定义 hook 的加载与求值
    config-scopes.e2e.test.ts      # 跨项目/本地/全局作用域的配置合并
    policy-params.e2e.test.ts      # 各参数化策略的参数注入

使用 E2E 辅助工具

FixtureEnv —— 每个测试的隔离环境:
import { createFixtureEnv } from "../helpers/fixture-env";

const env = createFixtureEnv();
// env.cwd    - 临时目录;作为 payload.cwd 传入以读取 .failproofai/policies-config.json
// env.home   - 隔离的 home 目录;不会泄漏真实的 ~/.failproofai 配置

env.writeConfig({
  enabledPolicies: ["block-sudo"],
  policyParams: {
    "block-sudo": { allowPatterns: ["sudo systemctl status"] },
  },
});
createFixtureEnv() 会自动注册 afterEach 清理逻辑。 runHook —— 调用二进制文件:
import { runHook } from "../helpers/hook-runner";
import { Payloads } from "../helpers/payloads";

const result = await runHook(
  "PreToolUse",
  Payloads.preToolUse.bash("sudo apt install nodejs", env.cwd),
  { homeDir: env.home }
);

expect(result.exitCode).toBe(0);
expect(result.parsed?.hookSpecificOutput?.permissionDecision).toBe("deny");
Payloads —— 预置载荷工厂函数:
Payloads.preToolUse.bash(command, cwd)
Payloads.preToolUse.write(filePath, content, cwd)
Payloads.preToolUse.read(filePath, cwd)
Payloads.postToolUse.bash(command, output, cwd)
Payloads.postToolUse.read(filePath, content, cwd)
Payloads.notification(message, cwd)
Payloads.stop(cwd)

编写 E2E 测试

import { describe, it, expect } from "vitest";
import { createFixtureEnv } from "../helpers/fixture-env";
import { runHook } from "../helpers/hook-runner";
import { Payloads } from "../helpers/payloads";

describe("block-rm-rf (E2E)", () => {
  it("denies rm -rf", async () => {
    const env = createFixtureEnv();
    env.writeConfig({ enabledPolicies: ["block-rm-rf"] });

    const result = await runHook(
      "PreToolUse",
      Payloads.preToolUse.bash("rm -rf /", env.cwd),
      { homeDir: env.home }
    );

    expect(result.exitCode).toBe(0);
    expect(result.parsed?.hookSpecificOutput?.permissionDecision).toBe("deny");
  });

  it("allows non-recursive rm", async () => {
    const env = createFixtureEnv();
    env.writeConfig({ enabledPolicies: ["block-rm-rf"] });

    const result = await runHook(
      "PreToolUse",
      Payloads.preToolUse.bash("rm /tmp/file.txt", env.cwd),
      { homeDir: env.home }
    );

    expect(result.exitCode).toBe(0);
    expect(result.stdout).toBe("");  // allow → 空 stdout
  });
});

E2E 响应结构

决策退出码stdout
PreToolUse deny0{"hookSpecificOutput":{"permissionDecision":"deny","permissionDecisionReason":"..."}}
PostToolUse deny0{"hookSpecificOutput":{"additionalContext":"Blocked ... because: ..."}}
Instruct(非 Stop)0{"hookSpecificOutput":{"additionalContext":"Instruction from failproofai: ..."}}
Stop instruct2stdout 为空;原因输出至 stderr
Allow0空字符串

Vitest 配置

E2E 测试使用 vitest.config.e2e.mts,配置如下:
  • environment: "node" —— 不需要浏览器全局变量
  • pool: "forks" —— 真正的进程隔离(测试会启动子进程)
  • testTimeout: 20_000 —— 每个测试超时 20 秒(含二进制启动 + hook 求值时间)
使用 forks 池非常重要:基于线程的 worker 会共享 globalThis,可能干扰启动子进程的测试。基于进程的 forks 可避免此问题。

CI

在合并代码前,必须通过完整的 CI 流程(bun run lint && bunx tsc --noEmit && bun run test:run && bun run build)。E2E 测试套件作为独立的 CI 任务并行运行。 完整的合并前检查清单请参阅 Contributing