Nodejs stdout mock: console.log()测试方法

Nodejs stdout mock: console.log()测试方法

stdout mock

我们知道console.log是放到process.stdout里打印日志的方法，那么在单元测试里怎么测试呢？

这里给出一个机遇mocha的测试

思路很简单

  • 通过captureStream方法来拦截stdout
  • 通过captureStream#captured获取stdout内容

代码如下

var assert = require('chai').assert;
var expect = require('chai').expect;
require('chai').should();

var console = require(’…/index’);


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;
}
};
}


describe(‘Console’, function(){
var hook;


before(function() {
// runs before all tests in this block
})
after(function(){
// runs after all tests in this block
})
beforeEach(function(){
// runs before each test in this block
hook = captureStream(process.stdout);
})
afterEach(function(){
// runs after each test in this block
hook.unhook();
})


describe(’#debug()’, function(){
it(‘should return a string when debug = true;’, function(){
console.debug = true;
console.log(“debug = true;”);


		assert.equal(hook.captured(),'debug = true;\n');
})
	
it('should return empty string when debug = false;', function(){
		console.debug = false;
		console.log("debug = true;");
     	assert.equal(hook.captured(),'');
})

})
})


3 回复

Node.js stdout Mock: 测试 console.log() 方法

在Node.js中，console.log() 是一个常用的调试工具，它将输出内容发送到标准输出（process.stdout）。然而，在单元测试中，我们可能希望捕获这些输出以便进行验证。下面是一个使用Mocha框架的示例，展示如何通过模拟 stdout 来测试 console.log() 的输出。

1. stdout 模拟

首先，我们需要创建一个函数来捕获并模拟 process.stdout 的输出。这样我们就可以在测试中控制输出内容，并验证 console.log() 的行为。

// captureStream.js
function captureStream(stream) {
  var oldWrite = stream.write;
  var buf = '';

  stream.write = function (chunk, encoding, callback) {
    buf += chunk.toString(); // 将输出内容收集到buf中
    oldWrite.apply(stream, arguments);
  };

  return {
    unhook: function () {
      stream.write = oldWrite; // 恢复原始的write方法
    },
    captured: function () {
      return buf; // 返回收集到的输出内容
    }
  };
}

module.exports = captureStream;

2. 单元测试

接下来，我们编写一个单元测试来验证 console.log() 的输出。我们将使用上述的 captureStream 函数来捕获 stdout，并在测试结束后恢复其原始状态。

// test/console.test.js
var assert = require('chai').assert;
var captureStream = require('./captureStream');
var console = require('../index');

describe('Console', function () {
  var hook;

  beforeEach(function () {
    // 在每个测试之前，启动捕获
    hook = captureStream(process.stdout);
  });

  afterEach(function () {
    // 在每个测试之后，停止捕获并恢复原始的write方法
    hook.unhook();
  });

  describe('#log()', function () {
    it('should log the message when debug = true', function () {
      console.debug = true;
      console.log('debug = true;');
      assert.equal(hook.captured(), 'debug = true;\n');
    });

    it('should not log the message when debug = false', function () {
      console.debug = false;
      console.log('debug = true;');
      assert.equal(hook.captured(), '');
    });
  });
});

解释

  1. captureStream 函数：该函数接收一个流对象（如 process.stdout），然后覆盖其 write 方法以捕获所有写入的数据。在测试结束时，可以通过调用 unhook 方法来恢复原始的 write 方法。

  2. 单元测试：在每个测试用例之前，我们使用 captureStream 函数捕获 process.stdout。然后执行被测代码（例如 console.log() 调用），最后断言捕获到的内容是否符合预期。

通过这种方式，我们可以有效地模拟和测试 console.log() 的输出，确保我们的代码按预期工作。


正摸不著头绪，原来就这样，长知识了！

为了测试 console.log 输出的内容，可以使用类似的方法来拦截 process.stdout。这里提供了一个使用 sinon 库来实现的示例，它可以简化模拟和验证输出的过程。

示例代码

首先，确保安装了必要的库：

npm install sinon mocha chai

然后，创建一个简单的 index.js 文件作为被测模块：

// index.js
exports.logMessage = function(message) {
  console.log(message);
};

接下来是测试文件 test/index.test.js：

const { expect } = require('chai');
const sinon = require('sinon');
const { logMessage } = require('../index');

describe('logMessage', function() {
  let stub;

  beforeEach(function() {
    // 模拟 process.stdout.write 方法
    stub = sinon.stub(process.stdout, 'write');
  });

  afterEach(function() {
    // 重置模拟
    stub.restore();
  });

  it('should print the message to stdout', function() {
    const message = 'Hello, world!';
    logMessage(message);
    expect(stub.calledWith(message + '\n')).to.be.true;
  });
});

解释

  1. 模拟 process.stdout.write：

    • 使用 sinon.stub 来模拟 process.stdout.write 方法。这样我们就可以控制其行为并检查是否被调用。

  2. 测试函数 logMessage：

    • 在每个测试前 (beforeEach) 设置模拟，确保每次测试开始时 process.stdout.write 都被正确模拟。
    • 测试 logMessage 函数是否正确调用了 console.log，这相当于调用了 process.stdout.write 并传递了消息和换行符。

  3. 恢复模拟：

    • 在每个测试后 (afterEach) 恢复 process.stdout.write 的原始实现，以避免测试之间的干扰。

这种方法使得测试 console.log 的行为变得更加简单，并且代码更易于维护和理解。

回到顶部