Как заглушить require () / ожидают обращения к «корневой» функции модуля?

Question

Рассмотрим следующую спецификацию жасмина:

describe("something.act()", function() {
  it("calls some function of my module", function() {
    var mod = require('my_module');
    spyOn(mod, "someFunction");
    something.act();
    expect(mod.someFunction).toHaveBeenCalled();
  });
});

Это работает отлично. Что-то вроде этого делает его зеленым:

something.act = function() { require('my_module').someFunction(); };

Теперь взгляните на это:

describe("something.act()", function() {
  it("calls the 'root' function of my module", function() {
    var mod = require('my_module');
    spyOn(mod); // jasmine needs a property name
                // pointing to a function as param #2
                // therefore, this call is not correct.
    something.act();
    expect(mod).toHaveBeenCalled(); // mod should be a spy
  });
});

Это код, который я хотел бы проверить с помощью этой спецификации:

something.act = function() { require('my_module')(); };

За последние несколько месяцев это несколько раз меня задело. Одним из теоретических решений было бы заменить require () и вернуть шпиона, созданного с помощью createSpy (). НО require () - это неудержимый зверь: это отдельная «копия» функции в каждом исходном файле / модуле. Заглушка в спецификации не заменит реальную функцию require () в исходном файле "testee".

Альтернативой является добавление некоторых поддельных модулей к пути загрузки, но для меня это выглядит слишком сложно.

Есть идеи?

Answer 1

rewire отлично подходит для этого

var rewire = require('rewire');

describe("something.act()", function() {
  it("calls the 'root' function of my module", function() {
    var mod = rewire('my_module');
    var mockRootFunction = jasmine.createSpy('mockRootFunction');
    var requireSpy = {
      mockRequire: function() {
        return mockRootFunction;
      }
    };
    spyOn(requireSpy, 'mockRequire').andCallThrough();

    origRequire = mod.__get__('require');
    mod.__set__('require', requireSpy.mockRequire);

    something.act();
    expect(requireSpy.mockRequire).toHaveBeenCalledWith('my_module');
    expect(mockRootFunction).toHaveBeenCalled();

    mod.__set__('require', origRequire);
  });
});

Answer 2

Похоже, я нашел приемлемое решение.

Помощник по спецификациям:

var moduleSpies = {};
var originalJsLoader = require.extensions['.js'];

spyOnModule = function spyOnModule(module) {
  var path          = require.resolve(module);
  var spy           = createSpy("spy on module \"" + module + "\"");
  moduleSpies[path] = spy;
  delete require.cache[path];
  return spy;
};

require.extensions['.js'] = function (obj, path) {
  if (moduleSpies[path])
    obj.exports = moduleSpies[path];
  else
    return originalJsLoader(obj, path);
}

afterEach(function() {
  for (var path in moduleSpies) {
    delete moduleSpies[path];
  }
});

Спецификация:

describe("something.act()", function() {
  it("calls the 'root' function of my module", function() {
    var mod = spyOnModule('my_module');
    something.act();
    expect(mod).toHaveBeenCalled(); // mod is a spy
  });
});

Это не идеально, но делает работу довольно хорошо. Он даже не портит исходный код испытуемого , что для меня является своего рода критерием.

Answer 3

Мне нужно было сделать это сегодня, и наткнулся на этот пост. Мое решение следующее:

В спецификации помощника:

var originalRequire = require;
var requireOverrides = {};

stubModule = function(name) {
  var double = originalRequire(name);
  double['double'] = name;
  requireOverrides[name] = double;
  return double;
}

require = function(name) {
  if (requireOverrides[name]) {
    return requireOverrides[name];
  } else {
    return originalRequire(name);
  }
}

afterEach(function() {
  requireOverrides = {};
});

В спецификации:

AWS = stubModule('aws-sdk');
spyOn(AWS.S3, 'Client');

// do something

expect(AWS.S3.Client).toHaveBeenCalled();

Answer 4

Это было очень полезно, но не поддерживает звонки через .andCallThrough().

Я смог адаптировать его, поэтому подумал, что поделюсь:

function clone(obj) {
  if (obj === null || typeof obj !== 'object') {
    return obj;
  }
  var key;
  var temp = new obj.constructor();
  for (key in obj) {
    if (obj.hasOwnProperty(key)) {
      temp[key] = clone(obj[key]);
    }
  }
  return temp;
};

spyOnModule = function spyOnModule(name) {
  var path          = require.resolve(name);
  var spy           = createSpy("spy on module \"" + name + "\"");
  moduleSpies[path] = spy;

  // Fake calling through
  spy.andCallThrough = function() {

    // Create a module object
    var mod = clone(module);
    mod.parent = module;
    mod.id = path;
    mod.filename = path;

    // Load it backdoor
    originalJsLoader(mod, path);

    // And set it's export as a faked call
    return this.andCallFake(mod.exports);
  }

  delete require.cache[path];
  return spy;
};

Answer 5

Есть другой подход.Вы можете поместить модуль в глобальную область, не используя var, когда требуется:

someModule = require('someModule');

describe('whatever', function() {
  it('does something', function() {
    spyOn(global, 'someModule');

    someFunctionThatShouldCallTheModule();

    expect(someModule).toHaveBeenCalled();
  }
}

Вы также можете обернуть модуль в другой модуль:

//someModuleWrapper.js
require('someModule');

function callModule(arg) {
  someModule(arg);
}
exports.callModule = callModule;

//In the spec file:
someModuleWrapper = require('someModuleWrapper');

describe('whatever', function() {
  it('does something', function() {
    spyOn(someModuleWrapper, 'callModule');

    someFunctionThatShouldCallTheModule();

    expect(someModuleWrapper.callModule).toHaveBeenCalled();
  }
}

И затем, очевидно,убедитесь, что везде, где есть someFunctionThatShouldCallTheModule, вам требуется оболочка, а не настоящий модуль.

Answer 6

Вы можете аккуратно использовать модуль (https://github.com/felixge/node-gently). Требуется угон требуется в примерах, и грязный модуль NPM активно использует его, поэтому я полагаю, что он работает.