-
Notifications
You must be signed in to change notification settings - Fork 65
/
scenario-util.js
232 lines (216 loc) · 6.41 KB
/
scenario-util.js
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
import { mergePolicy } from 'lavamoat-core'
import util from 'node:util'
// @ts-expect-error - needs types
import { prepareScenarioOnDisk } from 'lavamoat-core/test/util.js'
import { memfs } from 'memfs'
import { once } from 'node:events'
import path from 'node:path'
import { pathToFileURL } from 'node:url'
import { Worker } from 'node:worker_threads'
/**
* Path to `./runner.js`
*/
const RUNNER_MODULE_PATH = (
process.env.WALLABY_PROJECT_DIR
? pathToFileURL(
path.join(
process.env.WALLABY_PROJECT_DIR,
'packages',
'endomoat',
'test',
'scenario-runner.js'
)
)
: new URL('./scenario-runner.js', import.meta.url)
).pathname
/**
* Dumps a bunch of information about an error and the virtual FS volume.
* Optionally, policies
*
* @param {unknown} err
* @param {import('memfs').Volume} vol
* @param {object} options
* @param {import('lavamoat-core').LavaMoatPolicy} [options.lavamoatPolicy]
* @param {import('../src/policy-converter.js').LavaMoatEndoPolicy} [options.endoPolicy]
* @param {(...args: any) => void} [options.log]
*/
function dumpError(
err,
vol,
// eslint-disable-next-line no-console
{ lavamoatPolicy, endoPolicy, log = console.error.bind(console) } = {}
) {
log()
log(err)
if (endoPolicy) {
log('Endo policy:')
log(util.inspect(endoPolicy, { depth: null }))
}
if (lavamoatPolicy) {
log('Lavamoat policy:')
log(util.inspect(lavamoatPolicy, { depth: null }))
}
log('Filesystem:')
log(vol.toTree())
log()
}
/**
* Reads a policy and policy overrides using a `ReadFn`, then merges the result.
*
* @param {import('@endo/compartment-mapper').ReadFn} readPower - File read
* power
* @param {string} policyDir - Path to the policy directory. If relative, will
* be resolved to cwd
* @returns {Promise<import('lavamoat-core').LavaMoatPolicy>}
* @todo Make the stuff in `lavamoat-core`'s `loadPolicy` accept a `readPower`,
* and get rid of this.
*/
async function readPolicy(readPower, policyDir) {
let [lavamoatPolicy, lavamoatPolicyOverrides] = await Promise.all(
['policy.json', 'policy-override.json'].map((filename) =>
readPower(path.resolve(policyDir, filename))
.then((bytes) => JSON.parse(`${bytes}`))
.catch((err) => {
if (err.code !== 'ENOENT') {
throw err
}
return undefined
})
)
)
if (!lavamoatPolicy) {
throw new Error(`LavaMoat - policy not found in ${policyDir}`)
}
if (lavamoatPolicyOverrides) {
lavamoatPolicy = mergePolicy(lavamoatPolicy, lavamoatPolicyOverrides)
}
return lavamoatPolicy
}
/**
* @param {NodeJS.ReadableStream} stdout
* @param {NodeJS.ReadableStream} stderr
* @returns {Promise<[stdout: string, stderr: string]>}
*/
async function trapOutput(stdout, stderr) {
/** @type {Buffer[]} */
const stdoutChunks = []
/** @type {Buffer[]} */
const stderrChunks = []
return Promise.all([
new Promise((resolve, reject) => {
stdout
.on('data', (chunk) => {
stdoutChunks.push(Buffer.from(chunk))
})
.on('end', () => {
resolve(Buffer.concat(stdoutChunks).toString('utf8'))
})
.on('error', reject)
}),
new Promise((resolve, reject) => {
stderr
.on('data', (chunk) => {
stderrChunks.push(Buffer.from(chunk))
})
.on('end', () => {
resolve(Buffer.concat(stderrChunks).toString('utf8'))
})
.on('error', reject)
}),
])
}
/**
* Bootstraps the scenario runner.
*
* Return value should be provided to `lavamoat-core`'s `runAndTestScenario`
*
* @param {(...args: any) => void} log Logger
* @returns
*/
// eslint-disable-next-line no-console
export function createScenarioRunner(log = console.error.bind(console)) {
/**
* Runs a scenario from `lavamoat-core`.
*
* The idea here is to establish feature-compatibility with `lavamoat-node`.
*
* @remarks
* The runner in e.g., `lavamoat-node` spawns a child process for each
* scenario; I don't feel that is necessary for our purposes. It _is_ useful
* and necessary to test the CLI, but I'm not convinced there's added value in
* doing so for _every scenario_.
* @param {{ scenario: any }} opts
* @returns {Promise<unknown>} Result of the stdout of the scenario parsed as
* JSON
* @todo Scenario needs a type definition
*/
return async ({ scenario }) => {
const { fs, vol } = memfs()
const readFile = /** @type {import('@endo/compartment-mapper').ReadFn} */ (
fs.promises.readFile
)
/** @type {string} */
let projectDir
/** @type {string} */
let policyDir
// for eslint
await Promise.resolve()
try {
;({ projectDir, policyDir } = await prepareScenarioOnDisk({
fs: fs.promises,
scenario,
policyName: 'endomoat',
}))
} catch (e) {
dumpError(e, vol, { log })
throw e
}
/** @type {import('lavamoat-core').LavaMoatPolicy} */
let lavamoatPolicy
try {
lavamoatPolicy = await readPolicy(readFile, policyDir)
} catch (err) {
dumpError(err, vol, { log })
throw err
}
/** @type {string} */
let stdout
/** @type {string} */
let stderr
/** @type {ReturnType<typeof trapOutput> | undefined} */
let outputPromise
try {
const entryPath = path.join(projectDir, scenario.entries[0])
const worker = new Worker(RUNNER_MODULE_PATH, {
stdout: true,
stderr: true,
workerData: { entryPath, policy: lavamoatPolicy, vol: vol.toJSON() },
})
outputPromise = trapOutput(worker.stdout, worker.stderr)
const [code] = await once(worker, 'exit')
if (code !== 0) {
throw new Error(
`Worker exited with code ${code} trying to run scenario ${scenario.name ?? '(unknown)'} `
)
}
;[stdout, stderr] = await outputPromise
} catch (err) {
if (!scenario.expectedFailure) {
dumpError(err, vol, { lavamoatPolicy, log })
}
throw err
} finally {
// TODO use AbortController
outputPromise?.catch(() => {})
}
// nothing should output to stderr. except a debugger
if (stderr && stderr.trim() !== 'Debugger attached.') {
throw new Error(`Unexpected output in standard err: \n${stderr}`)
}
try {
return JSON.parse(stdout)
} catch (err) {
throw new Error(`Unexpected output in standard out: \n${stdout}`)
}
}
}