@grest-ts/testkit 0.0.5 → 0.0.7

package/src/testers/RuntimeSelector.ts

@@ -1,151 +1,151 @@
-import type {GGTestRuntime} from "../GGTestRuntime";
-
-/**
- * Constructor type for a runtime class that has a static NAME property.
- * This enforces that all runtimes used with the selector system define NAME.
- *
- * Note: We use `unknown` instead of `GGRuntime` to avoid circular dependency
- * between @grest-ts/testkit and @grest-ts/runtime.
- */
-export interface RuntimeConstructor<N extends string = string> {
-    new(): unknown;
-
-    /** Name of the runtime - must be unique across all runtimes */
-    readonly NAME: N;
-    /** Source path set by GGRuntime.cli() - used for worker/isolated modes */
-    readonly SOURCE_MODULE_URL?: string;
-}
-
-/**
- * Extension interface for selector capabilities.
- * Modules augment this interface to add their accessors (config, logs, metrics, etc.)
- *
- * @example
- * // In @grest-ts/config module:
- * declare module '@grest-ts/testkit' {
- *   interface SelectorExtensions<T extends RuntimeConstructor[]> {
- *     config: GGTestConfigAccessor<T>;
- *   }
- * }
- */
-export interface SelectorExtensions<T extends RuntimeConstructor[]> {
-    // Base interface - modules add properties via declaration merging
-}
-
-/**
- * Selector for a group of runtime instances.
- * Provides access to selected runtimes and their extension accessors.
- *
- * @example
- * const t = GGTest.startWorker(MainRuntime);
- * t.logs.cursor();
- * t[0].logs.cursor();
- * await t.stop();
- */
-export interface Selector<T extends RuntimeConstructor[]> extends SelectorExtensions<T> {
-    /**
-     * Get the underlying runtime instances
-     */
-    readonly runtimes: GGTestRuntime[];
-
-    /**
-     * Access individual instance by index
-     */
-    [index: number]: Selector<[T[number]]>;
-
-    /**
-     * Number of selected instances
-     */
-    readonly length: number;
-
-    /**
-     * Stop runtimes (teardown services but keep IPC alive for log retrieval).
-     * After stop(), you can still call commands like log retrieval.
-     */
-    stop(): Promise<void>;
-
-    /**
-     * Fully shutdown runtimes (terminate workers/processes).
-     * After shutdown(), no commands can be sent.
-     */
-    shutdown(): Promise<void>;
-}
-
-// ============================================================================
-// Input types for startWorker/startInline/startIsolated
-// ============================================================================
-
-/**
- * Input can be a single runtime, array of runtimes, or object mapping names to runtimes.
- */
-export type RuntimeInput =
-    | RuntimeConstructor
-    | RuntimeConstructor[]
-    | Record<string, RuntimeConstructor | RuntimeConstructor[]>;
-
-/**
- * Normalize a single runtime or array to always be an array.
- */
-type NormalizeToArray<T> = T extends RuntimeConstructor[] ? T : [T];
-
-/**
- * Result type for object input: each key maps to a Selector.
- */
-export type ObjectResult<T extends Record<string, RuntimeConstructor | RuntimeConstructor[]>> = {
-    [K in keyof T]: Selector<NormalizeToArray<T[K]>>;
-} & {
-    /**
-     * Stop all runtimes in this group.
-     */
-    stop(): Promise<void>;
-
-    /**
-     * Shutdown all runtimes in this group.
-     */
-    shutdown(): Promise<void>;
-};
-
-/**
- * Result type based on input shape:
- * - Single runtime → Selector
- * - Array of runtimes → Selector
- * - Object → ObjectResult with named selectors
- */
-export type StartResult<T extends RuntimeInput> =
-    T extends Record<string, RuntimeConstructor | RuntimeConstructor[]>
-        ? ObjectResult<T>
-        : T extends RuntimeConstructor[]
-            ? Selector<T>
-            : T extends RuntimeConstructor
-                ? Selector<[T]>
-                : never;
-
-// ============================================================================
-// Legacy RuntimeResult (for backwards compatibility with .get())
-// ============================================================================
-
-/**
- * @deprecated Use the new startWorker overloads instead.
- * Legacy result type that provides .get() method.
- */
-export interface RuntimeResult<T extends RuntimeConstructor[]> {
-    /**
-     * Get selector for a specific runtime type
-     */
-    get<R extends T[number]>(runtime: R): Selector<[R]>;
-
-    /**
-     * Get selector for all runtimes
-     */
-    all(): Selector<T>;
-
-    /**
-     * Stop all runtimes.
-     */
-    stop(): Promise<void>;
-
-    /**
-     * Shutdown all runtimes.
-     */
-    shutdown(): Promise<void>;
-}
+import type {GGTestRuntime} from "../GGTestRuntime";
+
+/**
+ * Constructor type for a runtime class that has a static NAME property.
+ * This enforces that all runtimes used with the selector system define NAME.
+ *
+ * Note: We use `unknown` instead of `GGRuntime` to avoid circular dependency
+ * between @grest-ts/testkit and @grest-ts/runtime.
+ */
+export interface RuntimeConstructor<N extends string = string> {
+    new(): unknown;
+
+    /** Name of the runtime - must be unique across all runtimes */
+    readonly NAME: N;
+    /** Source path set by GGRuntime.cli() - used for worker/isolated modes */
+    readonly SOURCE_MODULE_URL?: string;
+}
+
+/**
+ * Extension interface for selector capabilities.
+ * Modules augment this interface to add their accessors (config, logs, metrics, etc.)
+ *
+ * @example
+ * // In @grest-ts/config module:
+ * declare module '@grest-ts/testkit' {
+ *   interface SelectorExtensions<T extends RuntimeConstructor[]> {
+ *     config: GGTestConfigAccessor<T>;
+ *   }
+ * }
+ */
+export interface SelectorExtensions<T extends RuntimeConstructor[]> {
+    // Base interface - modules add properties via declaration merging
+}
+
+/**
+ * Selector for a group of runtime instances.
+ * Provides access to selected runtimes and their extension accessors.
+ *
+ * @example
+ * const t = GGTest.startWorker(MainRuntime);
+ * t.logs.cursor();
+ * t[0].logs.cursor();
+ * await t.stop();
+ */
+export interface Selector<T extends RuntimeConstructor[]> extends SelectorExtensions<T> {
+    /**
+     * Get the underlying runtime instances
+     */
+    readonly runtimes: GGTestRuntime[];
+
+    /**
+     * Access individual instance by index
+     */
+    [index: number]: Selector<[T[number]]>;
+
+    /**
+     * Number of selected instances
+     */
+    readonly length: number;
+
+    /**
+     * Stop runtimes (teardown services but keep IPC alive for log retrieval).
+     * After stop(), you can still call commands like log retrieval.
+     */
+    stop(): Promise<void>;
+
+    /**
+     * Fully shutdown runtimes (terminate workers/processes).
+     * After shutdown(), no commands can be sent.
+     */
+    shutdown(): Promise<void>;
+}
+
+// ============================================================================
+// Input types for startWorker/startInline/startIsolated
+// ============================================================================
+
+/**
+ * Input can be a single runtime, array of runtimes, or object mapping names to runtimes.
+ */
+export type RuntimeInput =
+    | RuntimeConstructor
+    | RuntimeConstructor[]
+    | Record<string, RuntimeConstructor | RuntimeConstructor[]>;
+
+/**
+ * Normalize a single runtime or array to always be an array.
+ */
+type NormalizeToArray<T> = T extends RuntimeConstructor[] ? T : [T];
+
+/**
+ * Result type for object input: each key maps to a Selector.
+ */
+export type ObjectResult<T extends Record<string, RuntimeConstructor | RuntimeConstructor[]>> = {
+    [K in keyof T]: Selector<NormalizeToArray<T[K]>>;
+} & {
+    /**
+     * Stop all runtimes in this group.
+     */
+    stop(): Promise<void>;
+
+    /**
+     * Shutdown all runtimes in this group.
+     */
+    shutdown(): Promise<void>;
+};
+
+/**
+ * Result type based on input shape:
+ * - Single runtime → Selector
+ * - Array of runtimes → Selector
+ * - Object → ObjectResult with named selectors
+ */
+export type StartResult<T extends RuntimeInput> =
+    T extends Record<string, RuntimeConstructor | RuntimeConstructor[]>
+        ? ObjectResult<T>
+        : T extends RuntimeConstructor[]
+            ? Selector<T>
+            : T extends RuntimeConstructor
+                ? Selector<[T]>
+                : never;
+
+// ============================================================================
+// Legacy RuntimeResult (for backwards compatibility with .get())
+// ============================================================================
+
+/**
+ * @deprecated Use the new startWorker overloads instead.
+ * Legacy result type that provides .get() method.
+ */
+export interface RuntimeResult<T extends RuntimeConstructor[]> {
+    /**
+     * Get selector for a specific runtime type
+     */
+    get<R extends T[number]>(runtime: R): Selector<[R]>;
+
+    /**
+     * Get selector for all runtimes
+     */
+    all(): Selector<T>;
+
+    /**
+     * Stop all runtimes.
+     */
+    stop(): Promise<void>;
+
+    /**
+     * Shutdown all runtimes.
+     */
+    shutdown(): Promise<void>;
+}

package/src/utils/GGExpectations.ts

@@ -1,78 +1,78 @@
-import {Raw} from "@grest-ts/schema";
-import {updateErrorStack} from "./captureStack";
-
-interface Expectation<Data> {
-    err: Error;
-    execute: (input: Data) => void;
-}
-
-/**
- * Collection of expectations to validate data.
- * Pure validation utility - does not know about HTTP response structure.
- */
-export class GGExpectations<Data> {
-
-    private readonly expectations: Expectation<Data>[] = []
-
-    public check(data: Data) {
-        this.expectations.forEach(expectation => {
-            try {
-                expectation.execute(data)
-            } catch (e: any) {
-                throw updateErrorStack(e, expectation.err)
-            }
-        })
-    }
-
-    public flush() {
-        this.expectations.length = 0;
-    }
-
-    private add(execute: (input: Data) => void): void {
-        this.expectations.push({
-            err: new Error(),
-            execute: execute
-        })
-    }
-
-    public toEqual(expectedData: Data): void {
-        return this.add((input) => expect(input).toEqual(expectedData))
-    }
-
-    public toMatchObject(expectedData: Data): void {
-        return this.add((input) => expect(input).toMatchObject(expectedData as any))
-    }
-
-    public toBeUndefined(): void {
-        return this.add((input) => expect(input).toBeUndefined())
-    }
-
-    public toHaveLength(length: number) {
-        return this.add((input: any) => {
-            if (input?.length === undefined) {
-                throw new Error("expect.length is not defined on: " + JSON.stringify(input, null, 2));
-            }
-            expect(input.length).toEqual(length)
-        })
-    }
-
-    public arrayToContain<Item extends Data extends Array<infer R> ? R : never>(...items: Partial<Raw<Item>>[]) {
-        return this.add((input: any) => {
-            expect(Array.isArray(input)).toBe(true)
-            expect(input).toEqual(
-                expect.arrayContaining(
-                    items.map(item => expect.objectContaining(item as any))
-                )
-            );
-        })
-    }
-
-    public arrayToContainEqual<Item extends Data extends Array<infer R> ? R : never>(...items: Partial<Raw<Item>>[]) {
-        return this.add((input: any) => {
-            expect(Array.isArray(input)).toBe(true)
-            for (const item of items) {
-                expect(input).toContainEqual(item);
-            }
-        })
-    }
-}
+import {Raw} from "@grest-ts/schema";
+import {updateErrorStack} from "./captureStack";
+
+interface Expectation<Data> {
+    err: Error;
+    execute: (input: Data) => void;
+}
+
+/**
+ * Collection of expectations to validate data.
+ * Pure validation utility - does not know about HTTP response structure.
+ */
+export class GGExpectations<Data> {
+
+    private readonly expectations: Expectation<Data>[] = []
+
+    public check(data: Data) {
+        this.expectations.forEach(expectation => {
+            try {
+                expectation.execute(data)
+            } catch (e: any) {
+                throw updateErrorStack(e, expectation.err)
+            }
+        })
+    }
+
+    public flush() {
+        this.expectations.length = 0;
+    }
+
+    private add(execute: (input: Data) => void): void {
+        this.expectations.push({
+            err: new Error(),
+            execute: execute
+        })
+    }
+
+    public toEqual(expectedData: Data): void {
+        return this.add((input) => expect(input).toEqual(expectedData))
+    }
+
+    public toMatchObject(expectedData: Data): void {
+        return this.add((input) => expect(input).toMatchObject(expectedData as any))
+    }
+
+    public toBeUndefined(): void {
+        return this.add((input) => expect(input).toBeUndefined())
+    }
+
+    public toHaveLength(length: number) {
+        return this.add((input: any) => {
+            if (input?.length === undefined) {
+                throw new Error("expect.length is not defined on: " + JSON.stringify(input, null, 2));
+            }
+            expect(input.length).toEqual(length)
+        })
+    }
+
+    public arrayToContain<Item extends Data extends Array<infer R> ? R : never>(...items: Partial<Raw<Item>>[]) {
+        return this.add((input: any) => {
+            expect(Array.isArray(input)).toBe(true)
+            expect(input).toEqual(
+                expect.arrayContaining(
+                    items.map(item => expect.objectContaining(item as any))
+                )
+            );
+        })
+    }
+
+    public arrayToContainEqual<Item extends Data extends Array<infer R> ? R : never>(...items: Partial<Raw<Item>>[]) {
+        return this.add((input: any) => {
+            expect(Array.isArray(input)).toBe(true)
+            for (const item of items) {
+                expect(input).toContainEqual(item);
+            }
+        })
+    }
+}

package/src/utils/GGTestError.ts

@@ -1,37 +1,37 @@
-import {LOG_COLORS} from "@grest-ts/logger-console";
-
-export class GGTestError extends Error {
-
-    constructor(data: CreateErrorInput) {
-
-        const tab = (n: number, str: string) => {
-            return str.split("\n").join("\n" + ("\t".repeat(n)));
-        }
-
-        const fixValue = (value: any) => {
-            if (value instanceof Error) {
-                return value.stack
-            } else if (typeof value === "object") {
-                return JSON.stringify(value, null, 2)
-            } else {
-                return String(value);
-            }
-        }
-
-        super("Error: " + (data.context ? data.context + " " : "") + data.test + "\n" +
-            "\nExpected: " + LOG_COLORS.green + tab(1, fixValue(data.expected)) + LOG_COLORS.reset +
-            "\nReceived: " + tab(1, fixValue(data.received)) +
-            (data.extra ? "\n\t" + tab(1, data.extra) : "") +
-            (data.sourceFile ? "\n\t" + tab(1, data.sourceFile) : "") +
-            "\n");
-    }
-}
-
-interface CreateErrorInput {
-    context?: string;
-    test: string,
-    expected: any,
-    received: any,
-    extra?: any
-    sourceFile?: string;
+import {LOG_COLORS} from "@grest-ts/logger-console";
+
+export class GGTestError extends Error {
+
+    constructor(data: CreateErrorInput) {
+
+        const tab = (n: number, str: string) => {
+            return str.split("\n").join("\n" + ("\t".repeat(n)));
+        }
+
+        const fixValue = (value: any) => {
+            if (value instanceof Error) {
+                return value.stack
+            } else if (typeof value === "object") {
+                return JSON.stringify(value, null, 2)
+            } else {
+                return String(value);
+            }
+        }
+
+        super("Error: " + (data.context ? data.context + " " : "") + data.test + "\n" +
+            "\nExpected: " + LOG_COLORS.green + tab(1, fixValue(data.expected)) + LOG_COLORS.reset +
+            "\nReceived: " + tab(1, fixValue(data.received)) +
+            (data.extra ? "\n\t" + tab(1, data.extra) : "") +
+            (data.sourceFile ? "\n\t" + tab(1, data.sourceFile) : "") +
+            "\n");
+    }
+}
+
+interface CreateErrorInput {
+    context?: string;
+    test: string,
+    expected: any,
+    received: any,
+    extra?: any
+    sourceFile?: string;
 }

package/src/utils/captureStack.ts

@@ -1,54 +1,54 @@
-/**
- * @returns path to the source test file
- */
-export function captureStackSourceFile(): string {
-    return getLinesFromTestFile(new Error().stack.split("\n"))[0] ?? "[Source not found]";
-}
-
-/**
- * Switches source files part of the stack for err with actualSourceLocation, but keeping the original error message.
- */
-export function updateErrorStack(err: Error, actualSourceLocation?: Error) {
-    const lines = (err.stack ?? '').split("\n");
-    const errorLines = getErrorLinesOnly(lines);
-    const errLines = (actualSourceLocation?.stack ?? err.stack ?? '').split("\n");
-    const fileLines = getLinesFromTestFile(errLines);
-    err.stack = errorLines.join("\n") + "\n" + fileLines.join("\n");
-    return err;
-}
-
-/**
- * Returns error message part of the stack lines. Skips all lines after first path is detected.
- */
-function getErrorLinesOnly(lines: string[]): string [] {
-    const addedLines: string[] = [];
-    for (let i = 0; i < lines.length; i++) {
-        const line = lines[i];
-        if (line.startsWith("    at ")) {
-            break;
-        }
-        addedLines.push(line);
-    }
-    return addedLines;
-}
-
-/**
- * Returns source file path lines from the lines.
- * Starts stack from the "test" source file and skips all framework paths.
- * For example:
- * '   at PATH_TO_SOURCE'
- */
-function getLinesFromTestFile(lines: string[]): string[] {
-    const startIdx = lines.findIndex(line => {
-        return line.includes('.test.ts')
-            || line.includes('.spec.ts')
-    });
-    const endIds = lines.findIndex(line => {
-        return line.includes('@vitest')
-    });
-    if (startIdx === -1) {
-        return [];
-    }
-    return lines.slice(startIdx, endIds);
-
+/**
+ * @returns path to the source test file
+ */
+export function captureStackSourceFile(): string {
+    return getLinesFromTestFile(new Error().stack.split("\n"))[0] ?? "[Source not found]";
+}
+
+/**
+ * Switches source files part of the stack for err with actualSourceLocation, but keeping the original error message.
+ */
+export function updateErrorStack(err: Error, actualSourceLocation?: Error) {
+    const lines = (err.stack ?? '').split("\n");
+    const errorLines = getErrorLinesOnly(lines);
+    const errLines = (actualSourceLocation?.stack ?? err.stack ?? '').split("\n");
+    const fileLines = getLinesFromTestFile(errLines);
+    err.stack = errorLines.join("\n") + "\n" + fileLines.join("\n");
+    return err;
+}
+
+/**
+ * Returns error message part of the stack lines. Skips all lines after first path is detected.
+ */
+function getErrorLinesOnly(lines: string[]): string [] {
+    const addedLines: string[] = [];
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        if (line.startsWith("    at ")) {
+            break;
+        }
+        addedLines.push(line);
+    }
+    return addedLines;
+}
+
+/**
+ * Returns source file path lines from the lines.
+ * Starts stack from the "test" source file and skips all framework paths.
+ * For example:
+ * '   at PATH_TO_SOURCE'
+ */
+function getLinesFromTestFile(lines: string[]): string[] {
+    const startIdx = lines.findIndex(line => {
+        return line.includes('.test.ts')
+            || line.includes('.spec.ts')
+    });
+    const endIds = lines.findIndex(line => {
+        return line.includes('@vitest')
+    });
+    if (startIdx === -1) {
+        return [];
+    }
+    return lines.slice(startIdx, endIds);
+
 }