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
|
/**
* Copyright 2022 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import crypto from 'crypto';
import {mkdtemp, rm, writeFile} from 'fs/promises';
import {tmpdir} from 'os';
import {join} from 'path';
import {
PUPPETEER_CORE_PACKAGE_PATH,
PUPPETEER_PACKAGE_PATH,
PUPPETEER_BROWSERS_PACKAGE_PATH,
} from './constants.js';
import {execFile} from './util.js';
const PKG_MANAGER = process.env['PKG_MANAGER'] || 'npm';
let ADD_PKG_SUBCOMMAND = 'install';
if (PKG_MANAGER !== 'npm') {
ADD_PKG_SUBCOMMAND = 'add';
}
export interface ItEvaluatesOptions {
commonjs?: boolean;
}
export interface ItEvaluatesFn {
(
title: string,
options: ItEvaluatesOptions,
getScriptContent: (cwd: string) => Promise<string>
): void;
(title: string, getScriptContent: (cwd: string) => Promise<string>): void;
}
export interface SandboxOptions {
dependencies?: string[];
devDependencies?: string[];
/**
* This should be idempotent.
*/
env?: ((cwd: string) => NodeJS.ProcessEnv) | NodeJS.ProcessEnv;
before?: (cwd: string) => Promise<void>;
}
declare module 'mocha' {
export interface Context {
/**
* The path to the root of the sandbox folder.
*/
sandbox: string;
env: NodeJS.ProcessEnv | undefined;
runScript: (content: string, type: 'cjs' | 'mjs') => Promise<void>;
}
}
/**
* Configures mocha before/after hooks to create a temp folder and install
* specified dependencies.
*/
export const configureSandbox = (options: SandboxOptions): void => {
before(async function (): Promise<void> {
const sandbox = await mkdtemp(join(tmpdir(), 'puppeteer-'));
const dependencies = (options.dependencies ?? []).map(module => {
switch (module) {
case 'puppeteer':
return PUPPETEER_PACKAGE_PATH;
case 'puppeteer-core':
return PUPPETEER_CORE_PACKAGE_PATH;
case '@puppeteer/browsers':
return PUPPETEER_BROWSERS_PACKAGE_PATH;
default:
return module;
}
});
const devDependencies = options.devDependencies ?? [];
let getEnv: (cwd: string) => NodeJS.ProcessEnv | undefined;
if (typeof options.env === 'function') {
getEnv = options.env;
} else {
const env = options.env;
getEnv = () => {
return env;
};
}
const env = {...process.env, ...getEnv(sandbox)};
await options.before?.(sandbox);
if (dependencies.length > 0) {
await execFile(PKG_MANAGER, [ADD_PKG_SUBCOMMAND, ...dependencies], {
cwd: sandbox,
env,
shell: true,
});
}
if (devDependencies.length > 0) {
await execFile(
PKG_MANAGER,
[ADD_PKG_SUBCOMMAND, '-D', ...devDependencies],
{
cwd: sandbox,
env,
shell: true,
}
);
}
this.sandbox = sandbox;
this.env = env;
this.runScript = async (content: string, type: 'cjs' | 'mjs') => {
const script = join(sandbox, `script-${crypto.randomUUID()}.${type}`);
await writeFile(script, content);
await execFile('node', [script], {cwd: sandbox, env});
};
});
after(async function () {
if (!process.env['KEEP_SANDBOX']) {
await rm(this.sandbox, {recursive: true, force: true, maxRetries: 5});
} else {
console.log('sandbox saved in', this.sandbox);
}
});
};
|
