/
scenario.ts
126 lines (113 loc) · 3.14 KB
/
scenario.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
import type { ExecutionContext } from 'ava'
import { ModuleInitializer } from '../src/moduleRecord'
import type { LavaMoatOpts } from '../src/options'
import { LavaMoatPolicy, LavaMoatPolicyOverrides } from '../src/schema'
export type ScenarioType = 'truthy' | 'falsy' | 'deepEqual'
export type ScenarioFileType = 'builtin' | 'js' | 'native'
export type JSFilepath = `${string}.js`
/**
* Scenario file which is _not_ a `.js` file and has had defaults applied
*/
export interface NormalizedScenarioFile extends ScenarioFile {
file: string
}
/**
* Scenario file which is a `.js` file and has had defaults applied
*/
export interface NormalizedScenarioJSFile extends ScenarioFile {
file: JSFilepath
specifier: string
packageName: string
type: ScenarioFileType
entry?: true
importMap: Record<string, string>
}
export interface NormalizedBuiltin extends NormalizedScenarioJSFile {
specifier: string
moduleInitializer: ModuleInitializer
}
/**
* Scenario file as provided by user
*/
export interface ScenarioFile {
/**
* File content
*/
content: string
/**
* Filepath
*/
file?: string
specifier?: string
packageName?: string
type?: ScenarioFileType
entry?: boolean
importMap?: Record<string, string>
moduleInitializer?: ModuleInitializer
}
export type ScenarioSourceFn = () => void
export interface Scenario<Result = unknown> {
name?: string
config?: LavaMoatPolicy
configOverride?: LavaMoatPolicyOverrides
expectedFailure?: boolean
expectedResult?: Result
defineEntry?: ScenarioSourceFn
defineOne?: ScenarioSourceFn
defineTwo?: ScenarioSourceFn
defineThree?: ScenarioSourceFn
testType?: ScenarioType
expectedFailureMessageRegex?: RegExp
files?: Record<string, ScenarioFile>
defaultPolicy?: boolean
builtin?: Record<string, unknown>
context?: Record<string, unknown>
opts?: LavaMoatOpts
dir?: string
checkPostRun?: ScenarioCheckPostRunFn<Result>
checkError?: ScenarioCheckErrorFn<Result>
checkResult?: ScenarioCheckResultFn<Result>
kernelArgs?: Record<string, unknown>
beforeCreateKernel?: (scenario: NormalizedScenario<Result>) => void
}
export type NormalizedScenario<Result = unknown> = Required<
Pick<
Scenario<Result>,
| 'name'
| 'checkError'
| 'checkPostRun'
| 'checkResult'
| 'testType'
| 'builtin'
| 'expectedResult'
| 'expectedFailure'
| 'expectedFailureMessageRegex'
| 'files'
| 'config'
| 'configOverride'
| 'context'
| 'opts'
>
> &
Pick<Scenario<Result>, 'dir' | 'kernelArgs' | 'beforeCreateKernel'> & {
entries: string[]
globalThis?: Record<string, unknown>
vmContext?: Record<string, unknown>
}
export type ScenarioCheckPostRunFn<Result = unknown> = (
t: ExecutionContext,
result: Result | undefined,
err: Error | undefined,
scenario: Scenario<Result>
) => Promise<void>
export type ScenarioCheckResultFn<Result = unknown> = (
t: ExecutionContext,
result: Result,
scenario: Scenario<Result>
) => Promise<void>
export type ScenarioCheckErrorFn<Result = unknown> = (
t: ExecutionContext,
err: Error,
scenario: Scenario<Result>
) => Promise<void>
export type ScenarioFactory = () => Promise<Scenario>