How to test a react component that is dependent on useContext hook?
Solution 1
In general, using hooks shouldn't change testing strategy much. The bigger issue here actually isn't the hook, but the use of context, which complicates things a bit.
There's a number of ways to make this work, but only approach I've found that works with 'react-test-renderer/shallow'
is to inject a mock hook:
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');
});
This is a bit dirty, though, and implementation-specific, so if you're able to compromise on the use of the shallow renderer, there's a few other options available:
Non-shallow render
If you're not shallow rendering, you can just wrap the component in a context provider to inject the value you want:
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']);
});
(Disclaimer: this should work, but when I test it, I'm hitting an error which I think is an issue in my setup)
Shallow render with Enzyme and Dive
As @skyboyer commented, enzyme's shallow renderer supports .dive
allowing you to deeply renderer a part of an otherwise shallow rendered component:
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");
});
Use ReactDOM
Finally, the Hooks FAQ has an example of testing hooks with ReactDOM
, which works as well. Naturally, using ReactDOM
means this is also a deep render, not shallow.
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");
});
Solution 2
I tried to use Enzyme + .dive
, but when diving, it does not recognize the context props, it gets the default ones. Actually, it is a known issue by the Enzyme team.
Meanwhile, I came up with a simpler solution which consists in creating a custom hook just to return useContext
with your context and mocking the return of this custom hook on the test:
AppContext.js - Creates the context.
import React, { useContext } from 'react';
export const useAppContext = () => useContext(AppContext);
const defaultValues = { color: 'green' };
const AppContext = React.createContext(defaultValues);
export default AppContext;
App.js — Providing the context
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 - Consuming the context
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 - Testing the useContext with Enzyme shallow
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!');
});
});
Check the full Medium article out https://medium.com/7shifts-engineering-blog/testing-usecontext-react-hook-with-enzyme-shallow-da062140fc83
Solution 3
Or if you're testing your component in isolation without mounting the parent components you can simply mocking useContext:
jest.mock('react', () => {
const ActualReact = jest.requireActual('react')
return {
...ActualReact,
useContext: () => ({ }), // what you want to return when useContext get fired goes here
}
})
Solution 4
Old post but if it helps someone this is how I got it to work
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();
});
});
Solution 5
To complete the above accepted answer, for non-shallow rendering, I slightly tweaked the code to simply surround my component with the context
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...;
});
Related videos on Youtube
bensampaio
Updated on February 27, 2022Comments
-
bensampaio over 2 years
I have a component that uses
useContext
and then its output is dependent on the value in the context. A simple example:import React, { useContext } from 'react'; const MyComponent = () => { const name = useContext(NameContext); return <div>{name}</div>; };
When testing this component with the shallow renderer from react and jest snapshots. How can I change the value of
NameContext
?-
skyboyer over 5 yearsyou may just wrap your component with
<NameContext.Provider>
: github.com/facebook/react/issues/7905 -
bensampaio over 5 yearsThat doesn't seem to work with shallow rendering because then it won't render the internals of my component. When I tried that I got a snapshot like:
<NameContext.Provider value={'Paul'}><MyComponent/></NameContext.Provider>
instead of<div>Paul</div>
-
skyboyer over 5 yearsyes, here
.dive()
is made for -
bensampaio over 5 years
.dive()
is from enzym but there is nothing similar for the react shallow renderer. -
skyboyer over 5 yearsyes, you're right, missed that part
-
TToprak1 over 4 yearsAny suggestion for stackoverflow.com/questions/59331896/… ?
-
-
bensampaio over 5 yearsI like the mock idea. It didn't cross my mind. Not as elegant as the other approaches but more elegant than the approaches I tried. I love the
deep
function idea, I hope they will bring it to react shallow renderer at some point. Thanks for your answer! -
Yugandhar Pathi about 5 yearsI am facing a challenge when using Enzyme, I exactly followed the mock idea you have shown but the problem is by the time I check my condition component is not rendered with context value. Note : I update my component with context value in useEffect.
-
Sumanth madey almost 5 yearsI have followed same example. i see actual default values are mocked every time i run the test. Mock values not rendered, can you please let me know what is missing.
-
Shlang about 4 yearsThe accepted answer contains the exaple for non-shallow rendering
-
HomelessGruesomeMoose about 4 yearsHi, if you look carefully it's not quite the same (uses TestRenderer) and gave me an error when I tried it. Hence why I shared this.
-
Chris almost 4 yearsWarning: this replaces
useContext
everywhere and so breaks any part of the thing under test that also usesuseContext
, e.g. styled-components. Alex Andrade's answer will allow you to isolate which uses ofuseContext
you'd like to mock. -
Anna almost 4 yearsI implemented this and it's not working for me.
wrapper
returns as undefined =/ codesandbox.io/s/react-usecontext-jest-test-9r93g?file=/src/… -
KeitelDOG about 3 years@Chris you can check the
value.displayName
to see if it's fromStylesContext
,ThemeContext
in case of material ui if you haveuseContext: value => {...}
, and return accordingly or leave the original function. -
Menai Ala Eddine - Aladdin almost 3 yearsWhat if the
value
is an object that contains a property and a function. -
Menai Ala Eddine - Aladdin almost 3 yearsWhat if
MyComponent
contains a child? -
Akhil Ravindran about 2 yearsI am getting the following error - Cannot assign to 'useContext' because it is a read-only property.