存根 setTimeout 函数

Question

我有一个函数等待

async function wait(time) {
  return new Promise((resolve) => setTimeout(resolve, time));
}

我这样称呼等待：await wait(5000); 来自不同的函数。

我在写单元测试用例，它总是执行wait，每个测试用例等待5s。

如何使用 Sinon 存根 setTimeout？

我试过了：

  // Skip setTimeOut
  clock = sinon.useFakeTimers({
    now: Date.now(),
    toFake: ['setTimeout']
  });
  await clock.tickAsync(4000);
  await Promise.resolve();

但是没有用。

Answer 1

相关post：

Github 问题：https://github.com/sinonjs/fake-timers/issues/194#issuecomment-395224370

您可以通过两种方式解决这个问题。

考虑一下你的测试用例是否需要5000ms的延迟。

单元测试应该测试代码逻辑，而不是集成测试。所以，也许你只需要做一个断言检查 wait 函数是用参数调用的。够了。我们不需要在测试用例中等待5000ms的延迟。

如果你坚持要用sinon.useFakeTimers()和clock.tick(5000).

根据相关的post，我们可以这样做：

index.ts:

async function wait(time: number, clock?) {
  return new Promise((resolve) => {
    setTimeout(resolve, time);
    clock && clock.tick(time);
  });
}

export async function main(time, /* for testing */ clock?) {
  await wait(time, clock);
  console.log('main');
}

index.test.ts:

import { main } from './';
import sinon, { SinonFakeTimers } from 'sinon';

describe('60617715', () => {
  let clock: SinonFakeTimers;
  beforeEach(() => {
    clock = sinon.useFakeTimers();
  });
  afterEach(() => {
    clock.restore();
  });
  it('should pass', async () => {
    await main(5000, clock);
  });
});

单元测试结果：

  60617715
main
    ✓ should pass


  1 passing (9ms)

存根 setTimeout 函数

stub setTimeout function

javascript

unit-testing

node.js

sinon