test 测试 | Node.js v20 文档

测试运行器#>

【Test runner】

版本历史

版本	变更
v20.0.0	The test runner is now stable.
v18.0.0, v16.17.0	新增于: v18.0.0, v16.17.0

稳定性： 2 - 稳定

源代码: lib/test.js

node:test 模块便于创建 JavaScript 测试。要访问它，请使用:

【The node:test module facilitates the creation of JavaScript tests. To access it:】

import test from 'node:test';const test = require('node:test');

此模块仅在 node: 方案下可用。以下用法将无法工作：

【This module is only available under the node: scheme. The following will not work:】

import test from 'test';const test = require('test');

通过 test 模块创建的测试由单个函数组成，该函数可以通过三种方式之一进行处理：

【Tests created via the test module consist of a single function that is processed in one of three ways:】

如果同步函数抛出异常则被视为失败，否则被视为通过。
一个返回 Promise 的函数，如果 Promise 被拒绝则被视为失败，如果 Promise 成功则被视为通过。
一个接收回调函数的函数。如果回调的第一个参数接收到任何真值，则测试被视为失败。如果第一个参数传递的是假值，则测试被视为通过。如果测试函数既接收回调函数又返回一个 Promise，测试将会失败。

以下示例说明了如何使用 test 模块编写测试。

【The following example illustrates how tests are written using the test module.】

test('synchronous passing test', (t) => {
  // This test passes because it does not throw an exception.
  assert.strictEqual(1, 1);
});

test('synchronous failing test', (t) => {
  // This test fails because it throws an exception.
  assert.strictEqual(1, 2);
});

test('asynchronous passing test', async (t) => {
  // This test passes because the Promise returned by the async
  // function is settled and not rejected.
  assert.strictEqual(1, 1);
});

test('asynchronous failing test', async (t) => {
  // This test fails because the Promise returned by the async
  // function is rejected.
  assert.strictEqual(1, 2);
});

test('failing test using Promises', (t) => {
  // Promises can be used directly as well.
  return new Promise((resolve, reject) => {
    setImmediate(() => {
      reject(new Error('this will cause the test to fail'));
    });
  });
});

test('callback passing test', (t, done) => {
  // done() is the callback function. When the setImmediate() runs, it invokes
  // done() with no arguments.
  setImmediate(done);
});

test('callback failing test', (t, done) => {
  // When the setImmediate() runs, done() is invoked with an Error object and
  // the test fails.
  setImmediate(() => {
    done(new Error('callback failure'));
  });
});

如果有任何测试未通过，进程的退出代码将设置为 1。

【If any tests fail, the process exit code is set to 1.】

子测试#>

【Subtests】

测试上下文的 test() 方法允许创建子测试。它让你可以以层次化的方式组织测试，在一个较大的测试中创建嵌套测试。该方法的行为与顶层的 test() 函数完全相同。以下示例演示了创建一个包含两个子测试的顶层测试。

【The test context's test() method allows subtests to be created. It allows you to structure your tests in a hierarchical manner, where you can create nested tests within a larger test. This method behaves identically to the top level test() function. The following example demonstrates the creation of a top level test with two subtests.】

test('top level test', async (t) => {
  await t.test('subtest 1', (t) => {
    assert.strictEqual(1, 1);
  });

  await t.test('subtest 2', (t) => {
    assert.strictEqual(2, 2);
  });
});

注意： beforeEach 和 afterEach 钩子会在每个子测试执行之间触发。

在这个例子中，await 用于确保两个子测试都已完成。这是必要的，因为测试不会等待其子测试完成，不像在测试套件中创建的测试。当父测试完成时，任何仍未完成的子测试将被取消并视为失败。任何子测试的失败都会导致父测试失败。

【In this example, await is used to ensure that both subtests have completed. This is necessary because tests do not wait for their subtests to complete, unlike tests created within suites. Any subtests that are still outstanding when their parent finishes are cancelled and treated as failures. Any subtest failures cause the parent test to fail.】

跳过测试#>

【Skipping tests】

可以通过向测试传递 skip 选项来跳过单个测试，或者像下面的示例中那样调用测试上下文的 skip() 方法。

【Individual tests can be skipped by passing the skip option to the test, or by calling the test context's skip() method as shown in the following example.】

// The skip option is used, but no message is provided.
test('skip option', { skip: true }, (t) => {
  // This code is never executed.
});

// The skip option is used, and a message is provided.
test('skip option with message', { skip: 'this is skipped' }, (t) => {
  // This code is never executed.
});

test('skip() method', (t) => {
  // Make sure to return here as well if the test contains additional logic.
  t.skip();
});

test('skip() method with message', (t) => {
  // Make sure to return here as well if the test contains additional logic.
  t.skip('this is skipped');
});

TODO 测试#>

【TODO tests】

可以通过向测试传递 todo 选项，或调用测试上下文的 todo() 方法，将单个测试标记为不稳定或未完成，如下面的示例所示。这些测试表示一个待实现或需要修复的错误。TODO 测试会被执行，但不会被视为测试失败，因此不会影响进程退出代码。如果测试同时被标记为 TODO 和跳过，TODO 选项将被忽略。

【Individual tests can be marked as flaky or incomplete by passing the todo option to the test, or by calling the test context's todo() method, as shown in the following example. These tests represent a pending implementation or bug that needs to be fixed. TODO tests are executed, but are not treated as test failures, and therefore do not affect the process exit code. If a test is marked as both TODO and skipped, the TODO option is ignored.】

// The todo option is used, but no message is provided.
test('todo option', { todo: true }, (t) => {
  // This code is executed, but not treated as a failure.
  throw new Error('this does not fail the test');
});

// The todo option is used, and a message is provided.
test('todo option with message', { todo: 'this is a todo test' }, (t) => {
  // This code is executed.
});

test('todo() method', (t) => {
  t.todo();
});

test('todo() method with message', (t) => {
  t.todo('this is a todo test and is not treated as a failure');
  throw new Error('this does not fail the test');
});

`describe()` 和 `it()` 别名#>

【describe() and it() aliases】

测试套件和测试也可以使用 describe() 和 it() 函数来编写。describe() 是 suite() 的别名，it() 是 test() 的别名。

【Suites and tests can also be written using the describe() and it() functions. describe() is an alias for suite(), and it() is an alias for test().】

describe('A thing', () => {
  it('should work', () => {
    assert.strictEqual(1, 1);
  });

  it('should be ok', () => {
    assert.strictEqual(2, 2);
  });

  describe('a nested thing', () => {
    it('should work', () => {
      assert.strictEqual(3, 3);
    });
  });
});

describe() 和 it() 是从 node:test 模块中导入的。

import { describe, it } from 'node:test';const { describe, it } = require('node:test');

`only` 测试#>

【only tests】

如果使用 --test-only 命令行选项启动 Node.js，可以通过向应运行的测试传递 only 选项来跳过所有顶层测试，除了选定的子集。当运行设置了 only 选项的测试时，所有子测试也会运行。测试上下文的 runOnly() 方法可以用于在子测试级别实现相同的行为。

【If Node.js is started with the --test-only command-line option, it is possible to skip all top level tests except for a selected subset by passing the only option to the tests that should be run. When a test with the only option set is run, all subtests are also run. The test context's runOnly() method can be used to implement the same behavior at the subtest level.】

// Assume Node.js is run with the --test-only command-line option.
// The 'only' option is set, so this test is run.
test('this test is run', { only: true }, async (t) => {
  // Within this test, all subtests are run by default.
  await t.test('running subtest');

  // The test context can be updated to run subtests with the 'only' option.
  t.runOnly(true);
  await t.test('this subtest is now skipped');
  await t.test('this subtest is run', { only: true });

  // Switch the context back to execute all tests.
  t.runOnly(false);
  await t.test('this subtest is now run');

  // Explicitly do not run these tests.
  await t.test('skipped subtest 3', { only: false });
  await t.test('skipped subtest 4', { skip: true });
});

// The 'only' option is not set, so this test is skipped.
test('this test is not run', () => {
  // This code is not run.
  throw new Error('fail');
});

按名称过滤测试#>

【Filtering tests by name】

--test-name-pattern 命令行选项可用于仅运行名称与提供的模式匹配的测试。测试名称模式会被解释为 JavaScript 正则表达式。--test-name-pattern 选项可以多次指定以运行嵌套测试。对于每个执行的测试，任何相应的测试钩子，例如 beforeEach()，也会被执行。

【The --test-name-pattern command-line option can be used to only run tests whose name matches the provided pattern. Test name patterns are interpreted as JavaScript regular expressions. The --test-name-pattern option can be specified multiple times in order to run nested tests. For each test that is executed, any corresponding test hooks, such as beforeEach(), are also run.】

给定以下测试文件，使用 --test-name-pattern="test [1-3]" 选项启动 Node.js 会导致测试运行器执行 test 1、test 2 和 test 3。如果 test 1 不符合测试名称模式，则其子测试将不会执行，即使它们匹配该模式。同一组测试也可以通过多次传递 --test-name-pattern 来执行（例如 --test-name-pattern="test 1"、--test-name-pattern="test 2" 等）。

【Given the following test file, starting Node.js with the --test-name-pattern="test [1-3]" option would cause the test runner to execute test 1, test 2, and test 3. If test 1 did not match the test name pattern, then its subtests would not execute, despite matching the pattern. The same set of tests could also be executed by passing --test-name-pattern multiple times (e.g. --test-name-pattern="test 1", --test-name-pattern="test 2", etc.).】

test('test 1', async (t) => {
  await t.test('test 2');
  await t.test('test 3');
});

test('Test 4', async (t) => {
  await t.test('Test 5');
  await t.test('test 6');
});

测试名称模式也可以使用正则表达式字面量来指定。这允许使用正则表达式标志。在前面的示例中，使用 --test-name-pattern="/test [4-5]/i" 启动 Node.js 将匹配 Test 4 和 Test 5，因为该模式不区分大小写。

【Test name patterns can also be specified using regular expression literals. This allows regular expression flags to be used. In the previous example, starting Node.js with --test-name-pattern="/test [4-5]/i" would match Test 4 and Test 5 because the pattern is case-insensitive.】

测试名称模式不会更改测试运行程序执行的文件集。

【Test name patterns do not change the set of files that the test runner executes.】

无关的异步活动#>

【Extraneous asynchronous activity】

测试函数执行完成后，结果会迅速报告尽可能保持测试顺序。不过，这也是可能的测试函数产生异步活动并存续于测试就是它自己。测试跑者负责处理此类活动，但不会延迟报告检测结果以配合该情况。

【Once a test function finishes executing, the results are reported as quickly as possible while maintaining the order of the tests. However, it is possible for the test function to generate asynchronous activity that outlives the test itself. The test runner handles this type of activity, but does not delay the reporting of test results in order to accommodate it.】

在下面的示例中，一个测试在仍有两个 setImmediate() 操作未完成的情况下结束。第一个 setImmediate() 尝试创建一个新的子测试。由于父测试已经完成并输出了其结果，新子测试会立即被标记为失败，并随后报告给 <TestsStream>。

【In the following example, a test completes with two setImmediate() operations still outstanding. The first setImmediate() attempts to create a new subtest. Because the parent test has already finished and output its results, the new subtest is immediately marked as failed, and reported later to the <TestsStream>.】

第二个 setImmediate() 会触发 uncaughtException 事件。来自已完成测试的 uncaughtException 和 unhandledRejection 事件会被 test 模块标记为失败，并由 <TestsStream> 在顶层作为诊断警告报告。

【The second setImmediate() creates an uncaughtException event. uncaughtException and unhandledRejection events originating from a completed test are marked as failed by the test module and reported as diagnostic warnings at the top level by the <TestsStream>.】

test('a test that creates asynchronous activity', (t) => {
  setImmediate(() => {
    t.test('subtest that is created too late', (t) => {
      throw new Error('error1');
    });
  });

  setImmediate(() => {
    throw new Error('error2');
  });

  // The test finishes after this line.
});

监视模式#>

【Watch mode】

新增于: v19.2.0, v18.13.0

稳定性： 1 - 实验性

Node.js 测试运行器支持通过传递 --watch 标志来以观察模式运行：

【The Node.js test runner supports running in watch mode by passing the --watch flag:】

node --test --watch

在观察模式下，测试运行器会监视测试文件及其依赖的更改。当检测到更改时，测试运行器会重新运行受更改影响的测试。测试运行器会持续运行，直到进程被终止。

【In watch mode, the test runner will watch for changes to test files and their dependencies. When a change is detected, the test runner will rerun the tests affected by the change. The test runner will continue to run until the process is terminated.】

从命令行运行测试#>

【Running tests from the command line】

可以通过在命令行传递 --test 标志来调用 Node.js 测试运行器：

【The Node.js test runner can be invoked from the command line by passing the --test flag:】

node --test

默认情况下，Node.js 会递归搜索当前目录中符合特定命名约定的 JavaScript 源文件。匹配的文件会作为测试文件执行。有关预期测试文件命名约定和行为的更多信息，可以参见测试运行器执行模型部分。

【By default, Node.js will recursively search the current directory for JavaScript source files matching a specific naming convention. Matching files are executed as test files. More information on the expected test file naming convention and behavior can be found in the test runner execution model section.】

或者，可以将一个或多个路径作为 Node.js 命令的最终参数提供，如下所示。

【Alternatively, one or more paths can be provided as the final argument(s) to the Node.js command, as shown below.】

node --test test1.js test2.mjs custom_test_dir/

在这个例子中，测试运行器将执行文件 test1.js 和 test2.mjs。测试运行器还会递归地搜索 custom_test_dir/ 目录以查找要执行的测试文件。

【In this example, the test runner will execute the files test1.js and test2.mjs. The test runner will also recursively search the custom_test_dir/ directory for test files to execute.】

测试运行器执行模型#>

【Test runner execution model】

当搜索要执行的测试文件时，测试运行器的行为如下：

【When searching for test files to execute, the test runner behaves as follows:】

用户明确提供的任何文件都会被执行。
如果用户没有明确指定任何路径，将按照以下步骤在当前工作目录中递归搜索文件。
除非用户明确提供，否则会跳过 node_modules 目录。
如果遇到名为 test 的目录，测试运行器将递归搜索其中的所有 .js、.cjs 和 .mjs 文件。所有这些文件都会被视为测试文件，不需要符合下面详细说明的特定命名约定。这是为了适应将所有测试放在单个 test 目录中的项目。
在所有其他目录中，匹配以下模式的 .js、.cjs 和 .mjs 文件被视为测试文件：
- ^test$ - 基名为字符串 'test' 的文件。例如：test.js、test.cjs、test.mjs。
- ^test-.+ - 文件名以字符串 'test-' 开头，后跟一个或多个字符。例如：test-example.js、test-another-example.mjs。
- .+[\.\-\_]test$ - 文件名以 .test、-test 或 _test 结尾，前面有一个或多个字符。例如：example.test.js、example-test.cjs、example_test.mjs。
- Node.js 能识别的其他文件类型，如 .node 和 .json，不会被测试运行器自动执行，但如果在命令行中明确提供，则是支持的。

每个匹配的测试文件都在一个单独的子进程中执行。任意时刻运行的最大子进程数由 --test-concurrency 标志控制。如果子进程以退出码 0 结束，则测试被视为通过。否则，该测试将被视为失败。测试文件必须可以被 Node.js 执行，但不要求内部使用 node:test 模块。

【Each matching test file is executed in a separate child process. The maximum number of child processes running at any time is controlled by the --test-concurrency flag. If the child process finishes with an exit code of 0, the test is considered passing. Otherwise, the test is considered to be a failure. Test files must be executable by Node.js, but are not required to use the node:test module internally.】

每个测试文件都会像普通脚本一样执行。也就是说，如果测试文件本身使用 node:test 来定义测试，那么所有这些测试都会在单个应用线程中执行，而不管 test() 的 concurrency 选项的值是多少。

【Each test file is executed as if it was a regular script. That is, if the test file itself uses node:test to define tests, all of those tests will be executed within a single application thread, regardless of the value of the concurrency option of test().】

收集代码覆盖率#>

【Collecting code coverage】

稳定性： 1 - 实验性

当使用 --experimental-test-coverage 命令行标志启动 Node.js 时，会收集代码覆盖率，并在所有测试完成后报告统计信息。如果使用 NODE_V8_COVERAGE 环境变量指定代码覆盖率目录，生成的 V8 覆盖文件将写入该目录。默认情况下，Node.js 核心模块和 node_modules/ 目录内的文件不会包含在覆盖率报告中。然而，它们可以通过 --test-coverage-include 标志显式包含。如果启用了覆盖率，覆盖率报告会通过 'test:coverage' 事件发送给任何测试报告器。

【When Node.js is started with the --experimental-test-coverage command-line flag, code coverage is collected and statistics are reported once all tests have completed. If the NODE_V8_COVERAGE environment variable is used to specify a code coverage directory, the generated V8 coverage files are written to that directory. Node.js core modules and files within node_modules/ directories are, by default, not included in the coverage report. However, they can be explicity included via the --test-coverage-include flag. If coverage is enabled, the coverage report is sent to any test reporters via the 'test:coverage' event.】

可以使用以下注释语法在一系列行上禁用覆盖：

【Coverage can be disabled on a series of lines using the following comment syntax:】

/* node:coverage disable */
if (anAlwaysFalseCondition) {
  // Code in this branch will never be executed, but the lines are ignored for
  // coverage purposes. All lines following the 'disable' comment are ignored
  // until a corresponding 'enable' comment is encountered.
  console.log('this is never executed');
}
/* node:coverage enable */

覆盖也可以针对指定行数禁用。在指定行数之后，覆盖将自动重新启用。如果没有明确提供行数，则仅忽略一行。

【Coverage can also be disabled for a specified number of lines. After the specified number of lines, coverage will be automatically reenabled. If the number of lines is not explicitly provided, a single line is ignored.】

/* node:coverage ignore next */
if (anAlwaysFalseCondition) { console.log('this is never executed'); }

/* node:coverage ignore next 3 */
if (anAlwaysFalseCondition) {
  console.log('this is never executed');
}

覆盖报告器#>

【Coverage reporters】

tap 和 spec 报告器将打印覆盖率统计摘要。还有一个 lcov 报告器，它将生成一个 lcov 文件，可用于作为详细的覆盖率报告。

【The tap and spec reporters will print a summary of the coverage statistics. There is also an lcov reporter that will generate an lcov file which can be used as an in depth coverage report.】

node --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info

该报告员未报告任何测试结果。
这个报告器最好与另一个报告器一起使用。

局限性#>

【Limitations】

测试运行器的代码覆盖功能不支持从覆盖报告中排除特定文件或目录。

【The test runner's code coverage functionality does not support excluding specific files or directories from the coverage report.】

模拟#>

【Mocking】

node:test 模块在测试期间通过一个顶层的 mock 对象支持模拟。下面的示例创建了一个用于两个数字相加的函数的间谍。然后使用该间谍来断言函数是否按预期被调用。

【The node:test module supports mocking during testing via a top-level mock object. The following example creates a spy on a function that adds two numbers together. The spy is then used to assert that the function was called as expected.】

import assert from 'node:assert';
import { mock, test } from 'node:test';

test('spies on a function', () => {
  const sum = mock.fn((a, b) => {
    return a + b;
  });

  assert.strictEqual(sum.mock.callCount(), 0);
  assert.strictEqual(sum(3, 4), 7);
  assert.strictEqual(sum.mock.callCount(), 1);

  const call = sum.mock.calls[0];
  assert.deepStrictEqual(call.arguments, [3, 4]);
  assert.strictEqual(call.result, 7);
  assert.strictEqual(call.error, undefined);

  // Reset the globally tracked mocks.
  mock.reset();
});'use strict';
const assert = require('node:assert');
const { mock, test } = require('node:test');

test('spies on a function', () => {
  const sum = mock.fn((a, b) => {
    return a + b;
  });

  assert.strictEqual(sum.mock.callCount(), 0);
  assert.strictEqual(sum(3, 4), 7);
  assert.strictEqual(sum.mock.callCount(), 1);

  const call = sum.mock.calls[0];
  assert.deepStrictEqual(call.arguments, [3, 4]);
  assert.strictEqual(call.result, 7);
  assert.strictEqual(call.error, undefined);

  // Reset the globally tracked mocks.
  mock.reset();
});

相同的模拟功能也在每个测试的 TestContext 对象上公开。以下示例使用 TestContext 上公开的 API 创建了对象方法的间谍。通过测试上下文进行模拟的好处是，测试运行结束后，测试运行器会自动恢复所有被模拟的功能。

【The same mocking functionality is also exposed on the TestContext object of each test. The following example creates a spy on an object method using the API exposed on the TestContext. The benefit of mocking via the test context is that the test runner will automatically restore all mocked functionality once the test finishes.】

test('spies on an object method', (t) => {
  const number = {
    value: 5,
    add(a) {
      return this.value + a;
    },
  };

  t.mock.method(number, 'add');
  assert.strictEqual(number.add.mock.callCount(), 0);
  assert.strictEqual(number.add(3), 8);
  assert.strictEqual(number.add.mock.callCount(), 1);

  const call = number.add.mock.calls[0];

  assert.deepStrictEqual(call.arguments, [3]);
  assert.strictEqual(call.result, 8);
  assert.strictEqual(call.target, undefined);
  assert.strictEqual(call.this, number);
});

定时器#>

【Timers】

模拟定时器是一种常用于软件测试的技术，用于模拟和控制定时器的行为，例如 setInterval 和 setTimeout，而无需实际等待指定的时间间隔。

【Mocking timers is a technique commonly used in software testing to simulate and control the behavior of timers, such as setInterval and setTimeout, without actually waiting for the specified time intervals.】

请参阅 MockTimers 类以获取完整的方法和功能列表。

【Refer to the MockTimers class for a full list of methods and features.】

这允许开发者为时间相关的功能编写更可靠、更可预测的测试。

【This allows developers to write more reliable and predictable tests for time-dependent functionality.】

下面的示例显示了如何模拟 setTimeout。使用 .enable({ apis: ['setTimeout'] }); 它将模拟 node:timers 和 node:timers/promises 模块中的 setTimeout 函数，以及来自 Node.js 全局上下文的 setTimeout。

【The example below shows how to mock setTimeout. Using .enable({ apis: ['setTimeout'] }); it will mock the setTimeout functions in the node:timers and node:timers/promises modules, as well as from the Node.js global context.】

注意： 像 import { setTimeout } from 'node:timers' 这样的解构函数目前不被此 API 支持。

import assert from 'node:assert';
import { mock, test } from 'node:test';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', () => {
  const fn = mock.fn();

  // Optionally choose what to mock
  mock.timers.enable({ apis: ['setTimeout'] });
  setTimeout(fn, 9999);
  assert.strictEqual(fn.mock.callCount(), 0);

  // Advance in time
  mock.timers.tick(9999);
  assert.strictEqual(fn.mock.callCount(), 1);

  // Reset the globally tracked mocks.
  mock.timers.reset();

  // If you call reset mock instance, it will also reset timers instance
  mock.reset();
});const assert = require('node:assert');
const { mock, test } = require('node:test');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', () => {
  const fn = mock.fn();

  // Optionally choose what to mock
  mock.timers.enable({ apis: ['setTimeout'] });
  setTimeout(fn, 9999);
  assert.strictEqual(fn.mock.callCount(), 0);

  // Advance in time
  mock.timers.tick(9999);
  assert.strictEqual(fn.mock.callCount(), 1);

  // Reset the globally tracked mocks.
  mock.timers.reset();

  // If you call reset mock instance, it will also reset timers instance
  mock.reset();
});

相同的模拟功能也可以通过每个测试的 TestContext 对象上的 mock 属性访问。通过测试上下文进行模拟的好处是，一旦测试结束，测试运行器会自动恢复所有被模拟的定时器功能。

【The same mocking functionality is also exposed in the mock property on the TestContext object of each test. The benefit of mocking via the test context is that the test runner will automatically restore all mocked timers functionality once the test finishes.】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();

  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout'] });
  setTimeout(fn, 9999);
  assert.strictEqual(fn.mock.callCount(), 0);

  // Advance in time
  context.mock.timers.tick(9999);
  assert.strictEqual(fn.mock.callCount(), 1);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();

  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout'] });
  setTimeout(fn, 9999);
  assert.strictEqual(fn.mock.callCount(), 0);

  // Advance in time
  context.mock.timers.tick(9999);
  assert.strictEqual(fn.mock.callCount(), 1);
});

日期#>

【Dates】

模拟计时器 API 还允许对 Date 对象进行模拟。这是一个用于测试依赖时间功能或模拟内部日历函数（如 Date.now()）的有用功能。

【The mock timers API also allows the mocking of the Date object. This is a useful feature for testing time-dependent functionality, or to simulate internal calendar functions such as Date.now().】

日期的实现也是 MockTimers 类的一部分。有关方法和功能的完整列表，请参阅它。

【The dates implementation is also part of the MockTimers class. Refer to it for a full list of methods and features.】

注意： 当同时模拟日期和定时器时，它们是相互依赖的。这意味着如果你同时模拟了 Date 和 setTimeout，时间的推进也会同时推进模拟的日期，因为它们模拟的是同一个内部时钟。

下面的示例展示了如何模拟 Date 对象并获取当前的 Date.now() 值。

【The example below show how to mock the Date object and obtain the current Date.now() value.】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks the Date object', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['Date'] });
  // If not specified, the initial date will be based on 0 in the UNIX epoch
  assert.strictEqual(Date.now(), 0);

  // Advance in time will also advance the date
  context.mock.timers.tick(9999);
  assert.strictEqual(Date.now(), 9999);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks the Date object', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['Date'] });
  // If not specified, the initial date will be based on 0 in the UNIX epoch
  assert.strictEqual(Date.now(), 0);

  // Advance in time will also advance the date
  context.mock.timers.tick(9999);
  assert.strictEqual(Date.now(), 9999);
});

如果没有设置初始纪元，初始日期将基于 Unix 纪元中的 0。即 1970 年 1 月 1 日 00:00:00 UTC。你可以通过向 .enable() 方法传递 now 属性来设置初始日期。此值将用作模拟 Date 对象的初始日期。它可以是正整数，也可以是另一个 Date 对象。

【If there is no initial epoch set, the initial date will be based on 0 in the Unix epoch. This is January 1st, 1970, 00:00:00 UTC. You can set an initial date by passing a now property to the .enable() method. This value will be used as the initial date for the mocked Date object. It can either be a positive integer, or another Date object.】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks the Date object with initial time', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['Date'], now: 100 });
  assert.strictEqual(Date.now(), 100);

  // Advance in time will also advance the date
  context.mock.timers.tick(200);
  assert.strictEqual(Date.now(), 300);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks the Date object with initial time', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['Date'], now: 100 });
  assert.strictEqual(Date.now(), 100);

  // Advance in time will also advance the date
  context.mock.timers.tick(200);
  assert.strictEqual(Date.now(), 300);
});

你可以使用 .setTime() 方法手动将模拟的日期移动到另一个时间。此方法只接受正整数。

【You can use the .setTime() method to manually move the mocked date to another time. This method only accepts a positive integer.】

注意： 该方法会执行从新时间开始已经过去的所有模拟计时器。

在下面的示例中，我们为模拟日期设置新时间。

【In the below example we are setting a new time for the mocked date.】

import assert from 'node:assert';
import { test } from 'node:test';

test('sets the time of a date object', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['Date'], now: 100 });
  assert.strictEqual(Date.now(), 100);

  // Advance in time will also advance the date
  context.mock.timers.setTime(1000);
  context.mock.timers.tick(200);
  assert.strictEqual(Date.now(), 1200);
});const assert = require('node:assert');
const { test } = require('node:test');

test('sets the time of a date object', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['Date'], now: 100 });
  assert.strictEqual(Date.now(), 100);

  // Advance in time will also advance the date
  context.mock.timers.setTime(1000);
  context.mock.timers.tick(200);
  assert.strictEqual(Date.now(), 1200);
});

如果你有任何设置为在过去运行的计时器，它将被执行，就好像调用了 .tick() 方法一样。如果你想测试已经发生的依赖时间的功能，这非常有用。

【If you have any timer that's set to run in the past, it will be executed as if the .tick() method has been called. This is useful if you want to test time-dependent functionality that's already in the past.】

import assert from 'node:assert';
import { test } from 'node:test';

test('runs timers as setTime passes ticks', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const fn = context.mock.fn();
  setTimeout(fn, 1000);

  context.mock.timers.setTime(800);
  // Timer is not executed as the time is not yet reached
  assert.strictEqual(fn.mock.callCount(), 0);
  assert.strictEqual(Date.now(), 800);

  context.mock.timers.setTime(1200);
  // Timer is executed as the time is now reached
  assert.strictEqual(fn.mock.callCount(), 1);
  assert.strictEqual(Date.now(), 1200);
});const assert = require('node:assert');
const { test } = require('node:test');

test('runs timers as setTime passes ticks', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const fn = context.mock.fn();
  setTimeout(fn, 1000);

  context.mock.timers.setTime(800);
  // Timer is not executed as the time is not yet reached
  assert.strictEqual(fn.mock.callCount(), 0);
  assert.strictEqual(Date.now(), 800);

  context.mock.timers.setTime(1200);
  // Timer is executed as the time is now reached
  assert.strictEqual(fn.mock.callCount(), 1);
  assert.strictEqual(Date.now(), 1200);
});

使用 .runAll() 将会执行当前队列中的所有定时器。这也会将模拟的日期推进到最后执行的定时器的时间，就好像时间已经过去了一样。

【Using .runAll() will execute all timers that are currently in the queue. This will also advance the mocked date to the time of the last timer that was executed as if the time has passed.】

import assert from 'node:assert';
import { test } from 'node:test';

test('runs timers as setTime passes ticks', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const fn = context.mock.fn();
  setTimeout(fn, 1000);
  setTimeout(fn, 2000);
  setTimeout(fn, 3000);

  context.mock.timers.runAll();
  // All timers are executed as the time is now reached
  assert.strictEqual(fn.mock.callCount(), 3);
  assert.strictEqual(Date.now(), 3000);
});const assert = require('node:assert');
const { test } = require('node:test');

test('runs timers as setTime passes ticks', (context) => {
  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const fn = context.mock.fn();
  setTimeout(fn, 1000);
  setTimeout(fn, 2000);
  setTimeout(fn, 3000);

  context.mock.timers.runAll();
  // All timers are executed as the time is now reached
  assert.strictEqual(fn.mock.callCount(), 3);
  assert.strictEqual(Date.now(), 3000);
});

测试报告器#>

【Test reporters】

版本历史

版本	变更
v19.9.0	Reporters are now exposed at `node:test/reporters`.
v19.6.0, v18.15.0	新增于: v19.6.0, v18.15.0

node:test 模块支持传递 --test-reporter 标志，以便测试运行器使用特定的报告器。

【The node:test module supports passing --test-reporter flags for the test runner to use a specific reporter.】

支持以下内置报告器：

【The following built-reporters are supported:】

tap tap 报告器以轻拍格式输出测试结果。
spec spec 报告器以人类可读的格式输出测试结果。
dot dot 报告器以简洁的格式输出测试结果，其中每个通过的测试用 . 表示，每个失败的测试用 X 表示。
junit junit 报告器以 jUnit XML 格式输出测试结果
lcov 报告器在与 --experimental-test-coverage 标志一起使用时会输出测试覆盖率。

当 stdout 是文字电话时，默认使用 spec 报告器。否则，默认使用 tap 报告器。

【When stdout is a TTY, the spec reporter is used by default. Otherwise, the tap reporter is used by default.】

这些报告器的具体输出可能会因 Node.js 的版本而变化，因此不应在程序中依赖。如果需要以编程方式访问测试运行器的输出，请使用 <TestsStream> 发出的事件。

【The exact output of these reporters is subject to change between versions of Node.js, and should not be relied on programmatically. If programmatic access to the test runner's output is required, use the events emitted by the <TestsStream>.】

可以通过 node:test/reporters 模块使用这些 reporters：

【The reporters are available via the node:test/reporters module:】

import { tap, spec, dot, junit, lcov } from 'node:test/reporters';const { tap, spec, dot, junit, lcov } = require('node:test/reporters');

自定义报告器#>

【Custom reporters】

--test-reporter 可用于指定自定义报告器的路径。自定义报告器是一个模块，它导出一个流.组合可接受的值。报告器应转换由 <TestsStream> 发出的事件。

使用 <stream.Transform> 的自定义报告示例：

【Example of a custom reporter using <stream.Transform>:】

import { Transform } from 'node:stream';

const customReporter = new Transform({
  writableObjectMode: true,
  transform(event, encoding, callback) {
    switch (event.type) {
      case 'test:dequeue':
        callback(null, `test ${event.data.name} dequeued`);
        break;
      case 'test:enqueue':
        callback(null, `test ${event.data.name} enqueued`);
        break;
      case 'test:watch:drained':
        callback(null, 'test watch queue drained');
        break;
      case 'test:start':
        callback(null, `test ${event.data.name} started`);
        break;
      case 'test:pass':
        callback(null, `test ${event.data.name} passed`);
        break;
      case 'test:fail':
        callback(null, `test ${event.data.name} failed`);
        break;
      case 'test:plan':
        callback(null, 'test plan');
        break;
      case 'test:diagnostic':
      case 'test:stderr':
      case 'test:stdout':
        callback(null, event.data.message);
        break;
      case 'test:coverage': {
        const { totalLineCount } = event.data.summary.totals;
        callback(null, `total line count: ${totalLineCount}\n`);
        break;
      }
    }
  },
});

export default customReporter;const { Transform } = require('node:stream');

const customReporter = new Transform({
  writableObjectMode: true,
  transform(event, encoding, callback) {
    switch (event.type) {
      case 'test:dequeue':
        callback(null, `test ${event.data.name} dequeued`);
        break;
      case 'test:enqueue':
        callback(null, `test ${event.data.name} enqueued`);
        break;
      case 'test:watch:drained':
        callback(null, 'test watch queue drained');
        break;
      case 'test:start':
        callback(null, `test ${event.data.name} started`);
        break;
      case 'test:pass':
        callback(null, `test ${event.data.name} passed`);
        break;
      case 'test:fail':
        callback(null, `test ${event.data.name} failed`);
        break;
      case 'test:plan':
        callback(null, 'test plan');
        break;
      case 'test:diagnostic':
      case 'test:stderr':
      case 'test:stdout':
        callback(null, event.data.message);
        break;
      case 'test:coverage': {
        const { totalLineCount } = event.data.summary.totals;
        callback(null, `total line count: ${totalLineCount}\n`);
        break;
      }
    }
  },
});

module.exports = customReporter;

使用生成器函数的自定义报告器示例：

【Example of a custom reporter using a generator function:】

export default async function * customReporter(source) {
  for await (const event of source) {
    switch (event.type) {
      case 'test:dequeue':
        yield `test ${event.data.name} dequeued\n`;
        break;
      case 'test:enqueue':
        yield `test ${event.data.name} enqueued\n`;
        break;
      case 'test:watch:drained':
        yield 'test watch queue drained\n';
        break;
      case 'test:start':
        yield `test ${event.data.name} started\n`;
        break;
      case 'test:pass':
        yield `test ${event.data.name} passed\n`;
        break;
      case 'test:fail':
        yield `test ${event.data.name} failed\n`;
        break;
      case 'test:plan':
        yield 'test plan\n';
        break;
      case 'test:diagnostic':
      case 'test:stderr':
      case 'test:stdout':
        yield `${event.data.message}\n`;
        break;
      case 'test:coverage': {
        const { totalLineCount } = event.data.summary.totals;
        yield `total line count: ${totalLineCount}\n`;
        break;
      }
    }
  }
}module.exports = async function * customReporter(source) {
  for await (const event of source) {
    switch (event.type) {
      case 'test:dequeue':
        yield `test ${event.data.name} dequeued\n`;
        break;
      case 'test:enqueue':
        yield `test ${event.data.name} enqueued\n`;
        break;
      case 'test:watch:drained':
        yield 'test watch queue drained\n';
        break;
      case 'test:start':
        yield `test ${event.data.name} started\n`;
        break;
      case 'test:pass':
        yield `test ${event.data.name} passed\n`;
        break;
      case 'test:fail':
        yield `test ${event.data.name} failed\n`;
        break;
      case 'test:plan':
        yield 'test plan\n';
        break;
      case 'test:diagnostic':
      case 'test:stderr':
      case 'test:stdout':
        yield `${event.data.message}\n`;
        break;
      case 'test:coverage': {
        const { totalLineCount } = event.data.summary.totals;
        yield `total line count: ${totalLineCount}\n`;
        break;
      }
    }
  }
};

--test-reporter 提供的值应该是一个字符串，就像在 JavaScript 代码中的 import() 使用的那样，或者是为 --import 提供的值。

【The value provided to --test-reporter should be a string like one used in an import() in JavaScript code, or a value provided for --import.】

多报告器#>

【Multiple reporters】

--test-reporter 标志可以多次指定，以便以多种格式报告测试结果。在这种情况下，需要使用 --test-reporter-destination 为每个报告器指定一个目标。目标可以是 stdout、stderr 或文件路径。报告器和目标将按照它们被指定的顺序进行配对。

【The --test-reporter flag can be specified multiple times to report test results in several formats. In this situation it is required to specify a destination for each reporter using --test-reporter-destination. Destination can be stdout, stderr, or a file path. Reporters and destinations are paired according to the order they were specified.】

在下面的示例中，spec 报告器将输出到 stdout，而 dot 报告器将输出到 file.txt：

【In the following example, the spec reporter will output to stdout, and the dot reporter will output to file.txt:】

node --test-reporter=spec --test-reporter=dot --test-reporter-destination=stdout --test-reporter-destination=file.txt

当只指定一个报告器时，输出目标将默认为 stdout，除非明确提供了输出目标。

【When a single reporter is specified, the destination will default to stdout, unless a destination is explicitly provided.】

`run([options])`#>

版本历史

版本	变更
v20.14.0	Added the `forceExit` option.
v20.1.0, v18.17.0	Add a testNamePatterns option.
v18.9.0, v16.19.0	新增于: v18.9.0, v16.19.0

options <Object> 运行测试的配置选项。支持以下属性：
- concurrency <number> | <boolean> 如果提供了一个数字，那么将会有对应数量的测试进程并行运行，每个进程对应一个测试文件。如果为 true，则会并行运行 os.availableParallelism() - 1 个测试文件。如果为 false，则一次只运行一个测试文件。 默认值： false。
- files: <Array> 包含要运行文件列表的数组。 默认值: 与从命令行运行测试相同。
- forceExit: <boolean> 配置测试运行器在所有已知测试执行完毕后退出进程，即使事件循环本来仍会保持活动状态。默认值: false。
- inspectPort <number> | <Function> 设置测试子进程的调试端口。可以是一个数字，也可以是一个不带参数且返回数字的函数。如果提供的是空值，每个进程将使用自己的端口，从主进程的 process.debugPort 开始递增。默认值： undefined。
- only：<boolean> 如果为真，测试上下文将只运行设置了 only 选项的测试
- setup <Function> 一个接受 TestsStream 实例的函数，可用于在运行任何测试之前设置监听器。 默认值: undefined。
- signal <AbortSignal> 允许中止正在进行的测试执行。
- testNamePatterns <string> | <RegExp> | <Array> 一个字符串、正则表达式或正则表达式数组，可用于仅运行名称与提供的模式匹配的测试。测试名称模式被解释为 JavaScript 正则表达式。对于执行的每个测试，任何相应的测试钩子（如 beforeEach()）也会运行。默认值： undefined。
- testSkipPatterns <string> | <RegExp> | <Array> 一个字符串、正则表达式或正则表达式数组，可用于排除运行名称与提供的模式匹配的测试。测试名称模式被解释为 JavaScript 正则表达式。对于执行的每个测试，任何对应的测试钩子（如 beforeEach()）也会运行。默认值： undefined。
- timeout <number> 测试执行将在指定的毫秒数后失败。如果未指定，子测试将继承其父测试的该值。默认值: Infinity。
- watch <boolean> 是否以监听模式运行。默认值： false。
- shard <Object> 在特定分片中运行测试。默认值： undefined。
  - index <number> 是一个介于 1 和 <total> 之间的正整数，用于指定要运行的分片索引。此选项为必填。
  - total <number> 是一个正整数，用于指定要将测试文件拆分的总分片数。此选项是 必需的。
返回：<TestsStream>

注意： shard 用于在多台机器或多个进程之间水平并行运行测试，非常适合在各种环境下进行大规模执行。它与 watch 模式不兼容，后者用于快速代码迭代，通过在文件更改时自动重新运行测试。

import { tap } from 'node:test/reporters';
import { run } from 'node:test';
import process from 'node:process';
import path from 'node:path';

run({ files: [path.resolve('./tests/test.js')] })
 .on('test:fail', () => {
   process.exitCode = 1;
 })
 .compose(tap)
 .pipe(process.stdout);const { tap } = require('node:test/reporters');
const { run } = require('node:test');
const path = require('node:path');

run({ files: [path.resolve('./tests/test.js')] })
 .on('test:fail', () => {
   process.exitCode = 1;
 })
 .compose(tap)
 .pipe(process.stdout);

`suite([name][, options][, fn])`#>

新增于: v20.13.0

name <string> 测试套件的名称，在报告测试结果时显示。默认值： 如果 fn 有名称，则为 fn 的 name 属性；如果 fn 没有名称，则为 '<anonymous>'。
options <Object> 套件的可选配置选项。支持与 test([名称][, options][, fn]) 相同的选项。
fn <Function> | <AsyncFunction> 声明嵌套测试和套件的套件函数。此函数的第一个参数是一个 SuiteContext 对象。 默认值： 一个空操作函数。
返回：<Promise> 立即以 undefined 完成。

suite() 函数是从 node:test 模块导入的。

【The suite() function is imported from the node:test module.】

`suite.skip([name][, options][, fn])`#>

新增于: v20.13.0

跳过测试套件的简写。这与 suite([name], { skip: true }[, fn]) 相同。

【Shorthand for skipping a suite. This is the same as suite([name], { skip: true }[, fn]).】

`suite.todo([name][, options][, fn])`#>

新增于: v20.13.0

用于将测试套件标记为 TODO 的简写。这与 suite([name], { todo: true }[, fn]) 相同。

【Shorthand for marking a suite as TODO. This is the same as suite([name], { todo: true }[, fn]).】

`suite.only([name][, options][, fn])`#>

新增于: v20.13.0

用于将测试套件标记为 only 的简写。这与 suite([name], { only: true }[, fn]) 相同。

【Shorthand for marking a suite as only. This is the same as suite([name], { only: true }[, fn]).】

`test([name][, options][, fn])`#>

版本历史

版本	变更
v20.2.0	Added the `skip`, `todo`, and `only` shorthands.
v18.8.0, v16.18.0	Add a `signal` option.
v18.7.0, v16.17.0	Add a `timeout` option.
v18.0.0, v16.17.0	新增于: v18.0.0, v16.17.0

name <string> 测试的名称，在报告测试结果时显示。默认值： fn 的 name 属性，或如果 fn 没有名称，则为 '<anonymous>'。
options <Object> 测试的配置选项。支持以下属性：
- concurrency <number> | <boolean> 如果提供了一个数字，那么应用线程中会有相应数量的测试并行运行。如果为 true，所有计划的异步测试将在同一线程中同时运行。如果为 false，一次只运行一个测试。如果未指定，子测试将继承父测试的该值。默认值： false。
- only <boolean> 如果为真，并且测试环境配置为只运行 only 测试，则该测试将被执行。否则，该测试将被跳过。默认值： false。
- signal <AbortSignal> 允许中止正在进行的测试。
- skip <boolean> | <string> 如果为真，则跳过测试。如果提供一个字符串，该字符串将在测试结果中显示，作为跳过测试的原因。默认值： false。
- todo <boolean> | <string> 如果为真，则将测试标记为 TODO。如果提供了一个字符串，该字符串将在测试结果中显示，作为该测试为 TODO 的原因。默认值： false。
- timeout <number> 测试将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。
- plan <number> 预计在测试中运行的断言和子测试的数量。如果测试中运行的断言数量与计划中指定的数量不匹配，测试将失败。 默认值： undefined.
fn <Function> | <AsyncFunction> 被测试的函数。此函数的第一个参数是一个 TestContext 对象。如果测试使用回调函数，回调函数将作为第二个参数传入。默认值: 一个空操作函数。
返回：<Promise> 测试完成后会以 undefined 作为结果被解决，或者如果测试在一个套件中运行，则会立即解决。

test() 函数是从 test 模块导入的值。每次调用此函数都会将测试结果报告给 <TestsStream>。

【The test() function is the value imported from the test module. Each invocation of this function results in reporting the test to the <TestsStream>.】

传递给 fn 参数的 TestContext 对象可以用于执行与当前测试相关的操作。示例包括跳过测试、添加额外的诊断信息或创建子测试。

【The TestContext object passed to the fn argument can be used to perform actions related to the current test. Examples include skipping the test, adding additional diagnostic information, or creating subtests.】

test() 会返回一个在测试完成后执行的 Promise。如果在一个测试套件中调用 test()，它会立即完成。对于顶层测试，通常可以忽略返回值。然而，对于子测试，应该使用返回值以防止父测试先结束并取消子测试，如下例所示。

test('top level test', async (t) => {
  // The setTimeout() in the following subtest would cause it to outlive its
  // parent test if 'await' is removed on the next line. Once the parent test
  // completes, it will cancel any outstanding subtests.
  await t.test('longer running subtest', async (t) => {
    return new Promise((resolve, reject) => {
      setTimeout(resolve, 1000);
    });
  });
});

timeout 选项可用于在测试执行时间超过 timeout 毫秒时使其失败。然而，它并不是一个可靠的取消测试的机制，因为正在运行的测试可能会阻塞应用线程，从而阻止计划中的取消操作。

【The timeout option can be used to fail the test if it takes longer than timeout milliseconds to complete. However, it is not a reliable mechanism for canceling tests because a running test might block the application thread and thus prevent the scheduled cancellation.】

`test.skip([name][, options][, fn])`#>

跳过测试的简写，与 test([name], { skip: true }[, fn]) 相同。

【Shorthand for skipping a test, same as test([name], { skip: true }[, fn]).】

`test.todo([name][, options][, fn])`#>

用于将测试标记为 TODO 的简写，等同于 test([name], { todo: true }[, fn])。

【Shorthand for marking a test as TODO, same as test([name], { todo: true }[, fn]).】

`test.only([name][, options][, fn])`#>

用于将测试标记为 only 的简写，等同于 test([name], { only: true }[, fn])。

【Shorthand for marking a test as only, same as test([name], { only: true }[, fn]).】

`describe([name][, options][, fn])`#>

suite() 的别名。

【Alias for suite().】

describe() 函数是从 node:test 模块导入的。

【The describe() function is imported from the node:test module.】

`describe.skip([name][, options][, fn])`#>

跳过测试套件的简写。这与 describe([name], { skip: true }[, fn]) 相同。

【Shorthand for skipping a suite. This is the same as describe([name], { skip: true }[, fn]).】

`describe.todo([name][, options][, fn])`#>

用于将测试套件标记为 TODO 的简写。这与 describe([name], { todo: true }[, fn]) 相同。

【Shorthand for marking a suite as TODO. This is the same as describe([name], { todo: true }[, fn]).】

`describe.only([name][, options][, fn])`#>

新增于: v19.8.0, v18.15.0

用于将测试套件标记为 only 的简写。这与 describe([name], { only: true }[, fn]) 相同。

【Shorthand for marking a suite as only. This is the same as describe([name], { only: true }[, fn]).】

`it([name][, options][, fn])`#>

版本历史

版本	变更
v19.8.0	Calling `it()` is now equivalent to calling `test()`.
v18.6.0, v16.17.0	新增于: v18.6.0, v16.17.0

test() 的别名。

【Alias for test().】

it() 函数是从 node:test 模块导入的。

【The it() function is imported from the node:test module.】

`it.skip([name][, options][, fn])`#>

跳过测试的简写，与 it([name], { skip: true }[, fn]) 相同。

【Shorthand for skipping a test, same as it([name], { skip: true }[, fn]).】

`it.todo([name][, options][, fn])`#>

用于将测试标记为 TODO 的简写，和 it([name], { todo: true }[, fn]) 相同。

【Shorthand for marking a test as TODO, same as it([name], { todo: true }[, fn]).】

`it.only([name][, options][, fn])`#>

新增于: v19.8.0, v18.15.0

用于将测试标记为 only 的简写，等同于 it([name], { only: true }[, fn])。

【Shorthand for marking a test as only, same as it([name], { only: true }[, fn]).】

`before([fn][, options])`#>

新增于: v18.8.0, v16.18.0

fn <Function> | <AsyncFunction> 钩子函数。如果钩子使用回调，则回调函数作为第二个参数传入。默认值： 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

该函数创建一个在执行套件之前运行的钩子。

【This function creates a hook that runs before executing a suite.】

describe('tests', async () => {
  before(() => console.log('about to run some test'));
  it('is a subtest', () => {
    assert.ok('some relevant assertion here');
  });
});

`after([fn][, options])`#>

新增于: v18.8.0, v16.18.0

fn <Function> | <AsyncFunction> 钩子函数。如果钩子使用回调，则回调函数作为第二个参数传入。默认值： 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

该函数创建一个在执行套件后运行的钩子。

【This function creates a hook that runs after executing a suite.】

describe('tests', async () => {
  after(() => console.log('finished running tests'));
  it('is a subtest', () => {
    assert.ok('some relevant assertion here');
  });
});

注意： 即使测试套件中的测试失败，after 钩子也保证会运行。

`beforeEach([fn][, options])`#>

新增于: v18.8.0, v16.18.0

fn <Function> | <AsyncFunction> 钩子函数。如果钩子使用回调，则回调函数作为第二个参数传入。默认值： 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

此函数创建一个在当前套件中的每个测试之前运行的钩子。

【This function creates a hook that runs before each test in the current suite.】

describe('tests', async () => {
  beforeEach(() => console.log('about to run a test'));
  it('is a subtest', () => {
    assert.ok('some relevant assertion here');
  });
});

`afterEach([fn][, options])`#>

新增于: v18.8.0, v16.18.0

fn <Function> | <AsyncFunction> 钩子函数。如果钩子使用回调，则回调函数作为第二个参数传入。默认值： 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

此函数会创建一个钩子，在当前测试套件中的每个测试之后运行。即使测试失败，afterEach() 钩子也会执行。

【This function creates a hook that runs after each test in the current suite. The afterEach() hook is run even if the test fails.】

describe('tests', async () => {
  afterEach(() => console.log('finished running a test'));
  it('is a subtest', () => {
    assert.ok('some relevant assertion here');
  });
});

类：`MockFunctionContext`#>

【Class: MockFunctionContext】

新增于: v19.1.0, v18.13.0

MockFunctionContext 类用于检查或操作通过 MockTracker API 创建的模拟对象的行为。

【The MockFunctionContext class is used to inspect or manipulate the behavior of mocks created via the MockTracker APIs.】

`ctx.calls`#>

新增于: v19.1.0, v18.13.0

<Array>

一个 getter，用于返回用于跟踪对模拟调用的内部数组的副本。数组中的每个条目都是一个具有以下属性的对象。

【A getter that returns a copy of the internal array used to track calls to the mock. Each entry in the array is an object with the following properties.】

arguments <Array> 传递给模拟函数的参数数组。
error <any> 如果模拟函数抛出异常，则此属性包含被抛出的值。默认值：undefined。
result <any> 模拟函数返回的值。
stack <Error> 一个 Error 对象，其堆栈可用于确定模拟函数调用的位置。
target <Function> | <undefined> 如果被模拟的函数是一个构造函数，该字段包含正在构建的类。否则，它将是 undefined。
this <any> 模拟函数的 this 值。

`ctx.callCount()`#>

新增于: v19.1.0, v18.13.0

返回：<integer> 此模拟被调用的次数。

此函数返回此模拟被调用的次数。此函数比检查 ctx.calls.length 更高效，因为 ctx.calls 是一个 getter，它会创建内部调用跟踪数组的副本。

【This function returns the number of times that this mock has been invoked. This function is more efficient than checking ctx.calls.length because ctx.calls is a getter that creates a copy of the internal call tracking array.】

`ctx.mockImplementation(implementation)`#>

新增于: v19.1.0, v18.13.0

implementation <Function> | <AsyncFunction> 将作为模拟新实现的函数。

此函数用于更改现有模拟的行为。

【This function is used to change the behavior of an existing mock.】

下面的示例使用 t.mock.fn() 创建了一个模拟函数，调用该模拟函数，然后将模拟实现更改为另一个函数。

【The following example creates a mock function using t.mock.fn(), calls the mock function, and then changes the mock implementation to a different function.】

test('changes a mock behavior', (t) => {
  let cnt = 0;

  function addOne() {
    cnt++;
    return cnt;
  }

  function addTwo() {
    cnt += 2;
    return cnt;
  }

  const fn = t.mock.fn(addOne);

  assert.strictEqual(fn(), 1);
  fn.mock.mockImplementation(addTwo);
  assert.strictEqual(fn(), 3);
  assert.strictEqual(fn(), 5);
});

`ctx.mockImplementationOnce(implementation[, onCall])`#>

新增于: v19.1.0, v18.13.0

implementation <Function> | <AsyncFunction> 用作模拟在 onCall 指定的调用次数上的实现的函数。
onCall <integer> 将使用 implementation 的调用次数。如果指定的调用已经发生，则会抛出异常。**默认值：**下一次调用的次数。

此函数用于更改现有模拟的单次调用行为。一旦发生调用 onCall，模拟将恢复到如果未调用 mockImplementationOnce() 时的行为。

【This function is used to change the behavior of an existing mock for a single invocation. Once invocation onCall has occurred, the mock will revert to whatever behavior it would have used had mockImplementationOnce() not been called.】

下面的示例使用 t.mock.fn() 创建了一个模拟函数，调用了该模拟函数，将模拟实现更改为下一个调用使用的不同函数，然后恢复其之前的行为。

【The following example creates a mock function using t.mock.fn(), calls the mock function, changes the mock implementation to a different function for the next invocation, and then resumes its previous behavior.】

test('changes a mock behavior once', (t) => {
  let cnt = 0;

  function addOne() {
    cnt++;
    return cnt;
  }

  function addTwo() {
    cnt += 2;
    return cnt;
  }

  const fn = t.mock.fn(addOne);

  assert.strictEqual(fn(), 1);
  fn.mock.mockImplementationOnce(addTwo);
  assert.strictEqual(fn(), 3);
  assert.strictEqual(fn(), 4);
});

`ctx.resetCalls()`#>

新增于: v19.3.0, v18.13.0

重置模拟函数的调用历史。

【Resets the call history of the mock function.】

`ctx.restore()`#>

新增于: v19.1.0, v18.13.0

将模拟函数的实现重置为其原始行为。调用此函数后仍然可以使用该模拟函数。

【Resets the implementation of the mock function to its original behavior. The mock can still be used after calling this function.】

类：`MockModuleContext`#>

【Class: MockModuleContext】

新增于: v20.18.0

稳定性： 1.0 - 早期开发

MockModuleContext 类用于操作通过 MockTracker API 创建的模块模拟的行为。

【The MockModuleContext class is used to manipulate the behavior of module mocks created via the MockTracker APIs.】

`ctx.restore()`#>

新增于: v20.18.0

重置模拟模块的实现。

【Resets the implementation of the mock module.】

类：`MockTracker`#>

【Class: MockTracker】

新增于: v19.1.0, v18.13.0

MockTracker 类用于管理模拟功能。测试运行器模块提供了一个顶层的 mock 导出，它是一个 MockTracker 实例。每个测试也通过测试上下文的 mock 属性提供其自身的 MockTracker 实例。

【The MockTracker class is used to manage mocking functionality. The test runner module provides a top level mock export which is a MockTracker instance. Each test also provides its own MockTracker instance via the test context's mock property.】

`mock.fn([original[, implementation]][, options])`#>

新增于: v19.1.0, v18.13.0

original <Function> | <AsyncFunction> 一个可选的函数，用于创建模拟对象。 默认值： 一个空操作函数。
implementation <Function> | <AsyncFunction> 一个可选函数，用作 original 的模拟实现。这对于创建在指定次数的调用后表现出某种行为的模拟非常有用，然后恢复 original 的行为。默认值： original 指定的函数。
options <Object> 模拟函数的可选配置选项。支持以下属性：
- times <integer> 模拟将使用 implementation 行为的次数。一旦模拟函数被调用 times 次，它将自动恢复 original 的行为。此值必须是大于零的整数。 默认值： Infinity。
返回值：<Proxy> 模拟函数。模拟函数包含一个特殊的 mock 属性，该属性是 MockFunctionContext 的一个实例，可用于检查和更改模拟函数的行为。

此函数用于创建模拟函数。

【This function is used to create a mock function.】

以下示例创建了一个模拟函数，每次调用时使计数器增加一。times 选项用于修改模拟行为，使前两次调用将计数器增加二而不是一。

【The following example creates a mock function that increments a counter by one on each invocation. The times option is used to modify the mock behavior such that the first two invocations add two to the counter instead of one.】

test('mocks a counting function', (t) => {
  let cnt = 0;

  function addOne() {
    cnt++;
    return cnt;
  }

  function addTwo() {
    cnt += 2;
    return cnt;
  }

  const fn = t.mock.fn(addOne, addTwo, { times: 2 });

  assert.strictEqual(fn(), 2);
  assert.strictEqual(fn(), 4);
  assert.strictEqual(fn(), 5);
  assert.strictEqual(fn(), 6);
});

`mock.getter(object, methodName[, implementation][, options])`#>

新增于: v19.3.0, v18.13.0

这个函数是 MockTracker.method 的语法糖，其中 options.getter 设置为 true。

【This function is syntax sugar for MockTracker.method with options.getter set to true.】

`mock.method(object, methodName[, implementation][, options])`#>

新增于: v19.1.0, v18.13.0

object <Object> 方法被模拟的对象。
methodName <string> | <symbol> 要模拟的 object 上方法的标识符。如果 object[methodName] 不是一个函数，将会抛出错误。
implementation <Function> | <AsyncFunction> 一个可选函数，用作 object[methodName] 的模拟实现。默认值： object[methodName] 指定的原始方法。
options <Object> 模拟方法的可选配置选项。支持以下属性：
- getter <boolean> 如果为 true，object[methodName] 将被视为一个 getter。此选项不能与 setter 选项同时使用。默认值： false。
- setter <boolean> 如果为 true，object[methodName] 将被视为一个 setter。此选项不能与 getter 选项同时使用。默认值： false。
- times <integer> 模拟将使用 implementation 行为的次数。一旦被模拟的方法被调用 times 次，它将自动恢复原始行为。该值必须是大于零的整数。默认值: Infinity。
返回: <Proxy> 模拟方法。模拟方法包含一个特殊的 mock 属性，该属性是 MockFunctionContext 的实例，可用于检查和更改模拟方法的行为。

此函数用于在现有对象方法上创建模拟。以下示例演示了如何在现有对象方法上创建模拟。

【This function is used to create a mock on an existing object method. The following example demonstrates how a mock is created on an existing object method.】

test('spies on an object method', (t) => {
  const number = {
    value: 5,
    subtract(a) {
      return this.value - a;
    },
  };

  t.mock.method(number, 'subtract');
  assert.strictEqual(number.subtract.mock.callCount(), 0);
  assert.strictEqual(number.subtract(3), 2);
  assert.strictEqual(number.subtract.mock.callCount(), 1);

  const call = number.subtract.mock.calls[0];

  assert.deepStrictEqual(call.arguments, [3]);
  assert.strictEqual(call.result, 2);
  assert.strictEqual(call.error, undefined);
  assert.strictEqual(call.target, undefined);
  assert.strictEqual(call.this, number);
});

`mock.module(specifier[, options])`#>

新增于: v20.18.0

稳定性： 1.0 - 早期开发

specifier <string> 一个用于标识要模拟的模块的字符串。
options <Object> 模拟模块的可选配置选项。支持以下属性：
- cache <boolean> 如果为 false，每次调用 require() 或 import() 都会生成一个新的模拟模块。如果为 true，后续调用将返回相同的模块模拟，并且该模拟模块会被插入到 CommonJS 缓存中。默认值： false。
- defaultExport <any> 一个可选值，用作模拟模块的默认导出。如果未提供此值，ESM 模拟将不包括默认导出。如果模拟的是 CommonJS 或内置模块，该设置将用作 module.exports 的值。如果未提供此值，CJS 和内置模拟将使用一个空对象作为 module.exports 的值。
- namedExports <Object> 一个可选对象，其键和值用于创建模拟模块的命名导出。如果模拟是 CommonJS 或内置模块，这些值会被复制到 module.exports 上。因此，如果一个模拟同时具有命名导出和非对象默认导出，当将其用作 CJS 或内置模块时，模拟将抛出异常。
返回：<MockModuleContext> 可用于操作模拟对象的对象。

此函数用于模拟 ECMAScript 模块、CommonJS 模块以及 Node.js 内置模块的导出。在模拟之前对原始模块的任何引用都不会受到影响。以下示例演示了如何为一个模块创建模拟。

【This function is used to mock the exports of ECMAScript modules, CommonJS modules, and Node.js builtin modules. Any references to the original module prior to mocking are not impacted. The following example demonstrates how a mock is created for a module.】

test('mocks a builtin module in both module systems', async (t) => {
  // Create a mock of 'node:readline' with a named export named 'fn', which
  // does not exist in the original 'node:readline' module.
  const mock = t.mock.module('node:readline', {
    namedExports: { fn() { return 42; } },
  });

  let esmImpl = await import('node:readline');
  let cjsImpl = require('node:readline');

  // cursorTo() is an export of the original 'node:readline' module.
  assert.strictEqual(esmImpl.cursorTo, undefined);
  assert.strictEqual(cjsImpl.cursorTo, undefined);
  assert.strictEqual(esmImpl.fn(), 42);
  assert.strictEqual(cjsImpl.fn(), 42);

  mock.restore();

  // The mock is restored, so the original builtin module is returned.
  esmImpl = await import('node:readline');
  cjsImpl = require('node:readline');

  assert.strictEqual(typeof esmImpl.cursorTo, 'function');
  assert.strictEqual(typeof cjsImpl.cursorTo, 'function');
  assert.strictEqual(esmImpl.fn, undefined);
  assert.strictEqual(cjsImpl.fn, undefined);
});

`mock.reset()`#>

新增于: v19.1.0, v18.13.0

此函数会恢复由该 MockTracker 之前创建的所有模拟的默认行为，并将这些模拟与 MockTracker 实例解绑。解绑后，模拟仍然可以使用，但 MockTracker 实例将无法再重置它们的行为或以其他方式与它们互动。

【This function restores the default behavior of all mocks that were previously created by this MockTracker and disassociates the mocks from the MockTracker instance. Once disassociated, the mocks can still be used, but the MockTracker instance can no longer be used to reset their behavior or otherwise interact with them.】

每个测试完成后，将在测试上下文的 MockTracker 上调用此函数。如果全局 MockTracker 使用频繁，建议手动调用此函数。

【After each test completes, this function is called on the test context's MockTracker. If the global MockTracker is used extensively, calling this function manually is recommended.】

`mock.restoreAll()`#>

新增于: v19.1.0, v18.13.0

此函数会恢复由该 MockTracker 之前创建的所有模拟的默认行为。与 mock.reset() 不同，mock.restoreAll() 不会将模拟与 MockTracker 实例解除关联。

【This function restores the default behavior of all mocks that were previously created by this MockTracker. Unlike mock.reset(), mock.restoreAll() does not disassociate the mocks from the MockTracker instance.】

`mock.setter(object, methodName[, implementation][, options])`#>

新增于: v19.3.0, v18.13.0

这个函数是 MockTracker.method 的语法糖，其 options.setter 设置为 true。

【This function is syntax sugar for MockTracker.method with options.setter set to true.】

类：`MockTimers`#>

【Class: MockTimers】

新增于: v20.4.0

稳定性： 1 - 实验性

模拟定时器是一种常用于软件测试的技术，用于模拟和控制定时器的行为，例如 setInterval 和 setTimeout，而无需实际等待指定的时间间隔。

MockTimers 也能够模拟 Date 对象。

【MockTimers is also able to mock the Date object.】

MockTracker 提供了一个顶层的 timers 导出，它是一个 MockTimers 实例。

【The MockTracker provides a top-level timers export which is a MockTimers instance.】

`timers.enable([enableOptions])`#>

版本历史

版本	变更
v20.11.0	Updated parameters to be an option object with available APIs and the default initial epoch.
v20.4.0	新增于: v20.4.0

启用指定定时器的定时器模拟。

【Enables timer mocking for the specified timers.】

enableOptions <Object> 可选的配置选项，用于启用计时器模拟。支持以下属性：
- apis <Array> 一个可选数组，包含要模拟的计时器。目前支持的计时器值有 'setInterval'、'setTimeout'、'setImmediate' 和 'Date'。默认值：['setInterval', 'setTimeout', 'setImmediate', 'Date']。如果未提供数组，则默认会模拟所有与时间相关的 API（'setInterval'、'clearInterval'、'setTimeout'、'clearTimeout'、'setImmediate'、'clearImmediate' 和 'Date'）。
- now <number> | <Date> 一个可选的数字或 Date 对象，表示用作 Date.now() 值的初始时间（以毫秒为单位）。默认值： 0。

注意： 当你为特定计时器启用模拟时，其关联的清除函数也会被隐式地模拟。

注意: 模拟 Date 会影响被模拟计时器的行为，因为它们使用相同的内部时钟。

不设置初始时间的示例用法：

【Example usage without setting initial time:】

import { mock } from 'node:test';
mock.timers.enable({ apis: ['setInterval'] });const { mock } = require('node:test');
mock.timers.enable({ apis: ['setInterval'] });

上面的示例启用了对 setInterval 定时器的模拟，并隐式模拟了 clearInterval 函数。只有来自 node:timers、node:timers/promises 和 globalThis 的 setInterval 和 clearInterval 函数会被模拟。

【The above example enables mocking for the setInterval timer and implicitly mocks the clearInterval function. Only the setInterval and clearInterval functions from node:timers, node:timers/promises, and globalThis will be mocked.】

设置初始时间的示例用法

【Example usage with initial time set】

import { mock } from 'node:test';
mock.timers.enable({ apis: ['Date'], now: 1000 });const { mock } = require('node:test');
mock.timers.enable({ apis: ['Date'], now: 1000 });

将初始 Date 对象设置为时间的示例用法

【Example usage with initial Date object as time set】

import { mock } from 'node:test';
mock.timers.enable({ apis: ['Date'], now: new Date() });const { mock } = require('node:test');
mock.timers.enable({ apis: ['Date'], now: new Date() });

或者，如果你在没有任何参数的情况下调用 mock.timers.enable()：

【Alternatively, if you call mock.timers.enable() without any parameters:】

所有计时器（'setInterval'、'clearInterval'、'setTimeout'、'clearTimeout'、'setImmediate' 和 'clearImmediate'）都将被模拟。从 node:timers、node:timers/promises 和 globalThis 导入的 setInterval、clearInterval、setTimeout、clearTimeout、setImmediate 和 clearImmediate 函数也将被模拟。全局 Date 对象也会被模拟。

【All timers ('setInterval', 'clearInterval', 'setTimeout', 'clearTimeout', 'setImmediate', and 'clearImmediate') will be mocked. The setInterval, clearInterval, setTimeout, clearTimeout, setImmediate, and clearImmediate functions from node:timers, node:timers/promises, and globalThis will be mocked. As well as the global Date object.】

`timers.reset()`#>

新增于: v20.4.0

此函数会恢复由该 MockTimers 实例先前创建的所有模拟的默认行为，并将这些模拟与 MockTracker 实例取消关联。

【This function restores the default behavior of all mocks that were previously created by this MockTimers instance and disassociates the mocks from the MockTracker instance.】

注意: 每次测试完成后，该函数会在测试上下文的 MockTracker 上被调用。

import { mock } from 'node:test';
mock.timers.reset();const { mock } = require('node:test');
mock.timers.reset();

`timers[Symbol.dispose]()`#>

调用 timers.reset()。

【Calls timers.reset().】

`timers.tick([milliseconds])`#>

新增于: v20.4.0

提前所有模拟定时器的时间。

【Advances time for all mocked timers.】

milliseconds <number> 前进计时器的时间，单位为毫秒。默认值：1。

注意： 这与 Node.js 中 setTimeout 的行为有所不同，并且只接受正数。在 Node.js 中，setTimeout 支持负数仅出于网页兼容性的原因。

以下示例模拟了一个 setTimeout 函数，并通过使用 .tick 来推进时间，从而触发所有待处理的定时器。

【The following example mocks a setTimeout function and by using .tick advances in time triggering all pending timers.】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();

  context.mock.timers.enable({ apis: ['setTimeout'] });

  setTimeout(fn, 9999);

  assert.strictEqual(fn.mock.callCount(), 0);

  // Advance in time
  context.mock.timers.tick(9999);

  assert.strictEqual(fn.mock.callCount(), 1);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();
  context.mock.timers.enable({ apis: ['setTimeout'] });

  setTimeout(fn, 9999);
  assert.strictEqual(fn.mock.callCount(), 0);

  // Advance in time
  context.mock.timers.tick(9999);

  assert.strictEqual(fn.mock.callCount(), 1);
});

或者，.tick 函数可以被多次调用

【Alternatively, the .tick function can be called many times】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();
  context.mock.timers.enable({ apis: ['setTimeout'] });
  const nineSecs = 9000;
  setTimeout(fn, nineSecs);

  const threeSeconds = 3000;
  context.mock.timers.tick(threeSeconds);
  context.mock.timers.tick(threeSeconds);
  context.mock.timers.tick(threeSeconds);

  assert.strictEqual(fn.mock.callCount(), 1);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();
  context.mock.timers.enable({ apis: ['setTimeout'] });
  const nineSecs = 9000;
  setTimeout(fn, nineSecs);

  const threeSeconds = 3000;
  context.mock.timers.tick(threeSeconds);
  context.mock.timers.tick(threeSeconds);
  context.mock.timers.tick(threeSeconds);

  assert.strictEqual(fn.mock.callCount(), 1);
});

使用 .tick 推进时间也会推进任何在模拟启用后创建的 Date 对象的时间（如果 Date 也被设置为模拟）。

【Advancing time using .tick will also advance the time for any Date object created after the mock was enabled (if Date was also set to be mocked).】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();

  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  setTimeout(fn, 9999);

  assert.strictEqual(fn.mock.callCount(), 0);
  assert.strictEqual(Date.now(), 0);

  // Advance in time
  context.mock.timers.tick(9999);
  assert.strictEqual(fn.mock.callCount(), 1);
  assert.strictEqual(Date.now(), 9999);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });

  setTimeout(fn, 9999);
  assert.strictEqual(fn.mock.callCount(), 0);
  assert.strictEqual(Date.now(), 0);

  // Advance in time
  context.mock.timers.tick(9999);
  assert.strictEqual(fn.mock.callCount(), 1);
  assert.strictEqual(Date.now(), 9999);
});

使用明确的函数#>

【Using clear functions】

如前所述，所有来自定时器的清除函数（clearTimeout、clearInterval 和 clearImmediate）都会被隐式模拟。来看这个使用 setTimeout 的示例：

【As mentioned, all clear functions from timers (clearTimeout, clearInterval,and clearImmediate) are implicitly mocked. Take a look at this example using setTimeout:】

import assert from 'node:assert';
import { test } from 'node:test';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();

  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout'] });
  const id = setTimeout(fn, 9999);

  // Implicitly mocked as well
  clearTimeout(id);
  context.mock.timers.tick(9999);

  // As that setTimeout was cleared the mock function will never be called
  assert.strictEqual(fn.mock.callCount(), 0);
});const assert = require('node:assert');
const { test } = require('node:test');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', (context) => {
  const fn = context.mock.fn();

  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout'] });
  const id = setTimeout(fn, 9999);

  // Implicitly mocked as well
  clearTimeout(id);
  context.mock.timers.tick(9999);

  // As that setTimeout was cleared the mock function will never be called
  assert.strictEqual(fn.mock.callCount(), 0);
});

使用 Node.js 定时器模块#>

【Working with Node.js timers modules】

一旦你启用模拟计时器，node:timers、node:timers/promises 模块，以及来自 Node.js 全局上下文的计时器就会被启用：

【Once you enable mocking timers, node:timers, node:timers/promises modules, and timers from the Node.js global context are enabled:】

注意: 像 import { setTimeout } from 'node:timers' 这样的解构函数目前不被此 API 支持。

import assert from 'node:assert';
import { test } from 'node:test';
import nodeTimers from 'node:timers';
import nodeTimersPromises from 'node:timers/promises';

test('mocks setTimeout to be executed synchronously without having to actually wait for it', async (context) => {
  const globalTimeoutObjectSpy = context.mock.fn();
  const nodeTimerSpy = context.mock.fn();
  const nodeTimerPromiseSpy = context.mock.fn();

  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout'] });
  setTimeout(globalTimeoutObjectSpy, 9999);
  nodeTimers.setTimeout(nodeTimerSpy, 9999);

  const promise = nodeTimersPromises.setTimeout(9999).then(nodeTimerPromiseSpy);

  // Advance in time
  context.mock.timers.tick(9999);
  assert.strictEqual(globalTimeoutObjectSpy.mock.callCount(), 1);
  assert.strictEqual(nodeTimerSpy.mock.callCount(), 1);
  await promise;
  assert.strictEqual(nodeTimerPromiseSpy.mock.callCount(), 1);
});const assert = require('node:assert');
const { test } = require('node:test');
const nodeTimers = require('node:timers');
const nodeTimersPromises = require('node:timers/promises');

test('mocks setTimeout to be executed synchronously without having to actually wait for it', async (context) => {
  const globalTimeoutObjectSpy = context.mock.fn();
  const nodeTimerSpy = context.mock.fn();
  const nodeTimerPromiseSpy = context.mock.fn();

  // Optionally choose what to mock
  context.mock.timers.enable({ apis: ['setTimeout'] });
  setTimeout(globalTimeoutObjectSpy, 9999);
  nodeTimers.setTimeout(nodeTimerSpy, 9999);

  const promise = nodeTimersPromises.setTimeout(9999).then(nodeTimerPromiseSpy);

  // Advance in time
  context.mock.timers.tick(9999);
  assert.strictEqual(globalTimeoutObjectSpy.mock.callCount(), 1);
  assert.strictEqual(nodeTimerSpy.mock.callCount(), 1);
  await promise;
  assert.strictEqual(nodeTimerPromiseSpy.mock.callCount(), 1);
});

在 Node.js 中，node:timers/promises 的 setInterval 是一个 AsyncGenerator，并且也被此 API 支持：

【In Node.js, setInterval from node:timers/promises is an AsyncGenerator and is also supported by this API:】

import assert from 'node:assert';
import { test } from 'node:test';
import nodeTimersPromises from 'node:timers/promises';
test('should tick five times testing a real use case', async (context) => {
  context.mock.timers.enable({ apis: ['setInterval'] });

  const expectedIterations = 3;
  const interval = 1000;
  const startedAt = Date.now();
  async function run() {
    const times = [];
    for await (const time of nodeTimersPromises.setInterval(interval, startedAt)) {
      times.push(time);
      if (times.length === expectedIterations) break;
    }
    return times;
  }

  const r = run();
  context.mock.timers.tick(interval);
  context.mock.timers.tick(interval);
  context.mock.timers.tick(interval);

  const timeResults = await r;
  assert.strictEqual(timeResults.length, expectedIterations);
  for (let it = 1; it < expectedIterations; it++) {
    assert.strictEqual(timeResults[it - 1], startedAt + (interval * it));
  }
});const assert = require('node:assert');
const { test } = require('node:test');
const nodeTimersPromises = require('node:timers/promises');
test('should tick five times testing a real use case', async (context) => {
  context.mock.timers.enable({ apis: ['setInterval'] });

  const expectedIterations = 3;
  const interval = 1000;
  const startedAt = Date.now();
  async function run() {
    const times = [];
    for await (const time of nodeTimersPromises.setInterval(interval, startedAt)) {
      times.push(time);
      if (times.length === expectedIterations) break;
    }
    return times;
  }

  const r = run();
  context.mock.timers.tick(interval);
  context.mock.timers.tick(interval);
  context.mock.timers.tick(interval);

  const timeResults = await r;
  assert.strictEqual(timeResults.length, expectedIterations);
  for (let it = 1; it < expectedIterations; it++) {
    assert.strictEqual(timeResults[it - 1], startedAt + (interval * it));
  }
});

`timers.runAll()`#>

新增于: v20.4.0

立即触发所有挂起的模拟计时器。如果 Date 对象也被模拟，它也会将 Date 对象推进到最远计时器的时间。

【Triggers all pending mocked timers immediately. If the Date object is also mocked, it will also advance the Date object to the furthest timer's time.】

下面的示例会立即触发所有待处理的计时器，使它们无需任何延迟就执行。

【The example below triggers all pending timers immediately, causing them to execute without any delay.】

import assert from 'node:assert';
import { test } from 'node:test';

test('runAll functions following the given order', (context) => {
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const results = [];
  setTimeout(() => results.push(1), 9999);

  // Notice that if both timers have the same timeout,
  // the order of execution is guaranteed
  setTimeout(() => results.push(3), 8888);
  setTimeout(() => results.push(2), 8888);

  assert.deepStrictEqual(results, []);

  context.mock.timers.runAll();
  assert.deepStrictEqual(results, [3, 2, 1]);
  // The Date object is also advanced to the furthest timer's time
  assert.strictEqual(Date.now(), 9999);
});const assert = require('node:assert');
const { test } = require('node:test');

test('runAll functions following the given order', (context) => {
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const results = [];
  setTimeout(() => results.push(1), 9999);

  // Notice that if both timers have the same timeout,
  // the order of execution is guaranteed
  setTimeout(() => results.push(3), 8888);
  setTimeout(() => results.push(2), 8888);

  assert.deepStrictEqual(results, []);

  context.mock.timers.runAll();
  assert.deepStrictEqual(results, [3, 2, 1]);
  // The Date object is also advanced to the furthest timer's time
  assert.strictEqual(Date.now(), 9999);
});

注意： runAll() 函数专门用于在定时器模拟的环境中触发定时器。它不会对真实系统时钟或模拟环境之外的实际定时器产生任何影响。

`timers.setTime(milliseconds)`#>

新增于: v20.11.0

设置当前的 Unix 时间戳，该时间戳将被用作任何模拟 Date 对象的参考。

【Sets the current Unix timestamp that will be used as reference for any mocked Date objects.】

import assert from 'node:assert';
import { test } from 'node:test';

test('runAll functions following the given order', (context) => {
  const now = Date.now();
  const setTime = 1000;
  // Date.now is not mocked
  assert.deepStrictEqual(Date.now(), now);

  context.mock.timers.enable({ apis: ['Date'] });
  context.mock.timers.setTime(setTime);
  // Date.now is now 1000
  assert.strictEqual(Date.now(), setTime);
});const assert = require('node:assert');
const { test } = require('node:test');

test('setTime replaces current time', (context) => {
  const now = Date.now();
  const setTime = 1000;
  // Date.now is not mocked
  assert.deepStrictEqual(Date.now(), now);

  context.mock.timers.enable({ apis: ['Date'] });
  context.mock.timers.setTime(setTime);
  // Date.now is now 1000
  assert.strictEqual(Date.now(), setTime);
});

日期和定时器一起工作#>

【Dates and Timers working together】

日期和定时器对象相互依赖。如果你使用 setTime() 将当前时间传递给模拟的 Date 对象，使用 setTimeout 和 setInterval 设置的定时器将不会受到影响。

【Dates and timer objects are dependent on each other. If you use setTime() to pass the current time to the mocked Date object, the set timers with setTimeout and setInterval will not be affected.】

然而，tick 方法会推进模拟的 Date 对象。

【However, the tick method will advanced the mocked Date object.】

import assert from 'node:assert';
import { test } from 'node:test';

test('runAll functions following the given order', (context) => {
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const results = [];
  setTimeout(() => results.push(1), 9999);

  assert.deepStrictEqual(results, []);
  context.mock.timers.setTime(12000);
  assert.deepStrictEqual(results, []);
  // The date is advanced but the timers don't tick
  assert.strictEqual(Date.now(), 12000);
});const assert = require('node:assert');
const { test } = require('node:test');

test('runAll functions following the given order', (context) => {
  context.mock.timers.enable({ apis: ['setTimeout', 'Date'] });
  const results = [];
  setTimeout(() => results.push(1), 9999);

  assert.deepStrictEqual(results, []);
  context.mock.timers.setTime(12000);
  assert.deepStrictEqual(results, []);
  // The date is advanced but the timers don't tick
  assert.strictEqual(Date.now(), 12000);
});

类：`TestsStream`#>

【Class: TestsStream】

版本历史

版本	变更
v20.0.0, v19.9.0, v18.17.0	added type to test:pass and test:fail events for when the test is a suite.
v18.9.0, v16.19.0	新增于: v18.9.0, v16.19.0

扩展 <Readable>

成功调用 run() 方法将返回一个新的 <TestsStream> 对象，流式传输一系列表示测试执行的事件。TestsStream 将按照测试定义的顺序触发事件

【A successful call to run() method will return a new <TestsStream> object, streaming a series of events representing the execution of the tests. TestsStream will emit events, in the order of the tests definition】

有些事件保证按照测试定义的顺序触发，而有些事件则按照测试执行的顺序触发。

【Some of the events are guaranteed to be emitted in the same order as the tests are defined, while others are emitted in the order that the tests execute.】

事件：`'test:coverage'`#>

【Event: 'test:coverage'】

data <Object>
- summary <Object> 一个包含覆盖率报告的对象。
  - files <Array> 单个文件的覆盖率报告数组。每个报告都是一个具有以下结构的对象：
    - path <string> 文件的绝对路径。
    - totalLineCount <number> 行总数。
    - totalBranchCount <number> 分支的总数。
    - totalFunctionCount <number> 函数的总数。
    - coveredLineCount <number> 已覆盖的行数。
    - coveredBranchCount <number> 已覆盖分支的数量。
    - coveredFunctionCount <number> 已覆盖函数的数量。
    - coveredLinePercent <number> 覆盖的行百分比。
    - coveredBranchPercent <number> 覆盖的分支百分比。
    - coveredFunctionPercent <number> 已覆盖函数的百分比。
    - functions <Array> 一个表示函数覆盖的函数数组。
      - name <string> 函数的名称。
      - line <number> 函数定义所在的行号。
      - count <number> 函数被调用的次数。
    - branches <Array> 一个表示分支覆盖情况的分支数组。
      - line <number> 分支定义所在的行号。
      - count <number> 分支被采用的次数。
    - lines <Array> 一个包含行的数组，表示行号以及这些行被覆盖的次数。
      - line <number> 行号。
      - count <number> 该行被覆盖的次数。
  - totals <Object> 一个包含所有文件覆盖率摘要的对象。
    - totalLineCount <number> 行总数。
    - totalBranchCount <number> 分支的总数。
    - totalFunctionCount <number> 函数的总数。
    - coveredLineCount <number> 已覆盖的行数。
    - coveredBranchCount <number> 已覆盖分支的数量。
    - coveredFunctionCount <number> 已覆盖函数的数量。
    - coveredLinePercent <number> 覆盖的行百分比。
    - coveredBranchPercent <number> 覆盖的分支百分比。
    - coveredFunctionPercent <number> 已覆盖函数的百分比。
  - workingDirectory <string> 代码覆盖开始时的工作目录。这对于在测试更改了 Node.js 进程的工作目录时显示相对路径名非常有用。
- nesting <number> 测试的嵌套层级。

启用代码覆盖率并且所有测试都已完成时触发。

【Emitted when code coverage is enabled and all tests have completed.】

事件：`'test:complete'`#>

【Event: 'test:complete'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- details <Object> 额外的执行元数据。
  - passed <boolean> 测试是否通过。
  - duration_ms <number> 测试的持续时间（毫秒）。
  - error <Error> | <undefined> 封装测试抛出的错误的错误，如果测试未通过的话。
    - cause <Error> 测试实际抛出的错误。
  - type <string> | <undefined> 测试的类型，用于表示这是否是一个测试套件。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- name <string> 测试名称。
- nesting <number> 测试的嵌套层级。
- testNumber <number> 测试的序号。
- todo <string> | <boolean> | <undefined> 如果调用了 context.todo，则存在
- skip <string> | <boolean> | <undefined> 如果调用了 context.skip，则存在

当测试完成其执行时触发此事件。该事件的触发顺序不按照测试定义的顺序。对应的按顺序声明的事件是 'test:pass' 和 'test:fail'。

【Emitted when a test completes its execution. This event is not emitted in the same order as the tests are defined. The corresponding declaration ordered events are 'test:pass' and 'test:fail'.】

事件：`'test:dequeue'`#>

【Event: 'test:dequeue'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- name <string> 测试名称。
- nesting <number> 测试的嵌套层级。

当一个测试从队列中取出并准备执行时触发此事件。该事件不能保证与测试定义的顺序一致。对应的声明顺序事件是 'test:start'。

【Emitted when a test is dequeued, right before it is executed. This event is not guaranteed to be emitted in the same order as the tests are defined. The corresponding declaration ordered event is 'test:start'.】

事件：`'test:diagnostic'`#>

【Event: 'test:diagnostic'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- message <string> 诊断信息。
- nesting <number> 测试的嵌套层级。

当调用 context.diagnostic 时触发此事件。此事件保证按照测试定义的顺序触发。

【Emitted when context.diagnostic is called. This event is guaranteed to be emitted in the same order as the tests are defined.】

事件：`'test:enqueue'`#>

【Event: 'test:enqueue'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- name <string> 测试名称。
- nesting <number> 测试的嵌套层级。

当测试排队执行时触发。

【Emitted when a test is enqueued for execution.】

事件：`'test:fail'`#>

【Event: 'test:fail'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- details <Object> 额外的执行元数据。
  - duration_ms <number> 测试的持续时间（毫秒）。
  - error <Error> 一个封装测试中抛出错误的错误。
    - cause <Error> 测试实际抛出的错误。
  - type <string> | <undefined> 测试的类型，用于表示这是否是一个测试套件。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- name <string> 测试名称。
- nesting <number> 测试的嵌套层级。
- testNumber <number> 测试的序号。
- todo <string> | <boolean> | <undefined> 如果调用了 context.todo，则存在
- skip <string> | <boolean> | <undefined> 如果调用了 context.skip，则存在

当测试失败时触发。此事件保证按测试定义的顺序触发。对应的按执行顺序的事件是 'test:complete'。

【Emitted when a test fails. This event is guaranteed to be emitted in the same order as the tests are defined. The corresponding execution ordered event is 'test:complete'.】

事件：`'test:pass'`#>

【Event: 'test:pass'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- details <Object> 额外的执行元数据。
  - duration_ms <number> 测试的持续时间（毫秒）。
  - type <string> | <undefined> 测试的类型，用于表示这是否是一个测试套件。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- name <string> 测试名称。
- nesting <number> 测试的嵌套层级。
- testNumber <number> 测试的序号。
- todo <string> | <boolean> | <undefined> 如果调用了 context.todo，则存在
- skip <string> | <boolean> | <undefined> 如果调用了 context.skip，则存在

当测试通过时触发。
该事件保证按照测试定义的顺序触发。
对应的按执行顺序的事件是 'test:complete'。

【Emitted when a test passes. This event is guaranteed to be emitted in the same order as the tests are defined. The corresponding execution ordered event is 'test:complete'.】

事件：`'test:plan'`#>

【Event: 'test:plan'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- nesting <number> 测试的嵌套层级。
- count <number> 已运行子测试的数量。

当给定测试的所有子测试完成时触发。该事件保证按照测试定义的顺序触发。

【Emitted when all subtests have completed for a given test. This event is guaranteed to be emitted in the same order as the tests are defined.】

事件：`'test:start'`#>

【Event: 'test:start'】

data <Object>
- column <number> | <undefined> 测试定义所在的列号，如果测试是通过 REPL 运行，则为 undefined。
- file <string> | <undefined> 测试文件的路径，如果测试是在 REPL 中运行，则为 undefined。
- line <number> | <undefined> 定义测试的行号，如果测试是通过 REPL 运行的，则为 undefined。
- name <string> 测试名称。
- nesting <number> 测试的嵌套层级。

当测试开始报告其自身及其子测试的状态时触发此事件。该事件保证按照测试定义的顺序触发。对应的按执行顺序的事件是 'test:dequeue'。

【Emitted when a test starts reporting its own and its subtests status. This event is guaranteed to be emitted in the same order as the tests are defined. The corresponding execution ordered event is 'test:dequeue'.】

事件：`'test:stderr'`#>

【Event: 'test:stderr'】

data <Object>
- file <string> 测试文件的路径。
- message <string> 写入 stderr 的消息。

当正在运行的测试写入 stderr 时触发。只有在传递了 --test 标志时才会触发此事件。此事件不保证按测试定义的顺序触发。

【Emitted when a running test writes to stderr. This event is only emitted if --test flag is passed. This event is not guaranteed to be emitted in the same order as the tests are defined.】

事件：`'test:stdout'`#>

【Event: 'test:stdout'】

data <Object>
- file <string> 测试文件的路径。
- message <string> 写入到 stdout 的消息。

当正在运行的测试写入 stdout 时触发。只有在传递了 --test 标志时才会触发此事件。此事件不能保证按测试定义的顺序触发。

【Emitted when a running test writes to stdout. This event is only emitted if --test flag is passed. This event is not guaranteed to be emitted in the same order as the tests are defined.】

事件：`'test:watch:drained'`#>

【Event: 'test:watch:drained'】

当没有更多测试排队等待以监视模式执行时触发。

【Emitted when no more tests are queued for execution in watch mode.】

类：`TestContext`#>

【Class: TestContext】

版本历史

版本	变更
v20.1.0	The `before` function was added to TestContext.
v18.0.0, v16.17.0	新增于: v18.0.0, v16.17.0

每个测试函数都会传入一个 TestContext 实例，以便与测试运行器进行交互。然而，TestContext 构造函数并未作为 API 的一部分公开。

【An instance of TestContext is passed to each test function in order to interact with the test runner. However, the TestContext constructor is not exposed as part of the API.】

`context.before([fn][, options])`#>

新增于: v20.1.0

fn <Function> | <AsyncFunction> 钩子函数。该函数的第一个参数是一个 TestContext 对象。如果钩子使用回调函数，则回调函数作为第二个参数传入。默认值: 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

此函数用于在当前测试的子测试运行前创建一个钩子。

【This function is used to create a hook running before subtest of the current test.】

`context.beforeEach([fn][, options])`#>

新增于: v18.8.0, v16.18.0

fn <Function> | <AsyncFunction> 钩子函数。该函数的第一个参数是一个 TestContext 对象。如果钩子使用回调函数，则回调函数作为第二个参数传入。默认值: 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

此函数用于在当前测试的每个子测试之前创建一个钩子。

【This function is used to create a hook running before each subtest of the current test.】

test('top level test', async (t) => {
  t.beforeEach((t) => t.diagnostic(`about to run ${t.name}`));
  await t.test(
    'This is a subtest',
    (t) => {
      assert.ok('some relevant assertion here');
    },
  );
});

`context.after([fn][, options])`#>

新增于: v19.3.0, v18.13.0

fn <Function> | <AsyncFunction> 钩子函数。该函数的第一个参数是一个 TestContext 对象。如果钩子使用回调函数，则回调函数作为第二个参数传入。默认值: 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

此函数用于创建一个在当前测试结束后运行的钩子。

【This function is used to create a hook that runs after the current test finishes.】

test('top level test', async (t) => {
  t.after((t) => t.diagnostic(`finished running ${t.name}`));
  assert.ok('some relevant assertion here');
});

`context.afterEach([fn][, options])`#>

新增于: v18.8.0, v16.18.0

fn <Function> | <AsyncFunction> 钩子函数。该函数的第一个参数是一个 TestContext 对象。如果钩子使用回调函数，则回调函数作为第二个参数传入。默认值: 一个空操作函数。
options <Object> 钩子的配置选项。支持以下属性：
- signal <AbortSignal> 允许中止正在进行的钩子。
- timeout <number> 钩子将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。

此函数用于创建一个钩子，在当前测试的每个子测试之后运行。

【This function is used to create a hook running after each subtest of the current test.】

test('top level test', async (t) => {
  t.afterEach((t) => t.diagnostic(`finished running ${t.name}`));
  await t.test(
    'This is a subtest',
    (t) => {
      assert.ok('some relevant assertion here');
    },
  );
});

`context.assert`#>

新增于: v22.2.0

一个包含绑定到 context 的断言方法的对象。这里暴露了 node:assert 模块的顶层函数，以便创建测试计划。

【An object containing assertion methods bound to context. The top-level functions from the node:assert module are exposed here for the purpose of creating test plans.】

test('test', (t) => {
  t.plan(1);
  t.assert.strictEqual(true, true);
});

`context.diagnostic(message)`#>

新增于: v18.0.0, v16.17.0

message <string> 要报告的消息。

此函数用于将诊断信息写入输出。任何诊断信息都会包含在测试结果的末尾。此函数不返回值。

【This function is used to write diagnostics to the output. Any diagnostic information is included at the end of the test's results. This function does not return a value.】

test('top level test', (t) => {
  t.diagnostic('A diagnostic message');
});

`context.fullName`#>

新增于: v20.16.0

测试的名称及其每个祖级名称，用 > 分隔。

【The name of the test and each of its ancestors, separated by >.】

`context.name`#>

新增于: v18.8.0, v16.18.0

测试名称。

【The name of the test.】

`context.plan(count)`#>

新增于: v20.15.0

稳定性： 1 - 实验性

count <number> 预期要运行的断言和子测试的数量。

此函数用于设置测试中预期运行的断言和子测试的数量。如果实际运行的断言和子测试数量与预期数量不符，测试将会失败。

【This function is used to set the number of assertions and subtests that are expected to run within the test. If the number of assertions and subtests that run does not match the expected count, the test will fail.】

注意：为了确保断言被跟踪，必须使用 t.assert，而不能直接使用 assert。

test('top level test', (t) => {
  t.plan(2);
  t.assert.ok('some relevant assertion here');
  t.test('subtest', () => {});
});

在处理异步代码时，可以使用 plan 函数来确保运行正确数量的断言：

【When working with asynchronous code, the plan function can be used to ensure that the correct number of assertions are run:】

test('planning with streams', (t, done) => {
  function* generate() {
    yield 'a';
    yield 'b';
    yield 'c';
  }
  const expected = ['a', 'b', 'c'];
  t.plan(expected.length);
  const stream = Readable.from(generate());
  stream.on('data', (chunk) => {
    t.assert.strictEqual(chunk, expected.shift());
  });

  stream.on('end', () => {
    done();
  });
});

`context.runOnly(shouldRunOnlyTests)`#>

新增于: v18.0.0, v16.17.0

shouldRunOnlyTests <boolean> 是否只运行 only 测试。

如果 shouldRunOnlyTests 为真，测试上下文将只运行设置了 only 选项的测试。否则，将运行所有测试。如果 Node.js 不是使用 --test-only 命令行选项启动的，则该函数无任何操作。

【If shouldRunOnlyTests is truthy, the test context will only run tests that have the only option set. Otherwise, all tests are run. If Node.js was not started with the --test-only command-line option, this function is a no-op.】

test('top level test', (t) => {
  // The test context can be set to run subtests with the 'only' option.
  t.runOnly(true);
  return Promise.all([
    t.test('this subtest is now skipped'),
    t.test('this subtest is run', { only: true }),
  ]);
});

`context.signal`#>

新增于: v18.7.0, v16.17.0

类型：<AbortSignal>

可用于在测试中止时中止测试子任务。

【Can be used to abort test subtasks when the test has been aborted.】

test('top level test', async (t) => {
  await fetch('some/uri', { signal: t.signal });
});

`context.skip([message])`#>

新增于: v18.0.0, v16.17.0

message <string> 可选择的跳过消息。

此函数会使测试的输出显示该测试已被跳过。如果提供了 message，它将包含在输出中。调用 skip() 不会终止测试函数的执行。此函数不返回任何值。

【This function causes the test's output to indicate the test as skipped. If message is provided, it is included in the output. Calling skip() does not terminate execution of the test function. This function does not return a value.】

test('top level test', (t) => {
  // Make sure to return here as well if the test contains additional logic.
  t.skip('this is skipped');
});

`context.todo([message])`#>

新增于: v18.0.0, v16.17.0

message <string> 可选的 TODO 消息。

此函数会在测试输出中添加 TODO 指令。如果提供了 message，它将包含在输出中。调用 todo() 不会终止测试函数的执行。此函数不返回值。

【This function adds a TODO directive to the test's output. If message is provided, it is included in the output. Calling todo() does not terminate execution of the test function. This function does not return a value.】

test('top level test', (t) => {
  // This test is marked as `TODO`
  t.todo('this is a todo');
});

`context.test([name][, options][, fn])`#>

版本历史

版本	变更
v18.8.0, v16.18.0	Add a `signal` option.
v18.7.0, v16.17.0	Add a `timeout` option.
v18.0.0, v16.17.0	新增于: v18.0.0, v16.17.0

name <string> 子测试的名称，在报告测试结果时显示。默认值： fn 的 name 属性，或如果 fn 没有名称，则为 '<anonymous>'。
options <Object> 子测试的配置选项。支持以下属性：
- concurrency <number> | <boolean> | <null> 如果提供一个数字，那么应用线程中会同时运行相应数量的测试。如果为 true，则会并行运行所有子测试。如果为 false，则一次只运行一个测试。如果未指定，子测试会继承其父测试的该值。默认值: null。
- only <boolean> 如果为真，并且测试环境配置为只运行 only 测试，则该测试将被执行。否则，该测试将被跳过。默认值： false。
- signal <AbortSignal> 允许中止正在进行的测试。
- skip <boolean> | <string> 如果为真，则跳过测试。如果提供一个字符串，该字符串将在测试结果中显示，作为跳过测试的原因。默认值： false。
- todo <boolean> | <string> 如果为真，则将测试标记为 TODO。如果提供了一个字符串，该字符串将在测试结果中显示，作为该测试为 TODO 的原因。默认值： false。
- timeout <number> 测试将在指定毫秒数后失败。如果未指定，子测试将继承父测试的此值。默认值： Infinity。
- plan <number> 预计在测试中运行的断言和子测试的数量。如果测试中运行的断言数量与计划中指定的数量不匹配，测试将失败。 默认值： undefined.
fn <Function> | <AsyncFunction> 被测试的函数。此函数的第一个参数是一个 TestContext 对象。如果测试使用回调函数，回调函数将作为第二个参数传入。默认值: 一个空操作函数。
返回：<Promise> 在测试完成后以 undefined 状态兑现。

此函数用于在当前测试下创建子测试。此函数的行为与顶层 test() 函数相同。

【This function is used to create subtests under the current test. This function behaves in the same fashion as the top level test() function.】

test('top level test', async (t) => {
  await t.test(
    'This is a subtest',
    { only: false, skip: false, concurrency: 1, todo: false, plan: 1 },
    (t) => {
      t.assert.ok('some relevant assertion here');
    },
  );
});

类：`SuiteContext`#>

【Class: SuiteContext】

新增于: v18.7.0, v16.17.0

每个测试套件函数都会传入一个 SuiteContext 实例，以便与测试运行器进行交互。然而，SuiteContext 构造函数并未作为 API 的一部分公开。

【An instance of SuiteContext is passed to each suite function in order to interact with the test runner. However, the SuiteContext constructor is not exposed as part of the API.】

`context.name`#>

新增于: v18.8.0, v16.18.0

套件名称。

【The name of the suite.】

`context.signal`#>

新增于: v18.7.0, v16.17.0

类型：<AbortSignal>

可用于在测试中止时中止测试子任务。

【Can be used to abort test subtasks when the test has been aborted.】

测试运行器#>

子测试#>

跳过测试#>

TODO 测试#>

describe() 和 it() 别名#>

only 测试#>

按名称过滤测试#>

无关的异步活动#>

监视模式#>

从命令行运行测试#>

测试运行器执行模型#>

收集代码覆盖率#>

覆盖报告器#>

局限性#>

模拟#>

定时器#>

日期#>

测试报告器#>

自定义报告器#>

多报告器#>

run([options])#>

suite([name][, options][, fn])#>

suite.skip([name][, options][, fn])#>

suite.todo([name][, options][, fn])#>

suite.only([name][, options][, fn])#>

test([name][, options][, fn])#>

test.skip([name][, options][, fn])#>

test.todo([name][, options][, fn])#>

test.only([name][, options][, fn])#>

describe([name][, options][, fn])#>

describe.skip([name][, options][, fn])#>

describe.todo([name][, options][, fn])#>

describe.only([name][, options][, fn])#>

it([name][, options][, fn])#>

it.skip([name][, options][, fn])#>

it.todo([name][, options][, fn])#>

it.only([name][, options][, fn])#>

before([fn][, options])#>

after([fn][, options])#>

beforeEach([fn][, options])#>

afterEach([fn][, options])#>

类：MockFunctionContext#>

ctx.calls#>

ctx.callCount()#>

ctx.mockImplementation(implementation)#>

ctx.mockImplementationOnce(implementation[, onCall])#>

ctx.resetCalls()#>

ctx.restore()#>

类：MockModuleContext#>

ctx.restore()#>

类：MockTracker#>

mock.fn([original[, implementation]][, options])#>

mock.getter(object, methodName[, implementation][, options])#>

mock.method(object, methodName[, implementation][, options])#>

mock.module(specifier[, options])#>

mock.reset()#>

mock.restoreAll()#>

mock.setter(object, methodName[, implementation][, options])#>

类：MockTimers#>

timers.enable([enableOptions])#>

timers.reset()#>

timers[Symbol.dispose]()#>

timers.tick([milliseconds])#>

使用明确的函数#>

使用 Node.js 定时器模块#>

timers.runAll()#>

timers.setTime(milliseconds)#>

日期和定时器一起工作#>

类：TestsStream#>

事件：'test:coverage'#>

事件：'test:complete'#>

事件：'test:dequeue'#>

事件：'test:diagnostic'#>

事件：'test:enqueue'#>

事件：'test:fail'#>

事件：'test:pass'#>

事件：'test:plan'#>

事件：'test:start'#>

事件：'test:stderr'#>

事件：'test:stdout'#>

`describe()` 和 `it()` 别名#>

`only` 测试#>

`run([options])`#>

`suite([name][, options][, fn])`#>

`suite.skip([name][, options][, fn])`#>

`suite.todo([name][, options][, fn])`#>

`suite.only([name][, options][, fn])`#>

`test([name][, options][, fn])`#>

`test.skip([name][, options][, fn])`#>

`test.todo([name][, options][, fn])`#>

`test.only([name][, options][, fn])`#>

`describe([name][, options][, fn])`#>

`describe.skip([name][, options][, fn])`#>

`describe.todo([name][, options][, fn])`#>

`describe.only([name][, options][, fn])`#>

`it([name][, options][, fn])`#>

`it.skip([name][, options][, fn])`#>

`it.todo([name][, options][, fn])`#>

`it.only([name][, options][, fn])`#>

`before([fn][, options])`#>

`after([fn][, options])`#>

`beforeEach([fn][, options])`#>

`afterEach([fn][, options])`#>

类：`MockFunctionContext`#>

`ctx.calls`#>

`ctx.callCount()`#>

`ctx.mockImplementation(implementation)`#>

`ctx.mockImplementationOnce(implementation[, onCall])`#>

`ctx.resetCalls()`#>

`ctx.restore()`#>

类：`MockModuleContext`#>

`ctx.restore()`#>

类：`MockTracker`#>

`mock.fn([original[, implementation]][, options])`#>

`mock.getter(object, methodName[, implementation][, options])`#>

`mock.method(object, methodName[, implementation][, options])`#>

`mock.module(specifier[, options])`#>

`mock.reset()`#>

`mock.restoreAll()`#>

`mock.setter(object, methodName[, implementation][, options])`#>

类：`MockTimers`#>

`timers.enable([enableOptions])`#>

`timers.reset()`#>

`timers[Symbol.dispose]()`#>

`timers.tick([milliseconds])`#>

`timers.runAll()`#>

`timers.setTime(milliseconds)`#>

类：`TestsStream`#>

事件：`'test:coverage'`#>

事件：`'test:complete'`#>

事件：`'test:dequeue'`#>

事件：`'test:diagnostic'`#>

事件：`'test:enqueue'`#>

事件：`'test:fail'`#>

事件：`'test:pass'`#>

事件：`'test:plan'`#>

事件：`'test:start'`#>

事件：`'test:stderr'`#>

事件：`'test:stdout'`#>

事件：`'test:watch:drained'`#>

类：`TestContext`#>

`context.before([fn][, options])`#>

`context.beforeEach([fn][, options])`#>

`context.after([fn][, options])`#>

`context.afterEach([fn][, options])`#>

`context.assert`#>

`context.diagnostic(message)`#>

`context.fullName`#>

`context.name`#>

`context.plan(count)`#>

`context.runOnly(shouldRunOnlyTests)`#>

`context.signal`#>

`context.skip([message])`#>

`context.todo([message])`#>

`context.test([name][, options][, fn])`#>

类：`SuiteContext`#>

`context.name`#>

`context.signal`#>