@empiricalrun/test-run 0.4.5 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/test-run
 
+## 0.5.0
+
+### Minor Changes
+
+- 0c445bf: feat: add support for running specific file in test-run package
+
+## 0.4.6
+
+### Patch Changes
+
+- 4ab570f: fix: consider "setup" and "teardown" aliases as test block in test-run
+
 ## 0.4.5
 
 ### Patch Changes

package/dist/bin/index.js

@@ -11,8 +11,9 @@ const utils_1 = require("../utils");
     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("--skip-teardown", `This options skips running teardown 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();
     commander_1.program.parse(process.argv);
@@ -27,6 +28,8 @@ const utils_1 = require("../utils");
         "-n",
         "--name",
         "--skip-teardown",
+        "-f",
+        "--file",
         "-d",
         "--dir",
         "-p",
@@ -34,6 +37,7 @@ const utils_1 = require("../utils");
         options.skipTeardown,
         options.name,
         options.dir,
+        options.file,
         ...options.project, // an array of comma separated project names/pattern matching globs *,premium-*,super-premium-*,safari
     ];
     const pwOptions = process.argv
@@ -67,6 +71,7 @@ const utils_1 = require("../utils");
         }
         const { hasTestPassed } = await (0, __1.runTest)({
             name: options.name,
+            filePath: options.file,
             dir: directory,
             pwOptions: pwOptions.join(" "),
             platform,

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { TestRunParameters } from "./types";
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-export declare function runTest({ name, dir, pwOptions, platform, }: TestRunParameters): Promise<{
+export declare function runTest({ name, filePath, dir, 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,GAAG,EACH,SAAS,EACT,QAAQ,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAMD"}
+{"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,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAMD"}

package/dist/index.js

@@ -8,9 +8,9 @@ const run_specific_test_1 = require("./run-specific-test");
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-async function runTest({ name, dir, pwOptions, platform, }) {
+async function runTest({ name, filePath, dir, pwOptions, platform, }) {
     if (name) {
-        return await (0, run_specific_test_1.runSpecificTest)({ name, dir, pwOptions, platform });
+        return await (0, run_specific_test_1.runSpecificTest)({ name, dir, filePath, pwOptions, platform });
     }
     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, dir, pwOptions, platform, }: TestRunParameters): Promise<{
+export declare function runSpecificTest({ name, filePath, dir, 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,GAAG,EACH,SAAS,EACT,QAAQ,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CAwED"}
+{"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,GACT,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC,CA0ED"}

package/dist/run-specific-test.js

@@ -11,8 +11,10 @@ const utils_1 = require("./utils");
  * @export
  * @param {TestRunParameters} { name, dir, pwOptions }
  */
-async function runSpecificTest({ name, dir, pwOptions, platform, }) {
-    const files = await (0, utils_1.getAllFilePaths)(dir);
+async function runSpecificTest({ name, filePath, dir, pwOptions, platform, }) {
+    const files = await (0, utils_1.getAllFilePaths)(dir, {
+        filePath,
+    });
     let matchingFilePath = "";
     // find the first file that contains the test block
     // TODO: add suites support

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 export type TestRunParameters = {
     name: string;
+    filePath?: string;
     dir?: string;
     pwOptions?: string;
     platform: Platform;

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,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,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"}
+{"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;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/index.d.ts

@@ -9,7 +9,10 @@ export declare function cmd(command: string[], options: {
  * @param {string} [directoryPath=""]
  * @return {*}  {Promise<string[]>}
  */
-export declare function getAllFilePaths(directoryPath?: string): Promise<string[]>;
+export declare function getAllFilePaths(directoryPath?: string, filters?: {
+    filePath?: string;
+}): Promise<string[]>;
+export declare const getTestModuleAliasFromSourceFile: (sourceFile: SourceFile) => string;
 export declare function getTestCaseNode({ filePath, scenarioName, }: {
     filePath: string;
     scenarioName: string;

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

@@ -1 +1 @@
-{"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,OAAO,EAEL,QAAQ,EAER,aAAa,EACd,MAAM,UAAU,CAAC;AAElB,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,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"}
+{"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,OAAO,EAEL,QAAQ,EAER,aAAa,EACd,MAAM,UAAU,CAAC;AAElB,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,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,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,CAetE;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,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"}

package/dist/utils/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.getAllFilePaths = exports.cmd = void 0;
+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 minimatch_1 = require("minimatch");
@@ -47,23 +47,30 @@ exports.cmd = cmd;
  * @param {string} [directoryPath=""]
  * @return {*}  {Promise<string[]>}
  */
-async function getAllFilePaths(directoryPath = "") {
+async function getAllFilePaths(directoryPath = "", filters = {}) {
     let filePaths = [];
     try {
         const files = await fs_extra_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);
             if (stat.isDirectory()) {
                 // If it's a directory, recursively get file paths from the directory
-                const nestedFiles = await getAllFilePaths(filePath);
-                filePaths = filePaths.concat(nestedFiles);
+                const nestedFiles = await getAllFilePaths(filePath, filters);
+                allFilePaths = allFilePaths.concat(nestedFiles);
             }
             else {
                 // If it's a file, push its path to the array
-                filePaths.push(filePath);
+                allFilePaths.push(filePath);
             }
         }
+        filePaths = allFilePaths.filter((filePath) => {
+            if (filters.filePath) {
+                return filePath.includes(filters.filePath);
+            }
+            return true;
+        });
     }
     catch (err) {
         console.error("Error reading directory:", err);
@@ -71,12 +78,27 @@ async function getAllFilePaths(directoryPath = "") {
     return filePaths;
 }
 exports.getAllFilePaths = getAllFilePaths;
+const getTestModuleAliasFromSourceFile = (sourceFile) => {
+    return (sourceFile
+        .getImportDeclarations()
+        // Look for any import that includes "test" as a named import, regardless of module path
+        // "test" can be imported from "@playwright/test" or "<some-fixture>"
+        .find((importDecl) => importDecl
+        .getNamedImports()
+        .some((namedImport) => namedImport.getName() === "test"))
+        ?.getNamedImports()
+        .find((namedImport) => namedImport.getName() === "test")
+        ?.getAliasNode()
+        ?.getText() || "test");
+};
+exports.getTestModuleAliasFromSourceFile = getTestModuleAliasFromSourceFile;
 async function getTestCaseNode({ filePath, scenarioName, }) {
     const project = new ts_morph_1.Project();
     const content = await fs_extra_1.default.readFile(filePath, "utf-8");
     const sourceFile = project.createSourceFile("test.ts", content);
+    const testAlias = (0, exports.getTestModuleAliasFromSourceFile)(sourceFile);
     const testCaseNode = sourceFile.getFirstDescendant((node) => !!(node.isKind(ts_morph_1.SyntaxKind.CallExpression) &&
-        node.getExpression().getText() === "test" &&
+        node.getExpression().getText() === testAlias &&
         node.getArguments()[0]?.getText().includes(scenarioName)));
     return { testCaseNode, sourceFile };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-run",
-  "version": "0.4.5",
+  "version": "0.5.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"