loadUtils.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.collectProjectsAndTestFiles = collectProjectsAndTestFiles;
  6. exports.createRootSuite = createRootSuite;
  7. exports.loadFileSuites = loadFileSuites;
  8. exports.loadGlobalHook = loadGlobalHook;
  9. exports.loadReporter = loadReporter;
  10. var _path = _interopRequireDefault(require("path"));
  11. var _loaderHost = require("./loaderHost");
  12. var _test = require("../common/test");
  13. var _util = require("../util");
  14. var _projectUtils = require("./projectUtils");
  15. var _transform = require("../transform/transform");
  16. var _suiteUtils = require("../common/suiteUtils");
  17. var _testGroups = require("./testGroups");
  18. var _compilationCache = require("../transform/compilationCache");
  19. var _utilsBundle = require("../utilsBundle");
  20. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  21. /**
  22. * Copyright Microsoft Corporation. All rights reserved.
  23. *
  24. * Licensed under the Apache License, Version 2.0 (the "License");
  25. * you may not use this file except in compliance with the License.
  26. * You may obtain a copy of the License at
  27. *
  28. * http://www.apache.org/licenses/LICENSE-2.0
  29. *
  30. * Unless required by applicable law or agreed to in writing, software
  31. * distributed under the License is distributed on an "AS IS" BASIS,
  32. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  33. * See the License for the specific language governing permissions and
  34. * limitations under the License.
  35. */
  36. async function collectProjectsAndTestFiles(testRun, doNotRunTestsOutsideProjectFilter, additionalFileMatcher) {
  37. const config = testRun.config;
  38. const fsCache = new Map();
  39. const sourceMapCache = new Map();
  40. const cliFileMatcher = config.cliArgs.length ? (0, _util.createFileMatcherFromArguments)(config.cliArgs) : null;
  41. // First collect all files for the projects in the command line, don't apply any file filters.
  42. const allFilesForProject = new Map();
  43. const filteredProjects = (0, _projectUtils.filterProjects)(config.projects, config.cliProjectFilter);
  44. for (const project of filteredProjects) {
  45. const files = await (0, _projectUtils.collectFilesForProject)(project, fsCache);
  46. allFilesForProject.set(project, files);
  47. }
  48. // Filter files based on the file filters, eliminate the empty projects.
  49. const filesToRunByProject = new Map();
  50. for (const [project, files] of allFilesForProject) {
  51. const matchedFiles = files.filter(file => {
  52. const hasMatchingSources = sourceMapSources(file, sourceMapCache).some(source => {
  53. if (additionalFileMatcher && !additionalFileMatcher(source)) return false;
  54. if (cliFileMatcher && !cliFileMatcher(source)) return false;
  55. return true;
  56. });
  57. return hasMatchingSources;
  58. });
  59. const filteredFiles = matchedFiles.filter(Boolean);
  60. if (filteredFiles.length) filesToRunByProject.set(project, filteredFiles);
  61. }
  62. // (Re-)add all files for dependent projects, disregard filters.
  63. const projectClosure = (0, _projectUtils.buildProjectsClosure)([...filesToRunByProject.keys()]);
  64. for (const [project, type] of projectClosure) {
  65. if (type === 'dependency') {
  66. filesToRunByProject.delete(project);
  67. const treatProjectAsEmpty = doNotRunTestsOutsideProjectFilter && !filteredProjects.includes(project);
  68. const files = treatProjectAsEmpty ? [] : allFilesForProject.get(project) || (await (0, _projectUtils.collectFilesForProject)(project, fsCache));
  69. filesToRunByProject.set(project, files);
  70. }
  71. }
  72. testRun.projects = [...filesToRunByProject.keys()];
  73. testRun.projectFiles = filesToRunByProject;
  74. testRun.projectSuites = new Map();
  75. }
  76. async function loadFileSuites(testRun, mode, errors) {
  77. // Determine all files to load.
  78. const config = testRun.config;
  79. const allTestFiles = new Set();
  80. for (const files of testRun.projectFiles.values()) files.forEach(file => allTestFiles.add(file));
  81. // Load test files.
  82. const fileSuiteByFile = new Map();
  83. const loaderHost = mode === 'out-of-process' ? new _loaderHost.OutOfProcessLoaderHost(config) : new _loaderHost.InProcessLoaderHost(config);
  84. if (await loaderHost.start(errors)) {
  85. for (const file of allTestFiles) {
  86. const fileSuite = await loaderHost.loadTestFile(file, errors);
  87. fileSuiteByFile.set(file, fileSuite);
  88. errors.push(...createDuplicateTitlesErrors(config, fileSuite));
  89. }
  90. await loaderHost.stop();
  91. }
  92. // Check that no test file imports another test file.
  93. // Loader must be stopped first, since it populates the dependency tree.
  94. for (const file of allTestFiles) {
  95. for (const dependency of (0, _compilationCache.dependenciesForTestFile)(file)) {
  96. if (allTestFiles.has(dependency)) {
  97. const importer = _path.default.relative(config.config.rootDir, file);
  98. const importee = _path.default.relative(config.config.rootDir, dependency);
  99. errors.push({
  100. message: `Error: test file "${importer}" should not import test file "${importee}"`,
  101. location: {
  102. file,
  103. line: 1,
  104. column: 1
  105. }
  106. });
  107. }
  108. }
  109. }
  110. // Collect file suites for each project.
  111. for (const [project, files] of testRun.projectFiles) {
  112. const suites = files.map(file => fileSuiteByFile.get(file)).filter(Boolean);
  113. testRun.projectSuites.set(project, suites);
  114. }
  115. }
  116. async function createRootSuite(testRun, errors, shouldFilterOnly) {
  117. const config = testRun.config;
  118. // Create root suite, where each child will be a project suite with cloned file suites inside it.
  119. const rootSuite = new _test.Suite('', 'root');
  120. const projectSuites = new Map();
  121. const filteredProjectSuites = new Map();
  122. // Filter all the projects using grep, testId, file names.
  123. {
  124. // Interpret cli parameters.
  125. const cliFileFilters = (0, _util.createFileFiltersFromArguments)(config.cliArgs);
  126. const grepMatcher = config.cliGrep ? (0, _util.createTitleMatcher)((0, _util.forceRegExp)(config.cliGrep)) : () => true;
  127. const grepInvertMatcher = config.cliGrepInvert ? (0, _util.createTitleMatcher)((0, _util.forceRegExp)(config.cliGrepInvert)) : () => false;
  128. const cliTitleMatcher = title => !grepInvertMatcher(title) && grepMatcher(title);
  129. // Filter file suites for all projects.
  130. for (const [project, fileSuites] of testRun.projectSuites) {
  131. const projectSuite = createProjectSuite(project, fileSuites);
  132. projectSuites.set(project, projectSuite);
  133. const filteredProjectSuite = filterProjectSuite(projectSuite, {
  134. cliFileFilters,
  135. cliTitleMatcher,
  136. testIdMatcher: config.testIdMatcher
  137. });
  138. filteredProjectSuites.set(project, filteredProjectSuite);
  139. }
  140. }
  141. if (shouldFilterOnly) {
  142. // Create a fake root to execute the exclusive semantics across the projects.
  143. const filteredRoot = new _test.Suite('', 'root');
  144. for (const filteredProjectSuite of filteredProjectSuites.values()) filteredRoot._addSuite(filteredProjectSuite);
  145. (0, _suiteUtils.filterOnly)(filteredRoot);
  146. for (const [project, filteredProjectSuite] of filteredProjectSuites) {
  147. if (!filteredRoot.suites.includes(filteredProjectSuite)) filteredProjectSuites.delete(project);
  148. }
  149. }
  150. // Add post-filtered top-level projects to the root suite for sharding and 'only' processing.
  151. const projectClosure = (0, _projectUtils.buildProjectsClosure)([...filteredProjectSuites.keys()], project => filteredProjectSuites.get(project)._hasTests());
  152. for (const [project, type] of projectClosure) {
  153. if (type === 'top-level') {
  154. var _project$fullConfig$c;
  155. project.project.repeatEach = (_project$fullConfig$c = project.fullConfig.configCLIOverrides.repeatEach) !== null && _project$fullConfig$c !== void 0 ? _project$fullConfig$c : project.project.repeatEach;
  156. rootSuite._addSuite(buildProjectSuite(project, filteredProjectSuites.get(project)));
  157. }
  158. }
  159. // Complain about only.
  160. if (config.config.forbidOnly) {
  161. const onlyTestsAndSuites = rootSuite._getOnlyItems();
  162. if (onlyTestsAndSuites.length > 0) {
  163. const configFilePath = config.config.configFile ? _path.default.relative(config.config.rootDir, config.config.configFile) : undefined;
  164. errors.push(...createForbidOnlyErrors(onlyTestsAndSuites, config.configCLIOverrides.forbidOnly, configFilePath));
  165. }
  166. }
  167. // Shard only the top-level projects.
  168. if (config.config.shard) {
  169. // Create test groups for top-level projects.
  170. const testGroups = [];
  171. for (const projectSuite of rootSuite.suites) testGroups.push(...(0, _testGroups.createTestGroups)(projectSuite, config.config.workers));
  172. // Shard test groups.
  173. const testGroupsInThisShard = (0, _testGroups.filterForShard)(config.config.shard, testGroups);
  174. const testsInThisShard = new Set();
  175. for (const group of testGroupsInThisShard) {
  176. for (const test of group.tests) testsInThisShard.add(test);
  177. }
  178. // Update project suites, removing empty ones.
  179. (0, _suiteUtils.filterTestsRemoveEmptySuites)(rootSuite, test => testsInThisShard.has(test));
  180. }
  181. // Now prepend dependency projects without filtration.
  182. {
  183. // Filtering 'only' and sharding might have reduced the number of top-level projects.
  184. // Build the project closure to only include dependencies that are still needed.
  185. const projectClosure = new Map((0, _projectUtils.buildProjectsClosure)(rootSuite.suites.map(suite => suite._fullProject)));
  186. // Clone file suites for dependency projects.
  187. for (const project of projectClosure.keys()) {
  188. if (projectClosure.get(project) === 'dependency') rootSuite._prependSuite(buildProjectSuite(project, projectSuites.get(project)));
  189. }
  190. }
  191. return rootSuite;
  192. }
  193. function createProjectSuite(project, fileSuites) {
  194. const projectSuite = new _test.Suite(project.project.name, 'project');
  195. for (const fileSuite of fileSuites) projectSuite._addSuite((0, _suiteUtils.bindFileSuiteToProject)(project, fileSuite));
  196. const grepMatcher = (0, _util.createTitleMatcher)(project.project.grep);
  197. const grepInvertMatcher = project.project.grepInvert ? (0, _util.createTitleMatcher)(project.project.grepInvert) : null;
  198. const titleMatcher = test => {
  199. const grepTitle = test.titlePath().join(' ');
  200. if (grepInvertMatcher !== null && grepInvertMatcher !== void 0 && grepInvertMatcher(grepTitle)) return false;
  201. return grepMatcher(grepTitle);
  202. };
  203. (0, _suiteUtils.filterTestsRemoveEmptySuites)(projectSuite, titleMatcher);
  204. return projectSuite;
  205. }
  206. function filterProjectSuite(projectSuite, options) {
  207. // Fast path.
  208. if (!options.cliFileFilters.length && !options.cliTitleMatcher && !options.testIdMatcher) return projectSuite;
  209. const result = projectSuite._deepClone();
  210. if (options.cliFileFilters.length) (0, _suiteUtils.filterByFocusedLine)(result, options.cliFileFilters);
  211. if (options.testIdMatcher) (0, _suiteUtils.filterByTestIds)(result, options.testIdMatcher);
  212. const titleMatcher = test => {
  213. return !options.cliTitleMatcher || options.cliTitleMatcher(test.titlePath().join(' '));
  214. };
  215. (0, _suiteUtils.filterTestsRemoveEmptySuites)(result, titleMatcher);
  216. return result;
  217. }
  218. function buildProjectSuite(project, projectSuite) {
  219. const result = new _test.Suite(project.project.name, 'project');
  220. result._fullProject = project;
  221. if (project.fullyParallel) result._parallelMode = 'parallel';
  222. for (const fileSuite of projectSuite.suites) {
  223. // Fast path for the repeatEach = 0.
  224. result._addSuite(fileSuite);
  225. for (let repeatEachIndex = 1; repeatEachIndex < project.project.repeatEach; repeatEachIndex++) {
  226. const clone = fileSuite._deepClone();
  227. (0, _suiteUtils.applyRepeatEachIndex)(project, clone, repeatEachIndex);
  228. result._addSuite(clone);
  229. }
  230. }
  231. return result;
  232. }
  233. function createForbidOnlyErrors(onlyTestsAndSuites, forbidOnlyCLIFlag, configFilePath) {
  234. const errors = [];
  235. for (const testOrSuite of onlyTestsAndSuites) {
  236. // Skip root and file.
  237. const title = testOrSuite.titlePath().slice(2).join(' ');
  238. const configFilePathName = configFilePath ? `'${configFilePath}'` : 'the Playwright configuration file';
  239. const forbidOnlySource = forbidOnlyCLIFlag ? `'--forbid-only' CLI flag` : `'forbidOnly' option in ${configFilePathName}`;
  240. const error = {
  241. message: `Error: item focused with '.only' is not allowed due to the ${forbidOnlySource}: "${title}"`,
  242. location: testOrSuite.location
  243. };
  244. errors.push(error);
  245. }
  246. return errors;
  247. }
  248. function createDuplicateTitlesErrors(config, fileSuite) {
  249. const errors = [];
  250. const testsByFullTitle = new Map();
  251. for (const test of fileSuite.allTests()) {
  252. const fullTitle = test.titlePath().slice(1).join(' › ');
  253. const existingTest = testsByFullTitle.get(fullTitle);
  254. if (existingTest) {
  255. const error = {
  256. message: `Error: duplicate test title "${fullTitle}", first declared in ${buildItemLocation(config.config.rootDir, existingTest)}`,
  257. location: test.location
  258. };
  259. errors.push(error);
  260. }
  261. testsByFullTitle.set(fullTitle, test);
  262. }
  263. return errors;
  264. }
  265. function buildItemLocation(rootDir, testOrSuite) {
  266. if (!testOrSuite.location) return '';
  267. return `${_path.default.relative(rootDir, testOrSuite.location.file)}:${testOrSuite.location.line}`;
  268. }
  269. async function requireOrImportDefaultFunction(file, expectConstructor) {
  270. let func = await (0, _transform.requireOrImport)(file);
  271. if (func && typeof func === 'object' && 'default' in func) func = func['default'];
  272. if (typeof func !== 'function') throw (0, _util.errorWithFile)(file, `file must export a single ${expectConstructor ? 'class' : 'function'}.`);
  273. return func;
  274. }
  275. function loadGlobalHook(config, file) {
  276. return requireOrImportDefaultFunction(_path.default.resolve(config.config.rootDir, file), false);
  277. }
  278. function loadReporter(config, file) {
  279. return requireOrImportDefaultFunction(_path.default.resolve(config.config.rootDir, file), true);
  280. }
  281. function sourceMapSources(file, cache) {
  282. let sources = [file];
  283. if (!file.endsWith('.js')) return sources;
  284. if (cache.has(file)) return cache.get(file);
  285. try {
  286. const sourceMap = _utilsBundle.sourceMapSupport.retrieveSourceMap(file);
  287. const sourceMapData = typeof (sourceMap === null || sourceMap === void 0 ? void 0 : sourceMap.map) === 'string' ? JSON.parse(sourceMap.map) : sourceMap === null || sourceMap === void 0 ? void 0 : sourceMap.map;
  288. if (sourceMapData !== null && sourceMapData !== void 0 && sourceMapData.sources) sources = sourceMapData.sources.map(source => _path.default.resolve(_path.default.dirname(file), source));
  289. } finally {
  290. cache.set(file, sources);
  291. return sources;
  292. }
  293. }