存根设置超时函数

2022-08-18 00:00:00 unit-testing node.js javascript sinon

我有一个函数WAIT

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

我这样调用此等待:await wait(5000);来自另一个函数。

我正在编写单元测试用例,它始终执行等待,每个测试用例都等待5秒。

如何使用sinon将setTimeout存根?

我已尝试:

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

但它没有起作用。


解决方案

相关帖子:setTimeout not triggered while using Sinon's fake timers

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

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

  1. 考虑您的测试用例是否需要5000毫秒的延迟。

单元测试应该测试代码逻辑,而不是集成测试。因此,您可能只需要做一个断言检查wait函数是用参数调用的。这就够了。我们不需要在测试用例中等待5000ms的延迟。

  1. 如果您坚持要使用sinon.useFakeTimers()clock.tick(5000)

在相关帖子中,我们可以这样做:

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)

相关文章