Песочницы

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

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 является песочницей по умолчанию. Если у вас не слишком сложная настройка или не требуется особая конфигурация, вам, вероятно, достаточно использовать её.

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 установлены в false, в отличие от значений по умолчанию в 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 может указать объект, к которому нужно добавить свойства.

свойства

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

useFakeTimers

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

useFakeServer

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

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

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, 'myMethod', 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();

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