jest单元测试入门

官方文档

安装

yarn add --dev jest

DEMO

下面我们开始给一个假定的函数写测试，这个函数的功能是两数相加。首先创建 sum.js 文件：

function sum(a, b) {
  return a + b;
}
module.exports = sum;

Copy

接下来，创建名为 sum.test.js 的文件。这个文件包含了实际测试内容：

const sum = require('./sum');

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Copy

将如下代码添加到 package.json 中：

{
  "scripts": {
    "test": "jest"
  }
}

Copy

最后，运行 yarn test 或者 npm run test ，Jest 将输出如下信息：

PASS  ./sum.test.js
✓ adds 1 + 2 to equal 3 (5ms)

Copy

你刚才使用 Jest 成功地写出了第一个测试！

在此测试中，使用了 expect 和 toBe 来检测两个值是否完全相同。若要了解其它使用 Jest 可以测试的内容，请参阅使用匹配器(Matcher)。

使用命令行

你可以直接从 CLI 运行 Jest 并使用一系列有用的配置参数（前提是已经配置了环境变量 PATH 使其全局可用，例如通过 yarn global add jest 或者 npm install jest --global 来安装 Jest）。

这里演示了如何对于能够匹配到 my-test 的文件运行 Jest，以 config.json 作为配置文件，并在运行后显示一个基于原生操作系统的通知：

jest my-test --notify --config=config.json

Copy

如果想要了解更多在命令行中运行 jest 的内容，请参阅 Jest CLI 配置项页面.

更多配置项

生成基础配置文件

Jest 将根据你的项目提出一系列问题，并且将创建一个基础配置文件。文件中的每一项都配有简短的说明：

jest --init

Copy

使用 Babel

要使用 Babel，请通过 yarn 来安装所需的依赖项：

yarn add --dev babel-jest @babel/core @babel/preset-env

Copy

在项目的根目录下创建 babel.config.js ，通过配置 Babel 使其能够兼容当前的 Node 版本。

babel.config.js

module.exports = {
  presets: [['@babel/preset-env', {targets: {node: 'current'}}]],
};

Copy

Babel 理想的配置取决于项目本身。 请查阅 Babel 官方文档 来获得更多详细信息。

使用 webpack

Jest 可以用于在使用 webpack 管理资源、样式和编译方式的项目中。webpack 和其它工具相比的确多了一些独特的挑战。请参阅 webpack 指南 快速上手。

显示测试报告

jest --coverage

动态监听文件改变进行测试

jest --watchAll

package.json

"scripts": {
    "test": "jest --watchAll",
    "coverage": "jest --coverage"
  },

匹配器

官方文档

// 用于.toBe比较原始值或检查对象实例的引用身份。它调用比较值，这比严格相等运算符Object.is更适合测试
  test("to be", () => {
    expect("a").toBe("a");
  });
  //  用于.toEqual递归比较对象实例的所有属性（也称为“深度”相等）。它调用比较原始值，这比严格相等运算符Object.is更适合测试。
  test(".toEqual()", () => {
    let a = { name: 1 };
    expect(a).toEqual({ name: 1 });
  });
  //   .toBeTruthy当您不关心值是什么并且希望确保值在布尔上下文中为真时使用。
  test(".toBeTruthy()", () => {
    let a = 22;
    expect(a).toBeTruthy();
  });
  //   .toBeFalsy当您不关心值是什么并且希望确保值在布尔上下文中为假时使用
  test(".toBeFalsy()", () => {
    let a = 0;
    expect(a).toBeFalsy();
  });
  //   用于.toBeUndefined检查变量是否未定义
  test(".toBeUndefined()", () => {
    let a;
    expect(a).toBeUndefined();
  });
  //   用于.toBeDefined检查变量是否未定义
  test(".toBeDefined()", () => {
    let a = 123;
    expect(a).toBeDefined();
  });
  //   toBeNull()是一样的，.toBe(null)但错误信息更好一点。所以.toBeNull()当你想检查某些东西是否为空时使用。
  test(".toBeNull()", () => {
    let a = null;
    // 期望（a）.为空（）;
    expect(a).toBeNull();
  });
  //   .toBeNaN检查值为 时使用NaN。
  test(".toBeNaN()", () => {
    let a = NaN;
    expect(a).toBeNaN();
  });
  //  大于
  test(".toBeGreaterThan()", () => {
    let a = 8;
    // 期望（a）大于（6）
    expect(a).toBeGreaterThan(6);
  });
  //   大于或等于
  test(".toBeGreaterThanOrEqual()", () => {
    let a = 8;
    // 期望（a）大于或等于（8）
    expect(a).toBeGreaterThanOrEqual(8);
  });
  //   小于
  test(".toBeLessThan()", () => {
    let a = 8;
    // 期望（a）小于（10）
    expect(a).toBeLessThan(10);
  });
  //   小于或等于
  test(".toBeLessThanOrEqual()", () => {
    let a = 8;
    // 期望（a）.小于或等于（8）
    expect(a).toBeLessThanOrEqual(8);
  });
  //   用于.toMatch检查字符串是否与正则表达式匹配
  test(".toMatch()", () => {
    let a = "jest-test, mock , api";
    expect(a).toMatch("api");
  });
  //   .toContain当您要检查项目是否在数组中时使用。为了测试数组中的项目，这使用===了严格的相等检查。.toContain还可以检查一个字符串是否是另一个字符串的子字符串
  test(".toContain()", () => {
    let a = ["react", "vue", "webpack", "node", "ts"];
    expect(a).toContain("webpack");
  });
  //   用于.toThrow测试函数在调用时是否抛出 错误
  test(".toThrow()", () => {
    let a = () => {
      //   throw Error("error");
      throw "error";
    };
    expect(a).toThrow("error");
  });