feat: add project setting in JSON instead of variable.env

Author: uid11

README.md

@@ -412,17 +412,25 @@ If the wait is longer than this timeout, then the promise returned by the `waitF
 `waitForResponseTimeout: number`: default timeout (in milliseconds) for `waitForResponse`/`waitForResponseToRoute` functions.
 If the wait is longer than this timeout, then the promise returned by the `waitForResponse`/`waitForResponseToRoute` function will be rejected.
 
-### Environment variables
+### Project settings
+
+General static project settings are stored in file `./autotests/projectSettings.json`. They apply to all project packs.
 
-Required environment variables are defined in the `./autotests/variables.env` file (they cannot be deleted):
+`allTestFileGlobs: string`: an array of globs covering all project test files across all packs
+(used to generate a code report).
 
-`E2ED_DOCKER_IMAGE`: the name of the docker image where the tests will run.
+`dockerImage: string | null`: the name of the docker image where the tests will run.
 The image must be based on the `e2ed` base image.
 
-`E2ED_PATH_TO_TS_CONFIG_OF_PROJECT_FROM_ROOT`: the path to TypeScript config file of the project
+`pathToTsConfigFromRoot: string`: the path to TypeScript config file of the project
 from the root directory of the project. The project should have one common TypeScript config
 for both the application code and the autotest code.
 
+`testIdentifierKey: Record<string, string>`: an object with a single field that serves as the test identifier key in the test `meta`.
+If the project does not use such a key, leave the object empty.
+
+### Environment variables
+
 You can pass the following optional environment variables to the `e2ed` process in any standard way:
 
 `E2ED_ORIGIN`: origin-part of the url (`protocol` + `host`) on which the tests will be run. For example, `https://bing.com`.

autotests/bin/runDocker.sh

@@ -5,16 +5,15 @@ set +u
 CONTAINER_LABEL="e2ed"
 DEBUG_PORT=$([[ $E2ED_DEBUG == inspect-brk:* ]] && echo "${E2ED_DEBUG#inspect-brk:}" || echo "")
 DIR="${E2ED_WORKDIR:-$PWD}"
+E2ED_DOCKER_IMAGE=$(grep -m1 \"dockerImage\": $DIR/autotests/projectSettings.json | cut -d '"' -f 4)
 E2ED_TIMEOUT_FOR_GRACEFUL_SHUTDOWN_IN_SECONDS=16
 MOUNTDIR="${E2ED_MOUNTDIR:-$DIR}"
 WITH_DEBUG=$([[ -z $DEBUG_PORT ]] && echo "" || echo "--publish $DEBUG_PORT:$DEBUG_PORT --publish $((DEBUG_PORT + 1)):$((DEBUG_PORT + 1))")
 VERSION=$(grep -m1 \"e2ed\": $DIR/package.json | cut -d '"' -f 4)
 
-source ./autotests/variables.env
-
 if [[ -z $E2ED_DOCKER_IMAGE ]]
 then
-    echo "Error: The \"autotests/variables.env\" file does not contain E2ED_DOCKER_IMAGE variable."
+    echo "Error: The \"autotests/projectSettings.json\" file does not contain dockerImage variable."
     echo "Add it so that \"runDocker.sh\" script can run the docker image."
     echo "Exit with code 9"
     exit 9

autotests/configurator/index.ts

@@ -9,6 +9,7 @@ export {mapLogPayloadInReport} from './mapLogPayloadInReport';
 export {matchScreenshot} from './matchScreenshot';
 export {regroupSteps} from './regroupSteps';
 export {skipTests} from './skipTests';
+export {testIdentifierKey} from './testIdentifierKey';
 export type {
   DoAfterPack,
   DoBeforePack,

autotests/configurator/testIdentifierKey.ts

@@ -0,0 +1,11 @@
+import {getTestIdentifierKey} from 'e2ed/configurator';
+
+import projectSettings from '../projectSettings.json';
+
+import type {GetTestIdentifierKey} from 'e2ed/types';
+
+/**
+ * Project test identifier key in test meta.
+ */
+export const testIdentifierKey: GetTestIdentifierKey<typeof projectSettings> =
+  getTestIdentifierKey(projectSettings);

autotests/projectSettings.json

@@ -0,0 +1,6 @@
+{
+  "allTestFileGlobs": ["**/autotests/tests/**/*.ts"],
+  "dockerImage": "e2edhub/e2ed",
+  "pathToTsConfigFromRoot": "./tsconfig.json",
+  "testIdentifierKey": {"testId": "key of the test identifier in test meta"}
+}

autotests/types/packsTypeChecks.ts

@@ -0,0 +1,11 @@
+import type {Pack, testIdentifierKey} from 'autotests/configurator';
+import type {pack as allTestsPack} from 'autotests/packs/allTests';
+import type {Expect, IsEqual, IsUnion, Not} from 'e2ed/types';
+
+/**
+ * Type checks of all project packs and test identifier key.
+ */
+export type TypeChecks = [
+  Expect<IsEqual<Pack, typeof allTestsPack>>,
+  Expect<Not<IsUnion<typeof testIdentifierKey>>>,
+];

autotests/types/typeChecks.ts

@@ -0,0 +1,9 @@
+import type {GetTestIdentifierKey, ProjectSettings} from '../types/internal';
+
+/**
+ * Get test identifier key from project settings.
+ */
+export const getTestIdentifierKey = <const Settings extends ProjectSettings>(
+  projectSettings: Settings,
+): GetTestIdentifierKey<Settings> =>
+  Object.keys(projectSettings.testIdentifierKey)[0] as GetTestIdentifierKey<Settings>;

autotests/variables.env

@@ -2,6 +2,7 @@ export type {UserlandPack as PackConfig} from '../types/internal';
 export {getDurationWithUnits} from '../utils/getDurationWithUnits';
 export {getShallowCopyOfObjectForLogs, getStringTrimmedToMaxLength} from '../utils/valueToString';
 export {RunEnvironment, startTimeInMs} from './constants';
+export {getTestIdentifierKey} from './getTestIdentifierKey';
 export {replaceFields} from './replaceFields';
 export {isDockerRun, isLocalRun, runEnvironment} from './runEnvironment';
 /** @internal */