tasks.js 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  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 tasks_exports = {};
  30. __export(tasks_exports, {
  31. TestRun: () => TestRun,
  32. createApplyRebaselinesTask: () => createApplyRebaselinesTask,
  33. createClearCacheTask: () => createClearCacheTask,
  34. createGlobalSetupTasks: () => createGlobalSetupTasks,
  35. createListFilesTask: () => createListFilesTask,
  36. createLoadTask: () => createLoadTask,
  37. createPluginSetupTasks: () => createPluginSetupTasks,
  38. createReportBeginTask: () => createReportBeginTask,
  39. createRunTestsTasks: () => createRunTestsTasks,
  40. createStartDevServerTask: () => createStartDevServerTask,
  41. runTasks: () => runTasks,
  42. runTasksDeferCleanup: () => runTasksDeferCleanup
  43. });
  44. module.exports = __toCommonJS(tasks_exports);
  45. var import_fs = __toESM(require("fs"));
  46. var import_path = __toESM(require("path"));
  47. var import_util = require("util");
  48. var import_utils = require("playwright-core/lib/utils");
  49. var import_utilsBundle = require("playwright-core/lib/utilsBundle");
  50. var import_dispatcher = require("./dispatcher");
  51. var import_failureTracker = require("./failureTracker");
  52. var import_loadUtils = require("./loadUtils");
  53. var import_projectUtils = require("./projectUtils");
  54. var import_rebase = require("./rebase");
  55. var import_taskRunner = require("./taskRunner");
  56. var import_vcs = require("./vcs");
  57. var import_test = require("../common/test");
  58. var import_testGroups = require("../runner/testGroups");
  59. var import_compilationCache = require("../transform/compilationCache");
  60. var import_util2 = require("../util");
  61. const readDirAsync = (0, import_util.promisify)(import_fs.default.readdir);
  62. class TestRun {
  63. constructor(config, reporter) {
  64. this.rootSuite = void 0;
  65. this.phases = [];
  66. this.projectFiles = /* @__PURE__ */ new Map();
  67. this.projectSuites = /* @__PURE__ */ new Map();
  68. this.config = config;
  69. this.reporter = reporter;
  70. this.failureTracker = new import_failureTracker.FailureTracker(config);
  71. }
  72. }
  73. async function runTasks(testRun, tasks, globalTimeout, cancelPromise) {
  74. const deadline = globalTimeout ? (0, import_utils.monotonicTime)() + globalTimeout : 0;
  75. const taskRunner = new import_taskRunner.TaskRunner(testRun.reporter, globalTimeout || 0);
  76. for (const task of tasks)
  77. taskRunner.addTask(task);
  78. testRun.reporter.onConfigure(testRun.config.config);
  79. const status = await taskRunner.run(testRun, deadline, cancelPromise);
  80. return await finishTaskRun(testRun, status);
  81. }
  82. async function runTasksDeferCleanup(testRun, tasks) {
  83. const taskRunner = new import_taskRunner.TaskRunner(testRun.reporter, 0);
  84. for (const task of tasks)
  85. taskRunner.addTask(task);
  86. testRun.reporter.onConfigure(testRun.config.config);
  87. const { status, cleanup } = await taskRunner.runDeferCleanup(testRun, 0);
  88. return { status: await finishTaskRun(testRun, status), cleanup };
  89. }
  90. async function finishTaskRun(testRun, status) {
  91. if (status === "passed")
  92. status = testRun.failureTracker.result();
  93. const modifiedResult = await testRun.reporter.onEnd({ status });
  94. if (modifiedResult && modifiedResult.status)
  95. status = modifiedResult.status;
  96. await testRun.reporter.onExit();
  97. return status;
  98. }
  99. function createGlobalSetupTasks(config) {
  100. const tasks = [];
  101. if (!config.configCLIOverrides.preserveOutputDir)
  102. tasks.push(createRemoveOutputDirsTask());
  103. tasks.push(
  104. ...createPluginSetupTasks(config),
  105. ...config.globalTeardowns.map((file) => createGlobalTeardownTask(file, config)).reverse(),
  106. ...config.globalSetups.map((file) => createGlobalSetupTask(file, config))
  107. );
  108. return tasks;
  109. }
  110. function createRunTestsTasks(config) {
  111. return [
  112. createPhasesTask(),
  113. createReportBeginTask(),
  114. ...config.plugins.map((plugin) => createPluginBeginTask(plugin)),
  115. createRunTestsTask()
  116. ];
  117. }
  118. function createClearCacheTask(config) {
  119. return {
  120. title: "clear cache",
  121. setup: async () => {
  122. await (0, import_util2.removeDirAndLogToConsole)(import_compilationCache.cacheDir);
  123. for (const plugin of config.plugins)
  124. await plugin.instance?.clearCache?.();
  125. }
  126. };
  127. }
  128. function createReportBeginTask() {
  129. return {
  130. title: "report begin",
  131. setup: async (testRun) => {
  132. testRun.reporter.onBegin?.(testRun.rootSuite);
  133. },
  134. teardown: async ({}) => {
  135. }
  136. };
  137. }
  138. function createPluginSetupTasks(config) {
  139. return config.plugins.map((plugin) => ({
  140. title: "plugin setup",
  141. setup: async ({ reporter }) => {
  142. if (typeof plugin.factory === "function")
  143. plugin.instance = await plugin.factory();
  144. else
  145. plugin.instance = plugin.factory;
  146. await plugin.instance?.setup?.(config.config, config.configDir, reporter);
  147. },
  148. teardown: async () => {
  149. await plugin.instance?.teardown?.();
  150. }
  151. }));
  152. }
  153. function createPluginBeginTask(plugin) {
  154. return {
  155. title: "plugin begin",
  156. setup: async (testRun) => {
  157. await plugin.instance?.begin?.(testRun.rootSuite);
  158. },
  159. teardown: async () => {
  160. await plugin.instance?.end?.();
  161. }
  162. };
  163. }
  164. function createGlobalSetupTask(file, config) {
  165. let title = "global setup";
  166. if (config.globalSetups.length > 1)
  167. title += ` (${file})`;
  168. let globalSetupResult;
  169. return {
  170. title,
  171. setup: async ({ config: config2 }) => {
  172. const setupHook = await (0, import_loadUtils.loadGlobalHook)(config2, file);
  173. globalSetupResult = await setupHook(config2.config);
  174. },
  175. teardown: async () => {
  176. if (typeof globalSetupResult === "function")
  177. await globalSetupResult();
  178. }
  179. };
  180. }
  181. function createGlobalTeardownTask(file, config) {
  182. let title = "global teardown";
  183. if (config.globalTeardowns.length > 1)
  184. title += ` (${file})`;
  185. return {
  186. title,
  187. teardown: async ({ config: config2 }) => {
  188. const teardownHook = await (0, import_loadUtils.loadGlobalHook)(config2, file);
  189. await teardownHook(config2.config);
  190. }
  191. };
  192. }
  193. function createRemoveOutputDirsTask() {
  194. return {
  195. title: "clear output",
  196. setup: async ({ config }) => {
  197. const outputDirs = /* @__PURE__ */ new Set();
  198. const projects = (0, import_projectUtils.filterProjects)(config.projects, config.cliProjectFilter);
  199. projects.forEach((p) => outputDirs.add(p.project.outputDir));
  200. await Promise.all(Array.from(outputDirs).map((outputDir) => (0, import_utils.removeFolders)([outputDir]).then(async ([error]) => {
  201. if (!error)
  202. return;
  203. if (error.code === "EBUSY") {
  204. const entries = await readDirAsync(outputDir).catch((e) => []);
  205. await Promise.all(entries.map((entry) => (0, import_utils.removeFolders)([import_path.default.join(outputDir, entry)])));
  206. } else {
  207. throw error;
  208. }
  209. })));
  210. }
  211. };
  212. }
  213. function createListFilesTask() {
  214. return {
  215. title: "load tests",
  216. setup: async (testRun, errors) => {
  217. testRun.rootSuite = await (0, import_loadUtils.createRootSuite)(testRun, errors, false);
  218. testRun.failureTracker.onRootSuite(testRun.rootSuite);
  219. await (0, import_loadUtils.collectProjectsAndTestFiles)(testRun, false);
  220. for (const [project, files] of testRun.projectFiles) {
  221. const projectSuite = new import_test.Suite(project.project.name, "project");
  222. projectSuite._fullProject = project;
  223. testRun.rootSuite._addSuite(projectSuite);
  224. const suites = files.map((file) => {
  225. const title = import_path.default.relative(testRun.config.config.rootDir, file);
  226. const suite = new import_test.Suite(title, "file");
  227. suite.location = { file, line: 0, column: 0 };
  228. projectSuite._addSuite(suite);
  229. return suite;
  230. });
  231. testRun.projectSuites.set(project, suites);
  232. }
  233. }
  234. };
  235. }
  236. function createLoadTask(mode, options) {
  237. return {
  238. title: "load tests",
  239. setup: async (testRun, errors, softErrors) => {
  240. await (0, import_loadUtils.collectProjectsAndTestFiles)(testRun, !!options.doNotRunDepsOutsideProjectFilter);
  241. await (0, import_loadUtils.loadFileSuites)(testRun, mode, options.failOnLoadErrors ? errors : softErrors);
  242. if (testRun.config.cliOnlyChanged || options.populateDependencies) {
  243. for (const plugin of testRun.config.plugins)
  244. await plugin.instance?.populateDependencies?.();
  245. }
  246. if (testRun.config.cliOnlyChanged) {
  247. const changedFiles = await (0, import_vcs.detectChangedTestFiles)(testRun.config.cliOnlyChanged, testRun.config.configDir);
  248. testRun.config.preOnlyTestFilters.push((test) => changedFiles.has(test.location.file));
  249. }
  250. testRun.rootSuite = await (0, import_loadUtils.createRootSuite)(testRun, options.failOnLoadErrors ? errors : softErrors, !!options.filterOnly);
  251. testRun.failureTracker.onRootSuite(testRun.rootSuite);
  252. if (options.failOnLoadErrors && !testRun.rootSuite.allTests().length && !testRun.config.cliPassWithNoTests && !testRun.config.config.shard && !testRun.config.cliOnlyChanged) {
  253. if (testRun.config.cliArgs.length) {
  254. throw new Error([
  255. `No tests found.`,
  256. `Make sure that arguments are regular expressions matching test files.`,
  257. `You may need to escape symbols like "$" or "*" and quote the arguments.`
  258. ].join("\n"));
  259. }
  260. throw new Error(`No tests found`);
  261. }
  262. }
  263. };
  264. }
  265. function createApplyRebaselinesTask() {
  266. return {
  267. title: "apply rebaselines",
  268. setup: async () => {
  269. (0, import_rebase.clearSuggestedRebaselines)();
  270. },
  271. teardown: async ({ config, reporter }) => {
  272. await (0, import_rebase.applySuggestedRebaselines)(config, reporter);
  273. }
  274. };
  275. }
  276. function createPhasesTask() {
  277. return {
  278. title: "create phases",
  279. setup: async (testRun) => {
  280. let maxConcurrentTestGroups = 0;
  281. const processed = /* @__PURE__ */ new Set();
  282. const projectToSuite = new Map(testRun.rootSuite.suites.map((suite) => [suite._fullProject, suite]));
  283. const allProjects = [...projectToSuite.keys()];
  284. const teardownToSetups = (0, import_projectUtils.buildTeardownToSetupsMap)(allProjects);
  285. const teardownToSetupsDependents = /* @__PURE__ */ new Map();
  286. for (const [teardown, setups] of teardownToSetups) {
  287. const closure = (0, import_projectUtils.buildDependentProjects)(setups, allProjects);
  288. closure.delete(teardown);
  289. teardownToSetupsDependents.set(teardown, [...closure]);
  290. }
  291. for (let i = 0; i < projectToSuite.size; i++) {
  292. const phaseProjects = [];
  293. for (const project of projectToSuite.keys()) {
  294. if (processed.has(project))
  295. continue;
  296. const projectsThatShouldFinishFirst = [...project.deps, ...teardownToSetupsDependents.get(project) || []];
  297. if (projectsThatShouldFinishFirst.find((p) => !processed.has(p)))
  298. continue;
  299. phaseProjects.push(project);
  300. }
  301. for (const project of phaseProjects)
  302. processed.add(project);
  303. if (phaseProjects.length) {
  304. let testGroupsInPhase = 0;
  305. const phase = { dispatcher: new import_dispatcher.Dispatcher(testRun.config, testRun.reporter, testRun.failureTracker), projects: [] };
  306. testRun.phases.push(phase);
  307. for (const project of phaseProjects) {
  308. const projectSuite = projectToSuite.get(project);
  309. const testGroups = (0, import_testGroups.createTestGroups)(projectSuite, testRun.config.config.workers);
  310. phase.projects.push({ project, projectSuite, testGroups });
  311. testGroupsInPhase += Math.min(project.workers ?? Number.MAX_SAFE_INTEGER, testGroups.length);
  312. }
  313. (0, import_utilsBundle.debug)("pw:test:task")(`created phase #${testRun.phases.length} with ${phase.projects.map((p) => p.project.project.name).sort()} projects, ${testGroupsInPhase} testGroups`);
  314. maxConcurrentTestGroups = Math.max(maxConcurrentTestGroups, testGroupsInPhase);
  315. }
  316. }
  317. testRun.config.config.metadata.actualWorkers = Math.min(testRun.config.config.workers, maxConcurrentTestGroups);
  318. }
  319. };
  320. }
  321. function createRunTestsTask() {
  322. return {
  323. title: "test suite",
  324. setup: async ({ phases, failureTracker }) => {
  325. const successfulProjects = /* @__PURE__ */ new Set();
  326. const extraEnvByProjectId = /* @__PURE__ */ new Map();
  327. const teardownToSetups = (0, import_projectUtils.buildTeardownToSetupsMap)(phases.map((phase) => phase.projects.map((p) => p.project)).flat());
  328. for (const { dispatcher, projects } of phases) {
  329. const phaseTestGroups = [];
  330. for (const { project, testGroups } of projects) {
  331. let extraEnv = {};
  332. for (const dep of project.deps)
  333. extraEnv = { ...extraEnv, ...extraEnvByProjectId.get(dep.id) };
  334. for (const setup of teardownToSetups.get(project) || [])
  335. extraEnv = { ...extraEnv, ...extraEnvByProjectId.get(setup.id) };
  336. extraEnvByProjectId.set(project.id, extraEnv);
  337. const hasFailedDeps = project.deps.some((p) => !successfulProjects.has(p));
  338. if (!hasFailedDeps)
  339. phaseTestGroups.push(...testGroups);
  340. }
  341. if (phaseTestGroups.length) {
  342. await dispatcher.run(phaseTestGroups, extraEnvByProjectId);
  343. await dispatcher.stop();
  344. for (const [projectId, envProduced] of dispatcher.producedEnvByProjectId()) {
  345. const extraEnv = extraEnvByProjectId.get(projectId) || {};
  346. extraEnvByProjectId.set(projectId, { ...extraEnv, ...envProduced });
  347. }
  348. }
  349. if (!failureTracker.hasWorkerErrors()) {
  350. for (const { project, projectSuite } of projects) {
  351. const hasFailedDeps = project.deps.some((p) => !successfulProjects.has(p));
  352. if (!hasFailedDeps && !projectSuite.allTests().some((test) => !test.ok()))
  353. successfulProjects.add(project);
  354. }
  355. }
  356. }
  357. },
  358. teardown: async ({ phases }) => {
  359. for (const { dispatcher } of phases.reverse())
  360. await dispatcher.stop();
  361. }
  362. };
  363. }
  364. function createStartDevServerTask() {
  365. return {
  366. title: "start dev server",
  367. setup: async ({ config }, errors, softErrors) => {
  368. if (config.plugins.some((plugin) => !!plugin.devServerCleanup)) {
  369. errors.push({ message: `DevServer is already running` });
  370. return;
  371. }
  372. for (const plugin of config.plugins)
  373. plugin.devServerCleanup = await plugin.instance?.startDevServer?.();
  374. if (!config.plugins.some((plugin) => !!plugin.devServerCleanup))
  375. errors.push({ message: `DevServer is not available in the package you are using. Did you mean to use component testing?` });
  376. },
  377. teardown: async ({ config }) => {
  378. for (const plugin of config.plugins) {
  379. await plugin.devServerCleanup?.();
  380. plugin.devServerCleanup = void 0;
  381. }
  382. }
  383. };
  384. }
  385. // Annotate the CommonJS export names for ESM import in node:
  386. 0 && (module.exports = {
  387. TestRun,
  388. createApplyRebaselinesTask,
  389. createClearCacheTask,
  390. createGlobalSetupTasks,
  391. createListFilesTask,
  392. createLoadTask,
  393. createPluginSetupTasks,
  394. createReportBeginTask,
  395. createRunTestsTasks,
  396. createStartDevServerTask,
  397. runTasks,
  398. runTasksDeferCleanup
  399. });