@jterrazz/test 3.2.0 → 3.3.0

package/dist/index.d.cts

@@ -109,6 +109,24 @@ declare class Orchestrator {
   getAppUrl(): null | string;
 }
 //#endregion
+//#region src/specification/ports/command.port.d.ts
+/**
+ * Result of executing a CLI command.
+ */
+interface CommandResult {
+  exitCode: number;
+  stdout: string;
+  stderr: string;
+}
+/**
+ * Abstract CLI interface for specification runners.
+ * Implement this to plug in your command execution strategy.
+ */
+interface CommandPort {
+  /** Execute a CLI command with the given arguments in the given working directory. */
+  exec(args: string, cwd: string): Promise<CommandResult>;
+}
+//#endregion
 //#region src/specification/ports/server.port.d.ts
 /**
  * HTTP response returned by a server port.
@@ -129,47 +147,76 @@ interface ServerPort {
 //#endregion
 //#region src/specification/specification.d.ts
 interface SpecificationConfig {
+  command?: CommandPort;
   database?: DatabasePort;
   databases?: Map<string, DatabasePort>;
-  server: ServerPort;
+  fixturesRoot?: string;
+  server?: ServerPort;
 }
 interface RequestInfo {
+  body?: unknown;
   method: string;
   path: string;
-  body?: unknown;
 }
 declare class SpecificationResult {
-  private response;
+  private commandResult?;
   private config;
+  private requestInfo?;
+  private response?;
   private testDir;
-  private requestInfo;
-  constructor(response: ServerResponse, config: SpecificationConfig, testDir: string, requestInfo: RequestInfo);
+  private workDir?;
+  constructor(options: {
+    commandResult?: CommandResult;
+    config: SpecificationConfig;
+    requestInfo?: RequestInfo;
+    response?: ServerResponse;
+    testDir: string;
+    workDir?: string;
+  });
   expectStatus(code: number): this;
   expectResponse(file: string): this;
+  expectExitCode(code: number): this;
+  expectStdout(file: string): this;
+  expectStdoutContains(str: string): this;
+  expectStderr(file: string): this;
+  expectStderrContains(str: string): this;
   expectTable(table: string, options: {
     columns: string[];
     rows: unknown[][];
     service?: string;
   }): Promise<this>;
+  expectFile(path: string): this;
+  expectNoFile(path: string): this;
+  expectFileContains(path: string, content: string): this;
   private resolveDatabase;
+  private resolveWorkPath;
 }
 declare class SpecificationBuilder {
+  private commandArgs;
   private config;
-  private testDir;
+  private fixtures;
   private label;
-  private seeds;
   private mocks;
+  private projectName;
   private request;
+  private seeds;
+  private testDir;
   constructor(config: SpecificationConfig, testDir: string, label: string);
   seed(file: string, options?: {
     service?: string;
   }): this;
+  fixture(file: string): this;
+  project(name: string): this;
   mock(file: string): this;
   get(path: string): this;
   post(path: string, bodyFile?: string): this;
   put(path: string, bodyFile?: string): this;
   delete(path: string): this;
+  exec(args: string): this;
   run(): Promise<SpecificationResult>;
+  private prepareWorkDir;
+  private runHttpAction;
+  private runCliAction;
 }
 type SpecificationRunner = (label: string) => SpecificationBuilder;
 //#endregion
@@ -240,6 +287,17 @@ declare class RedisHandle implements ServiceHandle {
  */
 declare function redis(options?: RedisOptions): RedisHandle;
 //#endregion
+//#region src/specification/adapters/exec.adapter.d.ts
+/**
+ * Executes CLI commands via execSync.
+ * Used by cli() for local command execution.
+ */
+declare class ExecAdapter implements CommandPort {
+  private command;
+  constructor(command: string);
+  exec(args: string, cwd: string): Promise<CommandResult>;
+}
+//#endregion
 //#region src/specification/adapters/fetch.adapter.d.ts
 /**
  * Server adapter for real HTTP — sends actual fetch requests.
@@ -274,17 +332,25 @@ type HonoApp = {
   request: (path: string, init?: RequestInit) => Promise<Response> | Response;
 };
 interface IntegrationOptions {
-  /** Declared services — started via testcontainers. */
-  services: ServiceHandle[];
   /** Factory that returns a Hono app — called after services start. */
   app: () => HonoApp;
   /** Project root for compose detection (relative paths supported). */
   root?: string;
+  /** Declared services — started via testcontainers. */
+  services: ServiceHandle[];
 }
 interface E2eOptions {
   /** Project root — must contain docker/compose.test.yaml. */
   root?: string;
 }
+interface CliOptions {
+  /** CLI command to run (resolved from node_modules/.bin or PATH). */
+  command: string;
+  /** Project root — base dir for .project() fixture lookup (relative paths supported). */
+  root?: string;
+  /** Optional infrastructure services (started via testcontainers). */
+  services?: ServiceHandle[];
+}
 interface SpecificationRunnerWithCleanup extends SpecificationRunner {
   cleanup: () => Promise<void>;
   orchestrator: Orchestrator;
@@ -292,25 +358,24 @@ interface SpecificationRunnerWithCleanup extends SpecificationRunner {
 /**
  * Create an integration specification runner.
  * Starts infra containers via testcontainers, app runs in-process.
- *
- * @example
- * const db = postgres({ compose: "db" });
- * export const spec = await integration({
- *     services: [db],
- *     app: () => createApp({ databaseUrl: db.connectionString }),
- * });
  */
 declare function integration(options: IntegrationOptions): Promise<SpecificationRunnerWithCleanup>;
 /**
  * Create an E2E specification runner.
  * Starts full docker compose stack. App URL and database auto-detected.
+ */
+declare function e2e(options?: E2eOptions): Promise<SpecificationRunnerWithCleanup>;
+/**
+ * Create a CLI specification runner.
+ * Runs CLI commands against fixture projects. Optionally starts infrastructure.
  *
  * @example
- * export const spec = await e2e({
- *     root: "../fixtures/app",
+ * export const spec = await cli({
+ *     command: resolve(import.meta.dirname, "../../bin/my-cli.sh"),
+ *     root: "../fixtures",
  * });
  */
-declare function e2e(options?: E2eOptions): Promise<SpecificationRunnerWithCleanup>;
+declare function cli(options: CliOptions): Promise<SpecificationRunnerWithCleanup>;
 //#endregion
-export { type DatabasePort, FetchAdapter, HonoAdapter, type MockDatePort, type MockPort, Orchestrator, type ServerPort, type ServerResponse, e2e, integration, mockOf, mockOfDate, normalizeOutput, postgres, redis, stripAnsi };
+export { type CommandPort, type CommandResult, type DatabasePort, ExecAdapter, FetchAdapter, HonoAdapter, type MockDatePort, type MockPort, Orchestrator, type ServerPort, type ServerResponse, cli, e2e, integration, mockOf, mockOfDate, normalizeOutput, postgres, redis, stripAnsi };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -109,6 +109,24 @@ declare class Orchestrator {
   getAppUrl(): null | string;
 }
 //#endregion
+//#region src/specification/ports/command.port.d.ts
+/**
+ * Result of executing a CLI command.
+ */
+interface CommandResult {
+  exitCode: number;
+  stdout: string;
+  stderr: string;
+}
+/**
+ * Abstract CLI interface for specification runners.
+ * Implement this to plug in your command execution strategy.
+ */
+interface CommandPort {
+  /** Execute a CLI command with the given arguments in the given working directory. */
+  exec(args: string, cwd: string): Promise<CommandResult>;
+}
+//#endregion
 //#region src/specification/ports/server.port.d.ts
 /**
  * HTTP response returned by a server port.
@@ -129,47 +147,76 @@ interface ServerPort {
 //#endregion
 //#region src/specification/specification.d.ts
 interface SpecificationConfig {
+  command?: CommandPort;
   database?: DatabasePort;
   databases?: Map<string, DatabasePort>;
-  server: ServerPort;
+  fixturesRoot?: string;
+  server?: ServerPort;
 }
 interface RequestInfo {
+  body?: unknown;
   method: string;
   path: string;
-  body?: unknown;
 }
 declare class SpecificationResult {
-  private response;
+  private commandResult?;
   private config;
+  private requestInfo?;
+  private response?;
   private testDir;
-  private requestInfo;
-  constructor(response: ServerResponse, config: SpecificationConfig, testDir: string, requestInfo: RequestInfo);
+  private workDir?;
+  constructor(options: {
+    commandResult?: CommandResult;
+    config: SpecificationConfig;
+    requestInfo?: RequestInfo;
+    response?: ServerResponse;
+    testDir: string;
+    workDir?: string;
+  });
   expectStatus(code: number): this;
   expectResponse(file: string): this;
+  expectExitCode(code: number): this;
+  expectStdout(file: string): this;
+  expectStdoutContains(str: string): this;
+  expectStderr(file: string): this;
+  expectStderrContains(str: string): this;
   expectTable(table: string, options: {
     columns: string[];
     rows: unknown[][];
     service?: string;
   }): Promise<this>;
+  expectFile(path: string): this;
+  expectNoFile(path: string): this;
+  expectFileContains(path: string, content: string): this;
   private resolveDatabase;
+  private resolveWorkPath;
 }
 declare class SpecificationBuilder {
+  private commandArgs;
   private config;
-  private testDir;
+  private fixtures;
   private label;
-  private seeds;
   private mocks;
+  private projectName;
   private request;
+  private seeds;
+  private testDir;
   constructor(config: SpecificationConfig, testDir: string, label: string);
   seed(file: string, options?: {
     service?: string;
   }): this;
+  fixture(file: string): this;
+  project(name: string): this;
   mock(file: string): this;
   get(path: string): this;
   post(path: string, bodyFile?: string): this;
   put(path: string, bodyFile?: string): this;
   delete(path: string): this;
+  exec(args: string): this;
   run(): Promise<SpecificationResult>;
+  private prepareWorkDir;
+  private runHttpAction;
+  private runCliAction;
 }
 type SpecificationRunner = (label: string) => SpecificationBuilder;
 //#endregion
@@ -240,6 +287,17 @@ declare class RedisHandle implements ServiceHandle {
  */
 declare function redis(options?: RedisOptions): RedisHandle;
 //#endregion
+//#region src/specification/adapters/exec.adapter.d.ts
+/**
+ * Executes CLI commands via execSync.
+ * Used by cli() for local command execution.
+ */
+declare class ExecAdapter implements CommandPort {
+  private command;
+  constructor(command: string);
+  exec(args: string, cwd: string): Promise<CommandResult>;
+}
+//#endregion
 //#region src/specification/adapters/fetch.adapter.d.ts
 /**
  * Server adapter for real HTTP — sends actual fetch requests.
@@ -274,17 +332,25 @@ type HonoApp = {
   request: (path: string, init?: RequestInit) => Promise<Response> | Response;
 };
 interface IntegrationOptions {
-  /** Declared services — started via testcontainers. */
-  services: ServiceHandle[];
   /** Factory that returns a Hono app — called after services start. */
   app: () => HonoApp;
   /** Project root for compose detection (relative paths supported). */
   root?: string;
+  /** Declared services — started via testcontainers. */
+  services: ServiceHandle[];
 }
 interface E2eOptions {
   /** Project root — must contain docker/compose.test.yaml. */
   root?: string;
 }
+interface CliOptions {
+  /** CLI command to run (resolved from node_modules/.bin or PATH). */
+  command: string;
+  /** Project root — base dir for .project() fixture lookup (relative paths supported). */
+  root?: string;
+  /** Optional infrastructure services (started via testcontainers). */
+  services?: ServiceHandle[];
+}
 interface SpecificationRunnerWithCleanup extends SpecificationRunner {
   cleanup: () => Promise<void>;
   orchestrator: Orchestrator;
@@ -292,25 +358,24 @@ interface SpecificationRunnerWithCleanup extends SpecificationRunner {
 /**
  * Create an integration specification runner.
  * Starts infra containers via testcontainers, app runs in-process.
- *
- * @example
- * const db = postgres({ compose: "db" });
- * export const spec = await integration({
- *     services: [db],
- *     app: () => createApp({ databaseUrl: db.connectionString }),
- * });
  */
 declare function integration(options: IntegrationOptions): Promise<SpecificationRunnerWithCleanup>;
 /**
  * Create an E2E specification runner.
  * Starts full docker compose stack. App URL and database auto-detected.
+ */
+declare function e2e(options?: E2eOptions): Promise<SpecificationRunnerWithCleanup>;
+/**
+ * Create a CLI specification runner.
+ * Runs CLI commands against fixture projects. Optionally starts infrastructure.
  *
  * @example
- * export const spec = await e2e({
- *     root: "../fixtures/app",
+ * export const spec = await cli({
+ *     command: resolve(import.meta.dirname, "../../bin/my-cli.sh"),
+ *     root: "../fixtures",
  * });
  */
-declare function e2e(options?: E2eOptions): Promise<SpecificationRunnerWithCleanup>;
+declare function cli(options: CliOptions): Promise<SpecificationRunnerWithCleanup>;
 //#endregion
-export { type DatabasePort, FetchAdapter, HonoAdapter, type MockDatePort, type MockPort, Orchestrator, type ServerPort, type ServerResponse, e2e, integration, mockOf, mockOfDate, normalizeOutput, postgres, redis, stripAnsi };
+export { type CommandPort, type CommandResult, type DatabasePort, ExecAdapter, FetchAdapter, HonoAdapter, type MockDatePort, type MockPort, Orchestrator, type ServerPort, type ServerResponse, cli, e2e, integration, mockOf, mockOfDate, normalizeOutput, postgres, redis, stripAnsi };
 //# sourceMappingURL=index.d.ts.map