Моки

Введение

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

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

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

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

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

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

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

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

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

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

Ожидания реализуют как шпионы, так и стабы 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();

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

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

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

Ожидания

Все методы ожидания возвращают ожидание, что означает возможность их объединения.

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

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_25%%.

expectation.verify();

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