使用从内置 bun:test 模块导入的类似 Jest 的 API 定义测试。从长远来看，Bun 的目标是完全兼容 Jest；目前，支持有限的匹配器集 expect。
基本用法
定义一个简单的测试
import { expect, test } from "bun:test";
test("2 + 2", () => {
expect(2 + 2).toBe(4);
});
Jest 风格的全局变量
可以使用 describe 将测试分组到套件中。
import { expect, test, describe } from "bun:test";
describe("arithmetic", () => {
test("2 + 2", () => {
expect(2 + 2).toBe(4);
});
test("2 * 2", () => {
expect(2 * 2).toBe(4);
});
});
测试可以是 async 的。
import { expect, test } from "bun:test";
test("2 * 2", async () => {
const result = await Promise.resolve(2 * 2);
expect(result).toEqual(4);
});
或者，使用 done 回调来发出完成信号。如果您在测试定义中包含 done 回调作为参数，则必须调用它，否则测试将挂起。
import { expect, test } from "bun:test";
test("2 * 2", done => {
Promise.resolve(2 * 2).then(result => {
expect(result).toEqual(4);
done();
});
});
超时
可以选择性地指定每个测试的超时时间，单位为毫秒，方法是将一个数字作为 test 的第三个参数传递。
import { test } from "bun:test";
test("wat", async () => {
const data = await slowOperation();
expect(data).toBe(42);
}, 500); // test must run in <500ms
在 bun:test 中，测试超时会抛出一个无法捕获的异常，以强制测试停止运行并失败。我们还会终止测试中衍生的任何子进程，以避免在后台留下僵尸进程。
🧟 僵尸进程杀手
当测试超时，并且通过 Bun.spawn、Bun.spawnSync 或 node:child_process 在测试中衍生的进程没有被终止时，它们将被自动终止，并且会在控制台中记录一条消息。
test.skip
使用 test.skip 跳过单个测试。这些测试将不会被运行。
import { expect, test } from "bun:test";
test.skip("wat", () => {
// TODO: fix this
expect(0.1 + 0.2).toEqual(0.3);
});
test.todo
使用 test.todo 将测试标记为待办 (todo)。这些测试将不会被运行。
import { expect, test } from "bun:test";
test.todo("fix this", () => {
myTestFunction();
});
要运行待办测试并查找任何通过的测试，请使用 bun test --todo。
bun test --todomy.test.ts:
✗ unimplemented feature
^ this test is marked as todo but passes. Remove `.todo` or check that test is correct.
0 pass
1 fail
1 expect() calls使用此标志，失败的待办测试不会导致错误，但通过的待办测试将被标记为失败，以便您可以移除待办标记或 修复测试。
test.only
要运行特定的测试或测试套件，请使用 test.only() 或 describe.only()。一旦声明，运行 bun test --only 将仅执行已标记为 `.only()` 的测试/套件。在声明了 test.only() 的情况下，不使用 --only 选项运行 bun test 将导致给定套件中的所有测试执行到带有 .only() 的测试为止。describe.only() 在两种执行场景中的功能相同。
import { test, describe } from "bun:test";
test("test #1", () => {
// does not run
});
test.only("test #2", () => {
// runs
});
describe.only("only", () => {
test("test #3", () => {
// runs
});
});
以下命令将仅执行测试 #2 和 #3。
bun test --only以下命令将仅执行测试 #1、#2 和 #3。
bun testtest.if
要有条件地运行测试，请使用 test.if()。如果条件为真值 (truthy)，则测试将运行。这对于仅应在特定架构或操作系统上运行的测试特别有用。
test.if(Math.random() > 0.5)("runs half the time", () => {
// ...
});
const macOS = process.arch === "darwin";
test.if(macOS)("runs on macOS", () => {
// runs if macOS
});
test.skipIf
要根据某些条件跳过测试，请使用 test.skipIf() 或 describe.skipIf()。
const macOS = process.arch === "darwin";
test.skipIf(macOS)("runs on non-macOS", () => {
// runs if *not* macOS
});
test.todoIf
如果您想将测试标记为 TODO，请使用 test.todoIf() 或 describe.todoIf()。仔细选择 skipIf 或 todoIf 可以显示例如“对此目标无效”和“计划中但尚未实现”的意图之间的差异。
const macOS = process.arch === "darwin";
// TODO: we've only implemented this for Linux so far.
test.todoIf(macOS)("runs on posix", () => {
// runs if *not* macOS
});
test.each
要为测试表中的多个用例返回一个函数，请使用 test.each。
const cases = [
[1, 2, 3],
[3, 4, 5],
];
test.each(cases)("%p + %p should be %p", (a, b, expected) => {
// runs once for each test case provided
});
有许多选项可用于根据用例标签的类型格式化它。
%p | pretty-format |
%s | String |
%d | Number |
%i | Integer |
%f | Floating point |
%j | JSON |
%o | Object |
%# | Index of the test case |
%% | Single percent sign (%) |
Matchers (匹配器)
Bun 实现了以下匹配器。完整的 Jest 兼容性已在路线图上；请此处跟踪进度。