使用node内置test runner，和 Jest say 拜拜

news/2024/11/28 11:46:45/

参考 https://nodejs.org/dist/latest-v20.x/docs/api/test.html#test-runner

在之前，我们写单元测试，必须安装第三方依赖包，而从node 20.0.0 版本之后，可以告别繁琐的第三方依赖包啦，可直接使用node的内置test runner。相关功能在20.0.0版本后才稳定，要使用test runner请安装node版本>=20.0.0。
在这里插入图片描述

使用：

import test from 'node:test';

注意必须使用node:test，下面的代码将不会生效：

import test from 'test';

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

  1. 同步函数，如果抛出异常则认为失败，否则认为通过。
  2. 返回Promise的函数，如果Promise rejects，则认为失败，如果resolves则认为通过。
  3. 接收回调函数的函数，如果回调函数的第一个参数是true，则认为失败，如果是false，则认为通过。如果测试函数接收的回调函数也返回Promise，则测试将失败。

示例：

  1. 同步函数，未抛出异常，测试通过
test('synchronous passing test', (t) => {assert.strictEqual(1, 1);
});
  1. 同步函数，抛出异常，测试失败
test('synchronous failing test', (t) => {assert.strictEqual(1, 2);
});
  1. 返回Promise的函数，Promise resolves，测试通过
test('asynchronous passing test', async (t) => {assert.strictEqual(1, 1);
});
  1. 返回Promise的函数，Promise rejected，测试失败
test('asynchronous failing test', async (t) => {assert.strictEqual(1, 2);
});
  1. 直接使用Promise rejected，测试失败
test('failing test using Promises', (t) => {return new Promise((resolve, reject) => {setImmediate(() => {reject(new Error('this will cause the test to fail'));});});
});
  1. 使用setImmediate()调用done()，不传参
test('callback passing test', (t, done) => {setImmediate(done);
});
  1. 使用setImmediate()调用done()，传参Error对象，测试失败。
test('callback failing test', (t, done) => {setImmediate(() => {done(new Error('callback failure'));});
});

如果任何测试失败，进程退出码会被设置为1。

子测试

test()方法允许创建子测试。此方法的行为与顶层test()函数相同。下面的示例演示了如何创建包含两个子测试的顶级测试。

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);});
});

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

跳过测试

可以通过将skip属性传递给测试，或通过调用测试上下文的skip()方法跳过单个测试，如下面的示例所示。

  1. 跳过该测试选项，但不提供任何提示。
test('skip option', { skip: true }, (t) => {// 这里的代码不会执行
});
  1. 跳过该测试选项，提供提示。
test('skip option with message', { skip: 'this is skipped' }, (t) => {// 这里的代码不会执行
});
  1. 如果测试包含额外的逻辑，请确保返回到正确的位置。
test('skip() method', (t) => {// 返回额外的逻辑t.skip();
});test('skip() method with message', (t) => {// 返回额外的逻辑t.skip('this is skipped');
});

describe/it 语法

运行测试也可以使用describe来声明一个套件，使用it来声明一个测试。套件用于组织和分组相关的测试。it是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';

only 测试

如果Node.js以--test-only命令行启动，则可以通过将only属性传递给应该运行的测试来跳过除选定子集之外的所有顶级测试。当运行具有only属性集的测试时，也会运行所有子测试。测试上下文的runOnly()方法可用于在子测试级别实现相同的行为。

// 假设 Node.js 使用 --test-only 命令行运行
// 设置了“only”属性，此测试会运行
test('this test is run', { only: true }, async (t) => {// 在此测试中，默认运行所有子测试await t.test('running subtest');// 可以使用“only”属性更新测试上下文，只运行子测试中有only属性的测试t.runOnly(true);await t.test('this subtest is now skipped');await t.test('this subtest is run', { only: true });// 切换上下文回执行所有子测试t.runOnly(false);await t.test('this subtest is now run');// 明确不运行以下测试await t.test('skipped subtest 3', { only: false });await t.test('skipped subtest 4', { skip: true });
});

// 未设置“only”选项，此测试会被跳过
test('this test is not run', () => {// This code is not run.throw new Error('fail');
});

按名称筛选测试

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

给定以下测试文件，使用--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"，等等)。

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，因为这个模式是不区分大小写的。

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

无关的异步活动

一旦测试函数执行完成，就会在保持测试顺序的同时尽可能快地报告结果。然而，测试函数有可能生成比测试本身更长久的异步活动。测试运行器处理这种类型的活动，但是不会为了适应它而延迟测试结果的报告。

在下面的示例中，一个测试完成时，两个setImmediate()操作仍然未执行。第一个setImmediate()尝试创建一个新的子测试。因为父测试已经完成并输出其结果，所以新的子测试立即被标记为失败，并稍后报告给<TestsStream>。

第二个setImmediate()创建一个uncaughtException事件。来自已完成测试的uncaughtException和unhandledRejection事件被test模块标记为失败，并由<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');});// 测试在此行之后结束
});

从命令行运行测试

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

node --test

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

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

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

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

测试运行器执行模型

当搜索要执行的测试文件时，测试运行程序的行为如下:

  • 执行用户显式提供的任何文件。

  • 如果用户没有显式指定任何路径，则按照以下步骤中指定的方式递归地搜索当前工作目录中的文件。

  • 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，不会被测试运行器自动执行，但如果在命令行上显式提供，则会得到支持。

每个匹配的测试文件在单独的子进程中执行。如果子进程结束时退出代码为0，则认为测试通过。否则，测试被认为是失败的。测试文件必须由node .js执行，但不需要在内部使用node:test模块。

node:test模块支持在测试期间通过顶级mock对象进行模拟。下面的示例创建一个监视函数，该函数将两个数字相加，然后使用spy来断言函数是否按预期调用。

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.calls.length, 0);assert.strictEqual(sum(3, 4), 7);assert.strictEqual(sum.mock.calls.length, 1);const call = sum.mock.calls[0];assert.deepStrictEqual(call.arguments, [3, 4]);assert.strictEqual(call.result, 7);assert.strictEqual(call.error, undefined);// 重置全局跟踪的mockmock.reset();
});

同样的模拟功能也暴露在每个测试的TestContext对象上。下面的示例使用TestContext上公开的API在对象方法上创建一个spy。通过测试上下文进行模拟的好处是，一旦测试结束，测试运行器将自动恢复所有模拟的功能。

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.calls.length, 0);assert.strictEqual(number.add(3), 8);assert.strictEqual(number.add.mock.calls.length, 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，而无需实际等待指定的时间间隔。

有关方法和特性的完整列表，请参考MockTimers类。

这允许开发人员为依赖时间的功能编写更可靠和可预测的测试。

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

注意: 此API目前不支持import {setTimeout} from 'node:timers'等解构函数。

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();// 选择要模拟的内容mock.timers.enable(['setTimeout']);setTimeout(fn, 9999);assert.strictEqual(fn.mock.callCount(), 0);// 推进时间mock.timers.tick(9999);assert.strictEqual(fn.mock.callCount(), 1);// 重置全局跟踪的mockmock.timers.reset();// 如果调用reset mock instance，它也会重置计时器实例mock.reset();
});

同样的模拟功能也暴露在每个测试的TestContext对象的mock属性中。通过测试上下文进行模拟的好处是，一旦测试结束，测试运行器将自动恢复所有模拟计时器功能。

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(['setTimeout']);setTimeout(fn, 9999);assert.strictEqual(fn.mock.callCount(), 0);// 推进时间context.mock.timers.tick(9999);assert.strictEqual(fn.mock.callCount(), 1);
});

测试reporter

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

支持以下内置reporter:

  • tap : tap reporter 以TAP格式输出测试结果。
  • spec : spec reporter 以人类可读的格式输出测试结果。
  • dot: dot reporter 以紧凑的格式输出测试结果，其中通过的测试用.表示，失败的测试用X表示。

当sdout是TTY时，默认情况下使用spec reporter。否则，默认使用tap reporter。

这些 reporter 的确切输出可能会在Node.js的不同版本之间发生变化，不应该以编程方式依赖于它们。如果需要对测试运行器的输出进行编程访问，请使用发出的事件。

reporter 可通过node:test/reports模块获得:

import { tap, spec, dot } from 'node:test/reporters';

自定义reporter

--test-reporter可以用来指定自定义 reporter 的路径。自定义 reporter 是一个导出stream.compose接受的值的模块。reporter 应该转换由发出的事件。

使用<stream.Transform>的自定义 reporter 的示例:

import { Transform } from 'node:stream';const customReporter = new Transform({writableObjectMode: true,transform(event, encoding, callback) {switch (event.type) {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':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;

提供给--test-reporter的值应该是一个字符串，类似于JavaScript代码中import()中使用的字符串，或者是提供给--import的值。

多种reporter

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

在下面的例子中，spec reporter 将输出到 stdout, dot reporter 将输出到file.txt:

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

当指定了单个reporter时，除非显式地提供了目标，否则将默认为stdout。


http://www.ppmy.cn/news/979214.html

相关文章

Ubuntu18.04 下配置Clion

Ubuntu18.04 下配置Clion

配置Clion 安装gcc、g、make Ubuntu中用到的编译工具是gcc©&#xff0c;g&#xff08;C&#xff09;&#xff0c;make(连接)。因此只需安装对应的工具包即可。Ubuntu下使用命令安装这些包&#xff1a; &#xff08;1&#xff09;安装gcc sudo apt install gcc&am…
阅读更多...
MFC第二十天 数值型关联变量 和单选按钮与复选框的开发应用

MFC第二十天 数值型关联变量 和单选按钮与复选框的开发应用

文章目录 数值型关联变量数值型关联变量的种类介绍 单选按钮与复选框单选按钮的组内选择原理解析单选按钮和复选框以及应用数值型关联变量的开发CMainDlg.cppCInputDlg.hCInputDlg.cpp 附录 数值型关联变量 数值型关联变量的种类介绍 1、 数值型关联变量&#xff1a; a)控件型…
阅读更多...
高压开关柜无线测温系统设计与实现 安科瑞 许敏

高压开关柜无线测温系统设计与实现 安科瑞 许敏

摘要&#xff1a;文章提出了一种用于小车式开关柜的无线测温系统&#xff0c;包括设于小车动触头套管上的温度传感器、环绕设于小车动触头上的电流传感器&#xff0c;温度传感器及电流传感器均分别连接有数据接收处理器&#xff0c;数据接收处理器电连接有设于小车式开关柜上的…
阅读更多...
min_free_kbytes

min_free_kbytes

转自&#xff1a;技术分享 | MemAvailable 是怎么计算的-腾讯云开发者社区-腾讯云 背景 前两天安装 OceanBase 时遇到一个小问题&#xff1a; 很明显&#xff0c;安装OB时要求服务器可用内存至少 8G&#xff0c;不达标就无法安装。为了凑这3台10G内存的服务器我已经费了不少劲…
阅读更多...
[DDPM] Denoising Diffusion Probabilistic Models

[DDPM] Denoising Diffusion Probabilistic Models

直接看paper云里雾里&#xff0c;一些推荐的讲解&#xff1a; The Annotated Diffusion Model 生成扩散模型漫谈&#xff08;一&#xff09;&#xff1a;DDPM 拆楼 建楼 生成扩散模型漫谈&#xff08;二&#xff09;&#xff1a;DDPM 自回归式VAE 生成扩散模型漫谈&#xff…
阅读更多...
管理类联考——数学——技巧篇——四大招——第一招 拿下应用题，稳江山

管理类联考——数学——技巧篇——四大招——第一招 拿下应用题，稳江山

第一招 拿下应用题&#xff0c;稳江山 应用题占 6 个题&#xff0c;计 18 分&#xff0c;拿分策略 【2 易&#xff0c;2 中&#xff0c;2 难】&#xff0c;【4 必考&#xff0c;2 可选】&#xff0c;【4 固定&#xff0c;2 灵活】核心&#xff1a;等量关系 等量关系 类型 设未…
阅读更多...
快速跑 nerf instant-ngp 快速调试与配置，跑自己的数据

快速跑 nerf instant-ngp 快速调试与配置，跑自己的数据

1.下载Anaconda3 2.打开Anaconda Prompt (Anaconda) 创建虚拟环境 conda create -n nerf-ngp python3.8切换到虚拟环境 conda activate nerf-ngp安装相关依赖包 pip install commentjson imageio numpy opencv-python-headless pybind11 pyquaternion scipy tqdm安装完毕后…
阅读更多...
学生宿舍用电管理系统的设计及应用 安科瑞 许敏

学生宿舍用电管理系统的设计及应用 安科瑞 许敏

安科瑞许敏18706168252 摘要&#xff1a;各式各样的电器给我们的生活带来了极大的便利&#xff0c;但是&#xff0c;不安全的用电方式也给我们的生活带来了极大的安全隐患&#xff0c;尤其是学生公寓安全用电管理更是学校面临的重要任务。从安全用电角度提出了一套集用电管理、…
阅读更多...
最新文章

Copyright @ 2022~2023