@empiricalrun/test-run 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/test-run
 
+## 0.2.0
+
+### Minor Changes
+
+- c6c6b49: feat: support project filtering via cli options
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/bin/index.js

@@ -3,17 +3,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const __1 = require("..");
+const utils_1 = require("../utils");
 (async function main() {
     // TODO: add support for suites
     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("-p, --project <project-name...>", "Test projects to run")
+        .option("--forbid-only", `This options forbids the use of ".only" in the test files`)
         .allowUnknownOption();
     commander_1.program.parse(process.argv);
     // Accessing the extracted parameters
     const options = commander_1.program.opts();
-    if (!options.name) {
-        console.error("Please provide a test name");
+    if (options.name && options.forbidOnly) {
+        console.error("--name and --forbid-only options cannot be used together");
         process.exit(1);
     }
     const optionsToStrip = [
@@ -21,17 +24,18 @@ const __1 = require("..");
         "--name",
         "-d",
         "--dir",
+        "-p",
+        "--project",
         options.name,
         options.dir,
+        ...options.project, // an array of comma separated project names/pattern matching globs *,premium-*,super-premium-*,safari
     ];
     const pwOptions = process.argv
         .slice(2)
         .filter((arg) => !optionsToStrip.includes(arg));
-    if (pwOptions.includes("--forbid-only")) {
-        console.error("forbid-only option is not supported");
-        process.exit(1);
-    }
     try {
+        const projectFilters = await (0, utils_1.generateProjectFilters)(options.project);
+        pwOptions.push(...projectFilters);
         const { hasTestPassed } = await (0, __1.runTest)({
             name: options.name,
             dir: options.dir || "tests",

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;AAW5C;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,EAC5B,IAAI,EACJ,GAAG,EACH,SAAS,GACV,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAoDD"}
+{"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,GAAG,EACH,SAAS,GACV,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAMD"}

package/dist/index.js

@@ -1,67 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runTest = void 0;
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const utils_1 = require("./utils");
+const run_all_tests_1 = require("./run-all-tests");
+const run_specific_test_1 = require("./run-specific-test");
 /**
  *
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
 async function runTest({ name, dir, pwOptions, }) {
-    const files = await (0, utils_1.getAllFilePaths)(dir);
-    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 });
-        if (match) {
-            matchingFilePath = file;
-            break;
-        }
+    if (name) {
+        return await (0, run_specific_test_1.runSpecificTest)({ name, dir, pwOptions });
     }
-    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,
-    });
-    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");
-    // 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 env = Object({ ...process.env });
-        const pwRunCmd = `npx playwright test ${matchingFilePath} ${pwOptions}`;
-        console.log("Playwright test command:", pwRunCmd);
-        await (0, utils_1.cmd)(pwRunCmd.split(" "), {
-            env,
-        });
-    }
-    catch (e) {
-        hasTestPassed = false;
-    }
-    // revert the changes made to the file to mark tests as only
-    await fs_extra_1.default.writeFile(matchingFilePath, currentFileContent);
-    return {
-        hasTestPassed,
-    };
+    return await (0, run_all_tests_1.runAllTests)({ pwOptions });
 }
 exports.runTest = runTest;

package/dist/run-all-tests.d.ts

@@ -0,0 +1,11 @@
+/**
+ *
+ * @export
+ * @param {TestRunParameters} { name, dir, pwOptions }
+ */
+export declare function runAllTests({ pwOptions, }: {
+    pwOptions?: string;
+}): Promise<{
+    hasTestPassed: boolean;
+}>;
+//# sourceMappingURL=run-all-tests.d.ts.map

package/dist/run-all-tests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-all-tests.d.ts","sourceRoot":"","sources":["../src/run-all-tests.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAChC,SAAS,GACV,EAAE;IACD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GAAG,OAAO,CAAC;IACV,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAkBD"}

package/dist/run-all-tests.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runAllTests = void 0;
+const utils_1 = require("./utils");
+/**
+ *
+ * @export
+ * @param {TestRunParameters} { name, dir, pwOptions }
+ */
+async function runAllTests({ pwOptions, }) {
+    let hasTestPassed = true;
+    try {
+        const env = Object({ ...process.env });
+        const pwRunCmd = `npx playwright test ${pwOptions}`;
+        console.log("Playwright test command:", pwRunCmd, {
+            arr: pwRunCmd.split(" "),
+        });
+        await (0, utils_1.cmd)(pwRunCmd.split(" "), {
+            env,
+        });
+    }
+    catch (e) {
+        hasTestPassed = false;
+    }
+    return {
+        hasTestPassed,
+    };
+}
+exports.runAllTests = runAllTests;

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

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

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

@@ -0,0 +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;AAW5C;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,IAAI,EACJ,GAAG,EACH,SAAS,GACV,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAoDD"}

package/dist/run-specific-test.js

@@ -0,0 +1,67 @@
+"use strict";
+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"));
+const utils_1 = require("./utils");
+/**
+ *
+ * @export
+ * @param {TestRunParameters} { name, dir, pwOptions }
+ */
+async function runSpecificTest({ name, dir, pwOptions, }) {
+    const files = await (0, utils_1.getAllFilePaths)(dir);
+    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 });
+        if (match) {
+            matchingFilePath = file;
+            break;
+        }
+    }
+    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,
+    });
+    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");
+    // 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 env = Object({ ...process.env });
+        const pwRunCmd = `npx playwright test ${matchingFilePath} ${pwOptions}`;
+        console.log("Playwright test command:", pwRunCmd);
+        await (0, utils_1.cmd)(pwRunCmd.split(" "), {
+            env,
+        });
+    }
+    catch (e) {
+        hasTestPassed = false;
+    }
+    // revert the changes made to the file to mark tests as only
+    await fs_extra_1.default.writeFile(matchingFilePath, currentFileContent);
+    return {
+        hasTestPassed,
+    };
+}
+exports.runSpecificTest = runSpecificTest;

package/dist/utils/index.d.ts

@@ -28,4 +28,7 @@ export declare function markTestAsOnly({ sourceFile, parentDescribeNode, testCas
     testCaseNode: Node;
     filePath: string;
 }): Promise<void>;
+export declare function getProjectsFromPlaywrightConfig(): Promise<string[]>;
+export declare const filterArrayByGlobMatchersSet: (input: string[], globMatcherSets: string[][]) => string[];
+export declare const generateProjectFilters: (filteringSets: string[]) => Promise<string[]>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAW,UAAU,EAAc,MAAM,UAAU,CAAC;AAEjE,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,CA2BjB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,aAAa,GAAE,MAAW,GACzB,OAAO,CAAC,MAAM,EAAE,CAAC,CAqBnB;AAED,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAatE;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,OAAO,CAAC,CAMnB;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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAW,UAAU,EAAc,MAAM,UAAU,CAAC;AAGjE,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,CA2BjB;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,aAAa,GAAE,MAAW,GACzB,OAAO,CAAC,MAAM,EAAE,CAAC,CAqBnB;AAED,wBAAsB,eAAe,CAAC,EACpC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,UAAU,CAAA;CAAE,CAAC,CAatE;AAED,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,YAAY,GACb,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,OAAO,CAAC,OAAO,CAAC,CAMnB;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,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAczE;AAED,eAAO,MAAM,4BAA4B,UAEhC,MAAM,EAAE,mBAGE,MAAM,EAAE,EAAE,KAC1B,MAAM,EAUR,CAAC;AAEF,eAAO,MAAM,sBAAsB,kBAClB,MAAM,EAAE,KACtB,QAAQ,MAAM,EAAE,CAkBlB,CAAC"}

package/dist/utils/index.js

@@ -3,11 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.markTestAsOnly = exports.hasTopLevelDescribeConfigureWithSerialMode = exports.findFirstSerialDescribeBlock = exports.hasTestBlock = exports.getTestCaseNode = exports.getAllFilePaths = exports.cmd = void 0;
+exports.generateProjectFilters = exports.filterArrayByGlobMatchersSet = exports.getProjectsFromPlaywrightConfig = exports.markTestAsOnly = exports.hasTopLevelDescribeConfigureWithSerialMode = exports.findFirstSerialDescribeBlock = exports.hasTestBlock = exports.getTestCaseNode = exports.getAllFilePaths = exports.cmd = void 0;
 const child_process_1 = require("child_process");
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const minimatch_1 = require("minimatch");
 const path_1 = __importDefault(require("path"));
 const ts_morph_1 = require("ts-morph");
+const api_1 = require("tsx/esm/api");
 function cmd(command, options) {
     let errorLogs = [];
     return new Promise((resolveFunc, rejectFunc) => {
@@ -157,3 +159,41 @@ async function markTestAsOnly({ sourceFile, parentDescribeNode, testCaseNode, fi
     await fs_extra_1.default.writeFile(filePath, updatedTestFileContent, "utf-8");
 }
 exports.markTestAsOnly = markTestAsOnly;
+async function getProjectsFromPlaywrightConfig() {
+    const configName = "playwright.config.ts";
+    const directoryPath = ".";
+    const pwFile = path_1.default.resolve(directoryPath, configName);
+    try {
+        const projectConfig = await (0, api_1.tsImport)(pwFile, __filename);
+        return projectConfig?.default?.default?.projects?.map((projectConfig) => projectConfig.name);
+    }
+    catch (err) {
+        console.error("Error getting project list from playwright config", err);
+    }
+    return [];
+}
+exports.getProjectsFromPlaywrightConfig = getProjectsFromPlaywrightConfig;
+const filterArrayByGlobMatchersSet = (
+// array that needs to be filtered
+input, 
+// set of glob patterns to filter the array sequentially (takes the intersection of all sets)
+globMatcherSets) => {
+    let filteredList = input;
+    globMatcherSets.forEach((matcherSet) => {
+        filteredList = filteredList.filter((item) => {
+            return matcherSet.some((matcherGlob) => (0, minimatch_1.minimatch)(item, matcherGlob));
+        });
+    });
+    return filteredList;
+};
+exports.filterArrayByGlobMatchersSet = filterArrayByGlobMatchersSet;
+const generateProjectFilters = async (filteringSets) => {
+    const projectsDefinedInPwConfig = await getProjectsFromPlaywrightConfig();
+    const filters = filteringSets.map((matchingString) => matchingString.split(","));
+    const filteredProjects = (0, exports.filterArrayByGlobMatchersSet)(projectsDefinedInPwConfig, filters);
+    if (filteredProjects.length === 0) {
+        throw new Error("No projects found in playwright config that matches the filtering criteria");
+    }
+    return filteredProjects.map((projectName) => `--project ${projectName}`);
+};
+exports.generateProjectFilters = generateProjectFilters;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-run",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -17,7 +17,9 @@
   "dependencies": {
     "commander": "^12.1.0",
     "fs-extra": "^11.2.0",
-    "ts-morph": "^23.0.0"
+    "minimatch": "^10.0.1",
+    "ts-morph": "^23.0.0",
+    "tsx": "^4.16.2"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",