Test Against Different React Releases with Enzyme

Setting up Enzyme with different releases of React

At the time of writing these notes, Create React App uses React 16. In order to use Enzyme with React 16, we need to install the enzyme-adapter-react-16 package:

npm install --save-dev enzyme-adapter-react-16

With this package, we can now configure our application to use this adapter. In src/App.test.js:

// ...
import { configure } from 'enzyme'
import Adapter from 'enzyme-adapter-react-16'

configure({ adapter: new Adapter() })
// ...

More information about the enzyme-adapter-react-16 package and what package to use with specific versions of React can be found in the resources.

Setting up a Shallow Render

Shallow Rendering is useful to test components as individual units.

"Shallow rendering is useful to constrain yourself to testing a component as a unit, and to ensure that your tests aren't indirectly asserting on behavior of child components."

Start by importing shallow from 'enzyme'. In App.test.js:

import { configure, shallow } from 'enzyme'

Now we describe our shallow render in App.test.js. Make sure to remove the default Create React App code:

// ...
configure({ adapter: new Adapter() })

describe('<App />', () => {
  it('should render App', () => {
    const wrapper = shallow(<App />, {context: {}, disableLifecycleMethods: bool})
  })
})

"Shallow rendering is easy to use when working with the component itself. It's not going to chase rendering child components."

We can see what our shallow rendered component looks like by calling the debug method on the wrapper:

configure({ adapter: new Adapter() })

describe('<App />', () => {
  it('should render App', () => {
    const wrapper = shallow(<App />, {context: {}, disableLifecycleMethods: bool})
    console.log(wrapper.debug())
  })
})

Now head over to src/App.js to view our App component. This is the default Create React App component. You may notice that your App.js looks different from the instructor's, but do not fret. Whatever we see here is what we expect to see in our terminal when we run our test script.

We can now run our test script in the terminal:

npm test

And our terminal should soon display the console.log of the shallow rendered component.

To test the rendering of children, we create a React functional component called Test, and place it inside of our App component. Again, your App.js may look different than that of the video or that which is shown below, but just make sure the Test component makes it into your App component. In App.js:

// ...
const Test = () => <div>Testing</div>

function App() {
  return (
    <div className="App">
      <header className="App-header">
        <img src={logo} className="App-logo" alt="logo" />
        <p>
          Edit <code>src/App.js</code> and save to reload.
        </p>
        <a
          className="App-link"
          href="https://reactjs.org"
          target="_blank"
          rel="noopener noreferrer"
        >
          Learn React
        </a>
      </header>
      <Test />
    </div>
  );
}

export default App;
// ...

We can also pass configurations to our shallow rendered component.

Note: In the video, the instructor uses bool as pseudocode representing either true or false. To run your test without error, change bool to true/false.

In App.test.js:

const wrapper = shallow(<App />, {context: {}, disableLifecycleMethods: bool})

The context property allows us to provide context to our rendered component, if that is important in our test.

The disableLifecycleMethods allows us to tell Enzyme whether to ignore calling componentDidMount on our component, and ignore calling componentDidUpdate on our component after setProps and setContexts is used. This is set to false by default, but can be set to true through these configurations.

Test Against Different React Releases with Enzyme

Setting up Enzyme with different releases of React

Setting up a Shallow Render

Resources