Песочницы

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

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

properties

Какие свойства вставлять. Обратите внимание, что только указание «server» здесь недостаточно для того, чтобы свойство 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();

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

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();

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

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();

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