nodejsの依存があるモジュールのテスト設計について

Question

次のような構造のプログラムがあるとします。

exports.pow2 = function(x) {
    return x*x;
}

const m1 = require('./m1.js');
exports.dist = function(x, y) {
    return m1.pow2(x) + m1.pow2(y);
}

このとき、m2.jsの単体テストを行おうとすると、以下の setMock のような関数が必要になると思いますが、正しいでしょうか。

const _m1 = require('./m1.js');
let m1 = _m1;
exports.dist = function(x, y) {
    return m1.pow2(x) + m1.pow2(y);
}
exports.setMock = function(mock_m1) {
  m1 = mock_m1;
}

あるいは、このような実装を回避する設計やテストモジュール・実装例等ありましたら、ご教授願います。

Answer 1

// BEGIN m1.js
exports.pow2 = function(x) {
    return x*x;
}
// END m1.js


// BEGIN m2_impl.js (このファイルをテストする)
let m1;
exports.DI = function(_m1) {
    m1 = _m1;
}
exports.dist = function(x, y) {
    return m1.pow2(x) + m1.pow2(y);
}
// END m2_impl.js


// BEGIN m2.js
const Impl = require('./m2_impl.js');
Impl.DI(require('./m1.js'));
exports.dist = Impl.dist; 
// END m2.js

Answer 2

このとき、m2.jsの単体テストを行おうとすると、

この例では、m2の利用者からすればm1を差し替える方法はありませんし、「m2がm1を使っている」ということは、m2側のインターフェースにも現れない、実装のディテールでしかありません。

そうであれば、「m1をモックしてm2をテストできるようにする」ことそのものが不要と考えます。むしろ、「テストコードは、m2のインターフェースだけに依存して、その中でm1を使おうが使わまいが同様に動作する」ほうが適当でしょう。

Comments

[maisumakun]

「m1にバグがあって動かない」のも、m2の利用者からすれば「m2が正しく動かない」ということになりますし、それもm2だけのテストで検知できるでしょう。そのような場合は、m1の正常に動作する範囲のバージョンを指定することで、m2の作者として対応することが可能です。

[maai]

ありがとうございます。m1はm2のインターフェースに現れないので、m2のテストではm1を考慮しなくても良い、ということですね…

もしm1がソケット通信関係のモジュールの場合、m2のテストは非効率的なものになってしまうように思うのですが、同様に考えるべきでしょうか。