Mocha, Enzyme: Unit testing custom functions in react component using enzyme

Question

I am working on creating unit tests of react components using mocha, enzyme. Below is a sample component.

Foo.js

class Foo extends React.Component {
    customFunction=() => {
    }

    render() {
        return (<div className={this.props.name}/>);
   }
}

And here is the testing file.

Foo-Test.js

import React from 'react';
import { expect } from 'chai';
import { shallow, mount, render } from 'enzyme';
import Foo from '../src/Foo';

describe("A suite", function() {
    it("contains spec with an expectation", function() {
        expect(shallow(<Foo />).contains(<div className="foo" />)).to.equal(true);
    });

    it("contains spec with an expectation", function() {
        expect(shallow(<Foo />).is('.foo')).to.equal(true);
    });
});

Everything is good. but I didn't understand how to unit test customFunction in Foo.js when we are using enzyme

Leland Richardson · Accepted Answer · 2016-03-01 17:32:43Z

27

The best answer to this question really depends on what it is that customFunction is actually doing...

You can call the function like this:

wrapper.instance().customFunction('foo', 'bar');

If it's a function that sets state on the instance itself, and thus affects what the rendered output looks like, you may want to call .update() as well

wrapper.instance().customFunction('foo', 'bar'); // uses setState internally
wrapper.update(); // updates render tree
// do assertions on the rendered output

answered Mar 1, 2016 at 17:32

Leland Richardson

2,6952 gold badges22 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

pnsrinivasreddy Over a year ago

but one thing that does this instace() method have any issues with global scope.the component which is rendered has localStorage. while testing the console it throwing ReferenceError: localStorage is not defined.

Frozen Crayon Over a year ago

@pnsrinivasreddy mock localStorage while bootstrapping Wallaby

gbenavid · Accepted Answer · 2018-06-20 15:03:45Z

You can also use the chai plugin to spy on custom functions in you jsx file.

// to use this pluggin add this to the top of your testing file

const chai = require("chai"), spies = require("chai-spies");
chai.use(spies);
import Foo from "./<path to component>/Foo.jsx";

describe("Foo", () => {
  it("a call to customFunction will not error", () => {
    let spy = chai.spy(Foo.prototype, "customFunciton"); // spy
    const wrapper = mount(<Foo/>);
    wrapper.setProps({bar: "baz"}); // manipulate you component in some way
    expect(spy).to.have.been.called.once();
  });
});

@leland-richardson is right, it depends on what your test is doing. Understanding that will help you compose new ways to manipulate your component and thus make assertions.

Another example testing a function that updates your components state.

it("function will assert new state", () => {
  const wrapper = shallow(<Foo {...props}/>);
  wrapper.instance.customFunction(); // call custom function
  wrapper.update();
  expect(wrapper.state("bar")).to.equal("new-state");
});

Chai-spies also has a handful of chainable getters that make testing custom functions much easier. Please see the docs for a more in-depth explanation.

Collectives™ on Stack Overflow

Mocha, Enzyme: Unit testing custom functions in react component using enzyme

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related