@empiricalrun/test-run 0.5.2 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/test-run
 
+## 0.6.0
+
+### Minor Changes
+
+- 5fbc669: feat: support for token and run config file
+
+## 0.5.3
+
+### Patch Changes
+
+- b9f53be: fix: logs for other signals to catch github actions behavior
+
 ## 0.5.2
 
 ### Patch Changes

package/README.md

@@ -1,21 +1,201 @@
 # test-run
 
-Library to run playwright tests.
+## 1. Introduction
 
-This package helps to run all the dependent tests for a particular test case.
+**@empiricalrun/test-run** is a CLI tool (and library) designed to facilitate running Playwright (or Appwright) tests in a project. It allows you to:
 
-## Usage
+- Run all tests or a specific test.
+- Filter tests by name, file, or suites.
+- Filter Playwright projects to run.
+- Skip teardown test blocks.
+- Integrate with an external dashboard for environment and build management.
+- Forward additional arguments directly to the underlying Playwright/Appwright test runner.
 
-```ts
-npx @empiricalrun/test-run -n "<test-name>" "<playwright-options>"
+---
+
+## 2. Installation
+
+Install from npm (usually as part of an Empirical-run monorepo, but can be done standalone):
+
+```bash
+npm install -D @empiricalrun/test-run
 ```
 
-The playwright options are passed as is to the playwright test command.
+You can also use the CLI directly with `npx`.
+
+---
+
+## 3. Basic Usage
+
+The CLI entry point is defined in `package.json` under `"bin"`. You can invoke it using:
+
+```bash
+npx @empiricalrun/test-run [flags] [Playwright/test arguments]
+```
 
-## Example
+### Example (running a test named "foo"):
 
-```ts
+```bash
 npx @empiricalrun/test-run -n "foo" --retries 0
 ```
 
-This will run the test named "foo" in the `tests` directory.
+Here, `--retries 0` (and any unrecognized options) get passed on to the underlying Playwright command.
+
+---
+
+## 4. CLI Flags
+
+Below are the main CLI options implemented in `src/bin/index.ts`:
+| Flag/Option | Description |
+|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `-n, --name <test-name>` | The scenario name (title) of the specific test to run. If provided, only that particular test/scenario is run instead of all tests. |
+| `-d, --dir <test-dir>` | Directory containing tests. Defaults to `tests`. |
+| `-f, --file <test-file-path>` | Specific test file path. If provided along with `--name`, it targets that file for the named test. |
+| `-p, --project <project-name...>` | One or more (space-delimited) project names/patterns used to filter the test run. Examples: `--project web` or `--project ios desktop`. |
+| `-s, --suites <suites>` | A comma-separated list of suite or describe-block names. Example: `--suites "suiteA,suiteB"`. |
+| `--skip-teardown` | Skips teardown tests by marking them as “skipped.” Reverts changes when the process exits. |
+| `--token <token>` | A base64-encoded token that, when decoded, can define test configuration (such as a test list). |
+| `--forbid-only` | Fails the run if there are any `.only` blocks in the code. |
+
+Other unrecognized flags on the command line will be appended as **Playwright arguments**.
+
+---
+
+## 5. Environment Variables
+
+The following environment variables can further customize behavior:
+
+- **`PROJECT_NAME`**  
+  Overrides project name detection from `package.json`.
+
+- **`TEST_RUN_ENVIRONMENT`**  
+  This helps fetch playwright projects, environment details and potential build artifacts before tests start.
+
+- **`BUILD_URL`**  
+  Overrides the build URL for downloading any build artifacts.
+
+---
+
+## 6. Running group of tests vs. All Tests
+
+- **Group Test**:  
+  Use `--name` to identify one tests with the specfied name, optionally adding `--file` or `--suites` if needed.
+
+  ```bash
+  npx @empiricalrun/test-run --name "my test" --file tests/example.spec.ts
+  ```
+
+- **All Tests**:  
+  Omit `--name`. This runs all tests.
+  ```bash
+  npx @empiricalrun/test-run --reporter=list
+  ```
+
+---
+
+## 7. Skipping Teardown Tests
+
+If you pass `--skip-teardown`, the CLI will:
+
+1. Temporarily annotate `*.teardown.ts` files so that they are skipped (for example, converting `teardown` calls to `teardown.skip`).
+2. After the run, it automatically reverts the code changes, triggered by process exit signals.
+
+This is useful for omitting teardown steps during certain runs or local development.
+
+---
+
+## 8. Using a “.rc” File or Token
+
+You can optionally define a configuration in `empiricalrc.json` or pass the same data as a base64-encoded `--token`. For example:
+
+```json
+{
+  "tests": [
+    {
+      "name": "some-test",
+      "filePath": "tests/abc.spec.ts",
+      "suites": ["suiteA"]
+    }
+  ]
+}
+```
+
+If both are missing or do not define tests, the CLI uses command-line parameters (`-n`, `--file`, etc.).
+
+---
+
+## 9. Environment & Build (Optional)
+
+If `TEST_RUN_ENVIRONMENT` is defined:
+
+1. The CLI fetches environment details (and optionally a build artifact) via the remote “dashboard” (see `dashboard.ts`).
+2. If no custom `BUILD_URL` is set, it uses the environment’s latest build.
+3. It runs an npm script named `download` to grab the build.
+
+This flow makes sure tests run against the relevant environment or a fresh build artifact.
+
+---
+
+## 10. Examples
+
+1. **Run a single named test**
+
+   ```bash
+   npx @empiricalrun/test-run -n "login test"
+   ```
+
+2. **Use specific test file and name**
+
+   ```bash
+   npx @empiricalrun/test-run -n "logout test" -f tests/logout.spec.ts
+   ```
+
+3. **Run multiple projects and skip teardown**
+
+   ```bash
+   npx @empiricalrun/test-run -n "mobile login" --project android --project ios --skip-teardown
+   ```
+
+4. **Run all tests with Playwright arguments**
+   ```bash
+   npx @empiricalrun/test-run -- --worker=2 --reporter=line
+   ```
+
+---
+
+## 11. Troubleshooting & Notes
+
+- The CLI automatically appends unrecognized flags to the underlying `playwright test` (or `appwright test`) command.
+- Errors like “No test block found” often mean the CLI did not locate your test name or file. Double-check `--name`, `--file`, etc.
+- The teardown skip logic modifies files but reverts them on exit. If a process is forcibly killed, you may need to manually restore.
+- If environment fetching or build downloading fails, confirm your environment slug and project name match those recognized by your dashboard.
+
+---
+
+## 12. Changelog
+
+For version history and patch notes, see [CHANGELOG.md]
+
+---
+
+## 13. Contributing
+
+- **Lint** with `pnpm lint`.
+- **Test** with `pnpm test`.
+- **Build** with `pnpm build`.
+- **Dev** watch mode with `pnpm dev`.
+
+Feel free to open issues or pull requests for enhancements or clarifications.
+
+---
+
+## 14. Conclusion
+
+@test-run simplifies orchestrating Playwright tests, especially for:
+
+- Filtering or focusing on specific test scenarios.
+- Managing environment-based test runs.
+- Skipping teardown blocks.
+- Working with multiple or specialized Playwright projects.
+
+Explore the source (particularly `src/bin/index.ts` and `src/utils`) for deeper technical insights and advanced customization.

package/dist/bin/index.js

@@ -6,14 +6,16 @@ const __1 = require("..");
 const dashboard_1 = require("../dashboard");
 const types_1 = require("../types");
 const utils_1 = require("../utils");
+const config_parser_1 = require("../utils/config-parser");
 (async function main() {
-    // TODO: add support for suites
+    // TODO: add documentation of the test run
     commander_1.program
         .option("-n, --name <test-name>", "Name of the test to run")
         .option("-d, --dir <test-dir>", "Path to the test directory")
         .option("-f, --file <test-file-path>", "Path to the test file")
         .option("-p, --project <project-name...>", "Test projects to run")
         .option("-s, --suites <suites>", "suites under which the test is defined")
+        .option("--payload <payload>", "Payload to run tests")
         .option("--skip-teardown", "This options skips running teardown tests")
         .option("--forbid-only", `This options forbids the use of ".only" in the test files`)
         .allowUnknownOption();
@@ -37,11 +39,13 @@ const utils_1 = require("../utils");
         "--project",
         "-s",
         "--suites",
+        "--payload",
         options.skipTeardown,
         options.name,
         options.dir,
         options.file,
         options.suites,
+        options.payload,
         ...options.project, // an array of comma separated project names/pattern matching globs *,premium-*,super-premium-*,safari
     ];
     const pwOptions = process.argv
@@ -51,11 +55,28 @@ const utils_1 = require("../utils");
     if (!projectName) {
         throw new Error("Project name is required");
     }
+    const directory = options.dir || "tests";
+    const suites = options.suites && options.suites.trim() !== ""
+        ? options.suites?.split(",")
+        : undefined;
+    let tests = (await (0, config_parser_1.parseRcConfig)())?.tests ||
+        (0, config_parser_1.parseToken)(options.payload)?.tests ||
+        (options.name
+            ? [
+                {
+                    name: options.name,
+                    dir: directory,
+                    filePath: options.file,
+                    suites,
+                },
+            ]
+            : undefined);
+    const environmentSlug = process.env.TEST_RUN_ENVIRONMENT || "";
     let environmentSpecificProjects = [];
     let platform = types_1.Platform.WEB;
     try {
-        if (process.env.TEST_RUN_ENVIRONMENT) {
-            const { environment, build: latestBuild } = await (0, dashboard_1.fetchEnvironmentAndBuild)(projectName, process.env.TEST_RUN_ENVIRONMENT);
+        if (environmentSlug) {
+            const { environment, build: latestBuild } = await (0, dashboard_1.fetchEnvironmentAndBuild)(projectName, environmentSlug);
             platform = environment.platform;
             environmentSpecificProjects = environment.playwright_projects;
             if (!process.env.BUILD_URL) {
@@ -69,20 +90,13 @@ const utils_1 = require("../utils");
             filteringSets: [...options.project, ...environmentSpecificProjects],
         });
         pwOptions.push(...projectFilters);
-        const directory = options.dir || "tests";
         if (options.skipTeardown) {
             await (0, utils_1.handleTeardownSkipFlag)(directory);
         }
-        const suites = options.suites && options.suites.trim() !== ""
-            ? options.suites?.split(",")
-            : undefined;
         const { hasTestPassed } = await (0, __1.runTest)({
-            name: options.name,
-            filePath: options.file,
-            dir: directory,
+            tests,
             pwOptions: pwOptions.join(" "),
             platform,
-            suites,
         });
         if (!hasTestPassed) {
             process.exit(1);

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { TestRunParameters } from "./types";
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-export declare function runTest({ name, filePath, dir, pwOptions, platform, suites, }: TestRunParameters): Promise<{
+export declare function runTest({ tests, pwOptions, platform, }: TestRunParameters): Promise<{
     hasTestPassed: boolean;
 }>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,EAC5B,IAAI,EACJ,QAAQ,EACR,GAAG,EACH,SAAS,EACT,QAAQ,EACR,MAAM,GACP,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAaD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,EAC5B,KAAK,EACL,SAAS,EACT,QAAQ,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAUD"}

package/dist/index.js

@@ -8,15 +8,12 @@ const run_specific_test_1 = require("./run-specific-test");
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-async function runTest({ name, filePath, dir, pwOptions, platform, suites, }) {
-    if (name) {
-        return await (0, run_specific_test_1.runSpecificTest)({
-            name,
-            dir,
-            filePath,
+async function runTest({ tests, pwOptions, platform, }) {
+    if (tests && tests.length > 0) {
+        return await (0, run_specific_test_1.runSpecificTests)({
+            tests,
             pwOptions,
             platform,
-            suites,
         });
     }
     return await (0, run_all_tests_1.runAllTests)({ pwOptions, platform });

package/dist/run-specific-test.d.ts

@@ -4,7 +4,7 @@ import { TestRunParameters } from "./types";
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-export declare function runSpecificTest({ name, filePath, dir, pwOptions, platform, suites, }: TestRunParameters): Promise<{
+export declare function runSpecificTests({ tests, pwOptions, platform, }: TestRunParameters): Promise<{
     hasTestPassed: boolean;
 }>;
 //# sourceMappingURL=run-specific-test.d.ts.map

package/dist/run-specific-test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run-specific-test.d.ts","sourceRoot":"","sources":["../src/run-specific-test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAY5C;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,IAAI,EACJ,QAAQ,EACR,GAAG,EACH,SAAS,EACT,QAAQ,EACR,MAAM,GACP,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CA2ED"}
+{"version":3,"file":"run-specific-test.d.ts","sourceRoot":"","sources":["../src/run-specific-test.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAY5C;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,KAAU,EACV,SAAS,EACT,QAAQ,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CA4FD"}

package/dist/run-specific-test.js

@@ -3,75 +3,88 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runSpecificTest = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
+exports.runSpecificTests = void 0;
+const fs_1 = require("fs");
+const promises_1 = __importDefault(require("fs/promises"));
 const utils_1 = require("./utils");
 /**
  *
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-async function runSpecificTest({ name, filePath, dir, pwOptions, platform, suites, }) {
-    const files = await (0, utils_1.getAllFilePaths)(dir, {
-        filePath,
-    });
-    let matchingFilePath = "";
-    // find the first file that contains the test block
-    // TODO: add suites support
-    for (const file of files) {
-        const match = await (0, utils_1.hasTestBlock)({
-            filePath: file,
-            scenarioName: name,
-            suites,
-        });
-        if (match) {
-            matchingFilePath = file;
-            break;
-        }
+async function runSpecificTests({ tests = [], pwOptions, platform, }) {
+    if (!tests || tests.length === 0) {
+        throw new Error("No tests found");
     }
-    if (!matchingFilePath) {
-        const message = `No test block found for the given test name: ${name}`;
-        throw Error(message);
-    }
-    const { testCaseNode, sourceFile } = await (0, utils_1.getTestCaseNode)({
-        filePath: matchingFilePath,
-        scenarioName: name,
-        suites,
-    });
-    const parentDescribe = (0, utils_1.findFirstSerialDescribeBlock)(testCaseNode);
-    const isFileMarkedSerial = await (0, utils_1.hasTopLevelDescribeConfigureWithSerialMode)(matchingFilePath);
-    console.log("Identified test block:", !!testCaseNode);
-    console.log("Is parent describe block marked serial:", !!parentDescribe);
-    console.log("Is file marked serial:", isFileMarkedSerial);
-    const currentFileContent = await fs_extra_1.default.readFile(matchingFilePath, "utf-8");
+    const touchedFiles = {};
     // revert the changes made to the file to mark tests as only
     // these needs to handle by listening to process exit/kill events
     const revertFileContent = () => {
         try {
-            fs_extra_1.default.writeFileSync(matchingFilePath, currentFileContent);
+            Object.keys(touchedFiles).forEach((filePath) => {
+                (0, fs_1.writeFileSync)(filePath, touchedFiles[filePath], "utf-8");
+            });
         }
         catch (error) {
             console.error("Error while cleaning up test file:", error);
         }
     };
+    for (const testCase of tests) {
+        const files = await (0, utils_1.getAllFilePaths)(testCase.dir, {
+            filePath: testCase.filePath,
+        });
+        let matchingFilePath = "";
+        for (const file of files) {
+            const match = await (0, utils_1.hasTestBlock)({
+                filePath: file,
+                scenarioName: testCase.name,
+                suites: testCase.suites,
+            });
+            if (match) {
+                matchingFilePath = file;
+                break;
+            }
+        }
+        if (!matchingFilePath) {
+            const message = `No test block found for the given test name: ${testCase.name} in file ${testCase.filePath} with suites: ${testCase.suites}`;
+            revertFileContent();
+            throw Error(message);
+        }
+        const { testCaseNode, sourceFile } = await (0, utils_1.getTestCaseNode)({
+            filePath: matchingFilePath,
+            scenarioName: testCase.name,
+            suites: testCase.suites,
+        });
+        const parentDescribe = (0, utils_1.findFirstSerialDescribeBlock)(testCaseNode);
+        const isFileMarkedSerial = await (0, utils_1.hasTopLevelDescribeConfigureWithSerialMode)(matchingFilePath);
+        console.log("Identified test block:", !!testCaseNode);
+        console.log("Is parent describe block marked serial:", !!parentDescribe);
+        console.log("Is file marked serial:", isFileMarkedSerial);
+        const currentFileContent = await promises_1.default.readFile(matchingFilePath, "utf-8");
+        // if file is not marked as touched, mark it as touched
+        if (!touchedFiles[matchingFilePath]) {
+            touchedFiles[matchingFilePath] = currentFileContent;
+        }
+        // if the file is not marked serial, we need to mark the test or describe block as only
+        if (!isFileMarkedSerial && testCaseNode) {
+            await (0, utils_1.markTestAsOnly)({
+                sourceFile,
+                parentDescribeNode: parentDescribe,
+                testCaseNode: testCaseNode,
+                filePath: matchingFilePath,
+            });
+        }
+    }
+    // TODO: check if this works for multiple listeners
     process.on("beforeExit", revertFileContent);
     process.on("exit", revertFileContent);
     process.on("SIGINT", revertFileContent);
     process.on("SIGTERM", revertFileContent);
-    // if the file is not marked serial, we need to mark the test or describe block as only
-    if (!isFileMarkedSerial && testCaseNode) {
-        await (0, utils_1.markTestAsOnly)({
-            sourceFile,
-            parentDescribeNode: parentDescribe,
-            testCaseNode: testCaseNode,
-            filePath: matchingFilePath,
-        });
-    }
     let hasTestPassed = true;
     try {
         const testRunner = (0, utils_1.getTestRunner)(platform);
         const env = Object({ ...process.env });
-        const testRunCmd = `npx ${testRunner} test ${matchingFilePath} ${pwOptions}`;
+        const testRunCmd = `npx ${testRunner} test ${Object.keys(touchedFiles).join(" ")} ${pwOptions}`;
         console.log(`${testRunner} test command:`, testRunCmd);
         await (0, utils_1.cmd)(testRunCmd.split(" "), {
             env,
@@ -84,4 +97,4 @@ async function runSpecificTest({ name, filePath, dir, pwOptions, platform, suite
         hasTestPassed,
     };
 }
-exports.runSpecificTest = runSpecificTest;
+exports.runSpecificTests = runSpecificTests;

package/dist/types/index.d.ts

@@ -1,10 +1,16 @@
-export type TestRunParameters = {
+export type TestCase = {
     name: string;
-    filePath?: string;
+    filePath: string;
     dir?: string;
+    suites?: string[];
+};
+export type Config = {
+    tests: TestCase[];
+} | undefined;
+export type TestRunParameters = {
+    tests?: TestCase[];
     pwOptions?: string;
     platform: Platform;
-    suites?: string[];
 };
 export type Environment = {
     id: number;

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,oBAAY,aAAa;IACvB,UAAU,eAAe;IACzB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,MAAM,GACd;IACE,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB,GACD,SAAS,CAAC;AAEd,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,GAAG,QAAQ;CACZ;AAED,oBAAY,aAAa;IACvB,UAAU,eAAe;IACzB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B,CAAC"}

package/dist/utils/config-parser.d.ts

@@ -0,0 +1,5 @@
+import { Config } from "../types";
+export declare function parseRcConfig(): Promise<Config>;
+export declare function parseToken(token: string): Config;
+export declare function buildConfigFromCliArgs(): void;
+//# sourceMappingURL=config-parser.d.ts.map

package/dist/utils/config-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-parser.d.ts","sourceRoot":"","sources":["../../src/utils/config-parser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,wBAAsB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAerD;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAchD;AAED,wBAAgB,sBAAsB,SAAK"}

package/dist/utils/config-parser.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildConfigFromCliArgs = exports.parseToken = exports.parseRcConfig = void 0;
+const fs_1 = require("fs");
+const promises_1 = __importDefault(require("fs/promises"));
+async function parseRcConfig() {
+    // check if file exists
+    if (!(0, fs_1.existsSync)("empiricalrc.json")) {
+        return undefined;
+    }
+    try {
+        const rcConfig = await promises_1.default.readFile("empiricalrc.json", "utf-8");
+        const json = JSON.parse(rcConfig);
+        // TODO: validate the json
+        return json;
+    }
+    catch (e) {
+        console.error("Error parsing rc file:", e);
+    }
+    return undefined;
+}
+exports.parseRcConfig = parseRcConfig;
+function parseToken(token) {
+    if (!token) {
+        return undefined;
+    }
+    try {
+        const str = atob(token);
+        const decodedStr = decodeURIComponent(str);
+        const json = JSON.parse(decodedStr);
+        // TODO: validate the json
+        return json;
+    }
+    catch (error) {
+        console.error("Error parsing token:", error);
+    }
+    return undefined;
+}
+exports.parseToken = parseToken;
+function buildConfigFromCliArgs() { }
+exports.buildConfigFromCliArgs = buildConfigFromCliArgs;

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,IAAI,EAAW,UAAU,EAAc,MAAM,UAAU,CAAC;AAGjE,OAAO,EAEL,QAAQ,EAER,aAAa,EACd,MAAM,UAAU,CAAC;AAuBlB,wBAAgB,GAAG,CACjB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,OAAO,CAAC,MAAM,CAAC,CAiCjB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,aAAa,GAAE,MAAW,EAC1B,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,GAClC,OAAO,CAAC,MAAM,EAAE,CAAC,CA4BnB;AAED,eAAO,MAAM,gCAAgC,eAC/B,UAAU,KACrB,MAgBF,CAAC;AAEF,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,YAAY,EACZ,MAAM,GACP,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,GAAG,OAAO,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAQtE;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,YAAY,EACZ,MAAM,GACP,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,GAAG,OAAO,CAAC,OAAO,CAAC,CAOnB;AAED,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,IAAI,GAAG,SAAS,GACrB,IAAI,GAAG,SAAS,CA2BlB;AAED,wBAAsB,0CAA0C,CAC9D,QAAQ,EAAE,MAAM,oBA+BjB;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAC;IACvB,kBAAkB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACtC,YAAY,EAAE,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,iBAgBA;AAED,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,gBAevE;AAED,eAAO,MAAM,4BAA4B,UAEhC,MAAM,EAAE,mBAGE,MAAM,EAAE,EAAE,KAC1B,MAAM,EAUR,CAAC;AAEF,eAAO,MAAM,sBAAsB;cAIvB,QAAQ;mBACH,MAAM,EAAE;MACrB,QAAQ,MAAM,EAAE,CAmBnB,CAAC;AAEF,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,eAAO,MAAM,uBAAuB,QAAa,QAC/C,MAAM,GAAG,SAAS,CAMnB,CAAC;AAEF,eAAO,MAAM,aAAa,aAAoB,MAAM,KAAG,QAAQ,IAAI,CAWlE,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc,QAAQ,KAAG,aAIlD,CAAC;AA4DF,eAAO,MAAM,sBAAsB,cAAqB,MAAM,kBAkB7D,CAAC;AAuBF;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,YAAY,EACZ,MAAM,EACN,OAAO,GACR,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG;IACF,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;CACxB,CA8CA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAAW,UAAU,EAAc,MAAM,UAAU,CAAC;AAGjE,OAAO,EAEL,QAAQ,EAER,aAAa,EACd,MAAM,UAAU,CAAC;AA6BlB,wBAAgB,GAAG,CACjB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GACxC,OAAO,CAAC,MAAM,CAAC,CAiCjB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,aAAa,GAAE,MAAgB,EAC/B,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,GAClC,OAAO,CAAC,MAAM,EAAE,CAAC,CA4BnB;AAED,eAAO,MAAM,gCAAgC,eAC/B,UAAU,KACrB,MAgBF,CAAC;AAEF,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,YAAY,EACZ,MAAM,GACP,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,GAAG,OAAO,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAQtE;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,YAAY,EACZ,MAAM,GACP,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,GAAG,OAAO,CAAC,OAAO,CAAC,CAOnB;AAED,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,IAAI,GAAG,SAAS,GACrB,IAAI,GAAG,SAAS,CA4BlB;AAED,wBAAsB,0CAA0C,CAC9D,QAAQ,EAAE,MAAM,oBA+BjB;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,UAAU,CAAC;IACvB,kBAAkB,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACtC,YAAY,EAAE,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,iBAgBA;AAED,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,gBAevE;AAED,eAAO,MAAM,4BAA4B,UAEhC,MAAM,EAAE,mBAGE,MAAM,EAAE,EAAE,KAC1B,MAAM,EAUR,CAAC;AAEF,eAAO,MAAM,sBAAsB;cAIvB,QAAQ;mBACH,MAAM,EAAE;MACrB,QAAQ,MAAM,EAAE,CAmBnB,CAAC;AAEF,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED,eAAO,MAAM,uBAAuB,QAAa,QAC/C,MAAM,GAAG,SAAS,CAMnB,CAAC;AAEF,eAAO,MAAM,aAAa,aAAoB,MAAM,KAAG,QAAQ,IAAI,CAWlE,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc,QAAQ,KAAG,aAIlD,CAAC;AA4DF,eAAO,MAAM,sBAAsB,cAAqB,MAAM,kBAkB7D,CAAC;AA0BF;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,YAAY,EACZ,MAAM,EACN,OAAO,GACR,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG;IACF,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,QAAQ,EAAE,IAAI,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;CACxB,CA8CA"}

package/dist/utils/index.js

@@ -5,7 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTypescriptTestBlock = exports.handleTeardownSkipFlag = exports.getTestRunner = exports.downloadBuild = exports.pickNameFromPackageJson = exports.buildRepoName = exports.generateProjectFilters = exports.filterArrayByGlobMatchersSet = exports.getProjectsFromPlaywrightConfig = exports.markTestAsOnly = exports.hasTopLevelDescribeConfigureWithSerialMode = exports.findFirstSerialDescribeBlock = exports.hasTestBlock = exports.getTestCaseNode = exports.getTestModuleAliasFromSourceFile = exports.getAllFilePaths = exports.cmd = void 0;
 const child_process_1 = require("child_process");
-const fs_extra_1 = __importDefault(require("fs-extra"));
+const fs_1 = require("fs");
+const promises_1 = __importDefault(require("fs/promises"));
 const lodash_isequal_1 = __importDefault(require("lodash.isequal"));
 const minimatch_1 = require("minimatch");
 const path_1 = __importDefault(require("path"));
@@ -29,6 +30,10 @@ function setupProcessSignalHandlers(proc) {
     };
     process.once("SIGINT", async () => await handleSignal("SIGINT"));
     process.once("SIGTERM", async () => await handleSignal("SIGTERM"));
+    // Handler for other signals to catch GitHub Actions behaviors
+    ["SIGABRT", "SIGHUP", "SIGQUIT"].forEach((signal) => {
+        process.once(signal, () => console.log(`Received ${signal}, which is a no-op`));
+    });
 }
 function cmd(command, options) {
     let errorLogs = [];
@@ -70,14 +75,14 @@ exports.cmd = cmd;
  * @param {string} [directoryPath=""]
  * @return {*}  {Promise<string[]>}
  */
-async function getAllFilePaths(directoryPath = "", filters = {}) {
+async function getAllFilePaths(directoryPath = "tests", filters = {}) {
     let filePaths = [];
     try {
-        const files = await fs_extra_1.default.readdir(directoryPath);
+        const files = await promises_1.default.readdir(directoryPath);
         let allFilePaths = [];
         for (const file of files) {
             const filePath = path_1.default.join(directoryPath, file);
-            const stat = await fs_extra_1.default.lstat(filePath);
+            const stat = await promises_1.default.lstat(filePath);
             if (stat.isDirectory()) {
                 // If it's a directory, recursively get file paths from the directory
                 const nestedFiles = await getAllFilePaths(filePath, filters);
@@ -116,7 +121,7 @@ const getTestModuleAliasFromSourceFile = (sourceFile) => {
 };
 exports.getTestModuleAliasFromSourceFile = getTestModuleAliasFromSourceFile;
 async function getTestCaseNode({ filePath, scenarioName, suites, }) {
-    const content = await fs_extra_1.default.readFile(filePath, "utf-8");
+    const content = await promises_1.default.readFile(filePath, "utf-8");
     const { testNode, sourceFile } = getTypescriptTestBlock({
         scenarioName,
         content,
@@ -140,7 +145,8 @@ function findFirstSerialDescribeBlock(node) {
     while (currentNode) {
         const parentDescribe = currentNode.getFirstAncestorByKind(ts_morph_1.SyntaxKind.CallExpression);
         if (parentDescribe) {
-            const isDescribe = parentDescribe.getFirstChild()?.getText() === "test.describe";
+            const isDescribe = parentDescribe.getFirstChild()?.getText() === "test.describe" ||
+                parentDescribe.getFirstChild()?.getText() === "test.describe.only";
             if (isDescribe) {
                 const configureCall = parentDescribe
                     .getDescendantsOfKind(ts_morph_1.SyntaxKind.CallExpression)
@@ -160,7 +166,7 @@ function findFirstSerialDescribeBlock(node) {
 exports.findFirstSerialDescribeBlock = findFirstSerialDescribeBlock;
 async function hasTopLevelDescribeConfigureWithSerialMode(filePath) {
     const project = new ts_morph_1.Project();
-    const content = await fs_extra_1.default.readFile(filePath, "utf-8");
+    const content = await promises_1.default.readFile(filePath, "utf-8");
     const sourceFile = project.createSourceFile("test.ts", content);
     const statements = sourceFile.getStatements();
     for (const statement of statements) {
@@ -202,7 +208,7 @@ async function markTestAsOnly({ sourceFile, parentDescribeNode, testCaseNode, fi
         parentDescribeNode.replaceWithText(describeMarkedAsOnly);
         updatedTestFileContent = sourceFile.getFullText();
     }
-    await fs_extra_1.default.writeFile(filePath, updatedTestFileContent, "utf-8");
+    await promises_1.default.writeFile(filePath, updatedTestFileContent, "utf-8");
 }
 exports.markTestAsOnly = markTestAsOnly;
 async function getProjectsFromPlaywrightConfig(platform) {
@@ -249,14 +255,14 @@ function buildRepoName(projectName) {
 exports.buildRepoName = buildRepoName;
 const pickNameFromPackageJson = async () => {
     const packageJSONPath = "package.json";
-    const packageJsonStr = await fs_extra_1.default.readFile(packageJSONPath, "utf-8");
+    const packageJsonStr = await promises_1.default.readFile(packageJSONPath, "utf-8");
     const packageJSONData = JSON.parse(packageJsonStr);
     return packageJSONData.name && packageJSONData.name.replace("-tests", "");
 };
 exports.pickNameFromPackageJson = pickNameFromPackageJson;
 const downloadBuild = async (buildUrl) => {
     const packageJSONPath = "package.json";
-    const packageJsonStr = await fs_extra_1.default.readFile(packageJSONPath, "utf-8");
+    const packageJsonStr = await promises_1.default.readFile(packageJSONPath, "utf-8");
     const packageJSONData = JSON.parse(packageJsonStr);
     const buildDownloadScript = packageJSONData.scripts["download"];
     if (buildDownloadScript && buildUrl) {
@@ -307,14 +313,14 @@ class TeardownManager {
     async skip() {
         this.teardownFiles = await getAllTeardownFiles(this.directory);
         this.teardownFileContents = await Promise.all(this.teardownFiles.map(async (filePath) => {
-            const content = await fs_extra_1.default.readFile(filePath, "utf-8");
+            const content = await promises_1.default.readFile(filePath, "utf-8");
             return { filePath, content };
         }));
         await Promise.all(this.teardownFiles.map(async (filePath) => await skipTeardownFile(filePath)));
     }
     unskip() {
         this.teardownFileContents.forEach(({ filePath, content }) => {
-            fs_extra_1.default.writeFileSync(filePath, content, "utf-8");
+            (0, fs_1.writeFileSync)(filePath, content, "utf-8");
         });
     }
 }
@@ -343,7 +349,8 @@ const getParentDescribeNames = (node) => {
     while (current) {
         if (ts_morph_1.Node.isCallExpression(current)) {
             const expr = current.getExpression();
-            if (expr.getText() === "test.describe") {
+            if (expr.getText() === "test.describe" ||
+                expr.getText() === "test.describe.only") {
                 const describeBlockArguments = current.getArguments();
                 if (describeBlockArguments.length > 0) {
                     const describeBlockName = describeBlockArguments[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-run",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,6 @@
     "@types/lodash.isequal": "^4.5.8",
     "async-retry": "^1.3.3",
     "commander": "^12.1.0",
-    "fs-extra": "^11.2.0",
     "lodash.isequal": "^4.5.0",
     "minimatch": "^10.0.1",
     "ts-morph": "^23.0.0",