start
This commit is contained in:
parent
8688af0580
commit
16536beed6
|
|
@ -110,9 +110,9 @@ export default defineConfig({
|
||||||
|
|
||||||
## property: TestConfig.globalSetup
|
## property: TestConfig.globalSetup
|
||||||
* since: v1.10
|
* since: v1.10
|
||||||
- type: ?<[string]>
|
- type: ?<[string]|[Array]<[string]>>
|
||||||
|
|
||||||
Path to the global setup file. This file will be required and run before all the tests. It must export a single function that takes a [FullConfig] argument.
|
Path to the global setup file. This file will be required and run before all the tests. It must export a single function that takes a [FullConfig] argument. Pass an array for multiple global setup files.
|
||||||
|
|
||||||
Learn more about [global setup and teardown](../test-global-setup-teardown.md).
|
Learn more about [global setup and teardown](../test-global-setup-teardown.md).
|
||||||
|
|
||||||
|
|
@ -128,9 +128,9 @@ export default defineConfig({
|
||||||
|
|
||||||
## property: TestConfig.globalTeardown
|
## property: TestConfig.globalTeardown
|
||||||
* since: v1.10
|
* since: v1.10
|
||||||
- type: ?<[string]>
|
- type: ?<[string]|[Array]<[string]>>
|
||||||
|
|
||||||
Path to the global teardown file. This file will be required and run after all the tests. It must export a single function. See also [`property: TestConfig.globalSetup`].
|
Path to the global teardown file. This file will be required and run after all the tests. It must export a single function. See also [`property: TestConfig.globalSetup`]. Pass an array for multiple global teardown files.
|
||||||
|
|
||||||
Learn more about [global setup and teardown](../test-global-setup-teardown.md).
|
Learn more about [global setup and teardown](../test-global-setup-teardown.md).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -57,6 +57,9 @@ export class FullConfigInternal {
|
||||||
testIdMatcher?: Matcher;
|
testIdMatcher?: Matcher;
|
||||||
defineConfigWasUsed = false;
|
defineConfigWasUsed = false;
|
||||||
|
|
||||||
|
globalSetups: string[] = [];
|
||||||
|
globalTeardowns: string[] = [];
|
||||||
|
|
||||||
constructor(location: ConfigLocation, userConfig: Config, configCLIOverrides: ConfigCLIOverrides) {
|
constructor(location: ConfigLocation, userConfig: Config, configCLIOverrides: ConfigCLIOverrides) {
|
||||||
if (configCLIOverrides.projects && userConfig.projects)
|
if (configCLIOverrides.projects && userConfig.projects)
|
||||||
throw new Error(`Cannot use --browser option when configuration file defines projects. Specify browserName in the projects instead.`);
|
throw new Error(`Cannot use --browser option when configuration file defines projects. Specify browserName in the projects instead.`);
|
||||||
|
|
@ -70,13 +73,16 @@ export class FullConfigInternal {
|
||||||
const privateConfiguration = (userConfig as any)['@playwright/test'];
|
const privateConfiguration = (userConfig as any)['@playwright/test'];
|
||||||
this.plugins = (privateConfiguration?.plugins || []).map((p: any) => ({ factory: p }));
|
this.plugins = (privateConfiguration?.plugins || []).map((p: any) => ({ factory: p }));
|
||||||
|
|
||||||
|
this.globalSetups = (Array.isArray(userConfig.globalSetup) ? userConfig.globalSetup : [userConfig.globalSetup]).map(s => resolveScript(s, configDir)).filter((script): script is string => !!script);
|
||||||
|
this.globalTeardowns = (Array.isArray(userConfig.globalTeardown) ? userConfig.globalTeardown : [userConfig.globalTeardown]).map(s => resolveScript(s, configDir)).filter((script): script is string => !!script);
|
||||||
|
|
||||||
this.config = {
|
this.config = {
|
||||||
configFile: resolvedConfigFile,
|
configFile: resolvedConfigFile,
|
||||||
rootDir: pathResolve(configDir, userConfig.testDir) || configDir,
|
rootDir: pathResolve(configDir, userConfig.testDir) || configDir,
|
||||||
forbidOnly: takeFirst(configCLIOverrides.forbidOnly, userConfig.forbidOnly, false),
|
forbidOnly: takeFirst(configCLIOverrides.forbidOnly, userConfig.forbidOnly, false),
|
||||||
fullyParallel: takeFirst(configCLIOverrides.fullyParallel, userConfig.fullyParallel, false),
|
fullyParallel: takeFirst(configCLIOverrides.fullyParallel, userConfig.fullyParallel, false),
|
||||||
globalSetup: takeFirst(resolveScript(userConfig.globalSetup, configDir), null),
|
globalSetup: takeFirst(...this.globalSetups, null),
|
||||||
globalTeardown: takeFirst(resolveScript(userConfig.globalTeardown, configDir), null),
|
globalTeardown: takeFirst(...this.globalTeardowns, null),
|
||||||
globalTimeout: takeFirst(configCLIOverrides.globalTimeout, userConfig.globalTimeout, 0),
|
globalTimeout: takeFirst(configCLIOverrides.globalTimeout, userConfig.globalTimeout, 0),
|
||||||
grep: takeFirst(userConfig.grep, defaultGrep),
|
grep: takeFirst(userConfig.grep, defaultGrep),
|
||||||
grepInvert: takeFirst(userConfig.grepInvert, null),
|
grepInvert: takeFirst(userConfig.grepInvert, null),
|
||||||
|
|
|
||||||
|
|
@ -98,8 +98,11 @@ export function createGlobalSetupTasks(config: FullConfigInternal) {
|
||||||
if (!config.configCLIOverrides.preserveOutputDir && !process.env.PW_TEST_NO_REMOVE_OUTPUT_DIRS)
|
if (!config.configCLIOverrides.preserveOutputDir && !process.env.PW_TEST_NO_REMOVE_OUTPUT_DIRS)
|
||||||
tasks.push(createRemoveOutputDirsTask());
|
tasks.push(createRemoveOutputDirsTask());
|
||||||
tasks.push(...createPluginSetupTasks(config));
|
tasks.push(...createPluginSetupTasks(config));
|
||||||
if (config.config.globalSetup || config.config.globalTeardown)
|
if (config.globalSetups.length || config.globalTeardowns.length) {
|
||||||
tasks.push(createGlobalSetupTask());
|
const length = Math.max(config.globalSetups.length, config.globalTeardowns.length);
|
||||||
|
for (let i = 0; i < length; i++)
|
||||||
|
tasks.push(createGlobalSetupTask(i, length));
|
||||||
|
}
|
||||||
return tasks;
|
return tasks;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -161,15 +164,20 @@ function createPluginBeginTask(plugin: TestRunnerPluginRegistration): Task<TestR
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function createGlobalSetupTask(): Task<TestRun> {
|
function createGlobalSetupTask(index: number, length: number): Task<TestRun> {
|
||||||
let globalSetupResult: any;
|
let globalSetupResult: any;
|
||||||
let globalSetupFinished = false;
|
let globalSetupFinished = false;
|
||||||
let teardownHook: any;
|
let teardownHook: any;
|
||||||
|
|
||||||
|
let title = 'global setup';
|
||||||
|
if (length > 1)
|
||||||
|
title += ` (${index + 1}/${length})`;
|
||||||
|
|
||||||
return {
|
return {
|
||||||
title: 'global setup',
|
title,
|
||||||
setup: async ({ config }) => {
|
setup: async ({ config }) => {
|
||||||
const setupHook = config.config.globalSetup ? await loadGlobalHook(config, config.config.globalSetup) : undefined;
|
const setupHook = config.globalSetups[index] ? await loadGlobalHook(config, config.globalSetups[index]) : undefined;
|
||||||
teardownHook = config.config.globalTeardown ? await loadGlobalHook(config, config.config.globalTeardown) : undefined;
|
teardownHook = config.globalTeardowns[index] ? await loadGlobalHook(config, config.globalTeardowns[index]) : undefined;
|
||||||
globalSetupResult = setupHook ? await setupHook(config.config) : undefined;
|
globalSetupResult = setupHook ? await setupHook(config.config) : undefined;
|
||||||
globalSetupFinished = true;
|
globalSetupFinished = true;
|
||||||
},
|
},
|
||||||
|
|
|
||||||
10
packages/playwright/types/test.d.ts
vendored
10
packages/playwright/types/test.d.ts
vendored
|
|
@ -1077,7 +1077,8 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Path to the global setup file. This file will be required and run before all the tests. It must export a single
|
* Path to the global setup file. This file will be required and run before all the tests. It must export a single
|
||||||
* function that takes a [FullConfig](https://playwright.dev/docs/api/class-fullconfig) argument.
|
* function that takes a [FullConfig](https://playwright.dev/docs/api/class-fullconfig) argument. Pass an array for
|
||||||
|
* multiple global setup files.
|
||||||
*
|
*
|
||||||
* Learn more about [global setup and teardown](https://playwright.dev/docs/test-global-setup-teardown).
|
* Learn more about [global setup and teardown](https://playwright.dev/docs/test-global-setup-teardown).
|
||||||
*
|
*
|
||||||
|
|
@ -1093,12 +1094,13 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
globalSetup?: string;
|
globalSetup?: string|Array<string>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Path to the global teardown file. This file will be required and run after all the tests. It must export a single
|
* Path to the global teardown file. This file will be required and run after all the tests. It must export a single
|
||||||
* function. See also
|
* function. See also
|
||||||
* [testConfig.globalSetup](https://playwright.dev/docs/api/class-testconfig#test-config-global-setup).
|
* [testConfig.globalSetup](https://playwright.dev/docs/api/class-testconfig#test-config-global-setup). Pass an array
|
||||||
|
* for multiple global teardown files.
|
||||||
*
|
*
|
||||||
* Learn more about [global setup and teardown](https://playwright.dev/docs/test-global-setup-teardown).
|
* Learn more about [global setup and teardown](https://playwright.dev/docs/test-global-setup-teardown).
|
||||||
*
|
*
|
||||||
|
|
@ -1114,7 +1116,7 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
|
||||||
* ```
|
* ```
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
globalTeardown?: string;
|
globalTeardown?: string|Array<string>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Maximum time in milliseconds the whole test suite can run. Zero timeout (default) disables this behavior. Useful on
|
* Maximum time in milliseconds the whole test suite can run. Zero timeout (default) disables this behavior. Useful on
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue