Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: allow opt-into the legacy global setup mode (#11888)

Browse source
This commit is contained in:
Pavel Feldman 2022-02-07 10:41:56 -08:00 committed by GitHub
parent c3c99a5f66
commit 9116adc684
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 316 additions and 278 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
packages/playwright-test/src/runner.ts
View file

@ -140,6 +140,14 @@ export class Runner {
async runAllTests(options: RunOptions = {}): Promise<FullResult> { async runAllTests(options: RunOptions = {}): Promise<FullResult> {
this._reporter = await this._createReporter(!!options.listOnly); this._reporter = await this._createReporter(!!options.listOnly);
const config = this._loader.fullConfig(); const config = this._loader.fullConfig();
let legacyGlobalTearDown: (() => Promise<void>) | undefined;
if (process.env.PW_TEST_LEGACY_GLOBAL_SETUP_MODE) {
legacyGlobalTearDown = await this._performGlobalSetup(config);
if (!legacyGlobalTearDown)
return { status: 'failed' };
}
const result = await raceAgainstTimeout(() => this._run(!!options.listOnly, options.filePatternFilter || [], options.projectFilter), config.globalTimeout); const result = await raceAgainstTimeout(() => this._run(!!options.listOnly, options.filePatternFilter || [], options.projectFilter), config.globalTimeout);
let fullResult: FullResult; let fullResult: FullResult;
if (result.timedOut) { if (result.timedOut) {
@ -149,6 +157,7 @@ export class Runner {
fullResult = result.result; fullResult = result.result;
} }
await this._reporter.onEnd?.(fullResult); await this._reporter.onEnd?.(fullResult);
await legacyGlobalTearDown?.();
// Calling process.exit() might truncate large stdout/stderr output. // Calling process.exit() might truncate large stdout/stderr output.
// See https://github.com/nodejs/node/issues/6456. // See https://github.com/nodejs/node/issues/6456.
@ -351,21 +360,19 @@ export class Runner {
if (list) if (list)
return { status: 'passed' }; return { status: 'passed' };
// 13. Declare global setup to tear down in finally.
const internalGlobalTeardowns: (() => Promise<void>)[] = []; // 13. Run Global setup.
let webServer: WebServer | undefined; let globalTearDown: (() => Promise<void>) | undefined;
let globalSetupResult: any; if (!process.env.PW_TEST_LEGACY_GLOBAL_SETUP_MODE) {
globalTearDown = await this._performGlobalSetup(config);
if (!globalTearDown)
return { status: 'failed' };
}
const result: FullResult = { status: 'passed' }; const result: FullResult = { status: 'passed' };
// 14. Run tests.
try { try {
// 14. Perform global setup.
for (const internalGlobalSetup of this._internalGlobalSetups)
internalGlobalTeardowns.push(await internalGlobalSetup());
webServer = config.webServer ? await WebServer.create(config.webServer) : undefined;
if (config.globalSetup)
globalSetupResult = await (await this._loader.loadGlobalHook(config.globalSetup, 'globalSetup'))(this._loader.fullConfig());
const sigintWatcher = new SigIntWatcher(); const sigintWatcher = new SigIntWatcher();
let hasWorkerErrors = false; let hasWorkerErrors = false;
@ -389,34 +396,58 @@ export class Runner {
this._reporter.onError?.(serializeError(e)); this._reporter.onError?.(serializeError(e));
return { status: 'failed' }; return { status: 'failed' };
} finally { } finally {
await globalTearDown?.();
await this._runAndAssignError(async () => {
if (globalSetupResult && typeof globalSetupResult === 'function')
await globalSetupResult(this._loader.fullConfig());
}, result);
await this._runAndAssignError(async () => {
if (config.globalTeardown)
await (await this._loader.loadGlobalHook(config.globalTeardown, 'globalTeardown'))(this._loader.fullConfig());
}, result);
await this._runAndAssignError(async () => {
await webServer?.kill();
}, result);
await this._runAndAssignError(async () => {
for (const internalGlobalTeardown of internalGlobalTeardowns)
await internalGlobalTeardown();
}, result);
} }
return result; return result;
} }
private async _runAndAssignError(callback: () => Promise<void>, result: FullResult) { private async _performGlobalSetup(config: FullConfig): Promise<(() => Promise<void>) | undefined> {
const result: FullResult = { status: 'passed' };
const internalGlobalTeardowns: (() => Promise<void>)[] = [];
let globalSetupResult: any;
let webServer: WebServer | undefined;
const tearDown = async () => {
await this._runAndReportError(async () => {
if (globalSetupResult && typeof globalSetupResult === 'function')
await globalSetupResult(this._loader.fullConfig());
}, result);
await this._runAndReportError(async () => {
if (config.globalTeardown)
await (await this._loader.loadGlobalHook(config.globalTeardown, 'globalTeardown'))(this._loader.fullConfig());
}, result);
await this._runAndReportError(async () => {
await webServer?.kill();
}, result);
await this._runAndReportError(async () => {
for (const internalGlobalTeardown of internalGlobalTeardowns)
await internalGlobalTeardown();
}, result);
};
await this._runAndReportError(async () => {
for (const internalGlobalSetup of this._internalGlobalSetups)
internalGlobalTeardowns.push(await internalGlobalSetup());
webServer = config.webServer ? await WebServer.create(config.webServer) : undefined;
if (config.globalSetup)
globalSetupResult = await (await this._loader.loadGlobalHook(config.globalSetup, 'globalSetup'))(this._loader.fullConfig());
}, result);
if (result.status !== 'passed') {
tearDown();
return;
}
return tearDown;
}
private async _runAndReportError(callback: () => Promise<void>, result: FullResult) {
try { try {
await callback(); await callback();
} catch (e) { } catch (e) {
if (result.status === 'passed')
result.status = 'failed'; result.status = 'failed';
this._reporter.onError?.(serializeError(e)); this._reporter.onError?.(serializeError(e));
} }

63
tests/playwright-test/global-setup.spec.ts
View file

@ -16,7 +16,11 @@
import { test, expect } from './playwright-test-fixtures'; import { test, expect } from './playwright-test-fixtures';
test('globalSetup and globalTeardown should work', async ({ runInlineTest }) => { for (const mode of ['legacy', 'default']) {
test.describe(`${mode} mode`, () => {
const env = { PW_TEST_LEGACY_GLOBAL_SETUP_MODE: mode === 'legacy' ? '1' : undefined };
test('globalSetup and globalTeardown should work', async ({ runInlineTest }) => {
const { results, output } = await runInlineTest({ const { results, output } = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -43,12 +47,12 @@ test('globalSetup and globalTeardown should work', async ({ runInlineTest }) =>
expect(process.env.FOO).toBe('42'); expect(process.env.FOO).toBe('42');
}); });
`, `,
}); }, undefined, env);
expect(results[0].status).toBe('passed'); expect(results[0].status).toBe('passed');
expect(output).toContain('teardown=42'); expect(output).toContain('teardown=42');
}); });
test('globalTeardown runs after failures', async ({ runInlineTest }) => { test('globalTeardown runs after failures', async ({ runInlineTest }) => {
const { results, output } = await runInlineTest({ const { results, output } = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -75,12 +79,13 @@ test('globalTeardown runs after failures', async ({ runInlineTest }) => {
expect(process.env.FOO).toBe('43'); expect(process.env.FOO).toBe('43');
}); });
`, `,
}); }, undefined, env);
expect(results[0].status).toBe('failed'); expect(results[0].status).toBe('failed');
expect(output).toContain('teardown=42'); expect(output).toContain('teardown=42');
}); });
test('globalTeardown does not run when globalSetup times out', async ({ runInlineTest }) => { test('globalTeardown does not run when globalSetup times out', async ({ runInlineTest }) => {
test.skip(!!env.PW_TEST_LEGACY_GLOBAL_SETUP_MODE);
const result = await runInlineTest({ const result = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -105,16 +110,16 @@ test('globalTeardown does not run when globalSetup times out', async ({ runInlin
test('should not run', async ({}, testInfo) => { test('should not run', async ({}, testInfo) => {
}); });
`, `,
}); }, undefined, env);
// We did not run tests, so we should only have 1 skipped test. // We did not run tests, so we should only have 1 skipped test.
expect(result.skipped).toBe(1); expect(result.skipped).toBe(1);
expect(result.passed).toBe(0); expect(result.passed).toBe(0);
expect(result.failed).toBe(0); expect(result.failed).toBe(0);
expect(result.exitCode).toBe(1); expect(result.exitCode).toBe(1);
expect(result.output).not.toContain('teardown='); expect(result.output).not.toContain('teardown=');
}); });
test('globalSetup should work with sync function', async ({ runInlineTest }) => { test('globalSetup should work with sync function', async ({ runInlineTest }) => {
const { passed } = await runInlineTest({ const { passed } = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -134,11 +139,11 @@ test('globalSetup should work with sync function', async ({ runInlineTest }) =>
expect(value).toEqual({ foo: 'bar' }); expect(value).toEqual({ foo: 'bar' });
}); });
`, `,
}); }, undefined, env);
expect(passed).toBe(1); expect(passed).toBe(1);
}); });
test('globalSetup should throw when passed non-function', async ({ runInlineTest }) => { test('globalSetup should throw when passed non-function', async ({ runInlineTest }) => {
const { output } = await runInlineTest({ const { output } = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -154,11 +159,11 @@ test('globalSetup should throw when passed non-function', async ({ runInlineTest
test('should work', async ({}) => { test('should work', async ({}) => {
}); });
`, `,
}); }, undefined, env);
expect(output).toContain(`globalSetup.ts: globalSetup file must export a single function.`); expect(output).toContain(`globalSetup.ts: globalSetup file must export a single function.`);
}); });
test('globalSetup should work with default export and run the returned fn', async ({ runInlineTest }) => { test('globalSetup should work with default export and run the returned fn', async ({ runInlineTest }) => {
const { output, exitCode, passed } = await runInlineTest({ const { output, exitCode, passed } = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -182,14 +187,14 @@ test('globalSetup should work with default export and run the returned fn', asyn
test('should work', async ({}) => { test('should work', async ({}) => {
}); });
`, `,
}); }, undefined, env);
expect(passed).toBe(1); expect(passed).toBe(1);
expect(exitCode).toBe(0); expect(exitCode).toBe(0);
expect(output).toContain(`%%setup: 42`); expect(output).toContain(`%%setup: 42`);
expect(output).toContain(`%%teardown: 42`); expect(output).toContain(`%%teardown: 42`);
}); });
test('globalSetup should allow requiring a package from node_modules', async ({ runInlineTest }) => { test('globalSetup should allow requiring a package from node_modules', async ({ runInlineTest }) => {
const { results } = await runInlineTest({ const { results } = await runInlineTest({
'playwright.config.ts': ` 'playwright.config.ts': `
import * as path from 'path'; import * as path from 'path';
@ -210,11 +215,11 @@ test('globalSetup should allow requiring a package from node_modules', async ({
expect(process.env.FOO).toBe('42'); expect(process.env.FOO).toBe('42');
}); });
`, `,
}); }, undefined, env);
expect(results[0].status).toBe('passed'); expect(results[0].status).toBe('passed');
}); });
const authFiles = { const authFiles = {
'playwright.config.ts': ` 'playwright.config.ts': `
const config: pwt.PlaywrightTestConfig = { const config: pwt.PlaywrightTestConfig = {
globalSetup: require.resolve('./auth'), globalSetup: require.resolve('./auth'),
@ -253,15 +258,17 @@ const authFiles = {
expect(value).toBe('value'); expect(value).toBe('value');
}); });
`, `,
}; };
test('globalSetup should work for auth', async ({ runInlineTest }) => { test('globalSetup should work for auth', async ({ runInlineTest }) => {
const result = await runInlineTest(authFiles); const result = await runInlineTest(authFiles, undefined, env);
expect(result.exitCode).toBe(0); expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1); expect(result.passed).toBe(1);
}); });
test('globalSetup auth should compile', async ({ runTSC }) => { test('globalSetup auth should compile', async ({ runTSC }) => {
const result = await runTSC(authFiles); const result = await runTSC(authFiles);
expect(result.exitCode).toBe(0); expect(result.exitCode).toBe(0);
}); });
});
}