如何测试依赖于 useContext 钩子的react组件?

IT技术 reactjs jestjs react-hooks react-test-renderer
2021-03-30 11:44:57

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

import React, { useContext } from 'react';

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

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

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

6个回答

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

有很多方法可以使这个工作,但我发现唯一的方法'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 评论的那样,酶的浅层渲染器支持.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");
});
我喜欢模拟的想法。我没有想到。不像其他方法那么优雅,但比我尝试的方法更优雅。我喜欢这个deep函数的想法,我希望他们能在某个时候把它带到对浅层渲染器的反应。感谢您的回答!
2021-05-24 11:44:57
如果MyComponent包含一个孩子怎么办?
2021-05-25 11:44:57
我在使用 Enzyme 时遇到了一个挑战,我完全遵循了你展示的模拟想法,但问题是当我检查我的条件组件没有用上下文值呈现时。注意:我使用 useEffect 中的上下文值更新我的组件。
2021-06-13 11:44:57
如果value是一个包含属性和函数的对象呢?
2021-06-15 11:44:57

我尝试使用 Enzyme + .dive,但是在潜水时,它无法识别上下文props,而是使用默认props。实际上,这是 Enzyme 团队的一个已知问题。同时,我想出了一个更简单的解决方案,它包括创建一个自定义钩子来返回useContext你的上下文,并在测试中模拟这个自定义钩子的返回:

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 浅层测试 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

我遵循了同样的例子。我看到每次运行测试时都会模拟实际的默认值。模拟值未呈现,您能否让我知道缺少什么。
2021-06-03 11:44:57

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

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

您仍然可以使用useContext具有全局变量的动态jest.fn

@Chris 你听说过玩笑吗?
2021-05-26 11:44:57
@Chris 你可以检查value.displayName它是否来自StylesContextThemeContext如果你有材料 ui useContext: value => {...},然后相应地返回或保留原始功能。
2021-05-28 11:44:57
警告:这会替换useContext 任何地方,因此会破坏也使用 的被测事物的任何部分useContext,例如样式组件。亚历克斯·安德拉德 (Alex Andrade) 的回答将使您能够隔离您想要模拟的哪些用途useContext
2021-06-05 11:44:57

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

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();
  });
});

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

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...;
});
嗨,如果你仔细看,它并不完全相同(使用 TestRenderer)并且在我尝试时给了我一个错误。这就是为什么我分享这个。
2021-05-27 11:44:57
接受的答案包含非浅层渲染的示例
2021-06-16 11:44:57
我实现了这个,但它对我不起作用。wrapper返回为 undefined =/ codesandbox.io / s / react-usecontext-jest-test-9r93g?file =/ src / ...
2021-06-20 11:44:57