使用sinon和babel-plugin-rewire时,不能在模块内部存根函数

时间:2018-05-10 16:56:12

标签: javascript unit-testing mocha sinon stub

在mocha / chai设置中,我尝试将babel-plugin-rewire与sinon一起用于在同一模块中测试和存根功能。这些是以下示例文件:

首先,index.js和test文件同时使用sinon和babel-plugin-rewire。重新布线工作,但由于某种原因,我的存根不起作用。它应用的函数永远不会被存根,只返回原始值:

// index.js

function foo() {
  return "foo";
}

export function bar() {
  return foo();
}

export function jar() {
  return "jar";
}

//index.test.js

import chai from "chai";
import sinon from "sinon";
import * as index from "./index";
const expect = chai.expect;

const sandbox = sinon.sandbox.create();

describe("babel-plugin-rewire", () => {
  it("should be able to rewire", () => {
    index.default.__set__("foo", () => {
      return "rewired"; // successfullly rewires
    });
    expect(index.bar()).to.equal("rewired"); // works fine
    index.default.__ResetDependency__("foo");
    expect(index.bar()).to.equal("bar"); // works fine
  });
});

describe("sinon", () => {
  afterEach(() => {
    sandbox.restore();
  });

  it("should call the original jar", () => {
    expect(index.jar()).to.equal("jar"); // works fine
  });

  it("should call the stubbed jar", () => {
    sandbox.stub(index, "jar").returns("stub");
    expect(index.jar()).to.equal("stub"); // fails
  });
});

这里有两个仅使用sinon存根的示例文件。同样的事情发生了:

// stub.js
export function stub() {
  return "stub me";
}

// stub.test.js
import * as stub from "./stub";
import sinon from "sinon";
import chai from "chai";

const expect = chai.expect;
const sandbox = sinon.createSandbox();

const text = "I have been stubbed";

describe("sinon stubs", () => {
  afterEach(() => {
    sandbox.restore();
  });
  it("should stub", () => {
    sandbox.stub(stub, "stub").returns(text);
    expect(stub.stub()).to.equal(text); // fails
  });
});

这就是用于摩卡的babelrc

{
   "presets": [
     "@babel/preset-env"
   ],
   "plugins": [
     "rewire"
   ]
}

如果我从插件中删除重新连接,则问题就会消失。虽然这显然意味着我不能使用重新连接,正如我之前提到的,我需要将重新连接的函数存储起来。这是模块的错误还是我在这里遗漏了什么?

1 个答案:

答案 0 :(得分:1)

我的一项测试也遇到了同样的问题。退出用户后,有一项操作触发了页面重定向。重定向本身是在单独的文件中实现的。

import * as utils from '../utils.js';
import sinon from 'sinon';

it('will dispatch an action and redirect the user when singing out', () => {
    const redirectStub = sinon.stub(utils, 'redirect').returns(true);
    // dispatch and assertion of action omitted
    expect(redirectStub.calledOnce).toBeTruthy();
    redirectStub.restore();
});

然后,由于各种原因,我不得不在测试中添加babel-rewire-plugin。这打破了上面的特定测试。 calledOnce或任何其他sinon方法始终返回false

不幸的是,我无法继续进行间谍/窃听工作。我不得不像这样重写我的测试:

import { __RewireAPI__ } from '../utils.js';
import sinon from 'sinon';

it('will dispatch an action and redirect the user when singing out', () => {
    __RewireAPI__.__Rewire__('redirect', () => true);
    // dispatch and assertion of action omitted
    __RewireAPI__.ResetDependencty('redirect');
});

如您所见,不再有间谍或存根断言。我重新布线了redirect方法,然后将其重置。

但是有一个babel-plugin-rewire-exports库,它似乎允许您重新接线和监视/存根。我自己还没有尝试过,但是如果您不想重写测试,可以选择它。这是link