node.js unit Como faço para testar corretamente as promessas com mocha e chai?




test nodejs mocha (4)

O teste a seguir está se comportando de maneira estranha:

it('Should return the exchange rates for btc_ltc', function(done) {
    var pair = 'btc_ltc';

    shapeshift.getRate(pair)
        .then(function(data){
            expect(data.pair).to.equal(pair);
            expect(data.rate).to.have.length(400);
            done();
        })
        .catch(function(err){
            //this should really be `.catch` for a failed request, but
            //instead it looks like chai is picking this up when a test fails
            done(err);
        })
});

Como devo lidar adequadamente com uma promessa rejeitada (e testá-la)?

Como devo lidar corretamente com um teste com falha (por exemplo: expect(data.rate).to.have.length(400);

Aqui está a implementação que estou testando:

var requestp = require('request-promise');
var shapeshift = module.exports = {};
var url = 'http://shapeshift.io';

shapeshift.getRate = function(pair){
    return requestp({
        url: url + '/rate/' + pair,
        json: true
    });
};

A coisa mais fácil de fazer seria usar o suporte embutido de promessas que o Mocha tem em versões recentes:

it('Should return the exchange rates for btc_ltc', function() { // no done
    var pair = 'btc_ltc';
    // note the return
    return shapeshift.getRate(pair).then(function(data){
        expect(data.pair).to.equal(pair);
        expect(data.rate).to.have.length(400);
    });// no catch, it'll figure it out since the promise is rejected
});

Ou com o nó moderno e async / await:

it('Should return the exchange rates for btc_ltc', async () => { // no done
    const pair = 'btc_ltc';
    const data = await shapeshift.getRate(pair);
    expect(data.pair).to.equal(pair);
    expect(data.rate).to.have.length(400);
});

Como essa abordagem é promete de ponta a ponta, é mais fácil testar e você não terá que pensar nos casos estranhos em que está pensando, como as chamadas raras done() todos os lugares.

Esta é uma vantagem que o Mocha tem sobre outras bibliotecas como o Jasmine no momento. Você também pode querer verificar o Chai As Promised, o que tornaria ainda mais fácil (no. .then ), mas pessoalmente eu prefiro a clareza e simplicidade da versão atual


Aqui está minha opinião:

  • usando async/await
  • não precisando de módulos chai extras
  • evitando a questão das capturas, @TheCrazyProgrammer apontado acima

Uma função de promessa atrasada, que falha, se for dado um atraso de 0:

const timeoutPromise = (time) => {
    return new Promise((resolve, reject) => {
        if (time === 0)
            reject({ 'message': 'invalid time 0' })
        setTimeout(() => resolve('done', time))
    })
}

//                     ↓ ↓ ↓
it('promise selftest', async () => {

    // positive test
    let r = await timeoutPromise(500)
    assert.equal(r, 'done')

    // negative test
    try {
        await timeoutPromise(0)
        // a failing assert here is a bad idea, since it would lead into the catch clause…
    } catch (err) {
        // optional, check for specific error (or error.type, error. message to contain …)
        assert.deepEqual(err, { 'message': 'invalid time 0' })
        return  // this is important
    }
    assert.isOk(false, 'timeOut must throw')
    log('last')
})

O teste positivo é bastante simples. Falha inesperada (simulação de 500→0 ) falhará no teste automaticamente, conforme a promessa rejeitada aumenta.

Teste negativo usa a ideia try-catch. No entanto: 'reclamar' sobre um passe indesejado acontece somente após a cláusula catch (assim, ele não acaba na cláusula catch (), provocando erros adicionais, mas enganosos.

Para que essa estratégia funcione, é preciso retornar o teste da cláusula catch. Se você não quiser testar mais nada, use outro () - bloco.


Tehre é uma solução melhor. Apenas retorne o erro com um bloco catch.

// ...

it('fail', (done) => {
  // any async call that will return a Promise 
  ajaxJson({})
  .then((req) => {
    expect(1).to.equal(11); //this will throw a error
    done(); //this will resove the test if there is no error
  }).catch((e) => {
    done(e); //this will catch the thrown error
  }); 
});

este teste falhará com a seguinte mensagem: AssertionError: expected 1 to equal 11


Como já foi mencionado here , as versões mais recentes do Mocha já são conscientes da Promise. Mas como o OP perguntou especificamente sobre Chai, é justo apontar o pacote chai-as-promised que fornece uma sintaxe limpa para testar promessas:

usando chai como prometido

Veja como você pode usar o chai-as-promised para testar os casos de resolve e reject de uma promessa:

var chai = require('chai');
var expect = chai.expect;
var chaiAsPromised = require("chai-as-promised");
chai.use(chaiAsPromised);

...

it('resolves as promised', function() {
    return expect(Promise.resolve('woof')).to.eventually.equal('woof');
});

it('rejects as promised', function() {
    return expect(Promise.reject('caw')).to.be.rejectedWith('caw');
});

sem chai como prometido

Para deixar bem claro o que está sendo testado, aqui está o mesmo exemplo codificado sem o chai-as-promised:

it('resolves as promised', function() {
    return Promise.resolve("woof")
        .then(function(m) { expect(m).to.equal('woof'); })
        .catch(function(m) { throw new Error('was not supposed to fail'); })
            ;
});

it('rejects as promised', function() {
    return Promise.reject("caw")
        .then(function(m) { throw new Error('was not supposed to succeed'); })
        .catch(function(m) { expect(m).to.equal('caw'); })
            ;
});






chai