feat: test.skipIf and test.runIf apis

antfu · antfu · commit 76c389497ccf · 2022-05-02T23:48:14.000+08:00
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -46,6 +46,40 @@ In Jest, `TestFunction` can also be of type `(done: DoneCallback) => void`. If t
   })
   ```
 
+### test.skipIf
+
+- **Type:** `(condition: any) => Test`
+- **Alias:** `it.skipIf`
+
+  In some cases you might run tests multiple times with different environments, and some of the tests might be environment-specific. Instead of wrapping the test code with `if`, you can use `test.skipIf` to skip the test whenever the condition is truthy.
+
+  ```ts
+  import { assert, test } from 'vitest'
+  
+  const isDev = process.env.NODE_ENV === 'development'
+
+  test.skipIf(isDev)('prod only test', () => {
+    // this test only runs in production
+  })
+  ```
+
+### test.runIf
+
+- **Type:** `(condition: any) => Test`
+- **Alias:** `it.runIf`
+
+  Oppsit of [test.skipIf](#testskipif).
+
+  ```ts
+  import { assert, test } from 'vitest'
+  
+  const isDev = process.env.NODE_ENV === 'development'
+
+  test.runIf(isDev)('dev only test', () => {
+    // this test only runs in development
+  })
+  ```
+
 ### test.only
 
 - **Type:** `(name: string, fn: TestFunction, timeout?: number) => void`
diff --git a/packages/vitest/src/runtime/suite.ts b/packages/vitest/src/runtime/suite.ts
@@ -173,10 +173,20 @@ function createSuite() {
     }
   }
 
-  return suite as SuiteAPI
+  suite.skipIf = (condition: any) => (condition ? suite.skip : suite) as SuiteAPI
+  suite.runIf = (condition: any) => (condition ? suite : suite.skip) as SuiteAPI
+
+  return suite
 }
 
-function createTest(fn: ((this: Record<'concurrent' | 'skip' | 'only' | 'todo' | 'fails', boolean | undefined>, title: string, fn?: TestFunction, timeout?: number) => void)) {
+function createTest(fn: (
+  (
+    this: Record<'concurrent' | 'skip' | 'only' | 'todo' | 'fails', boolean | undefined>,
+    title: string,
+    fn?: TestFunction,
+    timeout?: number
+  ) => void
+)) {
   const test = createChainable(
     ['concurrent', 'skip', 'only', 'todo', 'fails'],
     fn,
@@ -191,5 +201,8 @@ function createTest(fn: ((this: Record<'concurrent' | 'skip' | 'only' | 'todo' |
     }
   }
 
+  test.skipIf = (condition: any) => (condition ? test.skip : test) as TestAPI
+  test.runIf = (condition: any) => (condition ? test : test.skip) as TestAPI
+
   return test as TestAPI
 }
diff --git a/packages/vitest/src/types/tasks.ts b/packages/vitest/src/types/tasks.ts
@@ -104,13 +104,21 @@ export type TestAPI<ExtraContext = {}> = ChainableFunction<
 'concurrent' | 'only' | 'skip' | 'todo' | 'fails',
 [name: string, fn?: TestFunction<ExtraContext>, timeout?: number],
 void
-> & { each: EachFunction }
+> & {
+  each: EachFunction
+  skipIf(condition: any): TestAPI<ExtraContext>
+  runIf(condition: any): TestAPI<ExtraContext>
+}
 
 export type SuiteAPI<ExtraContext = {}> = ChainableFunction<
 'concurrent' | 'only' | 'skip' | 'todo',
 [name: string, factory?: SuiteFactory],
 SuiteCollector<ExtraContext>
-> & { each: EachFunction }
+> & {
+  each: EachFunction
+  skipIf(condition: any): SuiteAPI<ExtraContext>
+  runIf(condition: any): SuiteAPI<ExtraContext>
+}
 
 export type HookListener<T extends any[], Return = void> = (...args: T) => Awaitable<Return | void>
 
diff --git a/test/core/test/basic.test.ts b/test/core/test/basic.test.ts
@@ -57,3 +57,18 @@ it('timeout', () => new Promise(resolve => setTimeout(resolve, timeout)))
 it.fails('deprecated done callback', (done) => {
   done()
 })
+
+const shouldSkip = true
+
+it.skipIf(shouldSkip)('skipped', () => {
+  throw new Error('foo')
+})
+it.skipIf(!shouldSkip)('not skipped', () => {
+  expect(1).toBe(1)
+})
+it.runIf(!shouldSkip)('skipped 2', () => {
+  throw new Error('foo')
+})
+it.runIf(shouldSkip)('not skipped 2', () => {
+  expect(1).toBe(1)
+})

Original file line number	Diff line number	Diff line change
`@@ -173,10 +173,20 @@ function createSuite() {`
`173`	`173`	`}`
`174`	`174`	`}`
`175`	`175`
`176`		`- return suite as SuiteAPI`
	`176`	`+ suite.skipIf = (condition: any) => (condition ? suite.skip : suite) as SuiteAPI`
	`177`	`+ suite.runIf = (condition: any) => (condition ? suite : suite.skip) as SuiteAPI`
	`178`	`+`
	`179`	`+ return suite`
`177`	`180`	`}`
`178`	`181`
`179`		`-function createTest(fn: ((this: Record<'concurrent' \| 'skip' \| 'only' \| 'todo' \| 'fails', boolean \| undefined>, title: string, fn?: TestFunction, timeout?: number) => void)) {`
	`182`	`+function createTest(fn: (`
	`183`	`+ (`
	`184`	`+ this: Record<'concurrent' \| 'skip' \| 'only' \| 'todo' \| 'fails', boolean \| undefined>,`
	`185`	`+ title: string,`
	`186`	`+ fn?: TestFunction,`
	`187`	`+ timeout?: number`
	`188`	`+ ) => void`
	`189`	`+)) {`
`180`	`190`	`const test = createChainable(`
`181`	`191`	`['concurrent', 'skip', 'only', 'todo', 'fails'],`
`182`	`192`	`fn,`
`@@ -191,5 +201,8 @@ function createTest(fn: ((this: Record<'concurrent' \| 'skip' \| 'only' \| 'todo' \|`
`191`	`201`	`}`
`192`	`202`	`}`
`193`	`203`
	`204`	`+ test.skipIf = (condition: any) => (condition ? test.skip : test) as TestAPI`
	`205`	`+ test.runIf = (condition: any) => (condition ? test : test.skip) as TestAPI`
	`206`	`+`
`194`	`207`	`return test as TestAPI`
`195`	`208`	`}`