180文字
1分
編集

VitestでsetTimeoutやsetIntervalなど時間が関与したコードのテストを記述する

#Vitest

#Fake Timer API

Vitest では、次のようにして時間を能動的にコントロールしたテストを記述することができる。

tsx
beforeEach(() => {
  vi.useFakeTimers();
});
afterEach(() => {
  vi.useRealTimers();
});
it("...", () => {
  // Arrange...
  // Act...
  vi.advanceTimersByTime(150);
  // Assert...
});

他にも多くのメソッドが提供されている。

https://vitest.dev/api/vi.html#fake-timers

#他のフレームワークにおける API

他のテストフレームワークでも同様の機能を提供しているものがある。

#Jest Timer Mocks

Vitest と同様の API が提供されている。

https://jestjs.io/ja/docs/timer-mocks

tsx
jest.useFakeTimers();
it("...", () => {
  // Arrange...
  // Act...
  jest.advanceTimersByTime(1000);
  // Assert...
});

#Playwright Clock API

Playwright では Clock API を利用することで時間を操作することが出来る。

https://playwright.dev/docs/api/class-clock

tsx
test("...", async ({ page }) => {
  // Arrange...
  await page.clock.install({ time: new Date("2001-01-01T00:00:00") });
  // Act...
  await page.clock.runFor("00:10");
  // Assert...
});
編集