@alchemy.run/test 0.0.0 → 2.0.0-beta.85

package/lib/Reporter.d.ts

@@ -0,0 +1,160 @@
+/**
+ * The Reporter is an Effect service the runner emits structured events into.
+ * Two implementations ship with the CLI: a plain line-oriented reporter for
+ * non-interactive terminals / CI, and an opentui TUI for interactive use.
+ */
+import * as Context from "effect/Context";
+import type * as Effect from "effect/Effect";
+import type { LogEntry } from "./Model.ts";
+export type TestStatus = "pass" | "fail" | "skip" | "todo";
+export interface TestMeta {
+    readonly tags: ReadonlyArray<string>;
+    readonly optInTags: ReadonlyArray<string>;
+    /** Unique test identity, stable across retries; use titlePath for display. */
+    readonly id: string;
+    readonly file: string;
+    readonly titlePath: ReadonlyArray<string>;
+    readonly name: string;
+}
+export interface TestResult {
+    readonly status: TestStatus;
+    readonly durationMs: number;
+    /** Pretty-printed failure (message + relevant stack), if failed. */
+    readonly error?: string | undefined;
+    /** Buffered Effect log / Console output captured during the test. */
+    readonly logs: ReadonlyArray<LogEntry>;
+    /** Number of retries that were attempted before this result. */
+    readonly retries: number;
+}
+export interface RunSummary {
+    readonly dryRun?: boolean;
+    /** Coverage within the command's path, name, .only and global tag filters. */
+    readonly plan?: {
+        readonly found: number;
+        readonly selected: number;
+        readonly excluded: number;
+    } | undefined;
+    readonly files: number;
+    readonly passed: number;
+    readonly failed: number;
+    readonly skipped: number;
+    readonly todo: number;
+    readonly durationMs: number;
+    readonly failures: ReadonlyArray<{
+        meta: TestMeta;
+        result: TestResult;
+    }>;
+    /**
+     * Files that failed as a whole (import error, or a `beforeAll`/`afterAll`
+     * hook failure) rather than through an individual test. Counted in
+     * {@link failed} alongside `failures`.
+     */
+    readonly fileFailures: ReadonlyArray<{
+        file: string;
+        error: string;
+    }>;
+}
+export type TestEvent = {
+    readonly _tag: "PlanPreview";
+    readonly phases: ReadonlyArray<ReadonlyArray<{
+        readonly tags: ReadonlyArray<string>;
+        readonly concurrency: number | "unbounded";
+        readonly tests: number;
+        readonly files: number;
+        readonly skipped: number;
+    }>>;
+} | {
+    readonly _tag: "PlanPhaseStart";
+    readonly phase: number;
+    readonly phases: number;
+    readonly tests: number;
+} | {
+    readonly _tag: "CollectStart";
+    readonly files: ReadonlyArray<string>;
+} | {
+    /** Import progress: one per file during the collection phase. */
+    readonly _tag: "FileCollected";
+    readonly file: string;
+} | {
+    /**
+     * Collection is complete; execution is about to begin. Carries the
+     * full (filtered) test list for the whole run.
+     */
+    readonly _tag: "RunStart";
+    readonly files: number;
+    readonly tests: ReadonlyArray<TestMeta>;
+} | {
+    readonly _tag: "FileStart";
+    readonly file: string;
+    /**
+     * LIVE reference to the file's hook log buffer (deploy/destroy). The
+     * runner appends to it as hooks execute — single-process, so reporters
+     * may read it incrementally (e.g. the TUI tailing a detail pane).
+     */
+    readonly logs?: ReadonlyArray<LogEntry>;
+} | {
+    /** A file-level hook (deploy/destroy) started running. */
+    readonly _tag: "HookStart";
+    readonly file: string;
+    readonly hook: "beforeAll" | "afterAll";
+} | {
+    readonly _tag: "HookEnd";
+    readonly file: string;
+    readonly hook: "beforeAll" | "afterAll";
+} | {
+    readonly _tag: "FileEnd";
+    readonly file: string;
+    /** Buffered output of file-level hooks (deploy/destroy). */
+    readonly logs: ReadonlyArray<LogEntry>;
+    readonly error?: string | undefined;
+} | {
+    readonly _tag: "TestStart";
+    readonly test: TestMeta;
+    /** LIVE reference to the test's captured-output buffer (see FileStart). */
+    readonly logs?: ReadonlyArray<LogEntry>;
+} | {
+    /**
+     * The test holds its run lock (`exclusive`) and starts executing. Until
+     * then it is queued: an exclusive test can wait out a busy phase.
+     */
+    readonly _tag: "TestLocked";
+    readonly test: TestMeta;
+} | {
+    readonly _tag: "TestEnd";
+    readonly test: TestMeta;
+    readonly result: TestResult;
+} | {
+    readonly _tag: "RunEnd";
+    readonly summary: RunSummary;
+};
+/**
+ * Interactive control over a live (or finished) run. The runner hands this
+ * to the Reporter so the TUI can retry and kill tests.
+ *
+ * Retries re-run the test body as-is: for files whose state was torn down by
+ * `afterAll` (deploy-once suites) the retried body may fail on missing
+ * infrastructure — `test.provider`-style self-contained tests retry cleanly.
+ */
+export interface RunController {
+    /** Re-run a finished test. No-op while the test is still running/queued. */
+    readonly retryTest: (id: string) => void;
+    /** Re-run every finished test of a file. */
+    readonly retryFile: (file: string) => void;
+    /** Interrupt a currently-running test (reported as failed/killed). */
+    readonly killTest: (id: string) => void;
+}
+export interface ReporterService {
+    readonly emit: (event: TestEvent) => Effect.Effect<void>;
+    /**
+     * Runs after RunEnd. The plain reporter returns immediately; the TUI blocks
+     * until the user quits so results can be inspected.
+     */
+    readonly waitForExit: (summary: RunSummary) => Effect.Effect<void>;
+    /** Called once by the runner when interactive control becomes available. */
+    readonly attachController?: (controller: RunController) => Effect.Effect<void>;
+}
+declare const Reporter_base: Context.ServiceClass<Reporter, "alchemy-test/Reporter", ReporterService>;
+export declare class Reporter extends Reporter_base {
+}
+export {};
+//# sourceMappingURL=Reporter.d.ts.map

package/lib/Reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Reporter.d.ts","sourceRoot":"","sources":["../src/Reporter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3D,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,oEAAoE;IACpE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,qEAAqE;IACrE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,CAAC,EACV;QACE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC3B,GACD,SAAS,CAAC;IACd,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE,CAAC,CAAC;IACzE;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACvE;AAED,MAAM,MAAM,SAAS,GACjB;IACE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAC5B,aAAa,CAAC;QACZ,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QACrC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAAC;QAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B,CAAC,CACH,CAAC;CACH,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAAE,GACxE;IACE,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,GACD;IACE;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;CACzC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;CACzC,GACD;IACE,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;CACzC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;CACzC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,2EAA2E;IAC3E,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;CACzC,GACD;IACE;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;CAC7B,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAA;CAAE,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,4EAA4E;IAC5E,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,4CAA4C;IAC5C,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3C,sEAAsE;IACtE,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzD;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnE,4EAA4E;IAC5E,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,UAAU,EAAE,aAAa,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;CAChF;;AAED,qBAAa,QAAS,SAAQ,aAE7B;CAAG"}

package/lib/Reporter.js

@@ -0,0 +1,9 @@
+/**
+ * The Reporter is an Effect service the runner emits structured events into.
+ * Two implementations ship with the CLI: a plain line-oriented reporter for
+ * non-interactive terminals / CI, and an opentui TUI for interactive use.
+ */
+import * as Context from "effect/Context";
+export class Reporter extends Context.Service()("alchemy-test/Reporter") {
+}
+//# sourceMappingURL=Reporter.js.map

package/lib/Reporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Reporter.js","sourceRoot":"","sources":["../src/Reporter.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAmK1C,MAAM,OAAO,QAAS,SAAQ,OAAO,CAAC,OAAO,EAA6B,CACxE,uBAAuB,CACxB;CAAG"}

package/lib/Runner.d.ts

@@ -0,0 +1,51 @@
+import * as Effect from "effect/Effect";
+import * as FileSystem from "effect/FileSystem";
+import * as Path from "effect/Path";
+import type { FileSuite } from "./Model.ts";
+import type { TestPlan } from "./Plan.ts";
+import { Reporter, type RunSummary } from "./Reporter.ts";
+export interface RunOptions {
+    /** Directory the run is rooted at (usually `packages/alchemy`). */
+    readonly root: string;
+    /**
+     * Positional filters. Existing files/directories are used as-is; anything
+     * else is a case-insensitive substring filter on test file paths (like
+     * vitest's positional filters). Defaults to `test`.
+     */
+    readonly paths: ReadonlyArray<string>;
+    /**
+     * Exclusion filters (`--exclude`). Existing files/directories exclude by
+     * path prefix; anything else is a case-insensitive substring exclusion on
+     * test file paths. A positional root explicitly given inside an excluded
+     * path overrides the exclusion (so `alchemy-test test/Railway` still works
+     * when the package script bakes in `--exclude test/Railway`).
+     */
+    readonly exclude?: ReadonlyArray<string> | undefined;
+    /**
+     * `-t` test-name filter, applied to the full title
+     * (`file > describe chain > name`).
+     */
+    readonly filter?: ((fullTitle: string) => boolean) | undefined;
+    /** Match the combined suite and test tags, in addition to other filters. */
+    readonly tagsFilter?: ReadonlyArray<string>;
+    readonly plan?: TestPlan | undefined;
+    readonly dryRun?: boolean;
+    /** Default per-test timeout in ms. */
+    readonly timeout: number;
+    /** Times a failing test body is re-run before being reported as failed. */
+    readonly retry: number;
+    /** Maximum number of files executing concurrently (default unbounded). */
+    readonly concurrency: number | "unbounded";
+    /** Force sequential execution within every file. */
+    readonly sequential: boolean;
+    /** Absolute path of the persistent run log (test.log). */
+    readonly logFile: string;
+}
+export declare const discover: (options: RunOptions) => Effect.Effect<string[], unknown, FileSystem.FileSystem | Path.Path>;
+export interface CollectedFile {
+    readonly file: string;
+    readonly suite: FileSuite;
+    readonly error?: string | undefined;
+}
+export declare const run: (input: RunOptions) => Effect.Effect<RunSummary, never, FileSystem.FileSystem | Path.Path | Reporter | import("effect/Scope").Scope>;
+//# sourceMappingURL=Runner.d.ts.map

package/lib/Runner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Runner.d.ts","sourceRoot":"","sources":["../src/Runner.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAGhD,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AAIpC,OAAO,KAAK,EAAa,SAAS,EAAmC,MAAM,YAAY,CAAC;AAExF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EACL,QAAQ,EAER,KAAK,UAAU,EAIhB,MAAM,eAAe,CAAC;AAGvB,MAAM,WAAW,UAAU;IACzB,mEAAmE;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACrD;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/D,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3C,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAyFD,eAAO,MAAM,QAAQ,8FA0FnB,CAAC;AAMH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC;AAsoBD,eAAO,MAAM,GAAG,sIA6ad,CAAC"}