Моки

Введение

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

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

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

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

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

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

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

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

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

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

Ожидания реализуют как 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 хранит только один набор аргументов, указанный с помощью withExactArgs. Последующие вызовы перезапишут ранее указанный набор аргументов (даже если они разные), поэтому, как правило, не предполагается, что этот метод будет вызван более одного раза в одном тесте.

expectation.on(obj);

Ожидать, что метод будет вызван с obj в качестве %%%CODE_BLOCK_29%%.”}

expectation.verify();

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