如何通过 Jest 测试 React PropTypes?

IT技术 reactjs jestjs reactjs-testutils react-proptypes
2021-05-02 02:49:56

我正在为我的 React 代码编写 Jest 测试,并希望使用/测试 PropType 检查。我对 Javascript 世界很陌生。我正在使用 npm 安装react-0.11.2并有一个简单的:

var React = require('react/addons');

在我的测试中。我的测试看起来与 jest/react 教程示例非常相似,代码如下:

var eventCell = TestUtils.renderIntoDocument(
  <EventCell
    slot={slot}
    weekId={weekId}
    day={day}
    eventTypes={eventTypes}
    />
);

var time = TestUtils.findRenderedDOMComponentWithClass(eventCell, 'time');
expect(time.getDOMNode().textContent).toEqual('19:00 ');

但是,似乎EventCell没有触发组件中的 PropType 检查我知道检查只在开发模式下运行,但后来我还认为react通过 npm 为您提供了开发版本。当我使用 watchify 构建组件时,检查会在我的浏览器中触发。

我错过了什么?

4个回答

潜在的问题是如何测试console.log

简短的回答是您应该console.{method}在测试期间更换常见的方法是使用spies在这种特殊情况下,您可能希望使用存根来阻止输出。

下面是一个使用Sinon.js的示例实现(Sinon.js 提供了独立的 spies、stubs 和 mocks):

import {
    expect
} from 'chai';
import DateName from './../../src/app/components/DateName';
import createComponent from './create-component';
import sinon from 'sinon';

describe('DateName', () => {
    it('throws an error if date input does not represent 12:00:00 AM UTC', () => {
        let stub;

        stub = sinon.stub(console, 'error');

        createComponent(DateName, {date: 1470009600000});

        expect(stub.calledOnce).to.equal(true);
        expect(stub.calledWithExactly('Warning: Failed propType: Date unix timestamp must represent 00:00:00 (HH:mm:ss) time.')).to.equal(true);

        console.error.restore();
    });
});

在此示例中,DataName组件在使用不代表精确日期(12:00:00 AM)的时间戳值初始化时将引发错误。

我正在对console.error方法进行存根(这是 Facebookwarningmodule在内部使用以生成错误的方法)。我确保存根已被调用一次,并且只有一个参数表示错误。

介绍

@Gajus 的回答肯定对我有帮助(所以,感谢 Gajus)。但是,我想我会提供一个答案:

  • 使用更新的 React (v15.4.1)
  • 使用Jest(随 React 一起提供)
  • 允许测试单个props的多个props值
  • 更通用

概括

就像 Gajus 和其他人在此处建议的方法一样,我建议的基本方法也是确定console.errorReact是否使用响应不可接受的 test prop value具体来说,这种方法涉及对每个测试props值执行以下操作:

  • 嘲笑和清除console.error(以确保之前的调用console.error不会干扰),
  • 使用所考虑的测试props值创建组件,以及
  • 确认是否console.error按预期被解雇

testPropTypes功能

以下代码可以放置在测试中,也可以作为单独的导入/必需module/文件:

const testPropTypes = (component, propName, arraysOfTestValues, otherProps) => {
    console.error = jest.fn();
    const _test = (testValues, expectError) => {
        for (let propValue of testValues) {
            console.error.mockClear();
            React.createElement(component, {...otherProps, [propName]: propValue});
            expect(console.error).toHaveBeenCalledTimes(expectError ? 1 : 0);
        }
    };
    _test(arraysOfTestValues[0], false);
    _test(arraysOfTestValues[1], true);
};

调用函数

任何测试检查propTypes都可以使用三个或四个参数调用testPropTypes

  • component被prop修改的React组件
  • propName被测props的字符串名称
  • arraysOfTestValues要测试的props所有所需测试值的数组数组
    • 第一个子数组包含所有可接受的测试props值,而
    • 第二个子数组包含所有不可接受的测试props值;
  • 可选,otherProps一个包含该组件任何其他所需propsprops名称/值对的对象

    otherProps需要对象以确保 React 不会console.error因为无意中丢失了其他必需的 props而对其进行不相关的调用只需为任何必需的props包含一个可接受的值,例如{requiredPropName1: anyAcceptableValue, requiredPropName2: anyAcceptableValue}.

功能逻辑

该函数执行以下操作:

  • 设置了一个模拟,console.error React 用它来报告错误类型的props。

  • 对于测试props值的每个子数组,只要它循环遍历每个子数组中的每个测试props值以测试props类型:

    • 两个子数组中的第一个应该是可接受的测试props值列表
    • 第二个应该是不可接受的测试props值
  • 在循环内的每个单独的测试丙值,所述console.error模拟首先清零,使得检测到的任何错误信息可被假定为有来自该测试。

  • 然后使用测试props值以及当前未测试的任何其他必要的必需props创建组件的实例

  • 最后,检查是否已触发警告,如果您的测试尝试使用不适当或缺失的props创建组件,则应该发生警告

测试可选与必需的props

请注意,从 React 的角度来看,null(或undefined)分配给prop 值与不为该 prop 提供任何值本质上是相同的。根据定义,这对于可选props是可以接受的,但对于必需props是不可接受的。因此,通过放置null在可接受或不可接受值的数组中,您可以分别测试该props是可选的还是必需的

示例代码

MyComponent.js(只是propTypes):

MyComponent.propTypes = {
    myProp1: React.PropTypes.number,      // optional number
    myProp2: React.PropTypes.oneOfType([  // required number or array of numbers
        React.PropTypes.number,
        React.PropTypes.arrayOf(React.PropTypes.number)
    ]).isRequired

MyComponent.test.js:

describe('MyComponent', () => {

    it('should accept an optional number for myProp1', () => {
        const testValues = [
            [0, null],   // acceptable values; note: null is acceptable
            ['', []] // unacceptable values
        ];
        testPropTypes(MyComponent, 'myProp1', testValues, {myProp2: 123});
    });

    it('should require a number or an array of numbers for myProp2', () => {
        const testValues = [
            [0, [0]], // acceptable values
            ['', null] // unacceptable values; note: null is unacceptable
        ];
        testPropTypes(MyComponent, 'myProp2', testValues);
    });
});

这种方法的局限性(重要)

目前对于如何使用这种方法存在一些重大限制,如果过度使用,可能会导致一些难以追踪的测试错误。此其他 SO 问题/答案中解释了这些限制的原因和含义总之,对于简单的 prop 类型,例如 for myProp1,您可以根据需要测试尽可能多的不可接受的非null测试 prop 值,只要它们都是不同的数据类型即可对于某些复杂的 prop 类型,例如 for myProp2,您只能测试任何类型单个不可接受的非nullprop 值请参阅其他问题/答案以进行更深入的讨论。

Mockingconsole.error不适合在单元测试中使用!@AndrewWillems在上面的评论中链接到另一个 SO 问题,该问题描述了这种方法的问题。

在 facebook/prop-types 上查看此问题以讨论该库抛出而不是记录 propType 错误的能力(在撰写本文时,它不受支持)。

我已经发布了一个辅助库来同时提供该行为,check-prop-types你可以这样使用它:

import PropTypes from 'prop-types';
import checkPropTypes from 'check-prop-types';

const HelloComponent = ({ name }) => (
  <h1>Hi, {name}</h1>
);

HelloComponent.propTypes = {
  name: PropTypes.string.isRequired,
};

let result = checkPropTypes(HelloComponent.propTypes, { name: 'Julia' }, 'prop', HelloComponent.name);
assert(`result` === null);

result = checkPropTypes(HelloComponent.propTypes, { name: 123 }, 'prop', HelloComponent.name);
assert(`result` === 'Failed prop type: Invalid prop `name` of type `number` supplied to `HelloComponent`, expected `string`.');

一个新的包jest-prop-type-error很容易添加并且在PropType出现错误时失败

通过以下方式安装:

yarn add -D jest-prop-type-error

那么下面添加到您package.jsonsetupFilesjest部分:

"setupFiles": [
  "jest-prop-type-error"
]