enzyme-get-wrapper v1.1.2

enzyme-get-wrapper

A tool for creating flexible Enzyme wrappers with less code.

Why?

There is a common pattern when using enzyme to test React components. People often create functions that take props, and then call enzyme’s mount, shallow, or render functions with their react component. This can get exhaustive when writing this same pattern in every test suite. Manually handling overriding the default props, errors when not passing your function at least an empty object (unless handled), and most commonly, rendering deeper than necessary for a lot of tests (doing a full enzyme mount when you may only need a render etc...). The flexibility and simplicity of this tool helps to alleviate some of these pain points.

Installation

yarn add enzyme-get-wrapper --dev

OR

npm install enzyme-get-wrapper -D

Enzyme is also a required package for this to work. See installation guide here: http://airbnb.io/enzyme/docs/installation/index.html

Configuration

In order to use Enzyme with modern versions of React, you need to install an adapter. That is outlined in the above installation guide. enzyme-get-wrapper needs to be configured with your version of Enzyme. Here is an example of a Jest test setup file:

import enzyme from 'enzyme';
import Adapter from 'enzyme-adapter-react-16';

import { configure } from './enzyme-get-wrapper';

enzyme.configure({ adapter: new Adapter() });
configure(enzyme);

Usage

import getWrapper from 'enzyme-get-wrapper';

import TestComponent from './test-component';

describe('the test', () => {
    const makeWrapper = getWrapper(TestComponent, { ...defaultProps });

    it('should pass the test', () => {
        // Arrange
        const wrapper = makeWrapper({
            depth: 'mount',
            props: {
                ...propsToPassToTestComponent,
            },
        });

        // Do things with wrapper
    });
});

How it works

When giving the main exposed function a React class, and default props (optional), it returns a function that expects a config (optional). The config options are simple and as follows:

The returned function when called, returns you an enzyme wrapper to use as you normally would with enzyme.

License

MIT