14、测试框架
最后更新于：2022-04-02 06:08:50
测试不仅可以发现和预防问题，还能降低风险、减少企业损失。在React中，涌现了多种测试框架，本节会对其中的Jest和Enzyme做详细的讲解。
## 一、Jest
[Jest](https://jestjs.io/docs/zh-Hans/getting-started)是由Facebook开源的一个测试框架，可无缝兼容[React项目](https://jestjs.io/docs/zh-Hans/tutorial-react)，专注简单，推崇零配置，开箱即用的宗旨，用于逻辑和组件的单元测试。它的语法和断言与Jasmine类似，并且还集成了快照测试、Mock、覆盖率报告等功能，支持多进程并行运行测试，在内部使用JSDOM操作DOM，[JSDOM](https://github.com/jsdom/jsdom)是一种模拟的DOM环境，其行为类似于常规浏览器，可用来与用户交互、在节点上派发事件等。
**1）运行**
为了便于运行Jest，本文使用[Create React App](https://www.html.cn/create-react-app/docs/running-tests/)创建项目，命令如下所示。
~~~
npx create-react-app my-app
~~~
只要把测试文件放置在\_\_tests\_\_目录内，或将它们的名称添加.test.js或.spec.js后缀，并保存在项目的src目录中的任何深度，就能被Jest检测到。当运行下面的命令时，可得到相关的测试结果。
~~~
npm test
~~~
默认情况下，Jest每次只运行与本次更改的文件相关的测试用例。
**2）创建测试**
如果要创建测试用例（Test Case），那么需要使用[test()](https://jestjs.io/docs/zh-Hans/api#testname-fn-timeout)或it()函数，其第一个参数是测试名称，第二个参数是包含测试代码的回调函数，如下所示。
~~~
test("two plus two is four", () => {
expect(2 + 2).toBe(4);
});
~~~
[expect()](https://jestjs.io/docs/zh-Hans/expect#expectvalue)函数用于断言，它能接收一个实际值，并将其作为结果与匹配器中的期望值做比较。如果匹配失败，那么就会在控制台输出相应的错误提示。
[describe()](https://jestjs.io/docs/zh-Hans/api#describename-fn)函数可将测试用例进行逻辑分组，其第一个参数可定义分组的名称，如下所示。
~~~
describe("my test case", () => {
test("one plus one is two", () => {
expect(1 + 1).toBe(2);
});
test("two plus two is four", () => {
expect(2 + 2).toBe(4);
});
});
~~~
**3）匹配器**
通过[匹配器](https://jestjs.io/docs/zh-Hans/using-matchers)（Matcher）可以各种方式来测试代码，例如之前示例中的toBe()就是一个匹配器，它使用Object.is()来测试精确匹配，如果要检查对象是否相等，可改用toEqual()，如下所示。
~~~
test("object assignment", () => {
const data = { name: "strick" };
data["age"] = 28;
expect(data).toEqual({ name: "strick", age: 28 });
});
~~~
其它常用的匹配器还有区分undefined、null和布尔值、比较数字、匹配字符串、检查数组或可迭代对象是否包含某个特定项、测试抛出的错误等功能。
所有的匹配器都可以通过.not取反，例如验证toBeUndefined()不能匹配null，如下所示。
~~~
test("null is not undefined", () => {
expect(null).not.toBeUndefined();
});
~~~
**4）异步测试**
Jest提供了多种方式来[测试异步代码](https://jestjs.io/docs/zh-Hans/asynchronous)，包括回调函数、Promise和Async/Await，接下来会逐个讲解用法。
（1）默认情况下，Jest测试一旦执行到末尾就会完成，例如有一个check()函数（如下所示），它能接收一个回调函数，一旦check()执行结束，此测试就会在没有执行回调函数前结束。
~~~
function check(func) {
const success = true;
func(success);
}
test("the data is truth", () => {
function callback(data) {
expect(data).toBeTruthy();
}
check(callback);
});
~~~
若要解决此问题，可为test()的回调函数传递一个名为done的函数参数，Jest会等done()回调函数执行完后，再结束测试，如下所示。
~~~
test("the data is truth", done => {
function callback(data) {
expect(data).toBeTruthy();
done();
}
check(callback);
});
~~~
（2）当异步代码返回Promise对象时，Jest会等待其状态的变化。如果状态变为已完成，那么得使用then()方法；如果状态变为已拒绝，那么得使用catch()方法，如下所示。
~~~
//状态为已完成
function checkResolve() {
return new Promise((resolve, reject) => {
resolve(true);
});
}
test("the data is truth", () => {
return checkResolve().then(data => {
expect(data).toBeTruthy();
});
});
//状态为已拒绝
function checkReject() {
return new Promise((resolve, reject) => {
reject(false);
});
}
test("the data is falsity", () => {
return checkReject().catch(data => {
expect(data).toBeFalsy();
});
});
~~~
注意，要将Promise对象作为test()的回调函数的返回值，以免测试提前完成，导致没有进行方法链中的断言。
在expect语句中也可以使用.resolves或.rejects两种匹配器来处理Promise的两种状态，如下所示，语法更为简洁。
~~~
test("the data is truth", () => {
expect(checkResolve()).resolves.toBeTruthy();
});
test("the data is falsity", () => {
expect(checkReject()).rejects.toBeFalsy();
});
~~~
（3）在测试中使用async和await两个关键字，也可以匹配Promise对象，例如断言checkResolve()的处理结果，如下所示。
~~~
test("the data is truth", async () => {
const data = await checkResolve();
expect(data).toBeTruthy();
});
~~~
它们也能用来测试已拒绝状态的Promise，如下所示，其中assertions()用于验证在测试中是否执行了指定数量的断言。
~~~
function checkError() {
return new Promise((resolve, reject) => {
reject();
}).catch(() => {
throw "error";
});
}
test("the check fails with an error", async () => {
expect.assertions(1);
try {
await checkError();
} catch (e) {
expect(e).toMatch("error");
}
});
~~~
aysnc和awiat还可以与.resolves或.rejects结合使用，如下所示。
~~~
test("the data is truth", async () => {
await expect(checkResolve()).resolves.toBeTruthy();
});
test("the check fails with an error", async () => {
await expect(checkError()).rejects.toMatch("error");
});
~~~
**5）辅助函数**
有时候，在运行测试前需要做些准备工作，而在运行测试之后又需要做些整理工作，Jest提供了四个相关的[辅助函数](https://jestjs.io/docs/zh-Hans/setup-teardown)来处理这两类工作，如下所列。
（1）beforeAll()和afterAll()会在所有测试用例之前和之后执行一次。
（2）beforeEach()和afterEach()会在每个测试用例之前和之后执行，并且可以像异步测试那样处理异步代码。
假设在四个辅助函数中输出各自的函数名称，并且有两个测试用例，如下代码所示。
~~~
beforeAll(() => {
console.log("beforeAll");
});
afterAll(() => {
console.log("afterAll");
});
beforeEach(() => {
console.log("beforeEach");
});
afterEach(() => {
console.log("afterEach");
});
test("first", () => {
expect(2).toBeGreaterThan(1);
});
test("second", () => {
expect(2).toBeLessThan(3);
});
~~~
每次运行测试，在控制台将依次打印出“beforeAll”，两对“beforeEach”和“afterEach”，“afterAll”。
当通过describe()对测试用例进行分组时（如下所示），外部的beforeEach()和afterEach()会优先执行。
~~~
describe("scoped", () => {
beforeEach(() => console.log("inner beforeEach"));
afterEach(() => console.log("inner afterEach"));
test("third", () => {
expect([1, 2]).toContain(1);
});
});
~~~
**6）Mock**
Jest内置了[Mock函数](https://jestjs.io/docs/zh-Hans/mock-functions)，可用于擦除函数的实际实现来测试代码之间的连接，捕获函数的调用和参数、配置其返回值等。
假设要测试一个自定义的forEach()函数的内部实现，那么可以使用jest.fn()创建一个Mock函数，然后通过检查它的mock属性来确保回调函数是否在按预期调用，如下所示。
~~~
function forEach(items, callback) {
for (let index = 0; index < items.length; index++) {
callback(items[index]);
}
}
test("forEach", () => {
const mockFunc = jest.fn(x => 42 + x);
forEach([0, 1], mockFunc);
expect(mockFunc.mock.calls.length).toBe(2); //此Mock函数被调用了两次
expect(mockFunc.mock.calls[0][0]).toBe(0); //第一次调用函数时的第一个参数是0
expect(mockFunc.mock.calls[1][0]).toBe(1); //第二次调用函数时的第一个参数是1
expect(mockFunc.mock.results[0].value).toBe(42); //第一次函数调用的返回值是42
});
~~~
每个Mock函数都会包含一个特殊的mock属性，记录了函数如何被调用、调用时的返回值等信息，通过该属性还能追踪每次调用时的this的值。如果要用Mock函数注入返回值，那么可以像下面这样链式的添加，首次调用返回10，第二次调用返回“x”，接下来的调用都返回true。其中mockName()方法可为Mock函数命名，该名称将在输出的日志中显示，可替换掉默认的“jest.fn()”。
~~~
const myMock = jest.fn().mockName("returnValue");
myMock
.mockReturnValueOnce(10)
.mockReturnValueOnce("x")
.mockReturnValue(true);
console.log(myMock(), myMock(), myMock(), myMock()); //10, 'x', true, true
~~~
Mock函数还可以模拟模块，例如拦截axios请求得到的数据，如下代码所示，为.get提供了一个mockResolvedValue()方法，它会返回用于测试的假数据。
~~~
import axios from "axios";
jest.mock("axios");
class Users {
static all() {
return axios.get("./users.json").then(resp => resp.data);
}
}
test("should fetch users", () => {
const users = [{ name: "strick" }];
const resp = { data: users };
axios.get.mockResolvedValue(resp);
return Users.all().then(data => expect(data).toEqual(users));
});
~~~
原生的定时器函数测试起来并不方便，通过jest.useFakeTimers()可以模拟定时器函数，如下所示。
~~~
function timerGame() {
setTimeout(() => {
console.log("start");
}, 1000);
}
jest.useFakeTimers();
test("setTimeout", () => {
timerGame();
expect(setTimeout).toHaveBeenCalledTimes(1); //调用了1次
expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 1000); //1秒后执行回调
});
~~~
Jest模拟出的定时器函数还有快进到正确的时间点、执行当前正在等待的定时器等功能。
**7）快照测试**
Jest提供的[快照测试](https://jestjs.io/docs/zh-Hans/snapshot-testing)（Spapshot Testing）是一种高效的UI测试，它会将React组件序列化成纯文本（即快照）并保存在硬盘中，每次测试就把当前生成的快照与保存的快照进行对比，接下来用一个例子来介绍快照测试的用法。
首先创建一个Link组件，它会渲染出一条包含onMouseEnter事件的链接，当鼠标移动到这条链接时，会改变它的class属性。
~~~
import React from "react";
const STATUS = {
HOVERED: "hovered",
NORMAL: "normal"
};
export default class Link extends React.Component {
constructor(props) {
super(props);
this._onMouseEnter = this._onMouseEnter.bind(this);
this.state = {
class: STATUS.NORMAL
};
}
_onMouseEnter() {
this.setState({ class: STATUS.HOVERED });
}
render() {
return (
{this.props.children}
);
}
}
~~~
然后创建测试文件spapshot.test.js，在其内部，除了要引入Link组件之外，还得引入[react-test-renderer](https://zh-hans.reactjs.org/docs/test-renderer.html)，它不依赖浏览器和JSDOM，可将React组件渲染成JavaScript对象（即快照）。
~~~
import React from "react";
import Link from "./Link";
import renderer from "react-test-renderer";
test("Link changes the class when hovered", () => {
const component = renderer.create(Strick);
let tree = component.toJSON();
expect(tree).toMatchSnapshot();
tree.props.onMouseEnter(); //触发事件
tree = component.toJSON(); //重新渲染
expect(tree).toMatchSnapshot();
});
~~~
在第一次运行测试时，会自动创建\_\_snapshots\_\_目录，放置对应的快照文件spapshot.test.js.snap，其内容如下所示，包含两张快照，第二张是触发onMouseEnter事件后生成的。
~~~
exports[`Link changes the class when hovered 1`] = `
Strick
`;
exports[`Link changes the class when hovered 2`] = `
Strick
`;
~~~
如果要刷新保存的快照，除了手动删除之外，还可以通过jest -u命令实现。
## 二、Enzyme
[Enzyme](https://airbnb.io/enzyme/)是一款用于React组件的测试框架，可处理渲染出的DOM结构，开放的API类似于jQuery的语法，提供了三种不同的方式来测试组件：浅层渲染（Shallow Rendering）、完全渲染（Full Rendering）和静态渲染（Static Rendering）。从Enzyme 3开始，在安装Enzyme的同时，还需要安装与React版本相对应的适配器，命令如下所示。
~~~
npm install --save enzyme enzyme-adapter-react-16
~~~
**1）浅层渲染**
独立于DOM的[浅层渲染](https://airbnb.io/enzyme/docs/api/shallow.html)只会渲染React组件的第一层，它会忽略子组件的行为，也就没必要渲染子组件了，这提供了更好的隔离性。不过浅层渲染也有它局限性，即不支持Refs。
以上一节中的Link组件为例，在进行Enzyme之前，需要先通过configure()函数配置适配器，然后才能通过shallow()函数浅渲染Link组件，如下所示。
~~~
import React from "react";
import { shallow, configure } from "enzyme";
import Adapter from "enzyme-adapter-react-16";
import Link from "../component/Form/Link";
configure({ adapter: new Adapter() });
test("Link changes the class after mouseenter", () => {
const wrapper = shallow(Strick),
a = wrapper.find("a");
expect(wrapper.text()).toEqual("Strick");
a.simulate("mouseenter"); //触发事件
expect(a.prop("className")).toEqual("normal"); //匹配样式
});
~~~
wrapper是一个虚拟的DOM对象，它包含多个操作DOM的方法，例如find()可根据选择器找到指定的节点，simulate()可触发当前节点的事件。
**2）完全渲染**
mount()函数会完全渲染接收的组件，即它的子组件也会被渲染。完全渲染依赖JSDOM，当多个测试处理同一个DOM时，可能会相互影响，因此在测试结束后需要使用unmount()方法卸载组件。
**3）静态渲染**
render()函数会静态渲染组件，也就是将它渲染成HTML字符串，再通过Cheerio库解析该HTML结构。Cheerio类似于JSDOM，但更轻量，可像jQuery那样操作字符串。
*****
> 原文出处：
[博客园-React躬行记](https://www.cnblogs.com/strick/category/1455720.html)
[知乎专栏-React躬行记](https://zhuanlan.zhihu.com/pwreact)
已建立一个微信前端交流群，如要进群，请先加微信号freedom20180706或扫描下面的二维码，请求中需注明“看云加群”，在通过请求后就会把你拉进来。还搜集整理了一套[面试资料](https://github.com/pwstrick/daily)，欢迎浏览。
';