How to mock external module method?

Question

I have this module with a function in it:

const utils = {
  redirectTo(url) {
    if (url) {
      window.location = url;
    }
  },
};

export default utils;

It is used somewhere in a React component like this:

import utils from '../../lib/utils';

componentWillUpdate() {
  this.redirectTo('foo')
}

Now I want to check that the value that redirectTo is called with equals foo.

  it('should redirect if no rights', () => {
    const mockRedirectFn = jest.fn();
    utils.redirectTo = mockRedirectFn;

    mount(
      <SomeComponent />,
    );

    expect(mockRedirectFn).toBeCalled();
    expect(mockRedirectFn).toBeCalledWith('foo');
    console.log(mockRedirectFn.mock);
    // { calls: [], instances: [] }
  });

Thats what I've got and it does not work. How do I do this?

where on the component is the function called? – Rei Dien Mar 29 '17 at 01:19 — Rei Dien, Mar 29 '17 at 01:19
componentWillUpdate, will update the desription too – SM79 Mar 29 '17 at 09:51 — SM79, Mar 29 '17 at 09:51

score 12 · Answer 1 · edited Mar 03 '20 at 12:11

You have to mock the lib/utils module like this:

import utils from '../../lib/utils';
jest.mock('../../lib/utils', () => ({
  redirect: jest.fn()
}))

it('should redirect if no rights', () => {
  mount(
    <SomeComponent />,
  );
  expect(utils.redirect).toHaveBeenCalledWith();
});

This will replace the module with a mock that just returns {redirect:jest.fn()}. This module is also imported into you test where you then can access the spy for redirect and test on this that it was called with the correct parameter.

score 4 · Answer 2 · answered Mar 29 '17 at 23:14

This is what I ended up using:

 it('should redirect if no rights', () => {

    // this way we mock only one method: redirectTo
    jest.mock('lib/utils', () => {
      const original = require.requireActual('lib/utils');
      original.default.redirectTo = jest.fn();
      return original;
    });

    const redirectTo = require.requireMock('lib/utils').default.redirectTo;

    mount(
      <SomeComponent />,
    );

    expect(redirectTo).toHaveBeenCalled();
  });

`require.requireActual('lib/utils')` is exactly what I was looking for — fen1ksss, Jul 18 '19 at 07:57

How to mock external module method?

2 Answers2

Linked