使用Jest测试React Component函数

时间:2014-08-27 17:04:06

标签: javascript reactjs reactjs-flux jestjs

原始

首先,我遵循Flux架构。

我有一个显示秒数的指示器,例如:30秒。每一秒它显示1秒减少,所以29,28,27直到0.当到达0时,我清除间隔,使其停止重复。而且,我触发了一个动作。调度此操作后,我的商店会通知我。因此,当发生这种情况时,我将间隔重置为30秒,依此类推。组件看起来像:

var Indicator = React.createClass({

  mixins: [SetIntervalMixin],

  getInitialState: function(){
    return{
      elapsed: this.props.rate
    };
  },

  getDefaultProps: function() {
    return {
      rate: 30
    };
  },

  propTypes: {
    rate: React.PropTypes.number.isRequired
  },

  componentDidMount: function() {
    MyStore.addChangeListener(this._onChange);
  },

  componentWillUnmount: function() {
    MyStore.removeChangeListener(this._onChange);
  },

  refresh: function(){
    this.setState({elapsed: this.state.elapsed-1})

    if(this.state.elapsed == 0){
      this.clearInterval();
      TriggerAnAction();
    }
  },

  render: function() {
    return (
      <p>{this.state.elapsed}s</p>
    );
  },

  /**
   * Event handler for 'change' events coming from MyStore
   */
  _onChange: function() {
    this.setState({elapsed: this.props.rate}
    this.setInterval(this.refresh, 1000);
  }

});

module.exports = Indicator;

组件按预期工作。现在,我想用Jest测试它。我知道我可以使用renderIntoDocument,然后我可以setTimeout为30s并检查我的component.state.elapsed是否等于0(例如)。

但是,我想在这里测试的是不同的东西。我想测试是否调用刷新函数。此外,我想测试当我的经过状态为0时,它会触发我的TriggerAnAction()。好的,我尝试做的第一件事就是:

jest.dontMock('../Indicator');

describe('Indicator', function() {
  it('waits 1 second foreach tick', function() {

    var React = require('react/addons');
    var Indicator = require('../Indicator.js');
    var TestUtils = React.addons.TestUtils;

    var Indicator = TestUtils.renderIntoDocument(
      <Indicator />
    );

    expect(Indicator.refresh).toBeCalled();

  });
});

但是在编写npm test时我收到以下错误:

Throws: Error: toBeCalled() should be used on a mock function

我从ReactTestUtils看到一个mockComponent函数,但鉴于它的解释,我不确定它是否是我需要的。

好的,在这一点上,我被卡住了。任何人都可以告诉我如何测试我上面提到的两件事情吗?


根据Ian回答

更新1

这是我试图运行的测试(参见某些内容中的评论):

jest.dontMock('../Indicator');

describe('Indicator', function() {
  it('waits 1 second foreach tick', function() {

    var React = require('react/addons');
    var Indicator = require('../Indicator.js');
    var TestUtils = React.addons.TestUtils;

    var refresh = jest.genMockFunction();
    Indicator.refresh = refresh;

    var onChange = jest.genMockFunction();
    Indicator._onChange = onChange;

    onChange(); //Is that the way to call it?

    expect(refresh).toBeCalled(); //Fails
    expect(setInterval.mock.calls.length).toBe(1); //Fails

    // I am trying to execute the 1 second timer till finishes (would be 60 seconds)
    jest.runAllTimers();

    expect(Indicator.state.elapsed).toBe(0); //Fails (I know is wrong but this is the idea)
    expect(clearInterval.mock.calls.length).toBe(1); //Fails (should call this function when time elapsed is 0)

  });
});

我仍然误解了一些事情......

2 个答案:

答案 0 :(得分:46)

看起来你正走在正确的轨道上。只是为了确保每个人都在同一页面上获得这个答案,让我们先来一些术语。

模拟:具有由单元测试控制的行为的函数。您通常使用mock函数替换某些对象上的实函数,以确保正确调用mock函数。 Jest会自动为模块上的每个功能提供模拟,除非您在该模块的名称上调用jest.dontMock

组件类:这是React.createClass返回的内容。您可以使用它来创建组件实例(它比这更复杂,但这足以满足我们的目的)。

组件实例:组件类的实际呈现实例。这是您在致电TestUtils.renderIntoDocument或许多其他TestUtils函数后获得的内容。


在您的问题的更新示例中,您将生成模拟并将其附加到组件而不是组件的实例。此外,您只想模拟要监视或以其他方式更改的功能;例如,你模仿了_onChange,但你并不是真的想要,因为你希望它能够正常运行 - 它只是你要模拟的refresh

这是我为这个组件编写的一组测试;评论是内联的,所以如果您有任何问题,请发表评论。此示例和测试套件的完整工作源位于https://github.com/BinaryMuse/so-jest-react-mock-example/tree/master;你应该能够克隆它并运行它没有任何问题。请注意,我必须对组件进行一些小的猜测和更改,因为并非所有引用的模块都在您的原始问题中。

/** @jsx React.DOM */

jest.dontMock('../indicator');
// any other modules `../indicator` uses that shouldn't
// be mocked should also be passed to `jest.dontMock`

var React, IndicatorComponent, Indicator, TestUtils;

describe('Indicator', function() {
  beforeEach(function() {
    React = require('react/addons');
    TestUtils = React.addons.TestUtils;
    // Notice this is the Indicator *class*...
    IndicatorComponent = require('../indicator.js');
    // ...and this is an Indicator *instance* (rendered into the DOM).
    Indicator = TestUtils.renderIntoDocument(<IndicatorComponent />);
    // Jest will mock the functions on this module automatically for us.
    TriggerAnAction = require('../action');
  });

  it('waits 1 second foreach tick', function() {
    // Replace the `refresh` method on our component instance
    // with a mock that we can use to make sure it was called.
    // The mock function will not actually do anything by default.
    Indicator.refresh = jest.genMockFunction();

    // Manually call the real `_onChange`, which is supposed to set some
    // state and start the interval for `refresh` on a 1000ms interval.
    Indicator._onChange();
    expect(Indicator.state.elapsed).toBe(30);
    expect(setInterval.mock.calls.length).toBe(1);
    expect(setInterval.mock.calls[0][1]).toBe(1000);

    // Now we make sure `refresh` hasn't been called yet.
    expect(Indicator.refresh).not.toBeCalled();
    // However, we do expect it to be called on the next interval tick.
    jest.runOnlyPendingTimers();
    expect(Indicator.refresh).toBeCalled();
  });

  it('decrements elapsed by one each time refresh is called', function() {
    // We've already determined that `refresh` gets called correctly; now
    // let's make sure it does the right thing.
    Indicator._onChange();
    expect(Indicator.state.elapsed).toBe(30);
    Indicator.refresh();
    expect(Indicator.state.elapsed).toBe(29);
    Indicator.refresh();
    expect(Indicator.state.elapsed).toBe(28);
  });

  it('calls TriggerAnAction when elapsed reaches zero', function() {
    Indicator.setState({elapsed: 1});
    Indicator.refresh();
    // We can use `toBeCalled` here because Jest automatically mocks any
    // modules you don't call `dontMock` on.
    expect(TriggerAnAction).toBeCalled();
  });
});

答案 1 :(得分:6)

我想我明白你在问什么,至少是它的一部分!

从错误开始,您看到的原因是因为您已指示开玩笑不模拟指标模块,因此所有内部都是您编写的。如果你想测试那个特定的函数被调用,我建议你创建一个模拟函数,然后使用它...

var React = require('react/addons');
var Indicator = require('../Indicator.js');
var TestUtils = React.addons.TestUtils;

var refresh = jest.genMockFunction();
Indicator.refresh = refresh; // this gives you a mock function to query

接下来要注意的是你实际上是在示例代码中重新分配Indicator变量,所以为了正确的行为我会重命名第二个变量(如下所示)

var indicatorComp = TestUtils.renderIntoDocument(<Indicator />);

最后,如果您想测试随时间变化的内容,请使用围绕计时器操作的TestUtils功能(http://facebook.github.io/jest/docs/timer-mocks.html)。在你的情况下,我认为你可以这样做:

jest.runAllTimers();

expect(refresh).toBeCalled();

或者,也许稍微不那么挑剔的是依靠setTimeout和setInterval的模拟实现来推理你的组件:

expect(setInterval.mock.calls.length).toBe(1);
expect(setInterval.mock.calls[0][1]).toBe(1000);

另外一点,对于上述任何一项更改,我认为您需要手动触发onChange方法,因为您的组件最初将使用您商店的模拟版本,因此不会发生任何更改事件。你还需要确保你设置了jest以忽略react模块,否则它们也会被自动模拟。

完全建议的测试

jest.dontMock('../Indicator');

describe('Indicator', function() {
  it('waits 1 second for each tick', function() {
    var React = require('react/addons');
    var TestUtils = React.addons.TestUtils;

    var Indicator = require('../Indicator.js');
    var refresh = jest.genMockFunction();
    Indicator.refresh = refresh;

    // trigger the store change event somehow

    expect(setInterval.mock.calls.length).toBe(1);
    expect(setInterval.mock.calls[0][1]).toBe(1000);

  });

});