node.js - Mocha Monitor 应用程序输出

Question

我正在为我的网络应用程序构建一个日志记录模块nodejs。我希望能够使用mocha我的模块将正确的消息输出到terminal. 我一直在环顾四周，但没有找到任何明显的解决方案来检查这一点。我已经找到

process.stdout.on('data', function (){})

但无法让它发挥作用。有人有什么建议吗？

Answer 1

process.stdout永远不会发出'data'事件，因为它不是可读的流。如果您好奇，可以在节点流文档中阅读所有相关信息。

据我所知，挂钩或捕获的最简单方法process.stdout是process.stderr替换process.stdout.write为您想要的功能。超级hacky，我知道，但在测试场景中，你可以在钩子之前和之后使用以确保它被解开，所以它或多或少是无害的。由于它无论如何都会写入底层流，如果你不解开它，它不是世界末日。

function captureStream(stream){
  var oldWrite = stream.write;
  var buf = '';
  stream.write = function(chunk, encoding, callback){
    buf += chunk.toString(); // chunk is a String or Buffer
    oldWrite.apply(stream, arguments);
  }

  return {
    unhook: function unhook(){
     stream.write = oldWrite;
    },
    captured: function(){
      return buf;
    }
  };
}

你可以像这样在 mocha 测试中使用它：

describe('console.log', function(){
  var hook;
  beforeEach(function(){
    hook = captureStream(process.stdout);
  });
  afterEach(function(){
    hook.unhook(); 
  });
  it('prints the argument', function(){
    console.log('hi');
    assert.equal(hook.captured(),'hi\n');
  });
});

这里有一个警告：摩卡记者打印到标准输出。据我所知，它们不会在 example ( it('...',function(){})) 函数运行时这样做，但如果您的 example 函数是异步的，您可能会遇到麻烦。我会看看我是否能找到更多关于这个的信息。

Answer 2

我尝试了 jjm 的答案，但我怀疑是由于我的程序异步行为造成的问题。

我通过 github 上的 cli 找到了一个使用 sinon 库的解决方案。

要测试的示例代码：

/* jshint node:true */
module.exports = Test1;

function Test1(options) {
  options = options || {};
}


Test1.prototype.executeSync = function() {
  console.log("ABC");
  console.log("123");
  console.log("CBA");
  console.log("321");
};

Test1.prototype.executeASync = function(time, callback) {
  setTimeout(function() {
    console.log("ABC");
    console.log("123");
    console.log("CBA");
    console.log("321");
    callback();
  }, time);
};

摩卡咖啡测试：

/* jshint node:true */
/* global describe:true, it:true, beforeEach:true, afterEach:true, expect:true */

var assert = require('chai').assert;
var expect = require('chai').expect;
var sinon  = require("sinon");

var Test1 = require("../test");

var test1 = null;

describe("test1", function() {
  beforeEach(function() {
    sinon.stub(console, "log").returns(void 0);
    sinon.stub(console, "error").returns(void 0);
    test1 = new Test1();
  });

  afterEach(function() {
    console.log.restore();
    console.error.restore();
  });

  describe("executeSync", function() {
    it("should output correctly", function() {
      test1.executeSync();

      assert.isTrue(console.log.called, "log should have been called.");
      assert.equal(console.log.callCount, 4);
      assert.isFalse(console.log.calledOnce);
      expect(console.log.getCall(0).args[0]).to.equal("ABC");
      expect(console.log.getCall(1).args[0]).to.equal("123");
      expect(console.log.args[2][0]).to.equal("CBA");
      expect(console.log.args[3][0]).to.equal("321");
    });
  });

  describe("executeASync", function() {
    it("should output correctly", function(done) {
      test1.executeASync(100, function() {
        assert.isTrue(console.log.called, "log should have been called.");
        assert.equal(console.log.callCount, 4);
        assert.isFalse(console.log.calledOnce);
        expect(console.log.getCall(0).args[0]).to.equal("ABC");
        expect(console.log.getCall(1).args[0]).to.equal("123");
        expect(console.log.args[2][0]).to.equal("CBA");
        expect(console.log.args[3][0]).to.equal("321");
        done();
      });

    });
  });
});

我提供上述内容是因为它演示了使用异步调用，它同时处理控制台和错误输出，并且检查方法更有用。

我应该注意，我提供了两种方法来获取传递给控制台的内容，console.log.getCall(0).args[0]以及console.log.args[0][0]. 第一个参数是写入控制台的行。随意使用你认为合适的。

Answer 3

对此有帮助的另外两个库是test-console和intercept-stdout我没有使用intercept-stdout，但这里是你可以如何使用 test-console 的方法。

var myAsync = require('my-async');
var stdout = require('test-console').stdout;

describe('myAsync', function() {
  it('outputs something', function(done) {
    var inspect = stdout.inspect();

    myAsync().then(function() {
      inspect.restore();
      assert.ok(inspect.output.length > 0);
      done();
    });
  });
});

注意：您必须使用 Mocha 的 async api。没有调用done()会吞噬 mocha 的测试消息。