Zenn
💈

vitestのskipIf/runIfを再利用できるようにする

2023/04/21に公開
JavaScript
TypeScript
Vitest
tech

vitestには、runIf/skipIfという機能がある

test.skipIf(process.env.NODE_ENV === "development")("only dev", () => {
  expect(1 + 2).toBe(3)
})

このように条件を指定して、実行するしないが決定される。

skipIf / runIfを再利用する

例えば遅いテストやDBを利用するテストなど、環境によって実行するしないを切り分けたいことは少なくない。

毎回定義するのも面倒なので、再利用できるようにしたい。

skipIfやrunIfはtestと同じものを返してくれるので、ただそれを定義すればよさそうだった。

const slowTest = test.skipIf(process.env.SKIP_SLOW_TEST || process.env.CI)

slowTest("slow test", () => {
  expect(1 + 2).toBe(3)
})

// DBのテストの実行を切り替えたいとき
const databaseTest = test.runIf(process.env.DATABASE_URL)

databaseTest("slow test", () => {
  expect(1 + 2).toBe(3)
})

ちなみにdescribeでも同様に利用可能

const describeSlow = describe.skipIf(process.env.SKIP_SLOW_TEST || process.env.CI)

describeSlow("xx", () => {
  test("yy", () => {
    expect(1 + 2).toBe(3)
  })
})
GitHubで編集を提案

Discussion