异步函数的行为不像我对 Jest 的预期那样

Question

Javascript Jest 测试框架documentation 说我需要在我的回调中添加done() 来测试异步函数，否则测试完成后函数会返回，所以测试会失败。我已将 Jest 添加到我的 package.json 中，以及以下两个文件：

src.js:

function fetchData(cb) {
  setTimeout(cb, 2000, 'peanut butter')
}

module.exports = fetchData

src.test.js:

const fetchData = require('./src')

test('the data is peanut butter', () => {
  function callback(data) {
    expect(data).toBe('peanut butter')
    // no done() method!
  }

  fetchData(callback);
})

我使用上面的代码通过了测试，但我认为我的测试应该失败，因为我的测试文件中没有done()。我的fetchData() 方法不是异步的吗？

---

编辑：按照 Nicholas 的回答，我将代码更改为：

src.js:

function fetchData(cb) {
  setTimeout(cb, 2000, 'peanut')
}

module.exports = fetchData

src.test.js:

const fetchData = require('./src')

test('the data is peanut butter', () => {
  function callback(data) {
    expect(data).toBe('peanut butter')
    done()
  }

  fetchData(callback);
})

测试运行者应根据 Jest 文档评估期望/断言并失败（花生通过，花生酱预期），但仍显示通过测试。

此外，Jest 文档说：

If done() is never called, the test will fail, which is what you want to happen

测试在回调中有和没有 done() 方法的情况下，以及在有和没有传递给回调的正确 (peanut butter) 参数的情况下都通过（即所有四个变体都通过）。

Answer 1

如果您不将done 作为参数传递，则测试运行程序会认为代码是同步的并且不会等待特殊情况发生——在这种情况下会调用done。

因此，在您的断言/期望有机会运行之前，测试被标记为成功。

Answer 2

您的fetchData 本身是异步的，Jest 对此没有影响。另一方面，Jest 需要知道测试何时完成，通常是测试函数退出的时间，但这仅涵盖同步代码。在您的情况下，当您的测试函数退出时，您还没有调用任何断言，Jest 认为这是成功的（因为没有失败）。

为了证明没有调用任何断言，我将使用expect.assertions(number) 仅在它完全调用number 断言的情况下通过测试。例如，如果您在示例中将其设置为 1：

test('the data is peanut butter', () => {
  // Require exactly 1 assertion to pass the test
  expect.assertions(1)

  function callback(data) {
    expect(data).toBe('peanut butter')
  }

  fetchData(callback)
})

你会看到错误信息：

● the data is peanut butter

  expect.assertions(1)

  Expected one assertion to be called but received zero assertion calls.

如您所见，没有调用任何断言。除了演示目的之外，您还可以使用expect.assertions 来确保在未调用断言时您的测试失败。

对于任何异步任务，您需要让 Jest 知道测试是异步的，并且您需要在测试完成时通知 Jest。一种方法是使用done 回调。当您的测试函数接受一个参数（通常称为done）时，Jest 会将其视为异步测试并等待直到您调用done() 回调，或达到超时阈值（默认值：5s）。在您编辑的示例中，您的函数采用零参数，并且您对 done() 的调用不是 Jest 的回调。

test('done callback', done => {
  //                  ^^^^ 1 argument
  // Jest waits until this callback is called or the timeout was reached.
  // ...
})

test('no callback argument', () => {
  //                         ^^ no argument
  // Test finishes as soon as the function exits
  // ...
})

这已经很少使用了，因为 Promise 现在更常见了，它们使这变得更简单，因为你可以返回 Promise，Jest 将等待它的完成而无需任何额外的设置。此外，您可以使用 async 和 await 使其更加美观，因为它是 Promise 之上的语法糖。

另见Testing Asynchronous Code - Promises和Testing Asynchronous Code - Async/Await