如何测试依赖于 useContext hook 的 React 组件？

Question

我有一个使用 useContext 的组件，然后它的输出取决于上下文中的值。一个简单的例子：

import React, { useContext } from 'react';

const MyComponent = () => {
  const name = useContext(NameContext);

  return <div>{name}</div>;
};

使用来自 React 和 jest 快照的浅层渲染器测试此组件时。如何更改 NameContext 的值？

Answer 1

一般来说，使用 hooks 应该不会改变测试策略。这里更大的问题实际上不是钩子，而是上下文的使用，这使事情变得有点复杂。

有多种方法可以实现此目的，但我发现唯一适用于 'react-test-renderer/shallow' 的方法是注入模拟钩子：

import ShallowRenderer from 'react-test-renderer/shallow';

let realUseContext;
let useContextMock;
// Setup mock
beforeEach(() => {
    realUseContext = React.useContext;
    useContextMock = React.useContext = jest.fn();
});
// Cleanup mock
afterEach(() => {
    React.useContext = realUseContext;
});

test("mock hook", () => {
    useContextMock.mockReturnValue("Test Value");
    const element = new ShallowRenderer().render(
        <MyComponent />
    );
    expect(element.props.children).toBe('Test Value');
});

虽然这有点脏，而且是特定于实现的，所以如果您能够在浅层渲染器的使用上做出妥协，还有一些其他选项可用：

非浅渲染

如果你不是浅层渲染，你可以将组件包装在上下文提供者中以注入你想要的值：

import TestRenderer from 'react-test-renderer';

test("non-shallow render", () => {
    const element = new TestRenderer.create(
        <NameContext.Provider value="Provided Value">
            <MyComponent />
        </NameContext.Provider>
    );
    expect(element.root.findByType("div").children).toEqual(['Provided Value']);
});

（免责声明：这个应该工作，但是当我测试它时，我遇到了一个错误，我认为这是我的设置中的一个问题）

使用 Enzyme 和 Dive 进行浅层渲染

正如@skyboyer 评论的那样，enzyme 的浅层渲染器支持 .dive 允许您深度渲染原本浅层渲染组件的一部分：

import { shallow } from "./enzyme";

test("enzyme dive", () => {
    const TestComponent = () => (
        <NameContext.Provider value="Provided Value">
            <MyComponent />
        </NameContext.Provider>
    );
    const element = shallow(<TestComponent />);
    expect(element.find(MyComponent).dive().text()).toBe("Provided Value");
});

使用 ReactDOM

最后，Hooks FAQ 有一个用 ReactDOM 测试钩子的例子，它也能正常工作。当然，使用 ReactDOM 意味着这也是深度渲染，而不是浅渲染。

let container;
beforeEach(() => {
    container = document.createElement('div');
    document.body.appendChild(container);
});

afterEach(() => {
    document.body.removeChild(container);
    container = null;
});

test("with ReactDOM", () => {
    act(() => {
        ReactDOM.render((
            <NameContext.Provider value="Provided Value">
                <MyComponent />
            </NameContext.Provider>
        ), container);
    });

    expect(container.textContent).toBe("Provided Value");
});

Answer 2

我尝试使用 Enzyme + .dive，但是在潜水时，它无法识别上下文道具，它会使用默认道具。实际上，这是 Enzyme 团队的一个已知问题。同时，我想出了一个更简单的解决方案，其中包括使用您的上下文创建一个自定义挂钩 return useContext 并在测试中模拟此自定义挂钩的 return ：

AppContext.js - 创建上下文。

import React, { useContext } from 'react';

export const useAppContext = () => useContext(AppContext);

const defaultValues = { color: 'green' };
const AppContext = React.createContext(defaultValues);

export default AppContext;

App.js — 提供上下文

import React from 'react';
import AppContext from './AppContext';
import Hello from './Hello';

export default function App() {
  return (
    <AppContext.Provider value={{ color: 'red' }}>
      <Hello />
    </AppContext.Provider>
  );
}

Hello.js - 使用上下文

import React from 'react';
import { useAppContext } from './AppContext';

const Hello = props => {
  const { color } = useAppContext();
  return <h1 style={{ color: color }}>Hello {color}!</h1>;
};

export default Hello;

Hello.test.js - 使用 Enzyme shallow

测试 useContext

import React from 'react';
import { shallow } from 'enzyme';
import * as AppContext from './AppContext';

import Hello from './Hello';

describe('<Hello />', () => {
  test('it should mock the context', () => {
    const contextValues = { color: 'orange' };
    jest
      .spyOn(AppContext, 'useAppContext')
      .mockImplementation(() => contextValues);
    const wrapper = shallow(<Hello />);
    const h1 = wrapper.find('h1');

    expect(h1.text()).toBe('Hello orange!');
  });
});

查看完整的 Medium 文章 https://medium.com/7shifts-engineering-blog/testing-usecontext-react-hook-with-enzyme-shallow-da062140fc83

Answer 3

或者，如果您在不安装父组件的情况下单独测试您的组件，您可以简单地模拟 useContext:

jest.mock('react', () => {
  const ActualReact = jest.requireActual('react')
  return {
    ...ActualReact,
    useContext: () => ({ }), // what you want to return when useContext get fired goes here
  }
})

Answer 4

为了完成上面接受的答案，对于非浅层渲染，我稍微调整了代码以简单地用上下文包围我的组件

import { mount } from 'enzyme';
import NameContext from './NameContext';

test("non-shallow render", () => {
    const dummyValue = {
      name: 'abcd',
      customizeName: jest.fn(),
      ...
    }; 
    const wrapper = mount(
        <NameContext.Provider value={dummyValue}>
            <MyComponent />
        </NameContext.Provider>
    );

    // then use  
    wrapper.find('...').simulate('change', ...);
    ...
    expect(wrapper.find('...')).to...;
});

Answer 5

旧 post 但如果它对某人有帮助，这就是我让它工作的方式

import * as React from 'react';
import { shallow } from 'enzyme';

describe('MyComponent', () => {
  it('should useContext mock and shallow render a div tag', () => {
    jest.spyOn(React, 'useContext').mockImplementation(() => ({
      name: 'this is a mock context return value'
    }));

    const myComponent = shallow(
      <MyComponent
        props={props}
      />).dive();

    expect(myComponent).toMatchSnapShot();
  });
});

Answer 6

我所做的是测试是否使用了useContext。在我的例子中，useContext returns 函数调用 dispatch.

在我的组件中：

const dispatch = useContext(...);

然后在 onChange 方法中：

dispatch({ type: 'edit', payload: { value: e.target.value, name: e.target.name } });

所以一开始的内部测试：

  const dispatch = jest.fn();
  React.useContext = (() => dispatch) as <T>(context: React.Context<T>) => T;

然后：

  it('calls function when change address input', () => {
   const input = component.find('[name="address"]');
   input.simulate('change', { target: { value: '123', name: 'address' } });

   expect(dispatch).toHaveBeenCalledTimes(1);
  });

Answer 7

在测试中，您需要使用“上下文提供程序”来包装组件。这是一个简单的例子。

DisplayInfo 组件依赖于 UserContext。

import React, { useContext } from 'react';
import { UserContext } from './contexts/UserContextProvider';

export const DisplayInfo = () => {
 const { userInfo } = useContext(UserContext);

 const dispUserInfo = () => {
   return userInfo.map((user, i) => {
    return (
     <div key={i}>
      <h1> Name: { user.name } </h1>
      <h1> Email: { user.email } </h1>
     </div>
    )
  });
 }

 return(
  <>
   <h1 data-testid="user-info"> USER INFORMATION </h1>
   { userInfo && dispUserInfo() })
  </>
 }

export default DisplayInfo;

这是用户上下文提供程序。

import React, {useState, createContext} from 'react';

export const UserContext = createContex();

const UserContextProvider = () => {
 const [userInfo, setUserInfo] = useState([]);

 const updateUserInfo = () => {
  setUserInfo([...userInfo, newData]);
 }

 const values = {
  userInfo,
  updateUserInfo
 }

 return(
  <UserContext.Provider = vlaue={values}>
   {props.children}
  </UserContext.Provider>
 )
}

export default UserContextProvider;

要测试“DisplayInfo”组件，可能还需要使用“react-router-dom”中的“MemoryRouter”。这是示例-

import React from "react";
import { render, screen } from "@testing-library/react";
import "@testing-library/jest-dom/extend-expect";
import { DisplayInfo } from "./DisplayInfo";
import UserContextProvider from "./contexts/UserContextProvider";
import { MemoryRouter } from "react-router-dom";

describe("DisplayInfo", () => {
 describe("layout", () => {
  it("has header of user info", () => {
   render(
    <UserContextProvider>
     <DisplayInfo />
    </UserContextProvider>,
    { wrapper: MemoryRouter }
   );
   let header = screen.getByTestId('user-info');
   expect(header).toHaveTextContent(/user information/i)
  });
 });
});

如何测试依赖于 useContext hook 的 React 组件？

How to test a react component that is dependent on useContext hook?

reactjs

jestjs

react-test-renderer

react-hooks

非浅渲染

使用 Enzyme 和 Dive 进行浅层渲染

使用 ReactDOM