javascript - 有没有办法让 Chai 使用异步 Mocha 测试？

Question

我正在使用 Browser Runner 在 Mocha 中运行一些异步测试，并且我正在尝试使用 Chai 的期望样式断言：

window.expect = chai.expect;
describe('my test', function() {
  it('should do something', function (done) {
    setTimeout(function () {
      expect(true).to.equal(false);
    }, 100);
  }
}

这不会给我正常的失败断言消息，而是我得到：

Error: the string "Uncaught AssertionError: expected true to equal false" was thrown, throw an Error :)
    at Runner.fail (http://localhost:8000/tests/integration/mocha/vendor/mocha.js:3475:11)
    at Runner.uncaught (http://localhost:8000/tests/integration/mocha/vendor/mocha.js:3748:8)
    at uncaught (http://localhost:8000/tests/integration/mocha/vendor/mocha.js:3778:10)

所以它显然捕捉到了错误，只是没有正确显示它。任何想法如何做到这一点？我想我可以用一个错误对象调用“完成”，但是我失去了像 Chai 这样的东西的所有优雅，它变得非常笨重......

score 97 · Accepted Answer

您的异步测试会在失败的 ations 上生成一个异常，该异常expect()无法被捕获，it()因为该异常是在的范围之外引发it()的。

您看到显示的捕获异常是使用process.on('uncaughtException')节点下或window.onerror()在浏览器中捕获的。

要解决此问题，您需要在调用的异步函数中捕获异常setTimeout()，以便done()将异常作为第一个参数进行调用。您还需要done()不带参数调用以指示成功，否则 mocha 会报告超时错误，因为您的测试函数永远不会发出信号表明它已完成：

window.expect = chai.expect;

describe( 'my test', function() {
  it( 'should do something', function ( done ) {
    // done() is provided by it() to indicate asynchronous completion
    // call done() with no parameter to indicate that it() is done() and successful
    // or with an error to indicate that it() failed
    setTimeout( function () {
      // Called from the event loop, not it()
      // So only the event loop could capture uncaught exceptions from here
      try {
        expect( true ).to.equal( false );
        done(); // success: call done with no parameter to indicate that it() is done()
      } catch( e ) {
        done( e ); // failure: call done with an error Object to indicate that it() failed
      }
    }, 100 );
    // returns immediately after setting timeout
    // so it() can no longer catch exception happening asynchronously
  }
}

在所有测试用例上这样做很烦人，而且不是 DRY，因此您可能希望提供一个函数来为您执行此操作。让我们调用这个函数check()：

function check( done, f ) {
  try {
    f();
    done();
  } catch( e ) {
    done( e );
  }
}

现在check()，您可以按如下方式重写异步测试：

window.expect = chai.expect;

describe( 'my test', function() {
  it( 'should do something', function( done ) {
    setTimeout( function () {
      check( done, function() {
        expect( true ).to.equal( false );
      } );
    }, 100 );
  }
}

score 21 · Accepted Answer

这是我对 ES6/ES2015 Promise 和 ES7/ES2016 async/await 的通过测试。希望这为研究此主题的任何人提供了一个很好的更新答案：

import { expect } from 'chai'

describe('Mocha', () => {
  it('works synchronously', () => {
    expect(true).to.equal(true)
  })

  it('works ansyncronously', done => {
    setTimeout(() => {
      expect(true).to.equal(true)
      done()
    }, 4)
  })

  it('throws errors synchronously', () => {
    return true
    throw new Error('it works')
  })

  it('throws errors ansyncronously', done => {
    setTimeout(() => {
      return done()
      done(new Error('it works'))
    }, 4)
  })

  it('uses promises', () => {
    var testPromise = new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve('Hello')
      }, 4)
    })

    testPromise.then(result => {
      expect(result).to.equal('Hello')
    }, reason => {
      throw new Error(reason)
    })
  })

  it('uses es7 async/await', async (done) => {
    const testPromise = new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve('Hello')
      }, 4)
    })

    try {
      const result = await testPromise
      expect(result).to.equal('Hello')
      done()
    } catch(err) {
      done(err)
    }
  })

  /*
  *  Higher-order function for use with async/await (last test)
  */
  const mochaAsync = fn => {
    return async (done) => {
      try {
        await fn()
        done()
      } catch (err) {
        done(err)
      }
    }
  }

  it('uses a higher order function wrap around async', mochaAsync(async () => {
    const testPromise = new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve('Hello')
      }, 4)
    })

    expect(await testPromise).to.equal('Hello')
  }))
})

score 13 · Accepted Answer

如果你喜欢承诺，试试Chai 作为 Promised + Q，它允许这样的事情：

doSomethingAsync().should.eventually.equal("foo").notify(done);

score 2 · Accepted Answer

我在 Mocha 邮件列表中问过同样的问题。他们基本上告诉我：用 Mocha 和 Chai 编写异步测试：

始终以if (err) done(err);
始终以 . 结束测试done()。

它解决了我的问题，并且没有改变我中间的任何一行代码（Chai 期望等）。这setTimout不是进行异步测试的方法。

这是邮件列表中讨论的链接。

score 1 · Accepted Answer

我已经发布了一个解决这个问题的包。

首先安装check-chai软件包：

npm install --save check-chai

然后在您的测试中，使用chai.use(checkChai);然后使用chai.check辅助函数，如下所示：

var chai = require('chai');
var dirtyChai = require('dirty-chai');
var checkChai = require('check-chai');
var expect = chai.expect;
chai.use(dirtyChai);
chai.use(checkChai);

describe('test', function() {

  it('should do something', function(done) {

    // imagine you have some API call here
    // and it returns (err, res, body)
    var err = null;
    var res = {};
    var body = {};

    chai.check(done, function() {
      expect(err).to.be.a('null');
      expect(res).to.be.an('object');
      expect(body).to.be.an('object');
    });

  });

});

Per有没有办法让 Chai 使用异步 Mocha 测试？我将其作为 NPM 包发布。

请参阅https://github.com/niftylettuce/check-chai了解更多信息。

score 1 · Accepted Answer

试试 chaiAsPromised！除了出色的命名之外，您还可以使用以下语句：

expect(asyncToResultingValue()).to.eventually.equal(true)

可以确认，对于 Mocha + Chai 非常有效。

https://github.com/domenic/chai-as-promised

score 1 · Accepted Answer

与Jean Vincent 的回答非常相关并受到启发，我们使用了一个与他的函数类似的辅助函数check，但我们eventually改为调用它（这有助于它与 chai-as-promised 的命名约定相匹配）。它返回一个函数，该函数接受任意数量的参数并将它们传递给原始回调。这有助于消除测试中额外的嵌套函数块，并允许您处理任何类型的异步回调。这里是用 ES2015 编写的：

function eventually(done, fn) {
  return (...args) => {
    try {
      fn(...args);
      done();
    } catch (err) {
      done(err);
    }
  };
};

示例用法：

describe("my async test", function() {
  it("should fail", function(done) {
    setTimeout(eventually(done, (param1, param2) => {
      assert.equal(param1, "foo");   // this should pass
      assert.equal(param2, "bogus"); // this should fail
    }), 100, "foo", "bar");
  });
});

score 1 · Accepted Answer

我知道有很多重复的答案和建议的包来解决这个问题，但是我还没有看到上面的简单解决方案为这两个用例提供了一个简洁的模式。我将其发布为其他希望复制意大利面的综合答案：

事件回调

function expectEventCallback(done, fn) {
  return function() {
    try { fn(...arguments); }
    catch(error) { return done(error); }
    done();
  };
}

节点样式回调

function expectNodeCallback(done, fn) {
  return function(err, ...args) {
    if (err) { return done(err); }
    try { fn(...args); }
    catch(error) { return done(error); }
    done();
  };
}

示例用法

it('handles event callbacks', function(done) {
  something.on('event', expectEventCallback(done, (payload) => {
    expect(payload).to.have.propertry('foo');
  }));
});

it('handles node callbacks', function(done) {
  doSomething(expectNodeCallback(done, (payload) => {
    expect(payload).to.have.propertry('foo');
  }));
});

score 0 · Accepted Answer

我解决了它提取try/catch到一个函数。

function asyncExpect(test, done){
    try{
        test();
        done();
    } catch(error){
        done(error);
    }
}

然后在it()我打电话：

it('shall update a host', function (done) {
            testee.insertHost({_id: 'host_id'})
                .then(response => {
                    asyncExpect(() => {
                        expect(response).to.have.property('ok', 1);
                        expect(response).to.have.property('nModified', 1);
                    }, done);
                });

        });

它也是可调试的。

score 0 · Accepted Answer

基于@richardforrester http://staxmanade.com/2015/11/testing-asyncronous-code-with-mochajs-and-es7-async-await/提供的此链接，如果省略 done，describe 可以使用返回的 Promise范围。

唯一的缺点是那里必须有一个 Promise，而不是任何异步函数（你可以用 Promise 包装它）。但在这种情况下，代码可以大大减少。

它考虑了初始 funcThatReturnsAPromise 函数或期望中的失败：

it('should test Promises', function () { // <= done removed
    return testee.funcThatReturnsAPromise({'name': 'value'}) // <= return added
        .then(response => expect(response).to.have.property('ok', 1));
});

score 0 · Accepted Answer

测试和异步期间的计时器听起来很粗糙。有一种方法可以使用基于承诺的方法来做到这一点。

const sendFormResp = async (obj) => {
    const result = await web.chat.postMessage({
        text: 'Hello world!',
    });
   return result
}

此异步函数使用 Web 客户端（在本例中为 Slacks SDK）。SDK 负责 API 调用的异步特性并返回有效负载。然后，我们可以通过运行expect异步承诺中返回的对象来测试 chai 中的有效负载。

describe("Slack Logic For Working Demo Environment", function (done) {
    it("Should return an object", () => {
        return sdkLogic.sendFormResp(testModels.workingModel).then(res => {
            expect(res).to.be.a("Object");
        })
    })
});

score 0 · Accepted Answer

一种更简单的方法是使用等待期望库。

const waitForExpect = require("wait-for-expect")

test("it waits for the number to change", async () => {
  let numberToChange = 10;

  setTimeout(() => {
    numberToChange = 100;
  }, randomTimeout);

  await waitForExpect(() => {
    expect(numberToChange).toEqual(100);
  });
});

score -2 · Accepted Answer

对我来说非常有效的 icm Mocha / Chai 是来自 Sinon 图书馆的 fakeTimer。只需在必要时提前测试中的计时器。

var sinon = require('sinon');
clock = sinon.useFakeTimers();
// Do whatever. 
clock.tick( 30000 ); // Advances the JS clock 30 seconds.

具有更快完成测试的额外好处。

score -2 · Accepted Answer

您还可以使用域模块。例如：

var domain = require('domain').create();

domain.run(function()
{
    // place you code here
});

domain.on('error',function(error){
    // do something with error or simply print it
});

javascript - 有没有办法让 Chai 使用异步 Mocha 测试？

14 回答 14

事件回调

节点样式回调

示例用法

Related

Reference