版本: 29.7

测试 React 应用

在 Facebook，我们使用 Jest 来测试 React 应用程序。

设置

使用 Create React App 设置

如果您是 React 新手，我们建议您使用 Create React App。它已准备好使用，并且附带 Jest！您只需要添加 react-test-renderer 来渲染快照。

运行

npm
Yarn
pnpm

npm install --save-dev react-test-renderer

yarn add --dev react-test-renderer

pnpm add --save-dev react-test-renderer

不使用 Create React App 设置

如果您有现有的应用程序，您需要安装一些包才能使一切都正常协同工作。我们正在使用 babel-jest 包和 react babel 预设来转换测试环境中的代码。另请参阅使用 babel。

运行

npm
Yarn
pnpm

npm install --save-dev jest babel-jest @babel/preset-env @babel/preset-react react-test-renderer

yarn add --dev jest babel-jest @babel/preset-env @babel/preset-react react-test-renderer

pnpm add --save-dev jest babel-jest @babel/preset-env @babel/preset-react react-test-renderer

您的 package.json 应该类似于以下内容（其中 <current-version> 是该包的实际最新版本号）。请添加脚本和 jest 配置条目

{
  "dependencies": {
    "react": "<current-version>",
    "react-dom": "<current-version>"
  },
  "devDependencies": {
    "@babel/preset-env": "<current-version>",
    "@babel/preset-react": "<current-version>",
    "babel-jest": "<current-version>",
    "jest": "<current-version>",
    "react-test-renderer": "<current-version>"
  },
  "scripts": {
    "test": "jest"
  }
}

babel.config.js
module.exports = {
  presets: [
    '@babel/preset-env',
    ['@babel/preset-react', {runtime: 'automatic'}],
  ],
};

现在您就可以开始了！

快照测试

让我们为渲染超链接的 Link 组件创建一个快照测试

Link.js
import {useState} from 'react';

const STATUS = {
  HOVERED: 'hovered',
  NORMAL: 'normal',
};

export default function Link({page, children}) {
  const [status, setStatus] = useState(STATUS.NORMAL);

  const onMouseEnter = () => {
    setStatus(STATUS.HOVERED);
  };

  const onMouseLeave = () => {
    setStatus(STATUS.NORMAL);
  };

  return (
    <a
      className={status}
      href={page || '#'}
      onMouseEnter={onMouseEnter}
      onMouseLeave={onMouseLeave}
    >
      {children}
    </a>
  );
}

注意

示例使用函数组件，但类组件也可以以相同的方式进行测试。请参阅 React：函数和类组件。提醒，对于类组件，我们希望 Jest 用于测试道具，而不是直接测试方法。

现在让我们使用 React 的测试渲染器和 Jest 的快照功能来与组件交互，捕获渲染输出并创建快照文件

Link.test.js
import renderer from 'react-test-renderer';
import Link from '../Link';

it('changes the class when hovered', () => {
  const component = renderer.create(
    <Link page="http://www.facebook.com">Facebook</Link>,
  );
  let tree = component.toJSON();
  expect(tree).toMatchSnapshot();

  // manually trigger the callback
  renderer.act(() => {
    tree.props.onMouseEnter();
  });
  // re-rendering
  tree = component.toJSON();
  expect(tree).toMatchSnapshot();

  // manually trigger the callback
  renderer.act(() => {
    tree.props.onMouseLeave();
  });
  // re-rendering
  tree = component.toJSON();
  expect(tree).toMatchSnapshot();
});

当您运行 yarn test 或 jest 时，这将生成一个类似于以下内容的输出文件

__tests__/__snapshots__/Link.test.js.snap
exports[`changes the class when hovered 1`] = `
<a
  className="normal"
  href="http://www.facebook.com"
  onMouseEnter={[Function]}
  onMouseLeave={[Function]}
>
  Facebook
</a>
`;

exports[`changes the class when hovered 2`] = `
<a
  className="hovered"
  href="http://www.facebook.com"
  onMouseEnter={[Function]}
  onMouseLeave={[Function]}
>
  Facebook
</a>
`;

exports[`changes the class when hovered 3`] = `
<a
  className="normal"
  href="http://www.facebook.com"
  onMouseEnter={[Function]}
  onMouseLeave={[Function]}
>
  Facebook
</a>
`;

下次您运行测试时，渲染输出将与之前创建的快照进行比较。快照应与代码更改一起提交。当快照测试失败时，您需要检查它是否是预期或意外更改。如果更改是预期的，您可以使用 jest -u 调用 Jest 来覆盖现有快照。

此示例的代码可在 examples/snapshot 中找到。

使用模拟、Enzyme 和 React 16+ 进行快照测试

在使用 Enzyme 和 React 16+ 时，快照测试存在一个问题。如果您使用以下样式模拟模块

jest.mock('../SomeDirectory/SomeComponent', () => 'SomeComponent');

那么您将在控制台中看到警告

Warning: <SomeComponent /> is using uppercase HTML. Always use lowercase HTML tags in React.

# Or:
Warning: The tag <SomeComponent> is unrecognized in this browser. If you meant to render a React component, start its name with an uppercase letter.

React 16 会触发这些警告，因为它检查元素类型的方式，而模拟模块无法通过这些检查。您的选择是

渲染为文本。这样您就不会在快照中看到传递给模拟组件的道具，但这很简单
```
jest.mock('./SomeComponent', () => () => 'SomeComponent');
```
渲染为自定义元素。DOM“自定义元素”不会被检查任何内容，并且不会触发警告。它们是小写并且名称中带有一个连字符。
```
jest.mock('./Widget', () => () => <mock-widget />);
```
使用 react-test-renderer。测试渲染器不关心元素类型，并且会很乐意接受例如 SomeComponent。您可以使用测试渲染器检查快照，并使用 Enzyme 单独检查组件行为。
完全禁用警告（应在您的 jest 设置文件中完成）
```
jest.mock('fbjs/lib/warning', () => require('fbjs/lib/emptyFunction'));
```
这通常不应该是您的首选，因为有用的警告可能会丢失。但是，在某些情况下，例如在测试 react-native 的组件时，我们将 react-native 标签渲染到 DOM 中，并且许多警告是无关紧要的。另一个选择是 swizzle console.warn 并抑制特定警告。

DOM 测试

如果您想断言和操作渲染的组件，您可以使用 @testing-library/react、Enzyme 或 React 的 TestUtils。以下示例使用 @testing-library/react。

@testing-library/react

npm
Yarn
pnpm

npm install --save-dev @testing-library/react

yarn add --dev @testing-library/react

pnpm add --save-dev @testing-library/react

让我们实现一个复选框，它在两个标签之间切换

CheckboxWithLabel.js
import {useState} from 'react';

export default function CheckboxWithLabel({labelOn, labelOff}) {
  const [isChecked, setIsChecked] = useState(false);

  const onChange = () => {
    setIsChecked(!isChecked);
  };

  return (
    <label>
      <input type="checkbox" checked={isChecked} onChange={onChange} />
      {isChecked ? labelOn : labelOff}
    </label>
  );
}

__tests__/CheckboxWithLabel-test.js
import {cleanup, fireEvent, render} from '@testing-library/react';
import CheckboxWithLabel from '../CheckboxWithLabel';

// Note: running cleanup afterEach is done automatically for you in @testing-library/[email protected] or higher
// unmount and cleanup DOM after the test is finished.
afterEach(cleanup);

it('CheckboxWithLabel changes the text after click', () => {
  const {queryByLabelText, getByLabelText} = render(
    <CheckboxWithLabel labelOn="On" labelOff="Off" />,
  );

  expect(queryByLabelText(/off/i)).toBeTruthy();

  fireEvent.click(getByLabelText(/off/i));

  expect(queryByLabelText(/on/i)).toBeTruthy();
});

此示例的代码可在 examples/react-testing-library 中找到。

自定义转换器

如果您需要更高级的功能，您还可以构建自己的转换器。这里是一个使用 @babel/core 的示例，而不是使用 babel-jest

custom-transformer.js
'use strict';

const {transform} = require('@babel/core');
const jestPreset = require('babel-preset-jest');

module.exports = {
  process(src, filename) {
    const result = transform(src, {
      filename,
      presets: [jestPreset],
    });

    return result || src;
  },
};

不要忘记安装 @babel/core 和 babel-preset-jest 包才能使此示例正常工作。

要使其与 Jest 协同工作，您需要使用以下内容更新 Jest 配置："transform": {"\\.js$": "path/to/custom-transformer.js"}。

如果您想使用 babel 支持构建转换器，您还可以使用 babel-jest 来组合一个转换器并传入您的自定义配置选项

const babelJest = require('babel-jest');

module.exports = babelJest.createTransformer({
  presets: ['my-custom-preset'],
});

有关更多详细信息，请参阅专用文档。

设置​

使用 Create React App 设置​

不使用 Create React App 设置​

快照测试​

使用模拟、Enzyme 和 React 16+ 进行快照测试​

DOM 测试​

@testing-library/react​

自定义转换器​

设置