Merge pull request #137 from joomcode/fix/duplicate-test-file-path

fix: show global error on duplicate test file paths

Author: uid11

src/README.md

@@ -40,19 +40,20 @@ Modules in the dependency graph should only import the modules above them:
 33. `utils/promise`
 34. `utils/resourceUsage`
 35. `utils/fs`
-36. `utils/getGlobalErrorHandler`
-37. `utils/tests`
-38. `utils/end`
-39. `utils/pack`
-40. `useContext`
-41. `context`
-42. `utils/step`
-43. `utils/apiStatistics`
-44. `utils/selectors`
-45. `selectors`
-46. `utils/log`
-47. `step`
-48. `utils/waitForEvents`
-49. `utils/expect`
-50. `expect`
-51. ...
+36. `utils/completedTestRuns`
+37. `utils/getGlobalErrorHandler`
+38. `utils/tests`
+39. `utils/end`
+40. `utils/pack`
+41. `useContext`
+42. `context`
+43. `utils/step`
+44. `utils/apiStatistics`
+45. `utils/selectors`
+46. `selectors`
+47. `utils/log`
+48. `step`
+49. `utils/waitForEvents`
+50. `utils/expect`
+51. `expect`
+52. ...

src/constants/internal.ts

@@ -52,6 +52,7 @@ export {
   API_STATISTICS_PATH,
   AUTOTESTS_DIRECTORY_PATH,
   COMPILED_USERLAND_CONFIG_DIRECTORY,
+  COMPLETED_TEST_RUNS_PATH,
   CONFIG_PATH,
   DOT_ENV_PATH,
   EVENTS_DIRECTORY_PATH,
@@ -61,6 +62,7 @@ export {
   INSTALLED_E2ED_DIRECTORY_PATH,
   INTERNAL_DIRECTORY_NAME,
   INTERNAL_REPORTS_DIRECTORY_PATH,
+  NOT_INCLUDED_IN_PACK_TESTS_PATH,
   REPORTS_DIRECTORY_PATH,
   SCREENSHOTS_DIRECTORY_PATH,
   START_INFO_PATH,

src/constants/paths.ts

@@ -99,6 +99,15 @@ export const COMPILED_USERLAND_CONFIG_DIRECTORY = join(
   'config',
 ) as DirectoryPathFromRoot;
 
+/**
+ * Relative (from root) path to file with already completed test runs.
+ * @internal
+ */
+export const COMPLETED_TEST_RUNS_PATH = join(
+  TMP_DIRECTORY_PATH,
+  'completedTestRuns.txt',
+) as FilePathFromRoot;
+
 /**
  * Relative (from root) path to `config` file,
  * that plays the role of the internal Playwright config.
@@ -137,6 +146,17 @@ export const GLOBAL_WARNINGS_PATH = join(
   'globalWarnings.txt',
 ) as FilePathFromRoot;
 
+/**
+ * Relative (from root) path to text file with list of not included in pack tests.
+ * For each not included in pack test in this file, a relative path
+ * to the file of this test is saved in a separate line.
+ * @internal
+ */
+export const NOT_INCLUDED_IN_PACK_TESTS_PATH = join(
+  TMP_DIRECTORY_PATH,
+  'notIncludedInPackTests.txt',
+) as FilePathFromRoot;
+
 /**
  * Relative (from root) path to directory with tests screenshots.
  * @internal

src/types/internal.ts

@@ -164,7 +164,7 @@ export type {
   TestStaticOptions,
 } from './testRun';
 /** @internal */
-export type {FullTestRun, RunTest, Test, TestUnit} from './testRun';
+export type {CompletedTestRun, FullTestRun, RunTest, Test, TestUnit} from './testRun';
 export type {MergeTuples, TupleRest} from './tuples';
 export type {
   CloneWithoutUndefinedProperties,

src/types/testRun.ts

@@ -11,6 +11,15 @@ import type {TestFilePath} from './paths';
 import type {StringForLogs} from './string';
 import type {TestMetaPlaceholder} from './userland';
 
+/**
+ * Completed test run object used by internal runtime mechanics.
+ * @internal
+ */
+export type CompletedTestRun<TestMeta = TestMetaPlaceholder> = Readonly<{
+  status: TestRunStatus | 'started';
+}> &
+  TestStaticOptions<TestMeta>;
+
 /**
  * Full test run object result of userland hooks (like mainParams and runHash).
  * @internal

src/utils/completedTestRuns/getIsSuccessfulTestRun.ts

@@ -0,0 +1,12 @@
+import {FAILED_TEST_RUN_STATUSES, TestRunStatus} from '../../constants/internal';
+
+import type {CompletedTestRun} from '../../types/internal';
+
+/**
+ * Returns `true`, if test run was successful, and `false` otherwise.
+ * @internal
+ */
+export const getIsSuccessfulTestRun = ({status}: CompletedTestRun): boolean =>
+  status !== 'started' &&
+  status !== TestRunStatus.Broken &&
+  !FAILED_TEST_RUN_STATUSES.includes(status);

src/utils/completedTestRuns/getIsTestFilePathUniq.ts

@@ -0,0 +1,34 @@
+import {writeGlobalError} from '../fs';
+
+import {getIsTestOptionsDifferent} from './getIsTestOptionsDifferent';
+
+import type {CompletedTestRun, TestStaticOptions} from '../../types/internal';
+
+/**
+ * Returns `true`, if new test file path is uniq in completed test runs,
+ * otherwise writes global error.
+ * @internal
+ */
+export const getIsTestFilePathUniq = async (
+  testStaticOptions: TestStaticOptions,
+  completedTestRuns: readonly CompletedTestRun[],
+): Promise<boolean> => {
+  const {filePath, name, options} = testStaticOptions;
+
+  const testRunsWithFilePath = completedTestRuns.filter((run) => run.filePath === filePath);
+
+  for (const completedTestRun of testRunsWithFilePath) {
+    if (
+      name !== completedTestRun.name ||
+      getIsTestOptionsDifferent(options, completedTestRun.options)
+    ) {
+      await writeGlobalError(
+        `The file "${filePath}" contains two different tests: "${completedTestRun.name}" (${JSON.stringify(completedTestRun.options)}) and "${name}" (${JSON.stringify(options)})`,
+      );
+
+      return false;
+    }
+  }
+
+  return true;
+};

src/utils/completedTestRuns/getIsTestNameUniq.ts

@@ -0,0 +1,34 @@
+import {writeGlobalError} from '../fs';
+
+import {getIsTestOptionsDifferent} from './getIsTestOptionsDifferent';
+
+import type {CompletedTestRun, TestStaticOptions} from '../../types/internal';
+
+/**
+ * Returns `true`, if new test file has uniq name in completed test runs,
+ * otherwise writes global error.
+ * @internal
+ */
+export const getIsTestNameUniq = async (
+  testStaticOptions: TestStaticOptions,
+  completedTestRuns: readonly CompletedTestRun[],
+): Promise<boolean> => {
+  const {filePath, name, options} = testStaticOptions;
+
+  const testRunsWithName = completedTestRuns.filter((run) => run.name === name);
+
+  for (const completedTestRun of testRunsWithName) {
+    if (
+      filePath !== completedTestRun.filePath ||
+      getIsTestOptionsDifferent(options, completedTestRun.options)
+    ) {
+      await writeGlobalError(
+        `There are two different tests with the same name "${name}": "${completedTestRun.filePath}" (${JSON.stringify(completedTestRun.options)}) and "${filePath}" (${JSON.stringify(options)})`,
+      );
+
+      return false;
+    }
+  }
+
+  return true;
+};

src/utils/completedTestRuns/getIsTestOptionsDifferent.ts

@@ -0,0 +1,18 @@
+import type {TestOptions} from '../../types/internal';
+
+/**
+ * Returns `true`, if test options different, and `false` otherwise.
+ * @internal
+ */
+export const getIsTestOptionsDifferent = (
+  firstOptions: TestOptions,
+  secondOptions: TestOptions,
+): boolean => {
+  const firstMeta = {...firstOptions.meta, skipReason: undefined};
+  const secondMeta = {...secondOptions.meta, skipReason: undefined};
+
+  return (
+    JSON.stringify({...firstOptions, meta: firstMeta}) !==
+    JSON.stringify({...secondOptions, meta: secondMeta})
+  );
+};

src/utils/completedTestRuns/getSuccessfulTestFilePaths.ts

@@ -0,0 +1,23 @@
+import {readCompletedTestRuns} from '../fs';
+
+import {getIsSuccessfulTestRun} from './getIsSuccessfulTestRun';
+
+import type {TestFilePath} from '../../types/internal';
+
+/**
+ * Get array of test file paths of successful tests.
+ * @internal
+ */
+export const getSuccessfulTestFilePaths = async (): Promise<readonly TestFilePath[]> => {
+  const completedTestRuns = await readCompletedTestRuns();
+
+  const successfulTestFilePaths: TestFilePath[] = [];
+
+  for (const completedTestRun of completedTestRuns) {
+    if (getIsSuccessfulTestRun(completedTestRun)) {
+      successfulTestFilePaths.push(completedTestRun.filePath);
+    }
+  }
+
+  return successfulTestFilePaths;
+};