|
| 1 | +--- |
| 2 | +title: 编写单元测试 |
| 3 | +order: 15 |
| 4 | +--- |
| 5 | + |
| 6 | +icejs 支持 `icejs test` 命令，内置 Jest 配置提供前端的单元测试解决方案。 |
| 7 | + |
| 8 | +## 测试文件名约定 |
| 9 | + |
| 10 | +默认的 `testMatch` 为 `**/?*.(spec|test).(j|t)s?(x)`，即 icejs 将查找项目目录下所有符合条件的文件来执行测试 |
| 11 | + |
| 12 | +* 文件后缀为 `.spec.js`、`.spec.jsx`、`.spec.ts`、`.spec.tsx` |
| 13 | +* 文件后缀为 `.test.js`、`.test.jsx`、`.test.ts`、`.test.tsx` |
| 14 | + |
| 15 | +## 使用 jest.config.js |
| 16 | + |
| 17 | +`icejs` 已经内置了 Jest 测试所需的配置，提供了开箱即用的测试能力，如果需要定制自己的 Jest 配置，可以在项目目录下添加 `jest.config.js` 文件。 |
| 18 | + |
| 19 | +```js |
| 20 | +// jest.config.js |
| 21 | +module.exports = { |
| 22 | + testMatch: ['**/?*.e2e.js'], |
| 23 | +}; |
| 24 | +``` |
| 25 | + |
| 26 | +jest.config.js 中自定义配置最终将和默认配置进行合并，更多 Jest 相关配置，请参见[官网](https://jestjs.io/docs/en/configuration)。 |
| 27 | + |
| 28 | +## 使用 Jest 相关参数 |
| 29 | + |
| 30 | +`icejs` 通过约定的方式支持所有 Jest CLI 参数，相关参数增加 jest 前缀即可。 |
| 31 | + |
| 32 | +```bash |
| 33 | +# Jest CLI 参数 --config=<path> |
| 34 | +$ icejs test --jest-config=<path> |
| 35 | + |
| 36 | +# Jest CLI 参数 --watchAll |
| 37 | +$ icejs test --jest-watchAll |
| 38 | +``` |
| 39 | + |
| 40 | +## 编写测试用例 |
| 41 | + |
| 42 | +使用 Jest 提供的内置函数可以快速创建相应的测试用例 |
| 43 | + |
| 44 | +```js |
| 45 | +function sum(a, b) { |
| 46 | + return a + b; |
| 47 | +} |
| 48 | + |
| 49 | +it('sum numbers', () => { |
| 50 | + expect(sum(1, 2)).toEqual(3); |
| 51 | + expect(sum(2, 2)).toEqual(4); |
| 52 | +}); |
| 53 | +``` |
| 54 | + |
| 55 | +在日常 React 项目开发中，上述简单的例子不足以满足测试需求，测试实践中的需求往往可以可以分为两类，根据相应的需求可以选择社区的工具来帮助完成测试。 |
| 56 | + |
| 57 | +* 通过快照进行 UI 测试 - 可以通过 Jest SnapShot 能力进行测试 |
| 58 | +* DOM 交互测试 - 推荐使用 Enzyme，它提供了强大的 API 能力支持 UI 交互测试 |
| 59 | + |
| 60 | +### 使用 Snapshot 进行 UI 测试 |
| 61 | + |
| 62 | +Snapshot 测试是 Jest 提供的能力，可以自动生成组件 UI 输出的描述文件，确保你的 UI 不会发生意外的改变。 |
| 63 | + |
| 64 | +组件实现代码： |
| 65 | + |
| 66 | +```js |
| 67 | +// ./src/test.js |
| 68 | +import React from 'react'; |
| 69 | + |
| 70 | +export default function Test() { |
| 71 | + return ( |
| 72 | + <div className="test-component"> |
| 73 | + test |
| 74 | + </div> |
| 75 | + ); |
| 76 | +} |
| 77 | +``` |
| 78 | + |
| 79 | +组件测试代码： |
| 80 | + |
| 81 | +```js |
| 82 | +// ./test/snapshot.test.js |
| 83 | +import React from 'react'; |
| 84 | +import renderer from 'react-test-renderer'; |
| 85 | +import Test from '../src/test'; |
| 86 | + |
| 87 | +it('renders', () => { |
| 88 | + const tree = renderer |
| 89 | + .create(<Test />) |
| 90 | + .toJSON(); |
| 91 | + expect(tree).toMatchSnapshot(); |
| 92 | +}); |
| 93 | +``` |
| 94 | + |
| 95 | +在第一次运行后，Jest Snapshot 将会生成对应的 `.snap` 文件，如果组件的输出内容发生变更，则会导致测试用例无法通过。 |
| 96 | + |
| 97 | +### 使用 Enzyme 测试组件 |
| 98 | + |
| 99 | +Enzyme 是 Airbnb 提供的测试类库，它提供了一套简洁强大的 API。能够灵活操作 DOM，是 React 社区推荐的测试方案。 |
| 100 | + |
| 101 | +#### 准备工作 |
| 102 | + |
| 103 | +安装测试相关依赖包 |
| 104 | + |
| 105 | +```bash |
| 106 | +$ npm install --save-dev enzyme enzyme-adapter-react-16 react-test-renderer |
| 107 | +``` |
| 108 | + |
| 109 | +基于 React 开发的测试，需要安装对应的 React Adapter 来保证 enzyme 渲染的版本和项目中使用的版本一致，以 react 16 版本为例，需要进行如下设置： |
| 110 | + |
| 111 | +```js |
| 112 | +import { configure } from 'enzyme'; |
| 113 | +import Adapter from 'enzyme-adapter-react-16'; |
| 114 | + |
| 115 | +configure({ adapter: new Adapter() }); |
| 116 | +``` |
| 117 | + |
| 118 | +如果不想每个测试用例都去定义一遍，可以将上述内容保存至 `src/setupTests.js` 文件中，并自定义 Jest 配置中的 `setupFilesAfterEnv` ： |
| 119 | + |
| 120 | +```js |
| 121 | +// jest.config.js |
| 122 | +module.exports = { |
| 123 | + setupFilesAfterEnv: ['<rootDir>/src/setupTests.js'], |
| 124 | +}; |
| 125 | +``` |
| 126 | + |
| 127 | +#### 组件测试用例 |
| 128 | + |
| 129 | +Enzyme 提供 shallow 方法对组件进行浅渲染，即它仅仅会渲染至虚拟 DOM，不会返回真实的 DOM 节点。多数情况下 shallow 方法就能满足测试需求。 |
| 130 | + |
| 131 | +组件实现代码： |
| 132 | + |
| 133 | +```js |
| 134 | +import React, { useState } from 'react'; |
| 135 | + |
| 136 | +export default function Test() { |
| 137 | + const [content, setContent] = useState('default content'); |
| 138 | + function onContentChanged() { |
| 139 | + setContent('test'); |
| 140 | + } |
| 141 | + return ( |
| 142 | + <div className="test-component"> |
| 143 | + <span>{content}</span> |
| 144 | + <button onClick={onContentChanged}>button</button> |
| 145 | + </div> |
| 146 | + ); |
| 147 | +} |
| 148 | +``` |
| 149 | + |
| 150 | +使用 shallow 方法测试组件： |
| 151 | + |
| 152 | +```js |
| 153 | +import React from 'react'; |
| 154 | +import Test from '../src/test'; |
| 155 | +import { shallow } from 'enzyme'; |
| 156 | + |
| 157 | +it('renders', () => { |
| 158 | + const wrapper = shallow(<Test />); |
| 159 | + const button = wrapper.find('button').at(0); |
| 160 | + // 模拟触发 点击 事件，来改变当前的 state |
| 161 | + button.simulate('click'); |
| 162 | + expect(wrapper.find('span').at(0).text()).toBe('test'); |
| 163 | +}); |
| 164 | +``` |
| 165 | + |
| 166 | +更多测试用例编写，可以参考 [Enzyme 官网](https://airbnb.io/enzyme/) |
0 commit comments