loadUtils.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  1. "use strict";
  2. var __create = Object.create;
  3. var __defProp = Object.defineProperty;
  4. var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
  5. var __getOwnPropNames = Object.getOwnPropertyNames;
  6. var __getProtoOf = Object.getPrototypeOf;
  7. var __hasOwnProp = Object.prototype.hasOwnProperty;
  8. var __export = (target, all) => {
  9. for (var name in all)
  10. __defProp(target, name, { get: all[name], enumerable: true });
  11. };
  12. var __copyProps = (to, from, except, desc) => {
  13. if (from && typeof from === "object" || typeof from === "function") {
  14. for (let key of __getOwnPropNames(from))
  15. if (!__hasOwnProp.call(to, key) && key !== except)
  16. __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  17. }
  18. return to;
  19. };
  20. var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  21. // If the importer is in node compatibility mode or this is not an ESM
  22. // file that has been converted to a CommonJS file using a Babel-
  23. // compatible transform (i.e. "__esModule" has not been set), then set
  24. // "default" to the CommonJS "module.exports" for node compatibility.
  25. isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  26. mod
  27. ));
  28. var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
  29. var loadUtils_exports = {};
  30. __export(loadUtils_exports, {
  31. collectProjectsAndTestFiles: () => collectProjectsAndTestFiles,
  32. createRootSuite: () => createRootSuite,
  33. loadFileSuites: () => loadFileSuites,
  34. loadGlobalHook: () => loadGlobalHook,
  35. loadReporter: () => loadReporter
  36. });
  37. module.exports = __toCommonJS(loadUtils_exports);
  38. var import_path = __toESM(require("path"));
  39. var import_loaderHost = require("./loaderHost");
  40. var import_util = require("../util");
  41. var import_projectUtils = require("./projectUtils");
  42. var import_testGroups = require("./testGroups");
  43. var import_suiteUtils = require("../common/suiteUtils");
  44. var import_test = require("../common/test");
  45. var import_compilationCache = require("../transform/compilationCache");
  46. var import_transform = require("../transform/transform");
  47. var import_utilsBundle = require("../utilsBundle");
  48. async function collectProjectsAndTestFiles(testRun, doNotRunTestsOutsideProjectFilter) {
  49. const config = testRun.config;
  50. const fsCache = /* @__PURE__ */ new Map();
  51. const sourceMapCache = /* @__PURE__ */ new Map();
  52. const cliFileMatcher = config.cliArgs.length ? (0, import_util.createFileMatcherFromArguments)(config.cliArgs) : null;
  53. const allFilesForProject = /* @__PURE__ */ new Map();
  54. const filteredProjects = (0, import_projectUtils.filterProjects)(config.projects, config.cliProjectFilter);
  55. for (const project of filteredProjects) {
  56. const files = await (0, import_projectUtils.collectFilesForProject)(project, fsCache);
  57. allFilesForProject.set(project, files);
  58. }
  59. const filesToRunByProject = /* @__PURE__ */ new Map();
  60. for (const [project, files] of allFilesForProject) {
  61. const matchedFiles = files.filter((file) => {
  62. const hasMatchingSources = sourceMapSources(file, sourceMapCache).some((source) => {
  63. if (cliFileMatcher && !cliFileMatcher(source))
  64. return false;
  65. return true;
  66. });
  67. return hasMatchingSources;
  68. });
  69. const filteredFiles = matchedFiles.filter(Boolean);
  70. filesToRunByProject.set(project, filteredFiles);
  71. }
  72. const projectClosure = (0, import_projectUtils.buildProjectsClosure)([...filesToRunByProject.keys()]);
  73. for (const [project, type] of projectClosure) {
  74. if (type === "dependency") {
  75. const treatProjectAsEmpty = doNotRunTestsOutsideProjectFilter && !filteredProjects.includes(project);
  76. const files = treatProjectAsEmpty ? [] : allFilesForProject.get(project) || await (0, import_projectUtils.collectFilesForProject)(project, fsCache);
  77. filesToRunByProject.set(project, files);
  78. }
  79. }
  80. testRun.projectFiles = filesToRunByProject;
  81. testRun.projectSuites = /* @__PURE__ */ new Map();
  82. }
  83. async function loadFileSuites(testRun, mode, errors) {
  84. const config = testRun.config;
  85. const allTestFiles = /* @__PURE__ */ new Set();
  86. for (const files of testRun.projectFiles.values())
  87. files.forEach((file) => allTestFiles.add(file));
  88. const fileSuiteByFile = /* @__PURE__ */ new Map();
  89. const loaderHost = mode === "out-of-process" ? new import_loaderHost.OutOfProcessLoaderHost(config) : new import_loaderHost.InProcessLoaderHost(config);
  90. if (await loaderHost.start(errors)) {
  91. for (const file of allTestFiles) {
  92. const fileSuite = await loaderHost.loadTestFile(file, errors);
  93. fileSuiteByFile.set(file, fileSuite);
  94. errors.push(...createDuplicateTitlesErrors(config, fileSuite));
  95. }
  96. await loaderHost.stop();
  97. }
  98. for (const file of allTestFiles) {
  99. for (const dependency of (0, import_compilationCache.dependenciesForTestFile)(file)) {
  100. if (allTestFiles.has(dependency)) {
  101. const importer = import_path.default.relative(config.config.rootDir, file);
  102. const importee = import_path.default.relative(config.config.rootDir, dependency);
  103. errors.push({
  104. message: `Error: test file "${importer}" should not import test file "${importee}"`,
  105. location: { file, line: 1, column: 1 }
  106. });
  107. }
  108. }
  109. }
  110. for (const [project, files] of testRun.projectFiles) {
  111. const suites = files.map((file) => fileSuiteByFile.get(file)).filter(Boolean);
  112. testRun.projectSuites.set(project, suites);
  113. }
  114. }
  115. async function createRootSuite(testRun, errors, shouldFilterOnly) {
  116. const config = testRun.config;
  117. const rootSuite = new import_test.Suite("", "root");
  118. const projectSuites = /* @__PURE__ */ new Map();
  119. const filteredProjectSuites = /* @__PURE__ */ new Map();
  120. {
  121. const cliFileFilters = (0, import_util.createFileFiltersFromArguments)(config.cliArgs);
  122. const grepMatcher = config.cliGrep ? (0, import_util.createTitleMatcher)((0, import_util.forceRegExp)(config.cliGrep)) : () => true;
  123. const grepInvertMatcher = config.cliGrepInvert ? (0, import_util.createTitleMatcher)((0, import_util.forceRegExp)(config.cliGrepInvert)) : () => false;
  124. const cliTitleMatcher = (title) => !grepInvertMatcher(title) && grepMatcher(title);
  125. for (const [project, fileSuites] of testRun.projectSuites) {
  126. const projectSuite = createProjectSuite(project, fileSuites);
  127. projectSuites.set(project, projectSuite);
  128. const filteredProjectSuite = filterProjectSuite(projectSuite, { cliFileFilters, cliTitleMatcher, testFilters: config.preOnlyTestFilters });
  129. filteredProjectSuites.set(project, filteredProjectSuite);
  130. }
  131. }
  132. if (shouldFilterOnly) {
  133. const filteredRoot = new import_test.Suite("", "root");
  134. for (const filteredProjectSuite of filteredProjectSuites.values())
  135. filteredRoot._addSuite(filteredProjectSuite);
  136. (0, import_suiteUtils.filterOnly)(filteredRoot);
  137. for (const [project, filteredProjectSuite] of filteredProjectSuites) {
  138. if (!filteredRoot.suites.includes(filteredProjectSuite))
  139. filteredProjectSuites.delete(project);
  140. }
  141. }
  142. const projectClosure = (0, import_projectUtils.buildProjectsClosure)([...filteredProjectSuites.keys()], (project) => filteredProjectSuites.get(project)._hasTests());
  143. for (const [project, type] of projectClosure) {
  144. if (type === "top-level") {
  145. project.project.repeatEach = project.fullConfig.configCLIOverrides.repeatEach ?? project.project.repeatEach;
  146. rootSuite._addSuite(buildProjectSuite(project, filteredProjectSuites.get(project)));
  147. }
  148. }
  149. if (config.config.forbidOnly) {
  150. const onlyTestsAndSuites = rootSuite._getOnlyItems();
  151. if (onlyTestsAndSuites.length > 0) {
  152. const configFilePath = config.config.configFile ? import_path.default.relative(config.config.rootDir, config.config.configFile) : void 0;
  153. errors.push(...createForbidOnlyErrors(onlyTestsAndSuites, config.configCLIOverrides.forbidOnly, configFilePath));
  154. }
  155. }
  156. if (config.config.shard) {
  157. const testGroups = [];
  158. for (const projectSuite of rootSuite.suites) {
  159. testGroups.push(...(0, import_testGroups.createTestGroups)(projectSuite, config.config.shard.total));
  160. }
  161. const testGroupsInThisShard = (0, import_testGroups.filterForShard)(config.config.shard, testGroups);
  162. const testsInThisShard = /* @__PURE__ */ new Set();
  163. for (const group of testGroupsInThisShard) {
  164. for (const test of group.tests)
  165. testsInThisShard.add(test);
  166. }
  167. (0, import_suiteUtils.filterTestsRemoveEmptySuites)(rootSuite, (test) => testsInThisShard.has(test));
  168. }
  169. if (config.postShardTestFilters.length)
  170. (0, import_suiteUtils.filterTestsRemoveEmptySuites)(rootSuite, (test) => config.postShardTestFilters.every((filter) => filter(test)));
  171. {
  172. const projectClosure2 = new Map((0, import_projectUtils.buildProjectsClosure)(rootSuite.suites.map((suite) => suite._fullProject)));
  173. for (const [project, level] of projectClosure2.entries()) {
  174. if (level === "dependency")
  175. rootSuite._prependSuite(buildProjectSuite(project, projectSuites.get(project)));
  176. }
  177. }
  178. return rootSuite;
  179. }
  180. function createProjectSuite(project, fileSuites) {
  181. const projectSuite = new import_test.Suite(project.project.name, "project");
  182. for (const fileSuite of fileSuites)
  183. projectSuite._addSuite((0, import_suiteUtils.bindFileSuiteToProject)(project, fileSuite));
  184. const grepMatcher = (0, import_util.createTitleMatcher)(project.project.grep);
  185. const grepInvertMatcher = project.project.grepInvert ? (0, import_util.createTitleMatcher)(project.project.grepInvert) : null;
  186. (0, import_suiteUtils.filterTestsRemoveEmptySuites)(projectSuite, (test) => {
  187. const grepTitle = test._grepTitleWithTags();
  188. if (grepInvertMatcher?.(grepTitle))
  189. return false;
  190. return grepMatcher(grepTitle);
  191. });
  192. return projectSuite;
  193. }
  194. function filterProjectSuite(projectSuite, options) {
  195. if (!options.cliFileFilters.length && !options.cliTitleMatcher && !options.testFilters.length)
  196. return projectSuite;
  197. const result = projectSuite._deepClone();
  198. if (options.cliFileFilters.length)
  199. (0, import_suiteUtils.filterByFocusedLine)(result, options.cliFileFilters);
  200. (0, import_suiteUtils.filterTestsRemoveEmptySuites)(result, (test) => {
  201. if (!options.testFilters.every((filter) => filter(test)))
  202. return false;
  203. if (options.cliTitleMatcher && !options.cliTitleMatcher(test._grepTitleWithTags()))
  204. return false;
  205. return true;
  206. });
  207. return result;
  208. }
  209. function buildProjectSuite(project, projectSuite) {
  210. const result = new import_test.Suite(project.project.name, "project");
  211. result._fullProject = project;
  212. if (project.fullyParallel)
  213. result._parallelMode = "parallel";
  214. for (const fileSuite of projectSuite.suites) {
  215. result._addSuite(fileSuite);
  216. for (let repeatEachIndex = 1; repeatEachIndex < project.project.repeatEach; repeatEachIndex++) {
  217. const clone = fileSuite._deepClone();
  218. (0, import_suiteUtils.applyRepeatEachIndex)(project, clone, repeatEachIndex);
  219. result._addSuite(clone);
  220. }
  221. }
  222. return result;
  223. }
  224. function createForbidOnlyErrors(onlyTestsAndSuites, forbidOnlyCLIFlag, configFilePath) {
  225. const errors = [];
  226. for (const testOrSuite of onlyTestsAndSuites) {
  227. const title = testOrSuite.titlePath().slice(2).join(" ");
  228. const configFilePathName = configFilePath ? `'${configFilePath}'` : "the Playwright configuration file";
  229. const forbidOnlySource = forbidOnlyCLIFlag ? `'--forbid-only' CLI flag` : `'forbidOnly' option in ${configFilePathName}`;
  230. const error = {
  231. message: `Error: item focused with '.only' is not allowed due to the ${forbidOnlySource}: "${title}"`,
  232. location: testOrSuite.location
  233. };
  234. errors.push(error);
  235. }
  236. return errors;
  237. }
  238. function createDuplicateTitlesErrors(config, fileSuite) {
  239. const errors = [];
  240. const testsByFullTitle = /* @__PURE__ */ new Map();
  241. for (const test of fileSuite.allTests()) {
  242. const fullTitle = test.titlePath().slice(1).join(" \u203A ");
  243. const existingTest = testsByFullTitle.get(fullTitle);
  244. if (existingTest) {
  245. const error = {
  246. message: `Error: duplicate test title "${fullTitle}", first declared in ${buildItemLocation(config.config.rootDir, existingTest)}`,
  247. location: test.location
  248. };
  249. errors.push(error);
  250. }
  251. testsByFullTitle.set(fullTitle, test);
  252. }
  253. return errors;
  254. }
  255. function buildItemLocation(rootDir, testOrSuite) {
  256. if (!testOrSuite.location)
  257. return "";
  258. return `${import_path.default.relative(rootDir, testOrSuite.location.file)}:${testOrSuite.location.line}`;
  259. }
  260. async function requireOrImportDefaultFunction(file, expectConstructor) {
  261. let func = await (0, import_transform.requireOrImport)(file);
  262. if (func && typeof func === "object" && "default" in func)
  263. func = func["default"];
  264. if (typeof func !== "function")
  265. throw (0, import_util.errorWithFile)(file, `file must export a single ${expectConstructor ? "class" : "function"}.`);
  266. return func;
  267. }
  268. function loadGlobalHook(config, file) {
  269. return requireOrImportDefaultFunction(import_path.default.resolve(config.config.rootDir, file), false);
  270. }
  271. function loadReporter(config, file) {
  272. return requireOrImportDefaultFunction(config ? import_path.default.resolve(config.config.rootDir, file) : file, true);
  273. }
  274. function sourceMapSources(file, cache) {
  275. let sources = [file];
  276. if (!file.endsWith(".js"))
  277. return sources;
  278. if (cache.has(file))
  279. return cache.get(file);
  280. try {
  281. const sourceMap = import_utilsBundle.sourceMapSupport.retrieveSourceMap(file);
  282. const sourceMapData = typeof sourceMap?.map === "string" ? JSON.parse(sourceMap.map) : sourceMap?.map;
  283. if (sourceMapData?.sources)
  284. sources = sourceMapData.sources.map((source) => import_path.default.resolve(import_path.default.dirname(file), source));
  285. } finally {
  286. cache.set(file, sources);
  287. return sources;
  288. }
  289. }
  290. // Annotate the CommonJS export names for ESM import in node:
  291. 0 && (module.exports = {
  292. collectProjectsAndTestFiles,
  293. createRootSuite,
  294. loadFileSuites,
  295. loadGlobalHook,
  296. loadReporter
  297. });