@itmetsam/samurai-framework 0.2.2 → 0.3.0

package/dist/runner/test-runner.d.ts

@@ -2,6 +2,7 @@ import type { RegisteredTestCase } from "../types/test.js";
 import type { PreparedRun } from "./prepare-run.js";
 import { type RunEvent } from "./reporter.js";
 import type { SamuraiGroup } from "../types/config.js";
+import type { ResolvedGroup } from "./groups.js";
 /** What decides which tests of the found files run, and how the browser starts */
 export interface RunnerOptions {
     /** Spec files to run, absolute or relative to the project folder. Default: every `*.spec.ts` under `srcDir` */
@@ -10,6 +11,8 @@ export interface RunnerOptions {
     grep?: string | RegExp;
     /** Only tests with exactly one of these full names (`describe` titles joined with " > ") */
     testNames?: string[];
+    /** Only the tests of this group of the config's `groups` (unknown name: an error). Combines with the other filters */
+    group?: string;
     /** Run the browser without a window. @default false */
     headless?: boolean;
     /** Remote debugging port of the browser. @default 9223 */
@@ -30,12 +33,19 @@ export default class TestRunner {
     private options;
     constructor(testFiles: string[], run: PreparedRun, group?: SamuraiGroup, options?: RunnerOptions);
     static init(run: PreparedRun, group?: SamuraiGroup, options?: RunnerOptions): Promise<TestRunner>;
-    /** Runs the selected tests and returns the summary that was also written to the report */
     /**
-     * Imports the spec files and returns the tests the options select. A fresh registry and a fresh import of each
+     * Imports the spec files and returns every test they register. A fresh registry and a fresh import of each
      * file, so a second run in this process registers its tests again (and sees edited specs, for files loaded as
      * ES modules; CommonJS files stay cached until the process ends)
      */
+    private registerAll;
+    /** Id of a registered test: its spec file relative to `srcDir`, then its name */
+    private idOf;
+    /** The config's groups, resolved against the tests the specs register */
+    private resolveAll;
+    /** The groups of the config with the tests each holds; see `listGroups` */
+    groups(): Promise<ResolvedGroup[]>;
+    /** Imports the spec files and returns the tests the options select: by `group`, `testNames` and `grep` */
     register(): Promise<RegisteredTestCase[]>;
     /** Runs the selected tests and returns the summary that was also written to the report */
     start(): Promise<import("../types/test.js").TestSummary>;

package/dist/runner/test-runner.js

@@ -3,7 +3,7 @@ import { glob } from "node:fs/promises";
 import path from "path";
 import { pathToFileURL } from "url";
 import { Browser } from "../browser/browser.js";
-import { projectDir, readConfig } from "../config/config.js";
+import { loadConfig, projectDir, readConfig } from "../config/config.js";
 import logger from "../logger/index.js";
 import { assertModuleProject } from "./module-type.js";
 import { clearRegistry, registeredTests } from "./registry.js";
@@ -14,6 +14,7 @@ import Page from "../browser/page.js";
 import { takePendingAssertions } from "../assert/expect.js";
 import { toTestError } from "./test-error.js";
 import { ConnectionClosedError } from "../transport/bidi-connection.js";
+import { DEFAULT_SRC_DIR, findGroup, resolveGroups, testId, toPosix, } from "./groups.js";
 import { judgePageLogs } from "./page-logs-report.js";
 /** Whether a test with this full name is selected by the options */
 export function isSelected(name, { grep, testNames }) {
@@ -57,13 +58,12 @@ export default class TestRunner {
         logger.debug("Found %d tests in srcDir", testFiles.length);
         return new TestRunner(testFiles.map((file) => path.join(cwd, file)), run, group, options);
     }
-    /** Runs the selected tests and returns the summary that was also written to the report */
     /**
-     * Imports the spec files and returns the tests the options select. A fresh registry and a fresh import of each
+     * Imports the spec files and returns every test they register. A fresh registry and a fresh import of each
      * file, so a second run in this process registers its tests again (and sees edited specs, for files loaded as
      * ES modules; CommonJS files stay cached until the process ends)
      */
-    async register() {
+    async registerAll() {
         clearRegistry();
         const stamp = `?run=${Date.now().toString(36)}`;
         for (const file of this.testFiles)
@@ -72,8 +72,38 @@ export default class TestRunner {
             logger.verbose("Trying to register file: %s", file);
             await import(pathToFileURL(file).href + stamp);
         }
-        // TODO: Implement test grouping
-        return registeredTests().filter((test) => isSelected(test.name, this.options));
+        return [...registeredTests()];
+    }
+    /** Id of a registered test: its spec file relative to `srcDir`, then its name */
+    idOf(test, srcDir) {
+        return testId(toPosix(path.relative(srcDir, test.file)), test.name);
+    }
+    /** The config's groups, resolved against the tests the specs register */
+    async resolveAll(tests) {
+        const config = await loadConfig();
+        const dir = projectDir();
+        const srcDir = path.resolve(dir, config.srcDir ?? DEFAULT_SRC_DIR);
+        const groups = resolveGroups(config, tests.map(({ file, name }) => ({
+            file: toPosix(path.relative(srcDir, file)),
+            name,
+        })), dir, srcDir);
+        return { groups, srcDir };
+    }
+    /** The groups of the config with the tests each holds; see `listGroups` */
+    async groups() {
+        return (await this.resolveAll(await this.registerAll())).groups;
+    }
+    /** Imports the spec files and returns the tests the options select: by `group`, `testNames` and `grep` */
+    async register() {
+        const all = await this.registerAll();
+        const { group } = this.options;
+        let inGroup = () => true;
+        if (group !== undefined) {
+            const { groups, srcDir } = await this.resolveAll(all);
+            const members = new Set(findGroup(groups, group).testIds);
+            inGroup = (test) => members.has(this.idOf(test, srcDir));
+        }
+        return all.filter((test) => inGroup(test) && isSelected(test.name, this.options));
     }
     /** Runs the selected tests and returns the summary that was also written to the report */
     async start() {

package/dist/steps/emit.js

@@ -63,6 +63,8 @@ export function stepToSource(step) {
             return `await ${locatorToSource(step.locator)}.click();`;
         case "fill":
             return `await ${locatorToSource(step.locator)}.fill(${valueToSource(step.value)});`;
+        case "press":
+            return `await ${locatorToSource(step.locator)}.press(${str(step.key)});`;
         case "expect":
             return `await expect(${locatorToSource(step.locator)})${step.not ? ".not" : ""}.${expectationToSource(step.expectation)};`;
         case "waitForNetworkIdle":

package/dist/steps/model.d.ts

@@ -75,6 +75,12 @@ export type Step = {
     locator: LocatorSpec;
     not: boolean;
     expectation: Expectation;
+}
+/** A key pressed while the element has focus, e.g. `Enter` to submit a field. Named as Playwright names keys */
+ | {
+    kind: "press";
+    locator: LocatorSpec;
+    key: string;
 } | {
     kind: "waitForNetworkIdle";
 }

package/dist/steps/parse.js

@@ -214,6 +214,10 @@ function readStep(statement) {
         return undefined;
     if (name.text === "click" && args.length === 0)
         return { kind: "click", locator };
+    if (name.text === "press" && args.length === 1) {
+        const key = stringOf(args[0]);
+        return key === undefined ? undefined : { kind: "press", locator, key };
+    }
     if (name.text === "fill" && args.length === 1) {
         const value = readValue(args[0]);
         return value ? { kind: "fill", locator, value } : undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itmetsam/samurai-framework",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Browser test framework over WebDriver BiDi: auto-waiting locators, environments and secrets, a recorder, and a command line.",
   "main": "dist/api.js",
   "exports": {
@@ -28,6 +28,14 @@
       "types": "./dist/browser/index.d.ts",
       "default": "./dist/browser/index.js"
     },
+    "./flows": {
+      "types": "./dist/flows/core/index.d.ts",
+      "default": "./dist/flows/core/index.js"
+    },
+    "./flows/run": {
+      "types": "./dist/flows/run/index.d.ts",
+      "default": "./dist/flows/run/index.js"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {