mirror of
https://github.com/cloudflare/wrangler-action.git
synced 2024-11-29 13:14:46 +01:00
198 lines
8.7 KiB
TypeScript
198 lines
8.7 KiB
TypeScript
import { ErrorWithDiff, Awaitable } from '@vitest/utils';
|
|
|
|
type ChainableFunction<T extends string, Args extends any[], R = any, E = {}> = {
|
|
(...args: Args): R;
|
|
} & {
|
|
[x in T]: ChainableFunction<T, Args, R, E>;
|
|
} & {
|
|
fn: (this: Record<T, any>, ...args: Args) => R;
|
|
} & E;
|
|
declare function createChainable<T extends string, Args extends any[], R = any, E = {}>(keys: T[], fn: (this: Record<T, any>, ...args: Args) => R): ChainableFunction<T, Args, R, E>;
|
|
|
|
type RunMode = 'run' | 'skip' | 'only' | 'todo';
|
|
type TaskState = RunMode | 'pass' | 'fail';
|
|
interface TaskBase {
|
|
id: string;
|
|
name: string;
|
|
mode: RunMode;
|
|
meta: TaskMeta;
|
|
each?: boolean;
|
|
concurrent?: boolean;
|
|
shuffle?: boolean;
|
|
suite?: Suite;
|
|
file?: File;
|
|
result?: TaskResult;
|
|
retry?: number;
|
|
repeats?: number;
|
|
}
|
|
interface TaskMeta {
|
|
}
|
|
interface TaskCustom extends TaskBase {
|
|
type: 'custom';
|
|
}
|
|
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;
|
|
repeatCount?: number;
|
|
}
|
|
type TaskResultPack = [id: string, result: TaskResult | undefined, meta: TaskMeta];
|
|
interface Suite extends TaskBase {
|
|
type: 'suite';
|
|
tasks: Task[];
|
|
filepath?: string;
|
|
projectName?: string;
|
|
}
|
|
interface File extends Suite {
|
|
filepath: string;
|
|
collectDuration?: number;
|
|
setupDuration?: number;
|
|
}
|
|
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>[];
|
|
}
|
|
type Task = Test | Suite | TaskCustom | File;
|
|
type DoneCallback = (error?: any) => void;
|
|
type TestFunction<ExtraContext = {}> = (context: TestContext & ExtraContext) => Awaitable<any> | void;
|
|
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 | Function, fn: (...args: T) => Awaitable<void>) => void;
|
|
<T extends ReadonlyArray<any>>(cases: ReadonlyArray<T>): (name: string | Function, fn: (...args: ExtractEachCallbackArgs<T>) => Awaitable<void>) => void;
|
|
<T>(cases: ReadonlyArray<T>): (name: string | Function, fn: (...args: T[]) => Awaitable<void>) => void;
|
|
}
|
|
interface TestEachFunction {
|
|
<T extends any[] | [any]>(cases: ReadonlyArray<T>): (name: string | Function, fn: (...args: T) => Awaitable<void>, options?: number | TestOptions) => void;
|
|
<T extends ReadonlyArray<any>>(cases: ReadonlyArray<T>): (name: string | Function, fn: (...args: ExtractEachCallbackArgs<T>) => Awaitable<void>, options?: number | TestOptions) => void;
|
|
<T>(cases: ReadonlyArray<T>): (name: string | Function, fn: (...args: T[]) => Awaitable<void>, options?: number | TestOptions) => void;
|
|
(...args: [TemplateStringsArray, ...any]): (name: string | Function, fn: (...args: any[]) => Awaitable<void>, options?: number | TestOptions) => void;
|
|
}
|
|
type ChainableTestAPI<ExtraContext = {}> = ChainableFunction<'concurrent' | 'only' | 'skip' | 'todo' | 'fails', [
|
|
name: string | Function,
|
|
fn?: TestFunction<ExtraContext>,
|
|
options?: number | TestOptions
|
|
], void, {
|
|
each: TestEachFunction;
|
|
<T extends ExtraContext>(name: string | Function, fn?: TestFunction<T>, options?: number | TestOptions): void;
|
|
}>;
|
|
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 0
|
|
*/
|
|
retry?: number;
|
|
/**
|
|
* How many times the test will run.
|
|
* Only inner tests will repeat if set on `describe()`, nested `describe()` will inherit parent's repeat by default.
|
|
*
|
|
* @default 0
|
|
*/
|
|
repeats?: number;
|
|
}
|
|
type TestAPI<ExtraContext = {}> = ChainableTestAPI<ExtraContext> & {
|
|
each: TestEachFunction;
|
|
skipIf(condition: any): ChainableTestAPI<ExtraContext>;
|
|
runIf(condition: any): ChainableTestAPI<ExtraContext>;
|
|
extend<T extends Record<string, any> = {}>(fixtures: Fixtures<T, ExtraContext>): TestAPI<{
|
|
[K in keyof T | keyof ExtraContext]: K extends keyof T ? T[K] : K extends keyof ExtraContext ? ExtraContext[K] : never;
|
|
}>;
|
|
};
|
|
type Fixtures<T extends Record<string, any>, ExtraContext = {}> = {
|
|
[K in keyof T]: T[K] | ((context: {
|
|
[P in keyof T | keyof ExtraContext as P extends K ? P extends keyof ExtraContext ? P : never : P]: K extends P ? K extends keyof ExtraContext ? ExtraContext[K] : never : P extends keyof T ? T[P] : never;
|
|
} & TestContext, use: (fixture: T[K]) => Promise<void>) => Promise<void>);
|
|
};
|
|
type ChainableSuiteAPI<ExtraContext = {}> = ChainableFunction<'concurrent' | 'only' | 'skip' | 'todo' | 'shuffle', [
|
|
name: string | Function,
|
|
factory?: SuiteFactory<ExtraContext>,
|
|
options?: number | TestOptions
|
|
], SuiteCollector<ExtraContext>, {
|
|
each: TestEachFunction;
|
|
<T extends ExtraContext>(name: string | Function, factory?: SuiteFactory<T>): SuiteCollector<T>;
|
|
}>;
|
|
type SuiteAPI<ExtraContext = {}> = ChainableSuiteAPI<ExtraContext> & {
|
|
each: SuiteEachFunction;
|
|
skipIf(condition: any): ChainableSuiteAPI<ExtraContext>;
|
|
runIf(condition: any): ChainableSuiteAPI<ExtraContext>;
|
|
};
|
|
type HookListener<T extends any[], Return = void> = (...args: T) => Awaitable<Return>;
|
|
type HookCleanupCallback = (() => Awaitable<unknown>) | void;
|
|
interface SuiteHooks<ExtraContext = {}> {
|
|
beforeAll: HookListener<[Readonly<Suite | File>], HookCleanupCallback>[];
|
|
afterAll: HookListener<[Readonly<Suite | File>]>[];
|
|
beforeEach: HookListener<[TestContext & ExtraContext, Readonly<Suite>], HookCleanupCallback>[];
|
|
afterEach: HookListener<[TestContext & ExtraContext, Readonly<Suite>]>[];
|
|
}
|
|
interface SuiteCollector<ExtraContext = {}> {
|
|
readonly name: string;
|
|
readonly mode: RunMode;
|
|
options?: TestOptions;
|
|
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;
|
|
}
|
|
type SuiteFactory<ExtraContext = {}> = (test: (name: string | Function, fn: TestFunction<ExtraContext>) => void) => Awaitable<void>;
|
|
interface RuntimeContext {
|
|
tasks: (SuiteCollector | Test)[];
|
|
currentSuite: SuiteCollector | null;
|
|
}
|
|
interface TestContext {
|
|
/**
|
|
* Metadata of the current test
|
|
*
|
|
* @deprecated Use `task` instead
|
|
*/
|
|
meta: Readonly<Test>;
|
|
/**
|
|
* Metadata of the current test
|
|
*/
|
|
task: Readonly<Test>;
|
|
/**
|
|
* Extract hooks on test failed
|
|
*/
|
|
onTestFailed: (fn: OnTestFailedHandler) => void;
|
|
}
|
|
type OnTestFailedHandler = (result: TaskResult) => Awaitable<void>;
|
|
type SequenceHooks = 'stack' | 'list' | 'parallel';
|
|
type SequenceSetupFiles = 'list' | 'parallel';
|
|
|
|
export { ChainableFunction as C, DoneCallback as D, File as F, HookListener as H, OnTestFailedHandler as O, RunMode as R, Suite as S, Task as T, Test as a, TaskCustom as b, createChainable as c, SuiteAPI as d, TestAPI as e, SuiteCollector as f, SuiteHooks as g, TaskState as h, TaskBase as i, TaskMeta as j, TaskResult as k, TaskResultPack as l, TestFunction as m, TestOptions as n, Fixtures as o, HookCleanupCallback as p, SuiteFactory as q, RuntimeContext as r, TestContext as s, SequenceHooks as t, SequenceSetupFiles as u };
|