Моки

Введение

Что такое моки?

Моки (и ожидания моков) — это фейковые методы (как шпионы) с запрограммированным поведением (как стабы), а также с **запрограммированными ожиданиями**.

Мок не пройдёт ваш тест, если он не будет использован как ожидалось.

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

Моки следует использовать только для метода, который тестируется. В каждом юнит-тесте должен быть один тестируемый элемент.

Если вы хотите контролировать, как используется ваш элемент, и хотите указать ожидания заранее (в отличие от проверки после факта), используйте мок.

Когда **не** использовать моки?

Моки имеют встроенные ожидания, которые могут не пройти ваш тест.

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

В общем случае вы должны иметь **не более одного** мока (возможно, с несколькими ожиданиями) в одном тесте.

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

Чтобы увидеть, как выглядят моки в Sinon.JS, вот один из тестов PubSubJS, на этот раз с использованием метода в качестве обратного вызова и с использованием моков для проверки его поведения

"test should call all subscribers when exceptions": function () {
    var myAPI = { method: function () {} };

    var spy = sinon.spy();
    var mock = sinon.mock(myAPI);
    mock.expects("method").once().throws();

    PubSub.subscribe("message", myAPI.method);
    PubSub.subscribe("message", spy);
    PubSub.publishSync("message", undefined);

    mock.verify();
    assert(spy.calledOnce);
}

API моков

Свойства

var mock = sinon.mock(obj);

Создаёт мок для предоставленного объекта.

Не изменяет объект, но возвращает объект мока для установки ожиданий для методов объекта.

var expectation = mock.expects("method");

Переопределяет obj.method с фейковой функцией и возвращает её.

См. ожидания ниже.

mock.restore();

Восстанавливает все смоделированные методы.

mock.verify();

Проверяет все ожидания мока.

Если какое-либо ожидание не выполняется, генерируется исключение.

Также восстанавливает смоделированные методы.

mock.usingPromise(promiseLibrary);

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

С sinon@6.2.0

Ожидания

Все методы ожидания возвращают ожидание, что означает возможность их цепочечного использования.

Типичное использование:

sinon.mock(jQuery).expects("ajax").atLeast(2).atMost(5);
jQuery.ajax.verify();

var expectation = sinon.expectation.create([methodName]);

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

Имя метода необязательно и используется в сообщениях об ошибках для повышения их удобочитаемости.

var expectation = sinon.mock([methodName]);

То же самое, что и выше.

expectation.atLeast(number);

Указывает минимальное количество ожидаемых вызовов.

expectation.atMost(number);

Указывает максимальное количество ожидаемых вызовов.

expectation.never();

Ожидается, что метод никогда не будет вызван.

expectation.once();

Ожидается, что метод будет вызван ровно один раз.

expectation.twice();

Ожидается, что метод будет вызван ровно дважды.

expectation.thrice();

Ожидается, что метод будет вызван ровно трижды.

expectation.exactly(number);

Ожидается, что метод будет вызван ровно number раз.

expectation.withArgs(arg1, arg2, ...);

Ожидается, что метод будет вызван с предоставленными аргументами и, возможно, с другими.

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

expectation.withExactArgs(arg1, arg2, ...);

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

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

expectation.on(obj);

Ожидается, что метод будет вызван с obj как this.

expectation.verify();

Проверяет ожидание и выбрасывает исключение, если оно не выполняется.