node.js 如何使用 mocha 为异步测试获取更好的错误消息

Question

我的 node.js mocha 套件中的典型测试如下所示：

 it("; client should do something", function(done) {
    var doneFn = function(args) {
      // run a bunch of asserts on args
      client.events.removeListener(client.events.someEvent, userMuteFn);
      done();
    }

    client.events.on(someEvent, doneFn);

    client.triggerEvent();
});

这里的问题是，如果client.triggerEvent() 没有做正确的事情，或者如果服务器中断并且从不调用someEvent，那么done() 将永远不会被调用。这会给之前没有使用过测试套件的人留下一个模棱两可的错误，例如：

Error: timeout of 10500ms exceeded. Ensure the done() callback is being called in this test.

我的问题是，有没有一种方法可以重写这些测试，无论是使用 mocha 还是添加另一个库，都可以使这样的异步工作更容易遵循。我希望能够输出如下内容：

the callback doneFn() was never invoked after clients.event.on(...) was invoked

或者类似的东西。

我不确定使用诸如承诺之类的东西是否会对此有所帮助。对于异步/回调类型代码更有意义的错误消息将是一件好事。如果这意味着从回调/异步转移到另一个工作流，我也可以。

有哪些解决方案？

Answer 1

除了someEvent，您还应该收听uncaughtException 事件。这样您就可以捕捉到客户端发生的错误，并且这些错误会显示在您的测试报告中。

 it("; client should do something", function(done) {
    var doneFn = function(args) {
      // run a bunch of asserts on args
      client.events.removeListener(client.events.someEvent, userMuteFn);
      done();
    }

    var failedFn = function(err) {
      client.events.removeListener('uncaughtException', failedFn);
      // propagate client error
      done(err);
    }
    client.events.on(someEvent, doneFn);

    client.events.on('uncaughtException', failedFn);

    client.triggerEvent();
});

附：如果client 是子进程，您还应该监听exit 事件，该事件将在子进程死亡时触发。

Answer 2

当您收到超时错误而不是更精确的错误时，首先要做的是检查您的代码是否不会吞下异常，并且不会吞下承诺拒绝。 Mocha 是旨在在您的测试中检测到这些。除非你做一些不寻常的事情，比如在你自己的 VM 中运行测试代码或操纵 domains，否则 Mocha 会检测到此类故障，但如果你的代码吞噬了它们，那么 Mocha 就无能为力了。

话虽如此，Mocha 无法告诉您 done 未被调用，因为您的实现有一个逻辑错误导致它无法调用回调。

下面是sinon 可以在测试失败后执行的事后分析。让我强调一下，这是一个概念证明。如果我想持续使用它，我会开发一个合适的库。

var sinon = require("sinon");
var assert = require("assert");

// MyEmitter is just some code to test, created for the purpose of
// illustration.
var MyEmitter = require("./MyEmitter");
var emitter = new MyEmitter();

var postMortem;
beforeEach(function () {
  postMortem = {
    calledOnce: []
  };
});

afterEach(function () {
  // We perform the post mortem only if the test failed to run properly.
  if (this.currentTest.state === "failed") {
    postMortem.calledOnce.forEach(function (fn) {
      if (!fn.calledOnce) {
        // I'm not raising an exception here because it would cause further
        // tests to be skipped by Mocha. Raising an exception in a hook is
        // interpreted as "the test suite is broken" rather than "a test
        // failed".
        console.log("was not called once");
      }
    });
  }
});

it("client should do something", function(done) {
  var doneFn = function(args) {
    // If you change this to false Mocha will give you a useful error.  This is
    // *not* due to the use of sinon. It is wholly due to the fact that
    // `MyEmitter` does not swallow exceptions.
    assert(true);
    done();
  };

  // We create and register our spy so that we can conduct a post mortem if the
  // test fails.
  var spy = sinon.spy(doneFn);
  postMortem.calledOnce.push(spy);
  emitter.on("foo", spy);

  emitter.triggerEvent("foo");
});

这里是MyEmitter.js的代码：

var EventEmitter = require("events");

function MyEmitter() {
    EventEmitter.call(this);
}

MyEmitter.prototype = Object.create(EventEmitter.prototype);
MyEmitter.prototype.constructor = MyEmitter;

MyEmitter.prototype.triggerEvent = function (event) {
    setTimeout(this.emit.bind(this, event), 1000);
};

module.exports = MyEmitter;