测试 React Modal 组件

IT技术 javascript unit-testing reactjs bootstrap-modal react-jsx
2021-05-22 08:10:29

抱歉,我一直在尝试通过单击按钮来测试关闭我的 React Modal 时遇到了最艰难的时刻。Modal 非常简单,我已经尝试了所有我能想到或找到的方法,但我仍然无法查询它的子代。

模态组件:

var React = require('react');
var Modal = require('react-bootstrap').Modal;
var Button = require('react-bootstrap').Button;

var MyModal = React.createClass({
  ...
  render: function() {
    return (
      <Modal className="my-modal-class" show={this.props.show}>
        <Modal.Header>
          <Modal.Title>My Modal</Modal.Title>
        </Modal.Header>
        <Modal.Body>
          Hello, World!
        </Modal.Body>
        <Modal.Footer>
          <Button onClick={this.props.onHide}>Close</Button>
        </Modal.Footer>
      </Modal>
    );
  }
});

我的目标是测试该关闭按钮在onHide()单击时是否会触发该功能。

我的测试文件:

describe('MyModal.jsx', function() {
  it('tests the Close Button', function() {
    var spy = sinon.spy();
    var MyModalComponent = TestUtils.renderIntoDocument(
      <MyModal show onHide={spy}/>
    );

    // This passes
    TestUtils.findRenderedComponentWithType(MyModalComponent, MyModal);

    // This fails
    var CloseButton = TestUtils.findRenderedDOMComponentWithTag(MyModalComponent, 'button');

    // Never gets here
    TestUtils.Simulate.click(CloseButton);
    expect(spy.calledOnce).to.be.true;
  });
});

无论我尝试什么,我似乎都找不到关闭按钮。

2个回答

使用React Base Fiddle (JSX)编写了一个jsFiddle来找出您的测试中发生了什么(我创建了自己的“间谍”,它在调用时只需登录到控制台)。

我发现您找不到按钮的原因是它不存在于您期望的位置。

所述引导模态分量<Modal/>)实际上被包含在内阵营叠加层模态分量(称为BaseModal在代码,这是从在这里)。这反过来渲染一个被调用Portal组件,它的渲染方法只返回nullnull您正试图在值上查找渲染组件。

由于模态不是以传统的 React 方式渲染的,因此 React 无法看到模态以便使用TestUtils一个完全独立的<div/>子节点被放置在document主体中,这个新节点<div/>用于构建模态。

因此,为了允许您使用 React 模拟点击TestUtils(按钮上的点击处理程序仍然绑定到按钮的点击事件),您可以使用标准的 JS 方法来搜索 DOM。设置您的测试如下:

describe('MyModal.jsx', function() {
  it('tests the Close Button', function() {
    var spy = sinon.spy();
    var MyModalComponent = TestUtils.renderIntoDocument(
      <MyModal show onHide={spy}/>
    );

    // This passes
    TestUtils.findRenderedComponentWithType(MyModalComponent, MyModal);

    // This will get the actual DOM node of the button
    var closeButton = document.body.getElementsByClassName("my-modal-class")[0].getElementsByClassName("btn btn-default")[0];

    // Will now get here
    TestUtils.Simulate.click(CloseButton);
    expect(spy.calledOnce).to.be.true;
  });
});

该函数getElementsByClassName返回具有该类的元素集合,因此您必须从每个集合中获取第一个(在您的测试用例中,您的唯一一个)。

您的测试现在应该通过 ^_^

这是我最终采用的解决方案。它将 React 呈现 Modal 的方式存根于仅呈现 a 的<div>方式。

test-utils.js

var sinon = require('sinon');
var React = require('react');
var Modal = require('react-bootstrap').Modal;

module.exports = {
  stubModal: function() {
    var createElement = React.createElement;
    modalStub = sinon.stub(React, 'createElement', function(elem) {
      return elem === Modal ?
        React.DOM.div.apply(this, [].slice.call(arguments, 1)) :
        createElement.apply(this, arguments);
    });
    return modalStub;
  },
  stubModalRestore: function() {
    if (modalStub) {
      modalStub.restore();
      modalStub = undefined;
    } else {
      console.error('Cannot restore nonexistent modalStub');
    }
  }
};

modal-test.jsx

var testUtils = require('./test-utils');

describe('test a Modal!', function() {
  before(testUtils.stubModal);
  after(testUtils.stubModalRestore);

  it('renders stuff', function() {
    var MyModalComponent = TestUtils.renderIntoDocument(
      <MyModal show/>
    );
    // Do more stuff you normally expect you can do
  });
});