Заглушки

Что такое заглушки?

Тестовые заглушки — это функции (шпионы) с предварительно запрограммированным поведением.

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

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

Когда использовать заглушки?

Используйте заглушку, когда вы хотите:

Управлять поведением метода из теста, чтобы заставить код пройти по определенному пути. Примеры включают принудительное выброс ошибки методом для проверки обработки ошибок.
Когда вы хотите предотвратить прямой вызов определенного метода (возможно, потому что он вызывает нежелательное поведение, такое как XMLHttpRequest или подобное).

Следующий пример — еще один тест из PubSubJS, который демонстрирует, как создать анонимную заглушку, которая выбрасывает исключение при вызове.

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

Определение поведения заглушки при последовательных вызовах

Вызов методов определения поведения, таких как returns или throws несколько раз перезаписывает поведение заглушки. Начиная с версии Sinon 1.8, вы можете использовать метод onCall, чтобы заглушка реагировала по-разному при последовательных вызовах.

Обратите внимание, что в версиях Sinon с 1.5 по 1.7 многократные вызовы семейства методов yields* и callsArg* определяют последовательность поведения для последовательных вызовов. Начиная с версии 1.8, эта функциональность была удалена в пользу API onCall.

API заглушек

Свойства

`var stub = sinon.stub();`

Создает анонимную функцию-заглушку

`var stub = sinon.stub(object, "method");`

Заменяет object.method функцией-заглушкой. Если свойство не является функцией, выбрасывается исключение.

Исходную функцию можно восстановить, вызвав object.method.restore(); (или stub.restore();).

`var stub = sinon.stub(object, "method", func);`

Это было удалено из v3.0.0. Вместо этого вы должны использовать

stub(obj, 'meth').callsFake(fn)

Доступен кодмод для обновления вашего кода

`var stub = sinon.stub(obj);`

Заглушает все методы объекта.

Обратите внимание, что обычно лучше заглушать отдельные методы, особенно для объектов, которые вы не понимаете или не контролируете все методы (например, зависимости библиотек).

Заглушение отдельных методов более точно тестирует намерение и менее восприимчиво к неожиданному поведению по мере эволюции кода объекта.

Если вы хотите создать объект-заглушку MyConstructor, но не хотите вызывать конструктор, используйте эту вспомогательную функцию.

var stub = sinon.createStubInstance(MyConstructor, overrides);

overrides — это необязательный массив, переопределяющий созданные заглушки, например:

var stub = sinon.createStubInstance(MyConstructor, {
  foo: sinon.stub().returnsThis(),
});

эквивалентно:

var stub = sinon.createStubInstance(MyConstructor);
stub.foo.returnsThis();

Если предоставленное значение не является заглушкой, оно будет использоваться в качестве возвращаемого значения:

var stub = sinon.createStubInstance(MyConstructor, {
  foo: 3,
});

эквивалентно:

var stub = sinon.createStubInstance(MyConstructor);
stub.foo.returns(3);

`stub.withArgs(arg1[, arg2, ...]);`

Заглушает метод только для указанных аргументов.

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

Использует глубокое сравнение для объектов и массивов. Используйте stub.withArgs(sinon.match.same(obj)) для строгого сравнения (см. сопоставители).

`stub.onCall(n);` Добавлен в v1.8

Определяет поведение заглушки при n-м вызове. Полезно для тестирования последовательных взаимодействий.

Существуют методы onFirstCall, onSecondCall, onThirdCall для более естественного чтения определений заглушки.

onCall может быть объединен со всеми методами определения поведения в этом разделе. В частности, он может быть использован вместе с withArgs.

Обратите внимание, как поведение заглушки для аргумента 42 возвращается к стандартному поведению, когда больше вызовов не определено.

`stub.onFirstCall();`

Псевдоним для stub.onCall(0);

`stub.onSecondCall();`

Псевдоним для stub.onCall(1);

`stub.onThirdCall();`

Псевдоним для stub.onCall(2);

`stub.reset();`

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

Это эквивалентно вызову stub.resetBehavior() и stub.resetHistory().

Обновлено в sinon@2.0.0

С sinon@5.0.0

Для удобства вы можете применить stub.reset() ко всем заглушкам, используя sinon.reset()

`stub.resetBehavior();`

Сбрасывает поведение заглушки до стандартного поведения

С sinon@5.0.0

Вы можете сбросить поведение всех заглушек, используя sinon.resetBehavior()

`stub.resetHistory();`

С sinon@2.0.0

Сбрасывает историю заглушки

С sinon@5.0.0

Вы можете сбросить историю всех заглушек, используя sinon.resetHistory()

`stub.callsFake(fakeFunction);`

Вызывает предоставленную fakeFunction при вызове.

`stub.returns(obj);`

Заставляет заглушку возвращать указанное значение.

`stub.returnsArg(index);`

Заставляет заглушку возвращать аргумент по указанному индексу.

stub.returnsArg(0); заставляет заглушку возвращать первый аргумент.

Если аргумент по указанному индексу недоступен, до sinon@6.1.2, будет возвращено значение undefined; начиная с sinon@6.1.2, будет выброшено исключение TypeError.

`stub.returnsThis();`

Заставляет заглушку возвращать своё значение this.

Полезно для заглушения jQuery-подобных API с плавным взаимодействием.

`stub.resolves(value);`

Заставляет заглушку возвращать Promise, который разрешается до предоставленного значения.

При создании Promise, sinon использует метод Promise.resolve. Вы ответственны за предоставление полифилла в средах, которые не предоставляют Promise. Библиотеку Promise можно переопределить, используя метод usingPromise.

С sinon@2.0.0

`stub.resolvesArg(index);`

Заставляет заглушку возвращать Promise, который разрешается до аргумента по указанному индексу.

stub.resolvesArg(0); заставляет заглушку возвращать Promise, который разрешается до первого аргумента.

Если аргумент по указанному индексу недоступен, будет выброшено исключение TypeError.

С sinon@6.1.1

`stub.throws();`

Заставляет заглушку выбрасывать исключение (Error).

`stub.throws("name"[, "optional message"]);`

Заставляет заглушку выбрасывать исключение со свойством name, установленным на указанную строку. Параметр message необязателен и установит свойство message исключения.

`stub.throws(obj);`

Заставляет заглушку выбрасывать предоставленный объект исключения.

`stub.throws(function() { return new Error(); });`

Заставляет заглушку выбрасывать исключение, возвращаемое функцией.

`stub.throwsArg(index);`

Заставляет заглушку выбрасывать аргумент по указанному индексу.

stub.throwsArg(0); заставляет заглушку выбрасывать первый аргумент как исключение.

Если аргумент по указанному индексу недоступен, будет выброшено исключение TypeError.

С sinon@2.3.0

`stub.rejects();`

Заставляет заглушку возвращать Promise, который отклоняется с исключением (Error).

При создании Promise, sinon использует метод Promise.reject. Вы ответственны за предоставление полифилла в средах, которые не предоставляют Promise. Библиотеку Promise можно переопределить, используя метод usingPromise.

С sinon@2.0.0

`stub.rejects("TypeError");`

Заставляет заглушку возвращать Promise, который отклоняется с исключением указанного типа.

С sinon@2.0.0

`stub.rejects(value);`

Заставляет заглушку возвращать Promise, который отклоняется с предоставленным объектом исключения.

С sinon@2.0.0

`stub.callsArg(index);`

Заставляет заглушку вызвать аргумент по указанному индексу как функцию обратного вызова.

stub.callsArg(0); заставляет заглушку вызвать первый аргумент как обратный вызов.

Если аргумент по указанному индексу недоступен или не является функцией, будет выброшено исключение TypeError.

`stub.callThrough();`

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

`stub.callThroughWithNew();`

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

`stub.callsArgOn(index, context);`

Как stub.callsArg(index); , но с дополнительным параметром для передачи контекста this.

`stub.callsArgWith(index, arg1, arg2, ...);`

Как callsArg, но с аргументами для передачи в обратный вызов.

`stub.callsArgOnWith(index, context, arg1, arg2, ...);`

Как выше, но с дополнительным параметром для передачи контекста this.

`stub.usingPromise(promiseLibrary);`

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

С sinon@2.0.0

`stub.yields([arg1, arg2, ...])`

Подобно callsArg.

Заставляет заглушку вызвать первый полученный обратный вызов с предоставленными аргументами (если таковые имеются).

Если метод принимает более одного обратного вызова, вам нужно использовать yieldsRight для вызова последнего обратного вызова или callsArg для того, чтобы заглушка вызывала обратные вызовы, отличные от первого или последнего.

`stub.yieldsRight([arg1, arg2, ...])`

Подобно yields , но вызывает последний полученный обратный вызов.

`stub.yieldsOn(context, [arg1, arg2, ...])`

Как yields, но с дополнительным параметром для передачи контекста this.

`stub.yieldsTo(property, [arg1, arg2, ...])`

Приводит к вызову шпиона обратного вызова, переданного как свойство объекта шпионu.

Подобно yields, yieldsTo получает первый соответствующий аргумент, находит обратный вызов и вызывает его с (необязательными) аргументами.

"test should fake successful ajax request": function () {
    sinon.stub(jQuery, "ajax").yieldsTo("success", [1, 2, 3]);

    jQuery.ajax({
        success: function (data) {
            assertEquals([1, 2, 3], data);
        }
    });
}

`stub.yieldsToOn(property, context, [arg1, arg2, ...])`

Как выше, но с дополнительным параметром для передачи контекста this.

`stub.yield([arg1, arg2, ...])`

Вызывает обратные вызовы, переданные к stub, с заданными аргументами.

Если фиктивная функция никогда не вызывалась с аргументом функцией, yield генерирует ошибку.

Возвращает массив со всеми значениями возврата обратных вызовов в порядке их вызова, если не возникает ошибка.

Также алиасируется как invokeCallback.

`stub.yieldTo(callback, [arg1, arg2, ...])`

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

Подобно yield, yieldTo получает первый соответствующий аргумент, находит обратный вызов и вызывает его с (необязательными) аргументами.

`stub.callArg(argNum)`

Как yield, но с явным номером аргумента, указывающим, какой обратный вызов вызвать.

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

"calling the last callback": function () {
    var callback = sinon.stub();
    callback(function () {
        console.log("Success!");
    }, function () {
        console.log("Oh noes!");
    });

    callback.callArg(1); // Logs "Oh noes!"
}

`stub.callArgWith(argNum, [arg1, arg2, ...])`

Как callArg, но с аргументами.

Асинхронные вызовы

То же самое, что и соответствующие им не-асинхронные аналоги, но с отложенным обратным вызовом после обработки всех инструкций в текущей стеке вызовов.

В среде Node обратный вызов откладывается с помощью process.nextTick.
В браузере обратный вызов откладывается с помощью setTimeout(callback, 0).

Дополнительная информация:

`stub.callsArgAsync(index);`

Асинхронная версия stub.callsArg(index). См. также Асинхронные вызовы.

`sinon.addBehavior(name, fn);`

Добавляет пользовательское поведение. Имя будет доступно в виде функции на фиктивных экземплярах, и для вас будет настроена механизм цепочки вызовов (например, нет необходимости возвращать что-либо из вашей функции, её возвращаемое значение будет проигнорировано). fn получит фейковый экземпляр в качестве первого аргумента, а затем аргументы пользователя.

`stub.get(getterFn)`

Заменяет новый геттер для этого фиктивного экземпляра.

`stub.set(setterFn)`

Определяет новый сеттер для этого фиктивного экземпляра.

`stub.value(newVal)`

Определяет новое значение для этого фиктивного экземпляра.

Вы можете восстановить значения, вызвав метод restore.

`stub.wrappedMethod`

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

Заглушки

Что такое заглушки?

Когда использовать заглушки?

Определение поведения заглушки при последовательных вызовах

API заглушек

Свойства

var stub = sinon.stub();

var stub = sinon.stub(object, "method");

var stub = sinon.stub(object, "method", func);

var stub = sinon.stub(obj);

stub.withArgs(arg1[, arg2, ...]);

stub.onCall(n); Добавлен в v1.8

stub.onFirstCall();

stub.onSecondCall();

stub.onThirdCall();

stub.reset();

stub.resetBehavior();

stub.resetHistory();

stub.callsFake(fakeFunction);

stub.returns(obj);

stub.returnsArg(index);

stub.returnsThis();

stub.resolves(value);

stub.resolvesArg(index);

stub.throws();

stub.throws("name"[, "optional message"]);

stub.throws(obj);

stub.throws(function() { return new Error(); });

stub.throwsArg(index);

stub.rejects();

stub.rejects("TypeError");

stub.rejects(value);

stub.callsArg(index);

stub.callThrough();

stub.callThroughWithNew();

stub.callsArgOn(index, context);

stub.callsArgWith(index, arg1, arg2, ...);

stub.callsArgOnWith(index, context, arg1, arg2, ...);

stub.usingPromise(promiseLibrary);

stub.yields([arg1, arg2, ...])

stub.yieldsRight([arg1, arg2, ...])

stub.yieldsOn(context, [arg1, arg2, ...])

stub.yieldsTo(property, [arg1, arg2, ...])

stub.yieldsToOn(property, context, [arg1, arg2, ...])

stub.yield([arg1, arg2, ...])

stub.yieldTo(callback, [arg1, arg2, ...])

stub.callArg(argNum)

stub.callArgWith(argNum, [arg1, arg2, ...])

Асинхронные вызовы

stub.callsArgAsync(index);

stub.callsArgOnAsync(index, context);

stub.callsArgWithAsync(index, arg1, arg2, ...);

stub.callsArgOnWithAsync(index, context, arg1, arg2, ...);

stub.yieldsAsync([arg1, arg2, ...]);

stub.yieldsOnAsync(context, [arg1, arg2, ...]);

stub.yieldsToAsync(property, [arg1, arg2, ...]);

stub.yieldsToOnAsync(property, context, [arg1, arg2, ...])

sinon.addBehavior(name, fn);

stub.get(getterFn)

stub.set(setterFn)

stub.value(newVal)

stub.wrappedMethod

`var stub = sinon.stub();`

`var stub = sinon.stub(object, "method");`

`var stub = sinon.stub(object, "method", func);`

`var stub = sinon.stub(obj);`

`stub.withArgs(arg1[, arg2, ...]);`

`stub.onCall(n);` Добавлен в v1.8

`stub.onFirstCall();`

`stub.onSecondCall();`

`stub.onThirdCall();`

`stub.reset();`

`stub.resetBehavior();`

`stub.resetHistory();`

`stub.callsFake(fakeFunction);`

`stub.returns(obj);`

`stub.returnsArg(index);`

`stub.returnsThis();`

`stub.resolves(value);`

`stub.resolvesArg(index);`

`stub.throws();`

`stub.throws("name"[, "optional message"]);`

`stub.throws(obj);`

`stub.throws(function() { return new Error(); });`

`stub.throwsArg(index);`

`stub.rejects();`

`stub.rejects("TypeError");`

`stub.rejects(value);`

`stub.callsArg(index);`

`stub.callThrough();`

`stub.callThroughWithNew();`

`stub.callsArgOn(index, context);`

`stub.callsArgWith(index, arg1, arg2, ...);`

`stub.callsArgOnWith(index, context, arg1, arg2, ...);`

`stub.usingPromise(promiseLibrary);`

`stub.yields([arg1, arg2, ...])`

`stub.yieldsRight([arg1, arg2, ...])`

`stub.yieldsOn(context, [arg1, arg2, ...])`

`stub.yieldsTo(property, [arg1, arg2, ...])`

`stub.yieldsToOn(property, context, [arg1, arg2, ...])`

`stub.yield([arg1, arg2, ...])`

`stub.yieldTo(callback, [arg1, arg2, ...])`

`stub.callArg(argNum)`

`stub.callArgWith(argNum, [arg1, arg2, ...])`

`stub.callsArgAsync(index);`

`stub.callsArgOnAsync(index, context);`

`stub.callsArgWithAsync(index, arg1, arg2, ...);`

`stub.callsArgOnWithAsync(index, context, arg1, arg2, ...);`

`stub.yieldsAsync([arg1, arg2, ...]);`

`stub.yieldsOnAsync(context, [arg1, arg2, ...]);`

`stub.yieldsToAsync(property, [arg1, arg2, ...]);`

`stub.yieldsToOnAsync(property, context, [arg1, arg2, ...])`

`sinon.addBehavior(name, fn);`

`stub.get(getterFn)`

`stub.set(setterFn)`

`stub.value(newVal)`

`stub.wrappedMethod`