在 Jest 中模拟按钮单击

Question

模拟按钮点击似乎是一个非常简单/标准的操作。然而，我无法让它在 Jest.js 测试中工作。

这是我尝试过的（也使用 jQuery），但它似乎没有触发任何事情：

import { mount } from 'enzyme';

page = <MyCoolPage />;
pageMounted = mount(page);

const button = pageMounted.find('#some_button');
expect(button.length).toBe(1); // It finds it alright
button.simulate('click'); // Nothing happens

Answer 1

#1 使用 Jest

这就是我使用 Jest 模拟回调函数来测试点击事件的方式：

import React from 'react';
import { shallow } from 'enzyme';
import Button from './Button';

describe('Test Button component', () => {
  it('Test click event', () => {
    const mockCallBack = jest.fn();

    const button = shallow((<Button onClick={mockCallBack}>Ok!</Button>));
    button.find('button').simulate('click');
    expect(mockCallBack.mock.calls.length).toEqual(1);
  });
});

我还使用了一个名为 enzyme 的模块。 Enzyme 是一个测试实用程序，可以更轻松地断言和选择您的 React 组件

#2 使用诗乃

此外，您还可以使用另一个名为 Sinon 的模块，它是 JavaScript 的独立测试间谍、存根和模拟。看起来是这样的：

import React from 'react';
import { shallow } from 'enzyme';
import sinon from 'sinon';

import Button from './Button';

describe('Test Button component', () => {
  it('simulates click events', () => {
    const mockCallBack = sinon.spy();
    const button = shallow((<Button onClick={mockCallBack}>Ok!</Button>));

    button.find('button').simulate('click');
    expect(mockCallBack).toHaveProperty('callCount', 1);
  });
});

#3 使用你自己的间谍

最后，您可以制作自己的幼稚间谍（除非您有正当理由，否则我不推荐这种方法）。

function MySpy() {
  this.calls = 0;
}

MySpy.prototype.fn = function () {
  return () => this.calls++;
}

it('Test Button component', () => {
  const mySpy = new MySpy();
  const mockCallBack = mySpy.fn();

  const button = shallow((<Button onClick={mockCallBack}>Ok!</Button>));

  button.find('button').simulate('click');
  expect(mySpy.calls).toEqual(1);
});

Answer 2

已弃用已接受答案中的解决方案

#4 直接调用 props

Enzyme simulation 应该在版本 4 中被删除。主要维护者建议直接调用 prop 函数，这就是模拟内部所做的。一种解决方案是直接测试调用这些道具是否正确；或者您可以模拟实例方法，测试 prop 函数是否调用它们，然后对实例方法进行单元测试。

你可以调用click，例如：

wrapper.find('Button').prop('onClick')() 

或者

wrapper.find('Button').props().onClick() 

关于弃用的信息： Deprecation of .simulate() #2173

Answer 3

使用 Jest，您可以这样做：

test('it calls start logout on button click', () => {
    const mockLogout = jest.fn();
    const wrapper = shallow(<Component startLogout={mockLogout}/>);
    wrapper.find('button').at(0).simulate('click');
    expect(mockLogout).toHaveBeenCalled();
});

Answer 4

Testing-library 使用click function 让您轻松完成这项工作。

它是 user-event 库的一部分，可用于每个 dom 环境（react、jsdom、浏览器……）

文档中的示例：

import React from 'react'
import {render, screen} from '@testing-library/react'
import userEvent from '@testing-library/user-event'

test('click', () => {
  render(
    <div>
      <label htmlFor="checkbox">Check</label>
      <input id="checkbox" type="checkbox" />
    </div>,
  )

  userEvent.click(screen.getByText('Check'))
  expect(screen.getByLabelText('Check')).toBeChecked()
})

Answer 5

您可以使用类似这样的方式来调用单击时编写的处理程序：

import { shallow } from 'enzyme'; // Mount is not required

page = <MyCoolPage />;
pageMounted = shallow(page);

// The below line will execute your click function
pageMounted.instance().yourOnClickFunction();

Answer 6

除了同级 cmets 中建议的解决方案之外，您可以稍微更改您的测试方法，而不是一次测试整个页面（使用深层子组件树），但要这样做隔离组件测试。这将简化onClick() 和类似事件的测试（参见下面的示例）。

我们的想法是一次只测试一个组件，而不是全部一起测试。在这种情况下，所有子组件都将使用jest.mock() 函数进行模拟。

下面是如何使用Jest 和react-test-renderer 在隔离的SearchForm 组件中测试onClick() 事件的示例。

import React from 'react';
import renderer from 'react-test-renderer';
import { SearchForm } from '../SearchForm';

describe('SearchForm', () => {
  it('should fire onSubmit form callback', () => {
    // Mock search form parameters.
    const searchQuery = 'kittens';
    const onSubmit = jest.fn();

    // Create test component instance.
    const testComponentInstance = renderer.create((
      <SearchForm query={searchQuery} onSearchSubmit={onSubmit} />
    )).root;

    // Try to find submit button inside the form.
    const submitButtonInstance = testComponentInstance.findByProps({
      type: 'submit',
    });
    expect(submitButtonInstance).toBeDefined();

    // Since we're not going to test the button component itself
    // we may just simulate its onClick event manually.
    const eventMock = { preventDefault: jest.fn() };
    submitButtonInstance.props.onClick(eventMock);

    expect(onSubmit).toHaveBeenCalledTimes(1);
    expect(onSubmit).toHaveBeenCalledWith(searchQuery);
  });
});

Answer 7

我需要自己测试一下按钮组件。这些测试对我有用；-)

import { shallow } from "enzyme";
import * as React from "react";
import Button from "../button.component";

describe("Button Component Tests", () => {
    it("Renders correctly in DOM", () => {
        shallow(
            <Button text="Test" />
        );
    });
    it("Expects to find button HTML element in the DOM", () => {
        const wrapper = shallow(<Button text="test"/>)
        expect(wrapper.find('button')).toHaveLength(1);
    });

    it("Expects to find button HTML element with className test in the DOM", () => {
        const wrapper = shallow(<Button className="test" text="test"/>)
        expect(wrapper.find('button.test')).toHaveLength(1);
    });

    it("Expects to run onClick function when button is pressed in the DOM", () => {
        const mockCallBackClick = jest.fn();
        const wrapper = shallow(<Button onClick={mockCallBackClick} className="test" text="test"/>);
        wrapper.find('button').simulate('click');
        expect(mockCallBackClick.mock.calls.length).toEqual(1);
    });
});