Skip to content

test: improve child process utilities in tests #9036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgozman merged 1 commit into from
Sep 21, 2021
Merged

test: improve child process utilities in tests #9036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 139 additions & 71 deletions tests/playwright-test/playwright-test-fixtures.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,15 @@
*/

import { TestInfo, test as base } from './stable-test-runner';
import { spawn } from 'child_process';
import { spawn, ChildProcess, execSync } from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import * as os from 'os';
import type { JSONReport, JSONReportSuite } from '../../src/test/reporters/json';
import rimraf from 'rimraf';
import { promisify } from 'util';
import * as url from 'url';
import net from 'net';

const removeFolderAsync = promisify(rimraf);

Expand All @@ -46,6 +47,76 @@ type Files = { [key: string]: string | Buffer };
type Params = { [key: string]: string | number | boolean | string[] };
type Env = { [key: string]: string | number | boolean | undefined };

type ChildParams = {
command: string[],
cwd?: string,
env?: Env,
shell?: boolean,
sendSIGINTAfter?: number,
};

class Child {
params: ChildParams;
process: ChildProcess;
output = '';
exited: Promise<number>;

constructor(params: ChildParams) {
this.params = params;
this.process = spawn(params.command[0], params.command.slice(1), {
env: {
...process.env,
...params.env,
} as any,
cwd: params.cwd,
shell: params.shell,
});
if (process.env.PW_RUNNER_DEBUG)
process.stdout.write(`\n\nLaunching ${params.command.join(' ')}\n`);
Comment thread
dgozman marked this conversation as resolved.

this.process.stderr.on('data', chunk => {
this.output += String(chunk);
if (process.env.PW_RUNNER_DEBUG)
process.stdout.write(String(chunk));
});

let didSendSigint = false;
this.process.stdout.on('data', chunk => {
this.output += String(chunk);
if (params.sendSIGINTAfter && !didSendSigint && countTimes(this.output, '%%SEND-SIGINT%%') >= params.sendSIGINTAfter) {
didSendSigint = true;
process.kill(this.process.pid, 'SIGINT');
}
if (process.env.PW_RUNNER_DEBUG)
process.stdout.write(String(chunk));
});

const onExit = () => {
if (!this.process.pid || this.process.killed)
return;
try {
if (process.platform === 'win32')
execSync(`taskkill /pid ${this.process.pid} /T /F /FI "MEMUSAGE gt 0"`);
else
process.kill(-this.process.pid, 'SIGKILL');
} catch (e) {
// the process might have already stopped
}
};
process.on('exit', onExit);
this.exited = new Promise(f => {
this.process.on('exit', (code, signal) => f(code));
process.off('exit', onExit);
});
}

async close() {
if (!this.process.killed)
this.process.kill();
return this.exited;
}
}

async function writeFiles(testInfo: TestInfo, files: Files) {
const baseDir = testInfo.outputPath();

Expand Down Expand Up @@ -91,58 +162,29 @@ async function writeFiles(testInfo: TestInfo, files: Files) {
return baseDir;
}

async function runTSC(baseDir: string): Promise<TSCResult> {
const tscProcess = spawn('npx', ['tsc', '-p', baseDir], {
cwd: baseDir,
shell: true,
});
let output = '';
tscProcess.stderr.on('data', chunk => {
output += String(chunk);
if (process.env.PW_RUNNER_DEBUG)
process.stderr.write(String(chunk));
});
tscProcess.stdout.on('data', chunk => {
output += String(chunk);
if (process.env.PW_RUNNER_DEBUG)
process.stdout.write(String(chunk));
});
const status = await new Promise<number>(x => tscProcess.on('close', x));
return {
exitCode: status,
output,
};
}

async function runPlaywrightTest(baseDir: string, params: any, env: Env, options: RunOptions): Promise<RunResult> {
async function runPlaywrightTest(childProcess: (params: ChildParams) => Promise<Child>, baseDir: string, params: any, env: Env, options: RunOptions): Promise<RunResult> {
const paramList = [];
let additionalArgs = '';
for (const key of Object.keys(params)) {
if (key === 'args') {
additionalArgs = params[key];
continue;
}
if (key === 'usesCustomOutputDir')
continue;
for (const value of Array.isArray(params[key]) ? params[key] : [params[key]]) {
const k = key.startsWith('-') ? key : '--' + key;
paramList.push(params[key] === true ? `${k}` : `${k}=${value}`);
}
}
const outputDir = path.join(baseDir, 'test-results');
const reportFile = path.join(outputDir, 'report.json');
const args = [path.join(__dirname, '..', '..', 'lib', 'cli', 'cli.js'), 'test'];
if (!params.usesCustomOutputDir)
const args = ['node', path.join(__dirname, '..', '..', 'lib', 'cli', 'cli.js'), 'test'];
if (!options.usesCustomOutputDir)
args.push('--output=' + outputDir);
args.push(
'--reporter=dot,json',
'--workers=2',
...paramList
);
if (additionalArgs)
args.push(...additionalArgs);
if (options.additionalArgs)
args.push(...options.additionalArgs);
const cacheDir = fs.mkdtempSync(path.join(os.tmpdir(), 'playwright-test-cache-'));
const testProcess = spawn('node', args, {
const testProcess = await childProcess({
command: args,
env: {
...process.env,
PLAYWRIGHT_JSON_OUTPUT_NAME: reportFile,
Expand All @@ -151,28 +193,13 @@ async function runPlaywrightTest(baseDir: string, params: any, env: Env, options
PWTEST_SKIP_TEST_OUTPUT: '1',
...env,
},
cwd: baseDir
});
let output = '';
let didSendSigint = false;
testProcess.stderr.on('data', chunk => {
output += String(chunk);
if (process.env.PW_RUNNER_DEBUG)
process.stderr.write(String(chunk));
});
testProcess.stdout.on('data', chunk => {
output += String(chunk);
if (options.sendSIGINTAfter && !didSendSigint && countTimes(output, '%%SEND-SIGINT%%') >= options.sendSIGINTAfter) {
didSendSigint = true;
process.kill(testProcess.pid, 'SIGINT');
}
if (process.env.PW_RUNNER_DEBUG)
process.stdout.write(String(chunk));
cwd: baseDir,
sendSIGINTAfter: options.sendSIGINTAfter,
});
const status = await new Promise<number>(x => testProcess.on('close', x));
const exitCode = await testProcess.exited;
await removeFolderAsync(cacheDir);

const outputString = output.toString();
const outputString = testProcess.output.toString();
const summary = (re: RegExp) => {
let result = 0;
let match = re.exec(outputString);
Expand All @@ -190,7 +217,7 @@ async function runPlaywrightTest(baseDir: string, params: any, env: Env, options
try {
report = JSON.parse(fs.readFileSync(reportFile).toString());
} catch (e) {
output += '\n' + e.toString();
testProcess.output += '\n' + e.toString();
}

const results = [];
Expand All @@ -209,8 +236,8 @@ async function runPlaywrightTest(baseDir: string, params: any, env: Env, options
visitSuites(report.suites);

return {
exitCode: status,
output,
exitCode,
output: testProcess.output,
passed,
failed,
flaky,
Expand All @@ -222,38 +249,79 @@ async function runPlaywrightTest(baseDir: string, params: any, env: Env, options

type RunOptions = {
sendSIGINTAfter?: number;
usesCustomOutputDir?: boolean;
additionalArgs?: string[];
};
type Fixtures = {
writeFiles: (files: Files) => Promise<string>;
runInlineTest: (files: Files, params?: Params, env?: Env, options?: RunOptions) => Promise<RunResult>;
runTSC: (files: Files) => Promise<TSCResult>;
childProcess: (params: ChildParams) => Promise<Child>;
waitForPort: (port: number) => Promise<void>;
};

export const test = base.extend<Fixtures>({
writeFiles: async ({}, use, testInfo) => {
await use(files => writeFiles(testInfo, files));
},

runInlineTest: async ({}, use, testInfo: TestInfo) => {
let runResult: RunResult | undefined;
runInlineTest: async ({ childProcess }, use, testInfo: TestInfo) => {
await use(async (files: Files, params: Params = {}, env: Env = {}, options: RunOptions = {}) => {
const baseDir = await writeFiles(testInfo, files);
runResult = await runPlaywrightTest(baseDir, params, env, options);
return runResult;
return await runPlaywrightTest(childProcess, baseDir, params, env, options);
});
if (testInfo.status !== testInfo.expectedStatus && runResult && !process.env.PW_RUNNER_DEBUG)
console.log('\n' + runResult.output + '\n');
},

runTSC: async ({}, use, testInfo) => {
let tscResult: TSCResult | undefined;
runTSC: async ({ childProcess }, use, testInfo) => {
await use(async files => {
const baseDir = await writeFiles(testInfo, { 'tsconfig.json': JSON.stringify(TSCONFIG), ...files });
tscResult = await runTSC(baseDir);
return tscResult;
const tsc = await childProcess({
command: ['npx', 'tsc', '-p', baseDir],
cwd: baseDir,
shell: true,
});
const exitCode = await tsc.exited;
return { exitCode, output: tsc.output };
});
},

childProcess: async ({}, use, testInfo) => {
const children: Child[] = [];
await use(async params => {
const child = new Child(params);
children.push(child);
return child;
});
await Promise.all(children.map(child => child.close()));
if (testInfo.status !== 'passed' && !process.env.PW_RUNNER_DEBUG) {
for (const child of children) {
console.log('====== ' + child.params.command.join(' '));
console.log(child.output);
console.log('=========================================');
}
}
},

waitForPort: async ({}, use) => {
const token = { canceled: false };
await use(async port => {
await test.step(`waiting for port ${port}`, async () => {
while (!token.canceled) {
const promise = new Promise<boolean>(resolve => {
const conn = net.connect(port)
.on('error', () => resolve(false))
.on('connect', () => {
conn.end();
resolve(true);
});
});
if (await promise)
return;
await new Promise(x => setTimeout(x, 100));
}
});
});
if (testInfo.status !== testInfo.expectedStatus && tscResult && !process.env.PW_RUNNER_DEBUG)
console.log('\n' + tscResult.output + '\n');
token.canceled = true;
},
});

Expand Down
25 changes: 5 additions & 20 deletions tests/playwright-test/raw-reporter.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,7 @@ test('should generate raw report', async ({ runInlineTest }, testInfo) => {
const { test } = pwt;
test('passes', async ({ page }, testInfo) => {});
`,
}, {
usesCustomOutputDir: true,
reporter: 'dot,' + kRawReporterPath
});
}, { reporter: 'dot,' + kRawReporterPath }, {}, { usesCustomOutputDir: true });
const json = JSON.parse(fs.readFileSync(testInfo.outputPath('test-results', 'report', 'project.report'), 'utf-8'));
expect(json.config).toBeTruthy();
expect(json.project).toBeTruthy();
Expand All @@ -50,10 +47,7 @@ test('should use project name', async ({ runInlineTest }, testInfo) => {
const { test } = pwt;
test('passes', async ({ page }, testInfo) => {});
`,
}, {
usesCustomOutputDir: true,
reporter: 'dot,' + kRawReporterPath
});
}, { reporter: 'dot,' + kRawReporterPath }, {}, { usesCustomOutputDir: true });
const json = JSON.parse(fs.readFileSync(testInfo.outputPath('output', 'report', 'project-name.report'), 'utf-8'));
expect(json.project.name).toBe('project-name');
expect(result.exitCode).toBe(0);
Expand All @@ -70,10 +64,7 @@ test('should save stdio', async ({ runInlineTest }, testInfo) => {
process.stderr.write(Buffer.from([4, 5, 6]));
});
`,
}, {
usesCustomOutputDir: true,
reporter: 'dot,' + kRawReporterPath
});
}, { reporter: 'dot,' + kRawReporterPath }, {}, { usesCustomOutputDir: true });
const json = JSON.parse(fs.readFileSync(testInfo.outputPath('test-results', 'report', 'project.report'), 'utf-8'));
const result = json.suites[0].tests[0].results[0];
expect(result.attachments).toEqual([
Expand Down Expand Up @@ -109,10 +100,7 @@ test('should save attachments', async ({ runInlineTest }, testInfo) => {
});
});
`,
}, {
usesCustomOutputDir: true,
reporter: 'dot,' + kRawReporterPath
});
}, { reporter: 'dot,' + kRawReporterPath }, {}, { usesCustomOutputDir: true });
const json = JSON.parse(fs.readFileSync(testInfo.outputPath('test-results', 'report', 'project.report'), 'utf-8'));
const result = json.suites[0].tests[0].results[0];
expect(result.attachments[0].name).toBe('binary');
Expand All @@ -137,10 +125,7 @@ test('dupe project names', async ({ runInlineTest }, testInfo) => {
const { test } = pwt;
test('passes', async ({ page }, testInfo) => {});
`,
}, {
usesCustomOutputDir: true,
reporter: 'dot,' + kRawReporterPath
});
}, { reporter: 'dot,' + kRawReporterPath }, {}, { usesCustomOutputDir: true });
const files = fs.readdirSync(testInfo.outputPath('test-results', 'report'));
expect(new Set(files)).toEqual(new Set(['project-name.report', 'project-name-1.report', 'project-name-2.report']));
});
Loading