-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
tasks.ts
237 lines (209 loc) · 6.92 KB
/
tasks.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
import type { Awaitable } from '@vitest/utils'
import type { ChainableFunction } from '../utils/chain'
import type { ErrorWithDiff } from '../utils/error'
export type RunMode = 'run' | 'skip' | 'only' | 'todo'
export type TaskState = RunMode | 'pass' | 'fail'
export interface TaskBase {
id: string
name: string
mode: RunMode
concurrent?: boolean
shuffle?: boolean
suite?: Suite
file?: File
result?: TaskResult
retry?: number
meta?: any
}
export interface TaskCustom extends TaskBase {
type: 'custom'
}
export interface TaskResult {
state: TaskState
duration?: number
startTime?: number
heap?: number
/**
* @deprecated Use "errors" instead
*/
error?: ErrorWithDiff
errors?: ErrorWithDiff[]
htmlError?: string
hooks?: Partial<Record<keyof SuiteHooks, TaskState>>
retryCount?: number
}
export type TaskResultPack = [id: string, result: TaskResult | undefined]
export interface Suite extends TaskBase {
type: 'suite'
tasks: Task[]
filepath?: string
projectName?: string
}
export interface File extends Suite {
filepath: string
collectDuration?: number
setupDuration?: number
}
export interface Test<ExtraContext = {}> extends TaskBase {
type: 'test'
suite: Suite
result?: TaskResult
fails?: boolean
context: TestContext & ExtraContext
onFailed?: OnTestFailedHandler[]
/**
* Store promises (from async expects) to wait for them before finishing the test
*/
promises?: Promise<any>[]
}
export type Task = Test | Suite | TaskCustom | File
export type DoneCallback = (error?: any) => void
export type TestFunction<ExtraContext = {}> = (context: TestContext & ExtraContext) => Awaitable<any> | void
// jest's ExtractEachCallbackArgs
type ExtractEachCallbackArgs<T extends ReadonlyArray<any>> = {
1: [T[0]]
2: [T[0], T[1]]
3: [T[0], T[1], T[2]]
4: [T[0], T[1], T[2], T[3]]
5: [T[0], T[1], T[2], T[3], T[4]]
6: [T[0], T[1], T[2], T[3], T[4], T[5]]
7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6]]
8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7]]
9: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], T[8]]
10: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], T[8], T[9]]
fallback: Array<T extends ReadonlyArray<infer U> ? U : any>
}[T extends Readonly<[any]>
? 1
: T extends Readonly<[any, any]>
? 2
: T extends Readonly<[any, any, any]>
? 3
: T extends Readonly<[any, any, any, any]>
? 4
: T extends Readonly<[any, any, any, any, any]>
? 5
: T extends Readonly<[any, any, any, any, any, any]>
? 6
: T extends Readonly<[any, any, any, any, any, any, any]>
? 7
: T extends Readonly<[any, any, any, any, any, any, any, any]>
? 8
: T extends Readonly<[any, any, any, any, any, any, any, any, any]>
? 9
: T extends Readonly<[any, any, any, any, any, any, any, any, any, any]>
? 10
: 'fallback']
interface SuiteEachFunction {
<T extends any[] | [any]>(cases: ReadonlyArray<T>): (
name: string,
fn: (...args: T) => Awaitable<void>,
) => void
<T extends ReadonlyArray<any>>(cases: ReadonlyArray<T>): (
name: string,
fn: (...args: ExtractEachCallbackArgs<T>) => Awaitable<void>,
) => void
<T>(cases: ReadonlyArray<T>): (
name: string,
fn: (...args: T[]) => Awaitable<void>,
) => void
}
interface TestEachFunction {
<T extends any[] | [any]>(cases: ReadonlyArray<T>): (
name: string,
fn: (...args: T) => Awaitable<void>,
options?: number | TestOptions,
) => void
<T extends ReadonlyArray<any>>(cases: ReadonlyArray<T>): (
name: string,
fn: (...args: ExtractEachCallbackArgs<T>) => Awaitable<void>,
options?: number | TestOptions,
) => void
<T>(cases: ReadonlyArray<T>): (
name: string,
fn: (...args: T[]) => Awaitable<void>,
options?: number | TestOptions,
) => void
(...args: [TemplateStringsArray, ...any]): (
name: string,
fn: (...args: any[]) => Awaitable<void>,
options?: number | TestOptions,
) => void
}
type ChainableTestAPI<ExtraContext = {}> = ChainableFunction<
'concurrent' | 'only' | 'skip' | 'todo' | 'fails',
[name: string, fn?: TestFunction<ExtraContext>, options?: number | TestOptions],
void,
{
each: TestEachFunction
<T extends ExtraContext>(name: string, fn?: TestFunction<T>, options?: number | TestOptions): void
}
>
export interface TestOptions {
/**
* Test timeout.
*/
timeout?: number
/**
* Times to retry the test if fails. Useful for making flaky tests more stable.
* When retries is up, the last test error will be thrown.
*
* @default 1
*/
retry?: number
}
export type TestAPI<ExtraContext = {}> = ChainableTestAPI<ExtraContext> & {
each: TestEachFunction
skipIf(condition: any): ChainableTestAPI<ExtraContext>
runIf(condition: any): ChainableTestAPI<ExtraContext>
}
type ChainableSuiteAPI<ExtraContext = {}> = ChainableFunction<
'concurrent' | 'only' | 'skip' | 'todo' | 'shuffle',
[name: string, factory?: SuiteFactory<ExtraContext>, options?: number | TestOptions],
SuiteCollector<ExtraContext>,
{
each: TestEachFunction
<T extends ExtraContext>(name: string, factory?: SuiteFactory<T>): SuiteCollector<T>
}
>
export type SuiteAPI<ExtraContext = {}> = ChainableSuiteAPI<ExtraContext> & {
each: SuiteEachFunction
skipIf(condition: any): ChainableSuiteAPI<ExtraContext>
runIf(condition: any): ChainableSuiteAPI<ExtraContext>
}
export type HookListener<T extends any[], Return = void> = (...args: T) => Awaitable<Return>
export type HookCleanupCallback = (() => Awaitable<unknown>) | void
export interface SuiteHooks<ExtraContext = {}> {
beforeAll: HookListener<[Suite | File], HookCleanupCallback>[]
afterAll: HookListener<[Suite | File]>[]
beforeEach: HookListener<[TestContext & ExtraContext, Suite], HookCleanupCallback>[]
afterEach: HookListener<[TestContext & ExtraContext, Suite]>[]
}
export interface SuiteCollector<ExtraContext = {}> {
readonly name: string
readonly mode: RunMode
type: 'collector'
test: TestAPI<ExtraContext>
tasks: (Suite | TaskCustom | Test | SuiteCollector<ExtraContext>)[]
custom: (name: string) => TaskCustom
collect: (file?: File) => Promise<Suite>
clear: () => void
on: <T extends keyof SuiteHooks<ExtraContext>>(name: T, ...fn: SuiteHooks<ExtraContext>[T]) => void
}
export type SuiteFactory<ExtraContext = {}> = (test: (name: string, fn: TestFunction<ExtraContext>) => void) => Awaitable<void>
export interface RuntimeContext {
tasks: (SuiteCollector | Test)[]
currentSuite: SuiteCollector | null
}
export interface TestContext {
/**
* Metadata of the current test
*/
meta: Readonly<Test>
/**
* Extract hooks on test failed
*/
onTestFailed: (fn: OnTestFailedHandler) => void
}
export type OnTestFailedHandler = (result: TaskResult) => Awaitable<void>
export type SequenceHooks = 'stack' | 'list' | 'parallel'
export type SequenceSetupFiles = 'list' | 'parallel'