console.log()の出力をUnitTestで検証したい

Question

実現したいこと

JavaScript初心者です。普段は、Javaを使ています。
JavaScriptでUnitTestをやろうとしています。

環境は、Node.jsとMochaを使っています。
すでに簡単なUnitTestはできています。

下記のようなコードに対して、strに応じてコンソール出力が切り替わることをassertするテストを書きたいです。

var foo = function(str) {
  if(str == null) {
    console.log("str is null");
  }
  else {
    console.log(str);
  }
}

その他

普段使っている、Javaであれば、コードを修正する、モックライブラリーを使う、出力を変更するなど、色々な解決策が思い浮かびますが、JavaScriptは初心者なので、この先、どの方向に進めばよいのか判断できずにいます。

幅広いご意見を、お待ちしております。

Answer 1

コンソールに出力されたテキストに後からアクセスする方法はありません。
このような場合、console.log() をカスタムコードで上書きしてテキストを横取りできるようにするのが一般的な方法ではないでしょうか。

/* console.log() を保存 */
var original_console_log = console.log;
/* console.log() をカスタム関数で上書き */
console.log = function(message) {
  /* ここでmessageを好きなように処理する */
  do_something(message);
  /* 最後に元の console.log() を呼び出す */
  original_console_log(message);
};

今回、出力された文字列が変化するかどうかを検証したいのですから、do_something() の部分で必要な検証を行うようにすればよろしいかと思われます。

ご参考になれば。

Comments

[hitomatagi]

教えていただいた方法をもとにテストを書いてみたところ、うまくいきました。
console.logを別の変数に一旦保存しておき、後で元に戻すのがポイントでした。

JavaScriptらしい方法で、簡潔だったので、ベストアンサーを押させていただきます。
ありがとうございました。

```JavaScript
const assert = require('assert');

//-----------------
// 対象コード
const foo = function(str) {
if(str == null) {
console.log("str is null");
}
else {
console.log(str);
}
}

//------------------
// テスト

var log = [];

// 最初の状態を保存
var original_console_log = console.log;
console.log = function(message) {
log[log.length] = message;
};

const msg1 = null;
foo(msg1);

const msg2 = "abc";
foo(msg2);

// 最初の状態に戻す
console.log = original_console_log;

const exp1 = "str is null";
assert.equal(log[0], exp1);

const exp2 = "abc";
assert.equal(log[1], exp2);
```

Answer 2

関数の第二引数（必須引数の後）には、オプション引数をオブジェクト{}を渡せるのが一般的なメソッドの実装方法ですが、ここにモック用のプロパティを用意するのが簡単な解決方法です。モックとしてsinonを使用します。

下記の例では、第二引数にモック{log}を与え、実行された際の引数を確認するものです。

var sinon = require('sinon');

var foo = function(str, opts) {
  opts = opts || {};
  opts.log = opts.log || console.log.bind(console);

  if(str == null) {
    opts.log("str is null");
  }
  else {
    opts.log(str);
  }
}

var log = sinon.spy();
foo('test', {log: log});
console.log(log.args[0]); // test

他の方法としてはchild_process.execを利用することでしょうか。

参考

• 標準出力のテストを書く - qiita/59naga

Comments

[hitomatagi]

ご回答ありがとうございました。
sinonやオプション引数の使い方が勉強になりました。
今後とも、よろしくお願いいたします。