如何在 ES6 中存根导出的函数？

Question

我有文件 foo.js:

export function bar (m) {
  console.log(m);
}

还有另一个使用 foo.js 的文件 cap.js：

import { bar } from 'foo';

export default m => {
  // Some logic that I need to test
  bar(m);
}

我有 test.js：

import cap from 'cap'

describe('cap', () => {
  it('should bar', () => {
      cap('some');
  });
});

不知何故，我需要在测试中覆盖 bar(m) 的实现。有没有办法做到这一点？

附：我使用 babel、webpack 和 mocha。

Answer 1

哎呀.. 我找到了解决方案，所以我使用sinon 存根和import * as foo from 'foo' 获取所有导出函数的对象，以便我可以存根它们。

import sinon from 'sinon';
import cap from 'cap';
import * as foo from 'foo';

sinon.stub(foo, 'bar', m => {
    console.log('confirm', m);
});

describe('cap', () => {
  it('should bar', () => {
    cap('some');
  });
});

Answer 2

您只能从模块本身内部替换/重写/存根导出。 （这里是explanation）

如果你像这样重写 'foo.js'：

var bar = function bar (m) {
  console.log(m);
};

export {bar}

export function stub($stub) {
  bar = $stub;
}

然后您可以像这样在测试中覆盖它：

import cap from 'cap'
import {stub} from 'foo'

describe('cap', () => {
  it('should bar', () => {
      stub(() => console.log('stubbed'));
      cap('some'); // will output 'stubbed' in the console instead of 'some'
  });
});

我创建了一个 Babel 插件，它可以自动转换所有导出，以便它们可以被存根：https://github.com/asapach/babel-plugin-rewire-exports

Answer 3

虽然@Mike 解决方案适用于旧版本的 sinon，但自 sinon 3.0.0 起已将其删除。

现在代替：

sinon.stub(obj, "meth", fn);

你应该这样做：

stub(obj, 'meth').callsFake(fn)

模拟 google oauth api 示例：

import google from 'googleapis';

const oauth2Stub = sinon.stub(); 

sinon.stub(google, 'oauth2').callsFake(oauth2Stub);

oauth2Stub.withArgs('v2').returns({
    tokeninfo: (accessToken, params, callback) => {
        callback(null, { email: 'poo@bar.com' }); // callback with expected result
    }
});

Answer 4

您可以使用babel-plugin-rewire (npm install --save-dev babel-plugin-rewire)

然后在test.js 中使用导入模块上的__Rewire__ 函数来替换该模块中的函数：

// test.js
import sinon from 'sinon'

import cap from 'cap'

describe('cap', () => {
  it('should bar', () => {
    const barStub = sinon.stub().returns(42);
    cap.__Rewire__('bar', barStub); // <-- Magic happens here
    cap('some');
    expect(barStub.calledOnce).to.be.true;
  });
});

请务必将rewire 添加到.babelrc 中的babel 插件中：

// .babelrc
{
  "presets": [
    "es2015"
  ],
  "plugins": [],
  "env": {
    "test": {
      "plugins": [
        "rewire"
      ]
    }
  }
}

最后，正如您所见，babel-plugin-rewire 插件仅在测试环境中启用，因此您应该调用您的测试运行程序，并将BABEL_ENV 环境变量设置为test（您可能已经这样做了） ：

env BABEL_ENV=test mocha --compilers js:babel-core/register test-example.js

注意：我无法让 babel-plugin-rewire-exports 工作。

Answer 5

这对我来说绝对是一个陷阱......

我创建了一个小工具来解决 sinon 的这个限制。 （在js too 中可用）。

// mockable.ts ?

import sinon from 'sinon'

export function mockable<T extends unknown[], Ret>(fn: (...fnArgs: T) => Ret) {
  let mock: sinon.SinonStub<T, Ret> | undefined
  const wrapper = (...args: T) => {
    if (mock) return mock(...args)
    return fn(...args)
  }
  const restore = () => {
    mock = undefined
  }
  wrapper.mock = (customMock?: sinon.SinonStub<T, Ret>) => {
    mock = customMock || sinon.stub()
    return Object.assign(mock, { restore })
  }
  wrapper.restore = restore
  return wrapper
}

如果你将上面的 sn-p 粘贴到你的项目中，你可以像这样使用它

// foo.js
import { mockable } from './mockable'

// we now need to wrap the function we wish to mock
export const foo = mockable((x) => {
   console.log(x)
})

// main.js
import { foo } from './foo'

export const main = () => {
  foo('asdf') // use as normal
}

// test.js
import { foo } from './foo'
import { main } from './main'

// mock the function - optionally pass in your own mock
const mock = foo.mock()

// test the function
main()
console.assert(mock.calledOnceWith('asdf'), 'not called')

// restore the function
stub.restore()

这种方法的好处是您不必记住总是以某种方式导入函数。 import { foo } from './foo' 和 import * as foo from './foo' 一样好用。自动导入可能只适用于您的 IDE。