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

这篇具有很好参考价值的文章主要介绍了使用node内置test runner,和 Jest say 拜拜。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

参考 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
使用node内置test runner,和 Jest say 拜拜,node.js,jest,test runner

使用:

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来声明一个测试。套件用于组织和分组相关的测试。ittest()的简写。

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

describeit是从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 1test 2test 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 4Test 5,因为这个模式是不区分大小写的。

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

无关的异步活动

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

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

第二个setImmediate()创建一个uncaughtException事件。来自已完成测试的uncaughtExceptionunhandledRejection事件被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.jstest2.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.jstest-another-example.mjs
    • +[.-_]test$ -文件名以.test-test_test结尾,前面有一个或多个字符的文件。示例:example.test.jsexample-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);

  // 重置全局跟踪的mock
  mock.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

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

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

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

下面的例子展示了如何模拟setTimeout。使用.enable(['setTimeout']);它将模拟node:timersnode: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);

  // 重置全局跟踪的mock
  mock.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为每个报告程序指定一个目标。目标可以是stdoutstderr或文件路径。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文章来源地址https://www.toymoban.com/news/detail-608393.html

到了这里,关于使用node内置test runner,和 Jest say 拜拜的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • React + jest 测试 hightlight.js 报错

    报错信息如下:    Jest encountered an unexpected token     Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax. 报错在这行 import \\\'highlight.js/styles/monokai.css\\\' 应该是js/css文件没有转换好,  处理方式如下:

    2024年02月12日
    浏览(48)
  • 什么是 Jest ? Vue2 如何使用 Jest 进行单元测试?Vue2 使用 Jest 开发单元测试实例

    Jest 是一个流行的 JavaScript 测试框架,由 Facebook 开发并维护,专注于简单性和速度。它通常用于编写 JavaScript 和 TypeScript 应用程序的单元测试、集成测试和端到端测试。 特点: 简单易用: Jest 提供简洁的 API 和易于理解的语法,使得编写测试用例变得简单快捷。 零配置:

    2024年01月25日
    浏览(50)
  • 快速上手 Jest 单元测试框架:使用 Jest Preset 加速配置,灵活应对项目需求

    Jest preset 参数的作用是提供一个预先定义好的配置集合,以便于快速开始使用 Jest 单元测试框架。你可以选择现有的 preset,如 jest-preset-angular 、 create-react-app 或自定义 preset,以根据你的项目需求自动应用一系列配置。 使用示例: 先安装一个现有的 preset,例如 jest-preset-angul

    2024年02月06日
    浏览(35)
  • Jest使用

    提到测试的时候,即使是最简单的一个代码块可能都让初学者不知所措。最常问的问题的是“我怎么知道要测试什么?”。如果你正在写一个 Web 应用,那么你每个页面每个页面的测试用户交互的方式,就是一个很好的开端了。但 Web 应用也是由很多个函数和模块组成的代码单

    2024年02月09日
    浏览(29)
  • 如何使用Jest进行单元测试

    Jest 是一种流行的 JavaScript 测试框架,它具有易用性和高效性。Jest 支持测试各种 JavaScript 应用程序,包括 React、Vue、Node.js 等。在本文中,我们将介绍如何使用 Jest 进行单元测试。 ## 1. 安装 Jest 首先,我们需要在项目中安装 Jest。可以使用 npm 或 yarn 安装 Jest: ``` npm install

    2024年02月10日
    浏览(36)
  • 单元测试(jest):理解、安装、使用

    一、理解单元测试的重要性 bug发现在开发阶段,成本很低, 如果发现在生产环境,成本很高, 如果是关键时刻,决定人生命运,决定企业发展。 从技术的角度讲,有效的提高代码的健壮性,有效的增加代码的可维护性,对于后期的代码重构是必要条件。 从团队的角度讲,

    2024年02月03日
    浏览(41)
  • Puppeteer结合测试工具jest使用(四)

    一、简介 Puppeteer是一个提供自动化控制Chrome或Chromium浏览器的Node.js库, Puppeteer支持与node测试工具进行配合集成,集成到一起进行自动化测试。 Jest 是由 Facebook 提供的一款 JavaScript 测试框架,它可以帮助我们编写可靠的测试用例,并能够实现断言、mock 函数等功能。Jest 能够帮

    2024年02月01日
    浏览(32)
  • 使用 Jest 在 Visual Studio Code 中进行更好的单元测试

    目录 前言: 使用 Jest 扩展显著改善测试流程 1.自动启动 Jest 测试 2. 显示单个失败/通过的测试用例 允许调试单元测试 在文件中显示代码覆盖率 结论 前言: Jest是一个流行的JavaScript测试框架,它提供了简洁、灵活和强大的工具来编写和运行单元测试。在Visual Studio Code(VS C

    2024年02月13日
    浏览(52)
  • 在单元测试中使用Jest模拟VS Code extension API

    对VS Code extension进行单元测试时通常会遇到一个问题,代码中所使用的VS Code编辑器的功能都依赖于 vscode 库,但是我们在单元测试中并没有添加对 vscode 库的依赖,所以导致运行单元测试时出错。由于 vscode 库是作为第三方依赖被引入到我们的VS Code extension中的,所以它并不受

    2024年02月14日
    浏览(43)
  • Node.js | 使用 zlib 内置模块进行 gzip 压缩

    🖥️ NodeJS专栏:Node.js从入门到精通 🖥️ 博主的前端之路:前端之行,任重道远(来自大三学长的万字自述) 🧧 加入社区领红包:海底烧烤店ai(从前端到全栈) 🧑‍💼个人简介:即将大三的学生,一个不甘平庸的平凡人🍬 👉 你的一键三连是我更新的最大动力❤️!

    2024年02月02日
    浏览(51)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包