bun test

Bun 自带一个快速、内置且与 Jest 兼容的测试运行器。测试通过 Bun 运行时执行，并支持以下功能。

• TypeScript 和 JSX
• 生命周期钩子
• 快照测试
• UI & DOM 测试
• 使用 --watch 的监听模式
• 使用 --preload 的脚本预加载

运行测试

bun test

测试使用 JavaScript 或 TypeScript 编写，并采用类似 Jest 的 API。有关完整文档，请参阅编写测试。

import { expect, test } from "bun:test";

test("2 + 2", () => {
  expect(2 + 2).toBe(4);
});

运行器在工作目录中递归搜索与以下模式匹配的文件

• *.test.{js|jsx|ts|tsx}
• *_test.{js|jsx|ts|tsx}
• *.spec.{js|jsx|ts|tsx}
• *_spec.{js|jsx|ts|tsx}

你可以通过将额外的位置参数传递给 bun test 来过滤要运行的测试文件集。任何路径与过滤器之一匹配的测试文件都将运行。通常，这些过滤器将是文件或目录名称；尚不支持 glob 模式。

bun test <filter> <filter> ...

要按测试名称过滤，请使用 -t/--test-name-pattern 标志。

# run all tests or test suites with "addition" in the name

bun test --test-name-pattern addition

要在测试运行器中运行特定文件，请确保路径以 ./ 或 / 开头，以将其与过滤器名称区分开来。

bun test ./test/specific-file.test.ts

测试运行器在单个进程中运行所有测试。它加载所有 --preload 脚本（有关详细信息，请参阅生命周期），然后运行所有测试。如果测试失败，测试运行器将以非零退出代码退出。

CI/CD 集成

bun test 支持各种 CI/CD 集成。

GitHub Actions

bun test 会自动检测是否在 GitHub Actions 内部运行，并将 GitHub Actions 注释直接输出到控制台。

除了在工作流程中安装 bun 并运行 bun test 之外，无需其他配置。

如何在 GitHub Actions 工作流程中安装 bun

要在 GitHub Actions 工作流程中使用 bun test，请添加以下步骤

jobs:
  build:
    name: build-app
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install bun
        uses: oven-sh/setup-bun@v2
      - name: Install dependencies # (assuming your project has dependencies)
        run: bun install # You can use npm/yarn/pnpm instead if you prefer
      - name: Run tests
        run: bun test

从那里，你将获得 GitHub Actions 注释。

JUnit XML 报告（GitLab 等）

要将 bun test 与 JUnit XML 报告器一起使用，你可以将 --reporter=junit 与 --reporter-outfile 结合使用。

bun test --reporter=junit --reporter-outfile=./bun.xml

这将继续像往常一样输出到 stdout/stderr，并在测试运行结束时将 JUnit XML 报告写入给定的路径。

JUnit XML 是一种在 CI/CD 管道中报告测试结果的流行格式。

超时

使用 --timeout 标志以毫秒为单位指定每个测试的超时时间。如果测试超时，它将被标记为失败。默认值为 5000。

# default value is 5000

bun test --timeout 20

重新运行测试

使用 --rerun-each 标志多次运行每个测试。这对于检测不稳定的或非确定性的测试失败很有用。

bun test --rerun-each 100

使用 --bail 退出

使用 --bail 标志在达到预定数量的测试失败后提前中止测试运行。默认情况下，Bun 将运行所有测试并报告所有失败，但有时在 CI 环境中，最好提前终止以减少 CPU 使用率。

# bail after 1 failure

bun test --bail

# bail after 10 failure

bun test --bail=10

监听模式

与 bun run 类似，你可以将 --watch 标志传递给 bun test 以监听更改并重新运行测试。

bun test --watch

生命周期钩子

Bun 支持以下生命周期钩子

这些钩子可以在测试文件内部定义，也可以在单独的文件中定义，该文件使用 --preload 标志预加载。

$ bun test --preload ./setup.ts

有关完整文档，请参阅测试 > 生命周期。

模拟

使用 mock 函数创建模拟函数。模拟在测试之间自动重置。

import { test, expect, mock } from "bun:test";
const random = mock(() => Math.random());

test("random", () => {
  const val = random();
  expect(val).toBeGreaterThan(0);
  expect(random).toHaveBeenCalled();
  expect(random).toHaveBeenCalledTimes(1);
});

或者，你可以使用 jest.fn()，它的行为完全相同。

import { test, expect, mock } from "bun:test";
import { test, expect, jest } from "bun:test";

const random = mock(() => Math.random());
const random = jest.fn(() => Math.random());

有关完整文档，请参阅测试 > 模拟。

快照测试

bun test 支持快照。

// example usage of toMatchSnapshot
import { test, expect } from "bun:test";

test("snapshot", () => {
  expect({ a: 1 }).toMatchSnapshot();
});

要更新快照，请使用 --update-snapshots 标志。

bun test --update-snapshots

有关完整文档，请参阅测试 > 快照。

UI & DOM 测试

Bun 与流行的 UI 测试库兼容

• HappyDOM
• DOM Testing Library
• React Testing Library

有关完整文档，请参阅测试 > DOM 测试。

性能

Bun 的测试运行器速度很快。