271 lines
14 KiB
JavaScript
271 lines
14 KiB
JavaScript
|
"use strict";
|
||
|
|
|
||
|
|
Object.defineProperty(exports, "__esModule", {
|
||
|
|
value: true
|
||
|
|
});
|
||
|
|
exports.defaultTimeout = exports.defaultReporter = exports.defaultGrep = exports.builtInReporters = exports.FullProjectInternal = exports.FullConfigInternal = void 0;
|
||
|
|
exports.getProjectId = getProjectId;
|
||
|
|
exports.takeFirst = takeFirst;
|
||
|
|
exports.toReporters = toReporters;
|
||
|
|
var _fs = _interopRequireDefault(require("fs"));
|
||
|
|
var _os = _interopRequireDefault(require("os"));
|
||
|
|
var _path = _interopRequireDefault(require("path"));
|
||
|
|
var _util = require("../util");
|
||
|
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
||
|
|
/**
|
||
|
|
* Copyright Microsoft Corporation. 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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
const defaultTimeout = exports.defaultTimeout = 30000;
|
||
|
|
class FullConfigInternal {
|
||
|
|
constructor(location, userConfig, configCLIOverrides, metadata) {
|
||
|
|
var _this$globalSetups$, _this$globalTeardowns;
|
||
|
|
this.config = void 0;
|
||
|
|
this.configDir = void 0;
|
||
|
|
this.configCLIOverrides = void 0;
|
||
|
|
this.webServers = void 0;
|
||
|
|
this.plugins = void 0;
|
||
|
|
this.projects = [];
|
||
|
|
this.singleTSConfigPath = void 0;
|
||
|
|
this.captureGitInfo = void 0;
|
||
|
|
this.cliArgs = [];
|
||
|
|
this.cliGrep = void 0;
|
||
|
|
this.cliGrepInvert = void 0;
|
||
|
|
this.cliOnlyChanged = void 0;
|
||
|
|
this.cliProjectFilter = void 0;
|
||
|
|
this.cliListOnly = false;
|
||
|
|
this.cliPassWithNoTests = void 0;
|
||
|
|
this.cliFailOnFlakyTests = void 0;
|
||
|
|
this.cliLastFailed = void 0;
|
||
|
|
this.testIdMatcher = void 0;
|
||
|
|
this.lastFailedTestIdMatcher = void 0;
|
||
|
|
this.defineConfigWasUsed = false;
|
||
|
|
this.globalSetups = [];
|
||
|
|
this.globalTeardowns = [];
|
||
|
|
if (configCLIOverrides.projects && userConfig.projects) throw new Error(`Cannot use --browser option when configuration file defines projects. Specify browserName in the projects instead.`);
|
||
|
|
const {
|
||
|
|
resolvedConfigFile,
|
||
|
|
configDir
|
||
|
|
} = location;
|
||
|
|
const packageJsonPath = (0, _util.getPackageJsonPath)(configDir);
|
||
|
|
const packageJsonDir = packageJsonPath ? _path.default.dirname(packageJsonPath) : process.cwd();
|
||
|
|
this.configDir = configDir;
|
||
|
|
this.configCLIOverrides = configCLIOverrides;
|
||
|
|
const privateConfiguration = userConfig['@playwright/test'];
|
||
|
|
this.plugins = ((privateConfiguration === null || privateConfiguration === void 0 ? void 0 : privateConfiguration.plugins) || []).map(p => ({
|
||
|
|
factory: p
|
||
|
|
}));
|
||
|
|
this.singleTSConfigPath = pathResolve(configDir, userConfig.tsconfig);
|
||
|
|
this.captureGitInfo = userConfig.captureGitInfo;
|
||
|
|
this.globalSetups = (Array.isArray(userConfig.globalSetup) ? userConfig.globalSetup : [userConfig.globalSetup]).map(s => resolveScript(s, configDir)).filter(script => script !== undefined);
|
||
|
|
this.globalTeardowns = (Array.isArray(userConfig.globalTeardown) ? userConfig.globalTeardown : [userConfig.globalTeardown]).map(s => resolveScript(s, configDir)).filter(script => script !== undefined);
|
||
|
|
|
||
|
|
// Make sure we reuse same metadata instance between FullConfigInternal instances,
|
||
|
|
// so that plugins such as gitCommitInfoPlugin can populate metadata once.
|
||
|
|
userConfig.metadata = userConfig.metadata || {};
|
||
|
|
this.config = {
|
||
|
|
configFile: resolvedConfigFile,
|
||
|
|
rootDir: pathResolve(configDir, userConfig.testDir) || configDir,
|
||
|
|
forbidOnly: takeFirst(configCLIOverrides.forbidOnly, userConfig.forbidOnly, false),
|
||
|
|
fullyParallel: takeFirst(configCLIOverrides.fullyParallel, userConfig.fullyParallel, false),
|
||
|
|
globalSetup: (_this$globalSetups$ = this.globalSetups[0]) !== null && _this$globalSetups$ !== void 0 ? _this$globalSetups$ : null,
|
||
|
|
globalTeardown: (_this$globalTeardowns = this.globalTeardowns[0]) !== null && _this$globalTeardowns !== void 0 ? _this$globalTeardowns : null,
|
||
|
|
globalTimeout: takeFirst(configCLIOverrides.debug ? 0 : undefined, configCLIOverrides.globalTimeout, userConfig.globalTimeout, 0),
|
||
|
|
grep: takeFirst(userConfig.grep, defaultGrep),
|
||
|
|
grepInvert: takeFirst(userConfig.grepInvert, null),
|
||
|
|
maxFailures: takeFirst(configCLIOverrides.debug ? 1 : undefined, configCLIOverrides.maxFailures, userConfig.maxFailures, 0),
|
||
|
|
metadata: metadata !== null && metadata !== void 0 ? metadata : userConfig.metadata,
|
||
|
|
preserveOutput: takeFirst(userConfig.preserveOutput, 'always'),
|
||
|
|
reporter: takeFirst(configCLIOverrides.reporter, resolveReporters(userConfig.reporter, configDir), [[defaultReporter]]),
|
||
|
|
reportSlowTests: takeFirst(userConfig.reportSlowTests, {
|
||
|
|
max: 5,
|
||
|
|
threshold: 300_000 /* 5 minutes */
|
||
|
|
}),
|
||
|
|
quiet: takeFirst(configCLIOverrides.quiet, userConfig.quiet, false),
|
||
|
|
projects: [],
|
||
|
|
shard: takeFirst(configCLIOverrides.shard, userConfig.shard, null),
|
||
|
|
updateSnapshots: takeFirst(configCLIOverrides.updateSnapshots, userConfig.updateSnapshots, 'missing'),
|
||
|
|
updateSourceMethod: takeFirst(configCLIOverrides.updateSourceMethod, userConfig.updateSourceMethod, 'patch'),
|
||
|
|
version: require('../../package.json').version,
|
||
|
|
workers: 0,
|
||
|
|
webServer: null
|
||
|
|
};
|
||
|
|
for (const key in userConfig) {
|
||
|
|
if (key.startsWith('@')) this.config[key] = userConfig[key];
|
||
|
|
}
|
||
|
|
this.config[configInternalSymbol] = this;
|
||
|
|
const workers = takeFirst(configCLIOverrides.debug ? 1 : undefined, configCLIOverrides.workers, userConfig.workers, '50%');
|
||
|
|
if (typeof workers === 'string') {
|
||
|
|
if (workers.endsWith('%')) {
|
||
|
|
const cpus = _os.default.cpus().length;
|
||
|
|
this.config.workers = Math.max(1, Math.floor(cpus * (parseInt(workers, 10) / 100)));
|
||
|
|
} else {
|
||
|
|
this.config.workers = parseWorkers(workers);
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
this.config.workers = workers;
|
||
|
|
}
|
||
|
|
const webServers = takeFirst(userConfig.webServer, null);
|
||
|
|
if (Array.isArray(webServers)) {
|
||
|
|
// multiple web server mode
|
||
|
|
// Due to previous choices, this value shows up to the user in globalSetup as part of FullConfig. Arrays are not supported by the old type.
|
||
|
|
this.config.webServer = null;
|
||
|
|
this.webServers = webServers;
|
||
|
|
} else if (webServers) {
|
||
|
|
// legacy singleton mode
|
||
|
|
this.config.webServer = webServers;
|
||
|
|
this.webServers = [webServers];
|
||
|
|
} else {
|
||
|
|
this.webServers = [];
|
||
|
|
}
|
||
|
|
const projectConfigs = configCLIOverrides.projects || userConfig.projects || [userConfig];
|
||
|
|
this.projects = projectConfigs.map(p => new FullProjectInternal(configDir, userConfig, this, p, this.configCLIOverrides, packageJsonDir));
|
||
|
|
resolveProjectDependencies(this.projects);
|
||
|
|
this._assignUniqueProjectIds(this.projects);
|
||
|
|
this.config.projects = this.projects.map(p => p.project);
|
||
|
|
}
|
||
|
|
_assignUniqueProjectIds(projects) {
|
||
|
|
const usedNames = new Set();
|
||
|
|
for (const p of projects) {
|
||
|
|
const name = p.project.name || '';
|
||
|
|
for (let i = 0; i < projects.length; ++i) {
|
||
|
|
const candidate = name + (i ? i : '');
|
||
|
|
if (usedNames.has(candidate)) continue;
|
||
|
|
p.id = candidate;
|
||
|
|
p.project.__projectId = p.id;
|
||
|
|
usedNames.add(candidate);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
exports.FullConfigInternal = FullConfigInternal;
|
||
|
|
class FullProjectInternal {
|
||
|
|
constructor(configDir, config, fullConfig, projectConfig, configCLIOverrides, packageJsonDir) {
|
||
|
|
var _this$expect$toHaveSc;
|
||
|
|
this.project = void 0;
|
||
|
|
this.fullConfig = void 0;
|
||
|
|
this.fullyParallel = void 0;
|
||
|
|
this.expect = void 0;
|
||
|
|
this.respectGitIgnore = void 0;
|
||
|
|
this.snapshotPathTemplate = void 0;
|
||
|
|
this.ignoreSnapshots = void 0;
|
||
|
|
this.id = '';
|
||
|
|
this.deps = [];
|
||
|
|
this.teardown = void 0;
|
||
|
|
this.fullConfig = fullConfig;
|
||
|
|
const testDir = takeFirst(pathResolve(configDir, projectConfig.testDir), pathResolve(configDir, config.testDir), fullConfig.configDir);
|
||
|
|
this.snapshotPathTemplate = takeFirst(projectConfig.snapshotPathTemplate, config.snapshotPathTemplate);
|
||
|
|
this.project = {
|
||
|
|
grep: takeFirst(projectConfig.grep, config.grep, defaultGrep),
|
||
|
|
grepInvert: takeFirst(projectConfig.grepInvert, config.grepInvert, null),
|
||
|
|
outputDir: takeFirst(configCLIOverrides.outputDir, pathResolve(configDir, projectConfig.outputDir), pathResolve(configDir, config.outputDir), _path.default.join(packageJsonDir, 'test-results')),
|
||
|
|
// Note: we either apply the cli override for repeatEach or not, depending on whether the
|
||
|
|
// project is top-level vs dependency. See collectProjectsAndTestFiles in loadUtils.
|
||
|
|
repeatEach: takeFirst(projectConfig.repeatEach, config.repeatEach, 1),
|
||
|
|
retries: takeFirst(configCLIOverrides.retries, projectConfig.retries, config.retries, 0),
|
||
|
|
metadata: takeFirst(projectConfig.metadata, config.metadata, {}),
|
||
|
|
name: takeFirst(projectConfig.name, config.name, ''),
|
||
|
|
testDir,
|
||
|
|
snapshotDir: takeFirst(pathResolve(configDir, projectConfig.snapshotDir), pathResolve(configDir, config.snapshotDir), testDir),
|
||
|
|
testIgnore: takeFirst(projectConfig.testIgnore, config.testIgnore, []),
|
||
|
|
testMatch: takeFirst(projectConfig.testMatch, config.testMatch, '**/*.@(spec|test).?(c|m)[jt]s?(x)'),
|
||
|
|
timeout: takeFirst(configCLIOverrides.debug ? 0 : undefined, configCLIOverrides.timeout, projectConfig.timeout, config.timeout, defaultTimeout),
|
||
|
|
use: (0, _util.mergeObjects)(config.use, projectConfig.use, configCLIOverrides.use),
|
||
|
|
dependencies: projectConfig.dependencies || [],
|
||
|
|
teardown: projectConfig.teardown
|
||
|
|
};
|
||
|
|
this.fullyParallel = takeFirst(configCLIOverrides.fullyParallel, projectConfig.fullyParallel, config.fullyParallel, undefined);
|
||
|
|
this.expect = takeFirst(projectConfig.expect, config.expect, {});
|
||
|
|
if ((_this$expect$toHaveSc = this.expect.toHaveScreenshot) !== null && _this$expect$toHaveSc !== void 0 && _this$expect$toHaveSc.stylePath) {
|
||
|
|
const stylePaths = Array.isArray(this.expect.toHaveScreenshot.stylePath) ? this.expect.toHaveScreenshot.stylePath : [this.expect.toHaveScreenshot.stylePath];
|
||
|
|
this.expect.toHaveScreenshot.stylePath = stylePaths.map(stylePath => _path.default.resolve(configDir, stylePath));
|
||
|
|
}
|
||
|
|
this.respectGitIgnore = takeFirst(projectConfig.respectGitIgnore, config.respectGitIgnore, !projectConfig.testDir && !config.testDir);
|
||
|
|
this.ignoreSnapshots = takeFirst(configCLIOverrides.ignoreSnapshots, projectConfig.ignoreSnapshots, config.ignoreSnapshots, false);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
exports.FullProjectInternal = FullProjectInternal;
|
||
|
|
function takeFirst(...args) {
|
||
|
|
for (const arg of args) {
|
||
|
|
if (arg !== undefined) return arg;
|
||
|
|
}
|
||
|
|
return undefined;
|
||
|
|
}
|
||
|
|
function pathResolve(baseDir, relative) {
|
||
|
|
if (!relative) return undefined;
|
||
|
|
return _path.default.resolve(baseDir, relative);
|
||
|
|
}
|
||
|
|
function resolveReporters(reporters, rootDir) {
|
||
|
|
var _toReporters;
|
||
|
|
return (_toReporters = toReporters(reporters)) === null || _toReporters === void 0 ? void 0 : _toReporters.map(([id, arg]) => {
|
||
|
|
if (builtInReporters.includes(id)) return [id, arg];
|
||
|
|
return [require.resolve(id, {
|
||
|
|
paths: [rootDir]
|
||
|
|
}), arg];
|
||
|
|
});
|
||
|
|
}
|
||
|
|
function parseWorkers(workers) {
|
||
|
|
const parsedWorkers = parseInt(workers, 10);
|
||
|
|
if (isNaN(parsedWorkers)) throw new Error(`Workers ${workers} must be a number or percentage.`);
|
||
|
|
return parsedWorkers;
|
||
|
|
}
|
||
|
|
function resolveProjectDependencies(projects) {
|
||
|
|
const teardownSet = new Set();
|
||
|
|
for (const project of projects) {
|
||
|
|
for (const dependencyName of project.project.dependencies) {
|
||
|
|
const dependencies = projects.filter(p => p.project.name === dependencyName);
|
||
|
|
if (!dependencies.length) throw new Error(`Project '${project.project.name}' depends on unknown project '${dependencyName}'`);
|
||
|
|
if (dependencies.length > 1) throw new Error(`Project dependencies should have unique names, reading ${dependencyName}`);
|
||
|
|
project.deps.push(...dependencies);
|
||
|
|
}
|
||
|
|
if (project.project.teardown) {
|
||
|
|
const teardowns = projects.filter(p => p.project.name === project.project.teardown);
|
||
|
|
if (!teardowns.length) throw new Error(`Project '${project.project.name}' has unknown teardown project '${project.project.teardown}'`);
|
||
|
|
if (teardowns.length > 1) throw new Error(`Project teardowns should have unique names, reading ${project.project.teardown}`);
|
||
|
|
const teardown = teardowns[0];
|
||
|
|
project.teardown = teardown;
|
||
|
|
teardownSet.add(teardown);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
for (const teardown of teardownSet) {
|
||
|
|
if (teardown.deps.length) throw new Error(`Teardown project ${teardown.project.name} must not have dependencies`);
|
||
|
|
}
|
||
|
|
for (const project of projects) {
|
||
|
|
for (const dep of project.deps) {
|
||
|
|
if (teardownSet.has(dep)) throw new Error(`Project ${project.project.name} must not depend on a teardown project ${dep.project.name}`);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
function toReporters(reporters) {
|
||
|
|
if (!reporters) return;
|
||
|
|
if (typeof reporters === 'string') return [[reporters]];
|
||
|
|
return reporters;
|
||
|
|
}
|
||
|
|
const builtInReporters = exports.builtInReporters = ['list', 'line', 'dot', 'json', 'junit', 'null', 'github', 'html', 'blob'];
|
||
|
|
function resolveScript(id, rootDir) {
|
||
|
|
if (!id) return undefined;
|
||
|
|
const localPath = _path.default.resolve(rootDir, id);
|
||
|
|
if (_fs.default.existsSync(localPath)) return localPath;
|
||
|
|
return require.resolve(id, {
|
||
|
|
paths: [rootDir]
|
||
|
|
});
|
||
|
|
}
|
||
|
|
const defaultGrep = exports.defaultGrep = /.*/;
|
||
|
|
const defaultReporter = exports.defaultReporter = process.env.CI ? 'dot' : 'list';
|
||
|
|
const configInternalSymbol = Symbol('configInternalSymbol');
|
||
|
|
function getProjectId(project) {
|
||
|
|
return project.__projectId;
|
||
|
|
}
|