@norskvideo/ctl-test-harness 0.1.20 → 0.1.22

package/demo/spec.d.ts

@@ -30,14 +30,26 @@ export interface DemoSource {
     ingest: DemoIngest;
     streamId?: string;
 }
-export interface DemoContext {
+/** How the product is registered: `dev` runs `dev.command` from source and
+ *  adds it by URL; `image` adds the built `image` (the customer path). */
+export type DemoMode = "dev" | "image";
+/** Whose daemon: a `private` one on a throwaway store (the default; what
+ *  `check` always uses), or `reuse` the developer's listening daemon and its
+ *  real store — where `product add` refuses an existing name and stored
+ *  templates are immutable, so the driver deletes/removes/re-adds first. */
+export type DemoDaemonPolicy = "private" | "reuse";
+/** What `beforeLaunch` sees: the template is stored, nothing is launched. */
+export interface DemoLaunchContext {
     action: "up" | "check";
+    mode: DemoMode;
+    daemon: DemoDaemonPolicy;
     product: string;
     instanceId: string;
     daemonPort: number;
     storeDir: string;
-    /** Resolve a spec URL against this run's ports. */
-    url(ref: DemoUrl): string;
+    templateName: string;
+    /** The stored template's directory (`compose.yml`, `workflow.yml`, ...). */
+    templateDir: string;
     cli(argv: string[], opts?: {
         output?: "json" | "yaml";
     }): Promise<{
@@ -45,9 +57,13 @@ export interface DemoContext {
         stderr: string;
         exitCode: number;
     }>;
-    fetch(url: string, init?: RequestInit): Promise<Response>;
     log(line: string): void;
 }
+export interface DemoContext extends DemoLaunchContext {
+    /** Resolve a spec URL against this run's ports. */
+    url(ref: DemoUrl): string;
+    fetch(url: string, init?: RequestInit): Promise<Response>;
+}
 export type DemoReady = {
     http: DemoUrl;
     status?: number;
@@ -75,9 +91,21 @@ export type DemoTemplate = {
         input: string | Record<string, unknown>;
     };
 };
+/** A sidecar container the demo needs beside the instance (funke's ad-push
+ *  capture origin): `docker run -d --name <name> --network norsk-net <args>
+ *  <image> <command>`, started before the launch, removed at teardown. */
+export interface DemoExtra {
+    name: string;
+    image: string;
+    /** Extra `docker run` flags (`-p`, `-v`, `--entrypoint`, ...). */
+    args?: string[];
+    command?: string[];
+}
 export interface DemoSpec {
     /** Manifest name, e.g. "norsk-playout". The registration must report it. */
     product: string;
+    /** The default `--mode`; `dev` when omitted. */
+    mode?: DemoMode;
     /** Started with PORT=<driver-chosen> in the environment; the driver polls
      *  `readyPath` (default `/manifest.json`, what `product add` fetches). */
     dev: {
@@ -99,6 +127,10 @@ export interface DemoSpec {
         path: string;
         hint: string;
     }>;
+    extras?: DemoExtra[];
+    /** Runs once the template is stored and pin-checked, before the launch —
+     *  the place for a product-only patch to the stored template. */
+    beforeLaunch?: (ctx: DemoLaunchContext) => Promise<void>;
     sources?: DemoSource[];
     /** Gates polled in order once the instance runs and the sources pump — so a
      *  gate may demand what only a source produces (composing, analysing). */
@@ -106,12 +138,22 @@ export interface DemoSpec {
     /** Runs once every gate holds. */
     after?: (ctx: DemoContext) => Promise<void>;
     open?: DemoOpen[];
-    /** The standalone tier's live-source links, for `--mode standalone`. Paths
-     *  are relative to the repo root. */
+    /** The standalone tier (`dev-loop`, `check --mode standalone --export-only`):
+     *  the live-source links (paths relative to the repo root) and, for the full
+     *  tier, where the engine and Studio checkouts and the exported workdir live
+     *  (absolute or `~`-rooted; NORSK_DIR / STUDIO_DIR / TO in the environment
+     *  override them, the conventional `~/dev/...` paths apply when neither says). */
     standalone?: {
         links?: Record<string, string>;
         dashboards?: string;
         params?: Record<string, string | number>;
+        norskDir?: string;
+        studioDir?: string;
+        workdir?: string;
+        /** The template the dev-loop builds when it is not the demo's (probe:
+         *  the standalone form assumes the box's side-loads, the demo form is
+         *  portable). The export gate keeps the demo's, CI-portable. */
+        template?: DemoTemplate;
     };
 }
 export declare const DemoSpecSchema: z.ZodType<DemoSpec>;

package/demo/spec.js

@@ -38,25 +38,31 @@ const relativePath = z
     .string()
     .min(1)
     .refine((p) => !isAbsolute(p) && !p.startsWith("~"), { message: "must be a relative path inside the repo" });
+const homePath = z
+    .string()
+    .min(1)
+    .refine((p) => isAbsolute(p) || p === "~" || p.startsWith("~/"), {
+    message: "must be an absolute or ~-rooted path (a checkout outside the repo)",
+});
+const Template = z.union([
+    z.strictObject({ name: z.string().min(1) }),
+    z.strictObject({
+        build: z.strictObject({
+            name: z.string().min(1).optional(),
+            input: z.union([z.string().min(1), z.record(z.string(), z.unknown())]),
+        }),
+    }),
+]);
 export const DemoSpecSchema = z
     .strictObject({
     product: z.string().min(1),
+    mode: z.enum(["dev", "image"]).optional(),
     dev: z.strictObject({
         command: z.array(z.string().min(1)).min(1),
         readyPath: z.string().startsWith("/").optional(),
     }),
     image: z.string().min(1).optional(),
-    template: z
-        .union([
-        z.strictObject({ name: z.string().min(1) }),
-        z.strictObject({
-            build: z.strictObject({
-                name: z.string().min(1).optional(),
-                input: z.union([z.string().min(1), z.record(z.string(), z.unknown())]),
-            }),
-        }),
-    ])
-        .optional(),
+    template: Template.optional(),
     launch: z
         .strictObject({
         hardware: z.enum(["nvidia", "none"]).optional(),
@@ -65,6 +71,15 @@ export const DemoSpecSchema = z
     })
         .optional(),
     prerequisites: z.array(z.strictObject({ path: z.string().min(1), hint: z.string().min(1) })).optional(),
+    extras: z
+        .array(z.strictObject({
+        name: z.string().min(1),
+        image: z.string().min(1),
+        args: z.array(z.string()).optional(),
+        command: z.array(z.string().min(1)).optional(),
+    }))
+        .optional(),
+    beforeLaunch: fn().optional(),
     sources: z
         .array(z.strictObject({
         name: z.string().min(1),
@@ -95,6 +110,10 @@ export const DemoSpecSchema = z
         links: z.record(z.string().min(1), relativePath).optional(),
         dashboards: relativePath.optional(),
         params: Params.optional(),
+        norskDir: homePath.optional(),
+        studioDir: homePath.optional(),
+        workdir: homePath.optional(),
+        template: Template.optional(),
     })
         .optional(),
 })
@@ -106,6 +125,13 @@ export const DemoSpecSchema = z
         }
         seen.add(s.name);
     });
+    const extras = new Set();
+    (spec.extras ?? []).forEach((e, i) => {
+        if (extras.has(e.name)) {
+            ctx.addIssue({ code: "custom", path: ["extras", i, "name"], message: `duplicate extra name '${e.name}'` });
+        }
+        extras.add(e.name);
+    });
 });
 /** Format zod's issue list as one line per problem, path first. A union's
  *  failure would otherwise arrive as every branch's complaint; the rule the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-test-harness",
-  "version": "0.1.20",
+  "version": "0.1.22",
   "type": "module",
   "exports": {
     ".": {
@@ -46,12 +46,21 @@
     "./demo": {
       "types": "./demo/index.d.ts",
       "default": "./demo/index.js"
+    },
+    "./container-logs": {
+      "types": "./container-logs.d.ts",
+      "default": "./container-logs.js"
+    },
+    "./compose-advancing": {
+      "types": "./compose-advancing.d.ts",
+      "default": "./compose-advancing.js"
     }
   },
   "main": "./index.js",
   "types": "./index.d.ts",
   "bin": {
-    "ctl-demo": "./demo/cli.js"
+    "ctl-demo": "./demo/cli.js",
+    "ctl-dev-loop": "./demo/dev-loop-cli.js"
   },
   "dependencies": {
     "@norskvideo/ctl-sdk": "^0.1.0",