これは私の問題の核心を説明する簡単な例です：

var innerLib = require('./path/to/innerLib');

function underTest() {
    return innerLib.doComplexStuff();
}

module.exports = underTest;

このコードの単体テストを記述しようとしています。関数を完全にモックアウトinnerLibせずに、の要件をモックアウトするにはどうすればよいrequireですか？

だから私はグローバルをモックアウトしようとrequireしていて、それをやってもうまくいかないことを見つけようとしています：

var path = require('path'),
    vm = require('vm'),
    fs = require('fs'),
    indexPath = path.join(__dirname, './underTest');

var globalRequire = require;

require = function(name) {
    console.log('require: ' + name);
    switch(name) {
        case 'connect':
        case indexPath:
            return globalRequire(name);
            break;
    }
};

問題はrequire、underTest.jsファイル内の関数が実際にモックアウトされていないことです。それはまだグローバルrequire関数を指しています。したがってrequire、モックインしているのと同じファイル内でのみ関数をモックアウトできるようです。requireローカルコピーをオーバーライドした後でも、グローバルを使用して何かを含める場合は、必要なファイルにはまだグローバルrequire参照。

今はできる！

私は、あなたがそれをテストしている間、あなたのモジュールの中でグローバルな要求を上書きすることを処理するproxyquireを公​​開しました。

つまり、必要なモジュールのモックを挿入するためにコードを変更する必要はありません。

Proxyquireには非常にシンプルなAPIがあり、テストしようとしているモジュールを解決して、必要なモジュールのモック/スタブを1つの簡単な手順で渡すことができます。

@Raynosは、それを実現するため、または代わりにボトムアップ開発を行うために、従来はあまり理想的ではないソリューションに頼らなければならなかったのは正しい

これが、私がプロキシクワイアを作成した主な理由です-手間のかからないトップダウンのテスト駆動開発を可能にするためです。

ドキュメントと例を見て、ニーズに合うかどうかを判断してください。

この場合のより良いオプションは、返されるモジュールのメソッドをモックすることです。

良くも悪くも、ほとんどのnode.jsモジュールはシングルトンです。同じモジュールを必要とする2つのコードは、そのモジュールへの同じ参照を取得します。

これを活用して、必要な項目を模擬するためにsinonなどを使用できます。 モカテストは次のとおりです。

// in your testfile
var innerLib  = require('./path/to/innerLib');
var underTest = require('./path/to/underTest');
var sinon     = require('sinon');

describe("underTest", function() {
  it("does something", function() {
    sinon.stub(innerLib, 'toCrazyCrap').callsFake(function() {
      // whatever you would like innerLib.toCrazyCrap to do under test
    });

    underTest();

    sinon.assert.calledOnce(innerLib.toCrazyCrap); // sinon assertion

    innerLib.toCrazyCrap.restore(); // restore original functionality
  });
});

Sinonはアサーションを作成するためにchaiと適切に統合されており、スパイ/スタブのクリーンアップを容易にするためにsinonとmochaを統合するモジュールを作成しました（テスト汚染を回避するため）。

underTestは関数のみを返すため、同じ方法でunderTestをモックすることはできません。

別のオプションは、Jestモックを使用することです。彼らのページでフォローアップ

私はmock-requireを使用しています。requireテストするモジュールの前にモックを定義してください。

あざけることrequireは私にとって厄介なハックのように感じます。私は個人的にはそれを避け、コードをリファクタリングしてテストしやすくします。依存関係を処理するには、さまざまな方法があります。

1）依存関係を引数として渡します

function underTest(innerLib) {
    return innerLib.doComplexStuff();
}

これにより、コードは普遍的にテスト可能になります。欠点は、依存関係を渡す必要があるため、コードがより複雑に見える可能性があることです。

2）モジュールをクラスとして実装し、クラスのメソッド/プロパティを使用して依存関係を取得する

（これは、クラスの使用が合理的ではない、不自然な例ですが、アイデアを伝えます）（ES6の例）

const innerLib = require('./path/to/innerLib')

class underTestClass {
    getInnerLib () {
        return innerLib
    }

    underTestMethod () {
        return this.getInnerLib().doComplexStuff()
    }
}

これで、getInnerLibメソッドを簡単にスタブしてコードをテストできます。コードはより冗長になりますが、テストも簡単になります。

jestを使用したことがあれば、jestのモック機能に慣れていることでしょう。

"jest.mock（...）"を使用すると、コード内のrequire-statementで発生する文字列をどこかに指定でき、その文字列を使用してモジュールが必要な場合は常に代わりにモックオブジェクトが返されます。

例えば

jest.mock("firebase-admin", () => {
    const a = require("mocked-version-of-firebase-admin");
    a.someAdditionalMockedMethod = () => {}
    return a;
})

「firebase-admin」のすべてのインポート/要件を、「factory」関数から返されたオブジェクトで完全に置き換えます。

まあ、jestは実行するすべてのモジュールの周りにランタイムを作成し、モジュールにrequireの「フック」バージョンを注入するため、jestを使用するときにそれを行うことができますが、jestなしではこれを行うことはできません。

私はモック必須でこれを達成しようとしましたが、私にとっては、ソース内のネストされたレベルでは機能しませんでした。githubで次の問題を確認してください：mock-requireは常にMochaで呼び出されるとは限りません。

これに対処するために、私はあなたが望むものを達成するために使用できる2つのnpm-モジュールを作成しました。

1つのbabelプラグインとモジュールモッカーが必要です。

• babel-plugin-mock-require
• ふざけたモック

.babelrcで、次のオプションを使用してbabel-plugin-mock-requireプラグインを使用します。

...
"plugins": [
        ["babel-plugin-mock-require", { "moduleMocker": "jestlike-mock" }],
        ...
]
...

テストファイルでは、次のようにjestlike-mockモジュールを使用します。

import {jestMocker} from "jestlike-mock";
...
jestMocker.mock("firebase-admin", () => {
            const firebase = new (require("firebase-mock").MockFirebaseSdk)();
            ...
            return firebase;
});
...

jestlike-mockモジュールはまだ非常にルディメンタルで、文書の多くを持っていませんが、多くのコードのいずれかがありません。より完全な機能セットのPRに感謝します。目標は、「jest.mock」機能全体を再作成することです。

jestがどのように実装されているかを確認するには、「jest-runtime」パッケージのコードを検索します。たとえば、https：//github.com/facebook/jest/blob/master/packages/jest-runtime/src/index.js#L734を参照してください。ここでは、モジュールの「オートモック」が生成されます。

それが役に立てば幸い;）

できません。最も低いモジュールが最初にテストされ、モジュールを必要とするより高いレベルのモジュールがその後にテストされるように、ユニットテストスイートを構築する必要があります。

また、サードパーティのコードとnode.js自体も十分にテストされていると想定する必要があります。

上書きするモックフレームワークが近い将来に届くのを見ると思います global.require

モックを注入する必要がある場合は、コードを変更してモジュールスコープを公開できます。

// underTest.js
var innerLib = require('./path/to/innerLib');

function underTest() {
    return innerLib.toCrazyCrap();
}

module.exports = underTest;
module.exports.__module = module;

// test.js
function test() {
    var underTest = require("underTest");
    underTest.__module.innerLib = {
        toCrazyCrap: function() { return true; }
    };
    assert.ok(underTest());
}

これは.__moduleAPIに公開され、コードはモジュール自体の危険にさらされてモジュールスコープにアクセスできます。

あなたはあざけるライブラリーを使うことができます：

describe 'UnderTest', ->
  before ->
    mockery.enable( warnOnUnregistered: false )
    mockery.registerMock('./path/to/innerLib', { doComplexStuff: -> 'Complex result' })
    @underTest = require('./path/to/underTest')

  it 'should compute complex value', ->
    expect(@underTest()).to.eq 'Complex result'

好奇心旺盛な人のためにモジュールをモックするシンプルなコード

これが秘密のソースなので、require.cacheand note require.resolveメソッドを操作する部分に注意してください。

class MockModules {  
  constructor() {
    this._resolvedPaths = {} 
  }
  add({ path, mock }) {
    const resolvedPath = require.resolve(path)
    this._resolvedPaths[resolvedPath] = true
    require.cache[resolvedPath] = {
      id: resolvedPath,
      file: resolvedPath,
      loaded: true,
      exports: mock
    }
  }
  clear(path) {
    const resolvedPath = require.resolve(path)
    delete this._resolvedPaths[resolvedPath]
    delete require.cache[resolvedPath]
  }
  clearAll() {
    Object.keys(this._resolvedPaths).forEach(resolvedPath =>
      delete require.cache[resolvedPath]
    )
    this._resolvedPaths = {}
  }
}

次のように使用：

describe('#someModuleUsingTheThing', () => {
  const mockModules = new MockModules()
  beforeAll(() => {
    mockModules.add({
      // use the same require path as you normally would
      path: '../theThing',
      // mock return an object with "theThingMethod"
      mock: {
        theThingMethod: () => true
      }
    })
  })
  afterAll(() => {
    mockModules.clearAll()
  })
  it('should do the thing', async () => {
    const someModuleUsingTheThing = require('./someModuleUsingTheThing')
    expect(someModuleUsingTheThing.theThingMethod()).to.equal(true)
  })
})

しかし... proxyquireはかなり素晴らしいので、それを使用する必要があります。それはあなたの要求オーバーライドをテストのみにローカライズしたままにし、私はそれを強くお勧めします。