How to spy on an imported function using Sinon?

Question

Let's say we want to test that a specific function is called by another function using Sinon.

fancyModule.js

export const fancyFunc = () => {
  console.log('fancyFunc')
}

export default const fancyDefault = () => {
  console.log('fancyDefault')
  fancyFunc()
}

fancyModule.test.js

import sinon from 'sinon'
import fancyDefault, { fancyFunc } from '../fancyModule'

describe('fancyModule', () => {
  it('calls fancyFunc', () => {
    const spy = sinon.spy(fancyFunc)
    fancyDefault()
    expect(spy.called).to.be.true
  })
})

When I run this test the actual value is always false. Also, the original function fancyFunc() gets invoked (outputs fancyFunc) instead of being mocked.

Please show the `export` statement of "fancyModule.js". – try-catch-finally Jul 16 '17 at 15:39 — try-catch-finally, Jul 16 '17 at 15:39
Thanks, I've updated my question with exports. – Marc Jul 16 '17 at 17:22 — Marc, Jul 16 '17 at 17:22

score 11 · Answer 1 · edited Mar 21 '21 at 22:21

11

You can change the import style, and import your module as an Object like this

import sinon from 'sinon'
import * as myModule from '../fancyModule'

describe('fancyModule', () => {
  it('calls fancyFunc', () => {
    const spy = sinon.spy(myModule, 'fancyFunc');
    myModule.fancyDefault()
    expect(spy.called).to.be.true
  })
})

edited Mar 21 '21 at 22:21

Yoav Kadosh

4,807
4
39
56

answered Jan 18 '18 at 18:03

Sebastian

301
3
4

score 2 · Answer 2 · edited Mar 21 '21 at 22:21

You should use https://github.com/speedskater/babel-plugin-rewire/

import sinon from 'sinon'
import fancyDefault, { __RewireAPI__ } from '../fancyModule'

describe('fancyModule', () => {
  it('calls fancyFunc', () => {
    const spy = sinon.spy()
    __RewireAPI__.__Rewire__('fancyFunc', spy)
    
    fancyDefault()

    expect(spy.called).to.be.true
  })
})

Also, check example: https://github.com/speedskater/babel-plugin-rewire#test-code-2

How to spy on an imported function using Sinon?

2 Answers2

Linked