在sinon中使用异步回调的存根方法

时间:2015-05-11 09:14:31

标签: javascript node.js asynchronous mocha sinon

我有parsePDF()方法调用extractText(),它会在异步回调中返回结果。

问题

如何编写一个mocha / chai / sinon测试,仅测试{em> parsePDF调用extractText一次,并且传递给path个参数parsePDF? (我对extractTextcleanUp进行了单独的单元测试。)

这里是parsePDF方法的基本结构:

Parser.parsePDF(path, callback) {
  Parser.extractText(path, function gotResult(err, raw_text) {
    if (err) {
      callback(err)
      return;
    }
    var clean_text = Parser.cleanUp(raw_text)
    callback(null, clean_text);
  });
};

我尝试了什么

尽管阅读了FiddleSinon documentation on callsArg,各种SO帖子,例如Mocha/Chai/Sinon tutorials,我仍然没有找到编写正确测试所需的内容。< / p>

此尝试失败,并显示消息Error: timeout of 2000ms exceeded. Ensure the done() callback is being called in this test.。 (这是有道理的:回调没有被解雇):

    it('should call extractText() with path argument', function(done) {
        sandbox.stub(Parser, 'extractText')
        Parser.parsePDF('a known path', function(err, bill) {
            expect(sinon).calledOnce(Parser.extractText).calledWith('a known path')
            done()
        });
    });

yeilds()的以下内容也失败,消息undefined is not a function指向expect...行:

    it('should call extractText() with path argument', function(done) {
        sandbox.stub(UtilityBillParser, 'extractText').yields(null, 'some text')
        Parser.parsePDF('a known path', function(err, bill) {
            expect(sinon).calledOnce(Parser.extractText).calledWith('a known path')
            done()
        });
    });

以下.callsArg(1)

    it('should call extractText() with path argument', function(done) {
        sandbox.stub(UtilityBillParser, 'extractText').callsArg(1)
        UtilityBillParser.parsePDF('a known path', function(err, bill) {
            expect(sinon).calledOnce(UtilityBillParser.extractText).calledWith('a known path')
            done()
        });
    });

2 个答案:

答案 0 :(得分:1)

由于您完全删除了extractText()方法,因此永远不会调用其回调,因此不需要与回调相关的特殊处理。以下作品:

    it('should call extractText() with path argument', function() {
        sandbox.stub(Parser, 'extractText')
        Parser.parsePDF('a known path', 'ignored');
        sinon.assert.calledOnce(Parser.extractText)
        sinon.assert.calledWith(Parser.extractText, 'a known path', sinon.match.func)
    });

在第二个断言中使用sinon.match.func反映了parsePDF创建自己的匿名函数以传递给extractText的事实;您可以做的最好的事情是断言某些函数已传递给extractText

答案 1 :(得分:1)

这是单元测试解决方案:

parser.js

const Parser = {
  parsePDF(path, callback) {
    Parser.extractText(path, function gotResult(err, raw_text) {
      if (err) {
        callback(err);
        return;
      }
      var clean_text = Parser.cleanUp(raw_text);
      callback(null, clean_text);
    });
  },
  extractText(path, callback) {
    callback();
  },
  cleanUp(rawText) {
    return "real clean text";
  },
};

module.exports = Parser;

parser.test.js

const Parser = require("./parser");
const sinon = require("sinon");

describe("Parser", () => {
  afterEach(() => {
    sinon.restore();
  });
  describe("#parsePDF", () => {
    it("should clean up raw test", () => {
      const callback = sinon.stub();
      sinon.stub(Parser, "extractText").yields(null, "fake raw text");
      sinon.stub(Parser, "cleanUp").returns("fake clean text");
      Parser.parsePDF("./somepath", callback);
      sinon.assert.calledWith(Parser.extractText, "./somepath", sinon.match.func);
      sinon.assert.calledWith(Parser.cleanUp, "fake raw text");
      sinon.assert.calledWith(callback, null, "fake clean text");
    });

    it("should handle err", () => {
      const callback = sinon.stub();
      const mError = new Error("some error");
      sinon.stub(Parser, "extractText").yields(mError, null);
      sinon.stub(Parser, "cleanUp").returns("fake clean text");
      Parser.parsePDF("./somepath", callback);
      sinon.assert.calledWith(Parser.extractText, "./somepath", sinon.match.func);
      sinon.assert.calledWith(callback, mError);
    });
  });
});

带有覆盖率报告的单元测试结果:

  Parser
    #parsePDF
      ✓ should clean up raw test
      ✓ should handle err


  2 passing (9ms)

----------------|----------|----------|----------|----------|-------------------|
File            |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
----------------|----------|----------|----------|----------|-------------------|
All files       |    93.75 |      100 |    77.78 |    93.75 |                   |
 parser.js      |       80 |      100 |       50 |       80 |             13,16 |
 parser.test.js |      100 |      100 |      100 |      100 |                   |
----------------|----------|----------|----------|----------|-------------------|

源代码:https://github.com/mrdulin/mocha-chai-sinon-codelab/tree/master/src/stackoverflow/30163720