Заглушки

Введение

fake была введена в Sinon с v5. Она упрощает и объединяет концепции из spies и stubs.

В Sinon, fake — это Function которая записывает аргументы, возвращаемое значение, значение this и брошенное исключение (если таковое имеется) для всех её вызовов.

Она может быть создана с поведением или без него; она может обернуть существующую функцию.

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

В отличие от sinon.spy и sinon.stub методов, API sinon.fake знает только как создавать заглушки и не занимается их подключением в тестируемую систему. Для подключения заглушек к тестируемой системе можно использовать методы sinon.replace*.

Создание заглушки

// create a basic fake, with no behavior
var fake = sinon.fake();

fake();

console.log(fake.callCount);
// 1

Заглушки с поведением

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

sinon.fake.returns(value);

Создаёт заглушку, которая возвращает value аргумент.

var fake = sinon.fake.returns('apple pie');

fake();
// apple pie

sinon.fake.throws(value);

Создаёт заглушку, которая бросает Error со значением, переданным в качестве свойства message.

Если в качестве аргумента Error передано значение, то это значение будет значением брошенного исключения. Если передано любое другое значение, оно будет использовано в качестве свойства message брошенного Error.

var fake = sinon.fake.throws(new Error('not apple pie'));

fake();
// Error: not apple pie

sinon.fake.resolves(value);

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

sinon.fake.rejects(value);

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

Если в качестве аргумента Error передано значение, то это значение будет значением обещания. Если передано любое другое значение, оно будет использовано в качестве свойства message Error возвращаемого обещанием.

sinon.fake.yields(callback[, value1, ..., valueN]);

fake ожидает, что последний аргумент будет коллбэком и вызовет его с предоставленными аргументами.

var fake = sinon.fake.yields('hello world');

fake(console.log);
// hello world

sinon.fake.yieldsAsync(callback[, value1, ..., valueN]);

fake ожидает, что последний аргумент будет коллбэком и вызовет его асинхронно с предоставленными аргументами.

var fake = sinon.fake.yieldsAsync('hello world');

fake(console.log);
// hello world

sinon.fake(func);

Оборачивает существующую Function для записи всех взаимодействий, оставив предоставление поведения самой func.

Это полезно, когда требуется сложное поведение, не охваченное методами sinon.fake.*, или при обёртке существующей функции или метода.

Свойства экземпляра

f.callback

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

var f = sinon.fake();
var cb1 = function () {};
var cb2 = function () {};

f(1, 2, 3, cb1);
f(1, 2, 3, cb2);

f.callback === cb2;
// true

Такая же удобство добавлена к вызовам шпионов:

f.getCall(1).callback === cb2;
// true
//
f.lastCall.callback === cb2;
// true

f.lastArg

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

var f = sinon.fake();
var date1 = new Date();
var date2 = new Date();

f(1, 2, date1);
f(1, 2, date2);

f.lastArg === date2;
// true

Такая же удобство добавлена к вызовам шпионов:

f.getCall(0).lastArg === date1;
// true
f.getCall(1).lastArg === date2;
// true

f.lastCall.lastArg === date2;
// true

Добавление заглушки в тестируемую систему

В отличие от sinon.spy и sinon.stub, sinon.fake знает только о создании заглушек, а не о замене свойств в тестируемой системе.

Для замены свойства можно использовать метод sinon.replace.

var fake = sinon.fake.returns('42');

sinon.replace(console, 'log', fake);

console.log('apple pie');
// 42

Когда вам нужно восстановить изменённые свойства, просто вызовите метод sinon.restore.

// restores all replaced properties set by sinon methods (replace, spy, stub)
sinon.restore();