单元测试 (Unit Testing) 在前端中的应用:Node.js 篇(Mocha 与 Jest)

知识背景

Unit Testing 目前分为两种——TDD(测试驱动开发)与 DDT(开发测试驱动),TDD 对程序员的编码能力要求更高,以下主要进行谈论的是 DDT。

Commonjs: require && module.exports

不管是 Mocha 还是 Jest 都直接支持对 Node.js 进行单元测试,只不过 Mocha 本身并没有自身的断言库需要额外引入,而 Jest 无需引入其他的依赖就可以对 Node.js 进行单元测试,只需要你的 JavaScript 代码以 module.exports 的形式暴露,以 require 的方式引入即可,也就是完全使用 Node.js 的 Commonjs 方式来进行 JavaScript 编码即可。

Mocha

Installation 安装

除了安装 Mocha 外,还需要添加额外的断言库(should.js,assert,chai.js),其中 should 最为语义化,assert 为 Node.js 运行环境自带的,无需进行安装

$ npm i -D mocha

也可以考虑全局安装

$ npm i -g mocha

Usage 用法

假设需要对 getWeek 方法进行测试

const getWeek = date => {
  date = new Date(date);

  return date.getDay();
};

module.exports = getWeek;

以chai.js断言库为例,需要先进行chai.js的安装

$ npm i -D chai

Mocha 默认的测试目录为项目根目录下的 test 文件夹,因此如果所有的测试文件都放于 test 文件夹下,那么则无需对 Mocha 的执行指令进行添加目录参数就可以进行运行测试,否则需要添加相应的测试目录参数给 Mocha 指令

测试代码全部位于 test 文件夹下

// package.json
{
  // ...
  "scripts": {
    "test": "mocha"
  }
  // ...
}

测试代码位于 src 文件夹下

// package.json
{
  // ...
  "scripts": {
    "test": "mocha ./src/**/*.spec.js"
  }
  // ...
}

运行时只需要执行

$ npm run test

测试代码形如

// 测试代码位于test文件夹下,文件名为get.week.spec.js
const chai = require("chai");
const expect = chai.expect;
const getWeek = require("../src/getWeek");

it("Should return 5", () => {
  expect(getWeek("2020-03-20")).to.equal(5);
});

需要注意的一点是使用chai.js时,形如 expect(value1).to.equal(value2)的写法是针对基本数据类型(string,number,boolean,null,undefined, symbol)而言的,当需要对引用数据类型进行断言时需要使用的 expect(value1).to.deep.equal(value2)

Jest

Installation 安装

Jest 是 FaceBook 推出的一款前端测试框架,集成了 Mocha,chai,jsdom,sinon 等功能,也因此 Jest 并不需要额外安装其他的断言库就可以进行断言,比 Mocha 更具有环境配置上的优势。毕竟是由 FaceBook 首推的前端测试框架,在对 React 的测试上 Jest 比 Mocha 更加友好。

$ npm i -D jest

也可以考虑全局安装

$ npm i -g jest

Usage 用法

Jest 不需要再安装额外的断言库,并且在 test 目录的支持上更加自由,基本上只要以.spec.js 结尾的文件都可以被 Jest 嗅探到,但为了使项目结构更友好与测试速度更快,推荐将测试代码文件统一放于某一个文件夹下。假设需要对 getWeek 方法进行测试

const getWeek = date => {
  date = new Date(date);

  return date.getDay();
};

module.exports = getWeek;

package.json 文件可以添加这样的指令

{
  // ...
  "scripts": {
    "test": "jest"
  }
  // ...
}

测试代码形如

const getWeek = require("../src/getWeek");

it("Should return 5", () => {
  expect(getWeek("2020-03-20")).toEqual(5);
});

在单个测试代码文件上 Jest 的体积更小,而且 Jest 的断言 expect(value1).toEqual(value2)更为强大,因为 toEqual 不仅支持对基本数据类型的断言也支持对引用数据类型的断言。

ES Module: import && export

在对 ES Module 的支持上,不管是 Mocha 还是 Jest 都需要引进 Babel 来进行 Transform,不然直接使用 ES Module 会当成错误处理。

调整功能代码与测试代码

// getWeek.js
const getWeek = date => {
  date = new Date(date);

  return date.getDay();
};

export default getWeek;
// get.week.spec.js
import getWeek from "../src/getWeek";

it("Should return 5", () => {
  expect(getWeek("2020-03-20")).toEqual(5);
});

Mocha

为了达到较好的开发效果,这里顺带引入了 Eslint 来做代码格式化

$ npm i -D @babel/core @babel/preset-env @babel/register babel-eslint eslint

为.babelrc 添加以下配置

{
  "presets": ["@babel/preset-env"]
}

为.eslintrc 添加以下配置

{
  "root": true,
  "env": {
    "amd": true,
    "es6": true,
    "node": true,
    "browser": true,
    "commonjs": true
  },
  "parser": "babel-eslint",
  "rules": {
    "no-unused-vars": 1,
    "semi": [2, "never"],
    "quotes": [2, "single"],
    "object-curly-spacing": [2, "always"],
    "array-bracket-spacing": [2, "always"],
    "comma-spacing": [2, { "before": false, "after": true }]
  }
}

需要对 package.json 的 test 指令做一点小的调整

{
  // ...
  "scripts": {
    "test": "mocha --require @babel/register"
  }
  // ...
}

@babel/register 会改写 require 命令,为它加上一个钩子(hook)。node 后续运行时所需要 require 进来的扩展名为 .es6、.es、.jsx、 .mjs 和 .js 的文件将由 Babel 自动转换。需要注意的是,@babel/register 只会对 require 命令加载的文件转码,而不会对当前文件转码。另外,由于它是实时转码,因此只适合在开发环境使用。

Jest

Jest 内置了运行时对代码进行实时转换的特性,因此并不需要进行安装@babel/register 来确保运行

$ npm i -D @babel/core @babel/preset-env babel-eslint eslint

由于 Jest 测试目录的相对自由性,也不需要调整 package.json 中的 test 指令,还有一点区别于 Mocha 的是 Jest 不仅有 it 关键字,也有 test 关键字,更为丰富了测试用例的定义。.babelrc 与 .eslintrc 的配置与 Mocha 中谈到的保持一致,这里不再进行阐述。

结论

  • 从个性化来说,Mocha 保持个性化配置的特性,对新手来说不是很友好,但对想体验不同风格的开发者来说无疑是最佳的选择。Jest 则主张零配置的思想,对新手相对友好。
  • 从终端输出的结果来说,性能上 Mocha 表现更佳,针对多个 test 文件时 Mocha 对结果的描述更为清晰,报错上不管是 Mocha 还是 Jest 都会具体到断言所处的位置,都会提供接收值(Received)与期待值(Expected)的对比。

你可能感兴趣的:(单元测试 (Unit Testing) 在前端中的应用:Node.js 篇(Mocha 与 Jest))