编写单元测试

ice-scripts 支持 ice-scripts test 命令,内置 Jest 配置提供前端的单元测试解决方案。

测试功能在 ice-scripts@2.1.3 及更高版本中支持

测试文件名约定

默认的 testMatch**/?*.(spec|test).(j|t)s?(x),即 ice-scripts 将查找项目目录下所有符合条件的文件来执行测试

  • 文件后缀为 .spec.js.spec.jsx.spec.ts.spec.tsx
  • 文件后缀为 .test.js.test.jsx.test.ts.test.tsx

使用 jest.config.js

ice-scripts 已经内置了 Jest 测试所需的配置,提供了开箱即用的测试能力,如果需要定制自己的 Jest 配置,可以在项目目录下添加 jest.config.js 文件。

  1. // jest.config.js
  2. module.exports = {
  3. testMatch: ['**/?*.e2e.js'],
  4. };

jest.config.js 中自定义配置最终将和默认配置进行合并,更多 Jest 相关配置,请参见官网

使用 Jest 相关参数

ice-scripts 通过约定的方式支持所有 Jest CLI 参数,相关参数增加 jest 前缀即可。

  1. # Jest CLI 参数 --config=<path>
  2. $ ice-scripts test --jest-config=<path>
  3. # Jest CLI 参数 --watchAll
  4. $ ice-scripts test --jest-watchAll

编写测试用例

使用 Jest 提供的内置函数可以快速创建相应的测试用例

  1. function sum(a, b) {
  2. return a + b;
  3. }
  4. it('sum numbers', () => {
  5. expect(sum(1, 2)).toEqual(3);
  6. expect(sum(2, 2)).toEqual(4);
  7. });

在日常 React 项目开发中,上述简单的例子不足以满足测试需求,测试实践中的需求往往可以可以分为两类,根据相应的需求可以选择社区的工具来帮助完成测试。

  • 通过快照进行 UI 测试 - 可以通过 Jest SnapShot 能力进行测试
  • DOM 交互测试 - 推荐使用 Enzyme,它提供了强大的 API 能力支持 UI 交互测试

使用 Snapshot 进行 UI 测试

Snapshot 测试是 Jest 提供的能力,可以自动生成组件 UI 输出的描述文件,确保你的 UI 不会发生意外的改变。

组件实现代码:

  1. // ./src/test.js
  2. import React from 'react';
  3. export default function Test() {
  4. return (
  5. <div className="test-component">
  6. test
  7. </div>
  8. );
  9. }

组件测试代码:

  1. // ./test/snapshot.test.js
  2. import React from 'react';
  3. import renderer from 'react-test-renderer';
  4. import Test from '../src/test';
  5. it('renders', () => {
  6. const tree = renderer
  7. .create(<Test />)
  8. .toJSON();
  9. expect(tree).toMatchSnapshot();
  10. });

在第一次运行后,Jest Snapshot 将会生成对应的 .snap 文件,如果组件的输出内容发生变更,则会导致测试用例无法通过。

使用 Enzyme 测试组件

Enzyme 是 Airbnb 提供的测试类库,它提供了一套简洁强大的 API。能够灵活操作 DOM,是 React 社区推荐的测试方案。

准备工作

安装测试相关依赖包

  1. $ npm install --save-dev enzyme enzyme-adapter-react-16 react-test-renderer

基于 React 开发的测试,需要安装对应的 React Adapter 来保证 enzyme 渲染的版本和项目中使用的版本一致,以 react 16 版本为例,需要进行如下设置:

  1. import { configure } from 'enzyme';
  2. import Adapter from 'enzyme-adapter-react-16';
  3. configure({ adapter: new Adapter() });

如果不想每个测试用例都去定义一遍,可以将上述内容保存至 src/setupTests.js 文件中,并自定义 Jest 配置中的 setupFilesAfterEnv

  1. // jest.config.js
  2. module.exports = {
  3. setupFilesAfterEnv: ['<rootDir>/src/setupTests.js'],
  4. };

组件测试用例

Enzyme 提供 shallow 方法对组件进行浅渲染,即它仅仅会渲染至虚拟 DOM,不会返回真实的 DOM 节点。多数情况下 shallow 方法就能满足测试需求。

组件实现代码:

  1. import React, { useState } from 'react';
  2. export default function Test() {
  3. const [content, setContent] = useState('default content');
  4. function onContentChanged() {
  5. setContent('test');
  6. }
  7. return (
  8. <div className="test-component">
  9. <span>{content}</span>
  10. <button onClick={onContentChanged}>button</button>
  11. </div>
  12. );
  13. }

使用 shallow 方法测试组件:

  1. import React from 'react';
  2. import Test from '../src/test';
  3. import { shallow } from 'enzyme';
  4. it('renders', () => {
  5. const wrapper = shallow(<Test />);
  6. const button = wrapper.find('button').at(0);
  7. // 模拟触发 点击 事件,来改变当前的 state
  8. button.simulate('click');
  9. expect(wrapper.find('span').at(0).text()).toBe('test');
  10. });

更多测试用例编写,可以参考 Enzyme 官网