Песочницы

Песочницы устраняют необходимость отслеживания каждого созданного фейка, что значительно упрощает очистку.

var sandbox = require("sinon").createSandbox();
var myAPI = { hello: function () {} };

describe("myAPI.hello method", function () {
  beforeEach(function () {
    // stub out the `hello` method
    sandbox.stub(myAPI, "hello");
  });

  afterEach(function () {
    // completely restore all fakes created through the sandbox
    sandbox.restore();
  });

  it("should be called once", function () {
    myAPI.hello();
    sandbox.assert.calledOnce(myAPI.hello);
  });

  it("should be called twice", function () {
    myAPI.hello();
    myAPI.hello();
    sandbox.assert.calledTwice(myAPI.hello);
  });
});

API песочницы

По умолчанию песочница

С sinon@5.0.0, объект sinon является песочницей по умолчанию. Если у вас нет очень сложной настройки или особой конфигурации, вам, вероятно, следует использовать только его.

const myObject = {
  hello: "world",
};

sinon.stub(myObject, "hello").value("Sinon");

console.log(myObject.hello);
// Sinon

sinon.restore();
console.log(myObject.hello);
// world

var sandbox = sinon.createSandbox();

Создаёт новый объект песочницы со шпионами, заглушками и моками.

var sandbox = sinon.createSandbox(config);

Метод sinon.createSandbox(config) часто является функцией интеграции и может использоваться в сценариях, включающих глобальный объект для координации всех фейков.

Песочницы частично настроены по умолчанию таким образом, что вызов:

var sandbox = sinon.createSandbox({});

будет объединять дополнительные значения по умолчанию, аналогично:

var sandbox = sinon.createSandbox({
  // ...
  injectInto: null,
  properties: ["spy", "stub", "mock"],
  useFakeTimers: false,
  useFakeServer: false,
});

Значения useFakeTimers и useFakeServers являются ложными, в отличие от значений по умолчанию в файле sinon.defaultConfig:

sinon.defaultConfig = {
  // ...
  injectInto: null,
  properties: ["spy", "stub", "mock", "clock", "server", "requests"],
  useFakeTimers: true,
  useFakeServer: true,
};

Чтобы получить полную песочницу со заглушками, шпионами и т. д. и фейковыми таймерами и серверами, можно вызвать:

// Inject the sinon defaults explicitly.
var sandbox = sinon.createSandbox(sinon.defaultConfig);

// (OR) Add the extra properties that differ from the sinon defaults.
var sandbox = sinon.createSandbox({
  useFakeTimers: true,
  useFakeServer: true,
});

injectInto

Методы песочницы могут быть вставлены в другой объект для удобства. Опция конфигурации injectInto может указать объект, к которому следует добавить свойства.

properties

Какие свойства вставлять. Обратите внимание, что только указание «сервера» здесь недостаточно, чтобы свойство server появилось в целевом объекте; также необходимо установить useFakeServer в значение true.

Список свойств, которые можно вставить, соответствует тем, которые экспонирует объект, возвращаемый функцией inject, а именно:

{
  //...
  properties: [
    "spy",
    "stub",
    "mock",
    "createStubInstance",
    "fake",
    "replace",
    "replaceSetter",
    "replaceGetter",
    "clock",
    "server",
    "requests",
    "match",
  ];
}

useFakeTimers

Если установлено значение true, в песочнице будет свойство clock. Можно дополнительно передать объект конфигурации, соответствующий спецификации фейковых таймеров, например, { toFake: ["setTimeout", "setInterval"] }.

useFakeServer

Если true, свойства server и requests добавляются в песочницу. Также может быть объектом для использования в качестве фейкового сервера. По умолчанию используется sinon.fakeServer, но если вы используете jQuery 1.3.x или какую-либо другую библиотеку, которая не устанавливает обработчик onreadystatechange для XHR, вам, возможно, нужно сделать следующее:

sinon.config = {
  useFakeServer: sinon.fakeServerWithClock,
};

Пример экспонирования песочницы

Чтобы создать объект sandboxFacade, которому вставляется метод spy, можно написать:

// object that will have the spy method injected into it
var sandboxFacade = {};

// create sandbox and inject properties (in this case spy) into sandboxFacade
var sandbox = sinon.createSandbox({
  injectInto: sandboxFacade,
  properties: ["spy"],
});

sandbox.assert();

Удобная ссылка для sinon.assert

С sinon@2.0.0

sandbox.replace(object, property, replacement);

Заменяет property в object на значение аргумента replacement. Попытки замены уже заменённого значения вызывают исключение.

replacement может быть любым значением, включая spies, stubs и fakes.

Этот метод работает только с обычными свойствами, для замены аксессоров используйте sandbox.replaceGetter() и sandbox.replaceSetter().

var myObject = {
  myMethod: function () {
    return "apple pie";
  },
};

sandbox.replace(myObject, "myMethod", function () {
  return "strawberry";
});

console.log(myObject.myMethod());
// strawberry

sandbox.replaceGetter();

Заменяет геттер для property в object на значение аргумента replacement.

replacement должен быть Function, и может быть экземпляром spies, stubs и fakes.

var myObject = {
    get myProperty: function() {
        return 'apple pie';
    }
};

sandbox.replaceGetter(myObject, 'myProperty', function () {
    return 'strawberry';
});

console.log(myObject.myProperty);
// strawberry

sandbox.replaceSetter();

Заменяет сеттер для property в object на значение аргумента replacement.

replacement должен быть Function, и может быть экземпляром spies, stubs и fakes.

var object = {
  set myProperty(value) {
    this.prop = value;
  },
};

sandbox.replaceSetter(object, "myProperty", function (value) {
  this.prop = "strawberry " + value;
});

object.myProperty = "pie";

console.log(object.prop);
// strawberry pie

sandbox.spy();

Работает точно так же, как sinon.spy

sandbox.createStubInstance();

Работает почти точно так же, как sinon.createStubInstance, но также добавляет возвращаемые заглушки в внутренний набор фейков для восстановления с помощью sandbox.restore().

sandbox.stub();

Работает точно так же, как sinon.stub.

Использование заглушки для нефункционального свойства

const myObject = {
  hello: "world",
};

sandbox.stub(myObject, "hello").value("Sinon");

console.log(myObject.hello);
// Sinon

sandbox.restore();
console.log(myObject.hello);
// world

sandbox.mock();

Работает точно так же, как sinon.mock

sandbox.useFakeTimers();

Заменяет таймеры и связывает объект clock с песочницей, так что он также восстанавливается при вызове sandbox.restore().

Доступ через sandbox.clock.

sandbox.useFakeXMLHttpRequest();

Заменяет XHR и связывает получившийся объект с песочницей, чтобы он также восстанавливался при вызове sandbox.restore().

С версии 2.x вы больше не можете получить доступ к запросам через sandbox.requests - используйте sandbox.useFakeServer для этого. Эта функция соответствует sinon.useFakeXMLHttpRequest, только с песочницей.

sandbox.useFakeServer();

Заменяет XHR и связывает объект сервера с песочницей, чтобы он также восстанавливался при вызове sandbox.restore().

Доступ к запросам через sandbox.requests и серверу через sandbox.server

sandbox.usingPromise(promiseLibrary);

Заставляет все заглушки и моки, созданные из песочницы, возвращать обещания, используя определённую библиотеку обещаний вместо глобальной, когда используется stub.rejects или stub.resolves. Возвращает заглушку для возможности цепочки.

С sinon@2.0.0

sandbox.restore();

Восстанавливает все фейки, созданные через песочницу.

sandbox.reset();

Сбрасывает внутреннее состояние всех фейков, созданных через песочницу.

sandbox.resetBehavior();

Сбрасывает поведение всех заглушек, созданных через песочницу.

С sinon@2.0.0

sandbox.resetHistory();

Сбрасывает историю всех заглушек, созданных через песочницу.

С sinon@2.0.0

sandbox.verify();

Проверяет все моки, созданные через песочницу.

sandbox.verifyAndRestore();

Проверяет все моки и восстанавливает все фейки, созданные через песочницу.