Обещания в модульных тестах JavaScript: полное руководство

Использование в eventually.become Вы можете использовать его для большинства сравнений на равенство с обещаниями — со строками, числами и т. Д. — если только вам не требуется сравнительное сравнение.

Утверждение против определенного свойства от объекта

Иногда вам может потребоваться проверить только одно свойство объекта из обещания. Вот один из способов сделать это:

 var value = systemUnderTest();

return value.then(function(obj) {
  expect(obj.someProp).to.equal('something');
});- var value = systemUnderTest().then(function(obj) {
  return obj.someProp;
});

return expect(value).to.eventually.equal('something');

Но, как и было обещано, есть альтернативный путь. Мы можем использовать тот факт, что вы можете связать обещания:

 var value = systemUnderTest()

return expect(value.then(o => o.someProp)).to.eventually.equal('something');

В качестве последней альтернативы, если вы используете ECMAScript 2015, вы можете сделать его немного чище, используя синтаксис жирной стрелки:

 Promise.all

Несколько обещаний

Если у вас есть несколько обещаний в тестах, вы можете использовать return Promise.all([
expect(value1).to.become('foo'),
expect(value2).to.become('bar')
]);

 return Promise.all([p1, p2]).then(function(values) {
  expect(values[0]).to.equal(values[1]);
});

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

Сравнение нескольких обещаний

Если у вас есть два (или более) обещания, которые нужно сравнить, можно использовать следующий шаблон:

 all

Другими словами, мы можем использовать then

Утверждение о неудачах

Иногда вы можете захотеть проверить, что определенный вызов делает обещание не выполненным, а не успешным. В этих случаях вы можете использовать rejected

 return expect(value).to.be.rejected;

Если вы хотите, чтобы отклонение сопровождалось определенным типом ошибки или сообщения, вы также можете использовать rejectedWith

 //require this promise to be rejected with a TypeError
return expect(value).to.be.rejectedWith(TypeError);

//require this promise to be rejected with message 'holy smokes, Batman!'
return expect(value).to.be.rejectedWith('holy smokes, Batman!');

Тестовые крючки

Вы можете использовать обещания в тестовых хуках так же, как и в любой другой тестовой функции. Это работает с beforeafterbeforeEachafterEach Например:

 describe('something', function() {
  before(function() {
    return somethingThatReturnsAPromise();
  });

  beforeEach(function() {
    return somethingElseWithPromises();
  });
});

Они работают аналогично тому, как обещания работают в тестах. Если обещание будет отклонено, Мокко выдаст ошибку.

Обещания и издевательства / окурки

Наконец, давайте посмотрим, как использовать обещания с заглушками. Я использую Sinon.JS для примеров ниже. Для этого вам необходимо установить его, выполнив команду:

 npm install sinon

Возвращение обещаний от окурков

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

 var stub = sinon.stub();

//return a failing promise
stub.returns(Promise.reject('a failure'));

//or a successful promise
stub.returns(Promise.resolve('a success'));

Шпионить за обещаниями

Вы можете использовать шпионов в качестве обратных вызовов обещаний, как и другие функции, но это может оказаться бесполезным из-за асинхронности обещаний. Если вам нужно сделать утверждение против обещания, вам лучше сделать это, используя слово «как обещано».

 var spy = sinon.spy();
var promise = systemUnderTest();

promise.then(spy);

Sinon-в обещанном

Чтобы немного упростить окурки и обещания, мы можем использовать sinon-as-обещано. Может быть установлен через npm:

 npm install sinon-as-promised

Предоставляет вспомогательные функции, resolvesrejects

 var sinon = require('sinon');

//this makes sinon-as-promised available in sinon:
require('sinon-as-promised');

var stub = sinon.stub();

//return a failing promise
stub.rejects('a failure');

//or a successful promise
stub.resolves('a success');

Выводы

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

Встроенная поддержка обещаний Mocha в сочетании с Chai и chai-as-обещает упрощает тестирование кода, возвращающего обещание. Добавьте в смесь SinonJS и sinon-as-обещанный, и вы также можете легко их заглушить.

Помните одну важную вещь: при использовании обещаний в ваших тестах всегда возвращайте обещание из теста , иначе Mocha не узнает об этом, и ваш тест может молча провалиться, не сообщив вам об этом.

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