slicetest 0.2.0 → 0.3.0

package/dist/openapi.js

@@ -128,6 +128,38 @@ export class OpenApiSpec {
                 : this.#sample(m.schema);
         return { status, headers: { "content-type": media === "*/*" ? "application/json" : media }, body: isJson(media) ? body : String(body ?? "") };
     }
+    /**
+     * Every operation with what it takes to call it: sample values for its
+     * required path and query parameters and for its JSON request body, and the
+     * properties of its first 2xx JSON response. Used by `slicetest gen`.
+     */
+    operations() {
+        return this.#documentOrder.map(({ template, method, op }) => {
+            const params = [...(this.doc.paths[template].parameters ?? []), ...(op.parameters ?? [])].map((p) => this.#deref(p)).filter(Boolean);
+            const sample = (p) => (p.example !== undefined ? p.example : p.schema ? this.#sample(p.schema) : "1");
+            const pathParams = Object.fromEntries(params.filter((p) => p.in === "path").map((p) => [p.name, sample(p)]));
+            const query = Object.fromEntries(params.filter((p) => p.in === "query" && p.required).map((p) => [p.name, sample(p)]));
+            const body = this.#deref(op.requestBody);
+            const media = body?.content && Object.keys(body.content).find(isJson);
+            const m = media ? body.content[media] : undefined;
+            const json = m ? (m.example !== undefined ? m.example : this.#sample(m.schema)) : undefined;
+            const responses = Object.keys(op.responses ?? {});
+            const ok = responses.filter((k) => /^2/.test(k)).sort()[0];
+            const okContent = ok ? this.#deref(op.responses[ok])?.content : undefined;
+            const okMedia = okContent && Object.keys(okContent).find(isJson);
+            const okSchema = okMedia ? this.#deref(okContent[okMedia]?.schema) : undefined;
+            return {
+                method: method.toUpperCase(),
+                template,
+                summary: op.summary ?? op.operationId,
+                pathParams,
+                query,
+                json: json ?? undefined,
+                responses,
+                createdFields: okSchema?.properties ? Object.keys(okSchema.properties) : [],
+            };
+        });
+    }
     /** A value that satisfies `schema` (as far as a simple walk can): examples, defaults, enums, then types. */
     #sample(schema, depth = 0) {
         const s = this.#deref(schema);

package/dist/provided.d.ts

@@ -7,6 +7,7 @@ declare module "vitest" {
             template: string;
             prefix: string;
             coverageDir?: string;
+            recordDir?: string;
         };
     }
 }

package/dist/recording.d.ts

@@ -0,0 +1,43 @@
+import type { RecordedCall, StubResponse } from "./stub.js";
+/** One recorded exchange with the real service, as stored in the recordings file. */
+export interface Recording {
+    request: {
+        method: string;
+        path: string;
+        query?: Record<string, string>;
+        json?: unknown;
+        body?: string;
+    };
+    response: {
+        status: number;
+        headers?: Record<string, string>;
+        json?: unknown;
+        body?: string;
+    };
+}
+/**
+ * Replays recorded exchanges for calls no route matches and, in record mode,
+ * forwards the calls it has no recording for to the real service and records
+ * the answer. Identical requests replay their recordings in order within a
+ * scenario; the last one repeats.
+ */
+export declare class Recorder {
+    #private;
+    readonly name: string;
+    readonly file: string;
+    readonly upstream: string;
+    readonly recording: boolean;
+    private constructor();
+    static load(name: string, file: string, upstream: string, recording: boolean): Promise<Recorder>;
+    /** What recording a call gets, or undefined to leave it unanswered. */
+    answer(call: RecordedCall): Promise<StubResponse | undefined>;
+    /** Why a call went unanswered, for the stub's 501 reply. */
+    hint(): string;
+    /** Start of a scenario: identical requests replay from their first recording again. */
+    reset(): void;
+    /** Recordings made by this worker, to be merged into the file when the run ends. */
+    added(): Recording[];
+}
+export declare function readRecordings(file: string): Promise<Recording[]>;
+/** Append new recordings to `file`, skipping exact duplicates, keeping the order they were made in. */
+export declare function mergeRecordings(file: string, upstream: string, added: Recording[]): Promise<void>;

package/dist/recording.js

@@ -0,0 +1,148 @@
+import { readFile, writeFile, mkdir } from "node:fs/promises";
+import path from "node:path";
+import { isDeepStrictEqual } from "node:util";
+import YAML from "yaml";
+/**
+ * Response headers worth keeping. Everything else (dates, cookies, rate-limit
+ * counters, request ids) is noise in a committed file, or a secret.
+ */
+const KEPT_HEADERS = ["content-type", "location", "retry-after", "link", "etag"];
+/** Request headers not forwarded to the real service. */
+const HOP_HEADERS = ["host", "connection", "content-length", "accept-encoding", "transfer-encoding", "keep-alive"];
+/**
+ * Replays recorded exchanges for calls no route matches and, in record mode,
+ * forwards the calls it has no recording for to the real service and records
+ * the answer. Identical requests replay their recordings in order within a
+ * scenario; the last one repeats.
+ */
+export class Recorder {
+    name;
+    file;
+    upstream;
+    recording;
+    #entries;
+    #added = [];
+    #seen = new Map();
+    constructor(name, file, upstream, recording, entries) {
+        this.name = name;
+        this.file = file;
+        this.upstream = upstream;
+        this.recording = recording;
+        this.#entries = entries;
+    }
+    static async load(name, file, upstream, recording) {
+        return new Recorder(name, file, upstream, recording, await readRecordings(file));
+    }
+    /** What recording a call gets, or undefined to leave it unanswered. */
+    async answer(call) {
+        const request = requestOf(call);
+        const key = keyOf(request);
+        const matches = this.#entries.filter((e) => keyOf(e.request) === key);
+        const n = this.#seen.get(key) ?? 0;
+        this.#seen.set(key, n + 1);
+        if (matches.length > 0 && (!this.recording || n < matches.length))
+            return toResponse(matches[Math.min(n, matches.length - 1)]);
+        if (!this.recording)
+            return undefined;
+        const entry = { request, response: await this.#forward(call) };
+        this.#entries.push(entry);
+        this.#added.push(entry);
+        return toResponse(entry);
+    }
+    /** Why a call went unanswered, for the stub's 501 reply. */
+    hint() {
+        return `no recording in ${this.file} either; run with SLICETEST_RECORD=${this.name} to record it from ${this.upstream}`;
+    }
+    /** Start of a scenario: identical requests replay from their first recording again. */
+    reset() {
+        this.#seen.clear();
+    }
+    /** Recordings made by this worker, to be merged into the file when the run ends. */
+    added() {
+        return this.#added;
+    }
+    async #forward(call) {
+        const url = new URL(this.upstream);
+        // Keep a path prefix on the upstream (e.g. https://api.example.com/v2) in front of the call's path.
+        url.pathname = url.pathname.replace(/\/$/, "") + call.path;
+        url.search = call.query.toString();
+        const headers = new Headers();
+        for (const [k, v] of Object.entries(call.headers)) {
+            if (v !== undefined && !HOP_HEADERS.includes(k))
+                headers.set(k, Array.isArray(v) ? v.join(", ") : v);
+        }
+        let res;
+        try {
+            res = await fetch(url, { method: call.method, headers, body: ["GET", "HEAD"].includes(call.method) ? undefined : call.body });
+        }
+        catch (e) {
+            throw new Error(`slicetest: recording stub ${this.name}: ${call.method} ${url} failed: ${e.message}`);
+        }
+        const text = await res.text();
+        const kept = Object.fromEntries(KEPT_HEADERS.flatMap((h) => (res.headers.has(h) ? [[h, res.headers.get(h)]] : [])));
+        const json = parse(text);
+        return {
+            status: res.status,
+            ...(Object.keys(kept).length ? { headers: kept } : {}),
+            ...(json !== undefined ? { json } : text ? { body: text } : {}),
+        };
+    }
+}
+function requestOf(call) {
+    const query = Object.fromEntries([...call.query.entries()].sort(([a], [b]) => a.localeCompare(b)));
+    return {
+        method: call.method,
+        path: call.path,
+        ...(Object.keys(query).length ? { query } : {}),
+        ...(call.json !== undefined ? { json: call.json } : call.body ? { body: call.body } : {}),
+    };
+}
+function keyOf(r) {
+    return JSON.stringify([r.method.toUpperCase(), r.path, sortKeys(r.query ?? {}), sortKeys(r.json ?? null), r.body ?? ""]);
+}
+function sortKeys(v) {
+    if (Array.isArray(v))
+        return v.map(sortKeys);
+    if (v && typeof v === "object")
+        return Object.fromEntries(Object.entries(v).sort(([a], [b]) => a.localeCompare(b)).map(([k, x]) => [k, sortKeys(x)]));
+    return v;
+}
+function toResponse(e) {
+    return { status: e.response.status, headers: e.response.headers, body: e.response.json !== undefined ? e.response.json : (e.response.body ?? "") };
+}
+function parse(text) {
+    if (!text)
+        return undefined;
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return undefined;
+    }
+}
+export async function readRecordings(file) {
+    let text;
+    try {
+        text = await readFile(file, "utf8");
+    }
+    catch {
+        return [];
+    }
+    const doc = YAML.parse(text);
+    if (doc == null)
+        return [];
+    if (!Array.isArray(doc) || !doc.every((e) => e?.request?.method && e?.request?.path && typeof e?.response?.status === "number")) {
+        throw new Error(`slicetest: ${file} is not a recordings file: expected a list of { request: { method, path }, response: { status } }`);
+    }
+    return doc;
+}
+/** Append new recordings to `file`, skipping exact duplicates, keeping the order they were made in. */
+export async function mergeRecordings(file, upstream, added) {
+    const entries = await readRecordings(file);
+    for (const e of added)
+        if (!entries.some((x) => isDeepStrictEqual(x, e)))
+            entries.push(e);
+    await mkdir(path.dirname(file), { recursive: true });
+    const header = `# Recorded by slicetest from ${upstream}. Review before committing: request bodies are stored as sent.\n`;
+    await writeFile(file, header + YAML.stringify(entries, { lineWidth: 0 }));
+}

package/dist/runtime.d.ts

@@ -1,8 +1,10 @@
 import { App } from "./app.js";
 import type { ResolvedOptions } from "./config.js";
+import { Dependency } from "./containers.js";
 import { Db } from "./db.js";
 import { HttpClient } from "./http.js";
 import { Stub } from "./stub.js";
+import { type MaskOptions, type Trace } from "./trace.js";
 export interface ScenarioContext {
     http: HttpClient;
     db: Db;
@@ -10,6 +12,13 @@ export interface ScenarioContext {
     app: App;
     /** A process from the `services` option: its `url`, `logs()` and `waitForLog()`. */
     service: (name: string) => App;
+    /** A container from the `containers` option: its `host`, `port`, `address` and `exec()`. */
+    container: (name: string) => Dependency;
+    /**
+     * What the scenario did so far: requests to the app, calls to stubs and database changes,
+     * with timestamps and UUIDs masked. `expect(await trace()).toMatchSnapshot()`.
+     */
+    trace: (opts?: MaskOptions) => Promise<Trace>;
 }
 /** Everything one test file needs: its own database, stub servers and app process. */
 export declare class Runtime {
@@ -22,6 +31,9 @@ export declare class Runtime {
     private readonly vars;
     private readonly specs;
     private readonly coverageDir?;
+    private readonly recorders;
+    private readonly recordDir?;
+    readonly containers: Map<string, Dependency>;
     private constructor();
     get http(): HttpClient;
     static start(opts: ResolvedOptions, shared: {
@@ -29,6 +41,7 @@ export declare class Runtime {
         template: string;
         prefix: string;
         coverageDir?: string;
+        recordDir?: string;
     }): Promise<Runtime>;
     context(): ScenarioContext;
     beforeScenario(): Promise<void>;

package/dist/runtime.js

@@ -2,11 +2,14 @@ import { randomUUID } from "node:crypto";
 import { writeFile } from "node:fs/promises";
 import path from "node:path";
 import { App } from "./app.js";
+import { Dependency } from "./containers.js";
 import { Db, formatChanges } from "./db.js";
 import { engineFor } from "./drivers/index.js";
 import { formatHistory, HttpClient } from "./http.js";
 import { OpenApiSpec } from "./openapi.js";
+import { Recorder } from "./recording.js";
 import { Stub } from "./stub.js";
+import { buildTrace, mask } from "./trace.js";
 /** Everything one test file needs: its own database, stub servers and app process. */
 export class Runtime {
     app;
@@ -17,12 +20,15 @@ export class Runtime {
     vars;
     specs;
     coverageDir;
+    recorders;
+    recordDir;
+    containers;
     #http;
     /** Responses from the app that don't match its OpenAPI spec, this scenario. */
     #contract = [];
     /** Documented responses seen in this file, for the run's coverage report. */
     #covered = new Set();
-    constructor(app, services, db, stubs, opts, vars, specs, coverageDir) {
+    constructor(app, services, db, stubs, opts, vars, specs, coverageDir, recorders = new Map(), recordDir, containers = new Map()) {
         this.app = app;
         this.services = services;
         this.db = db;
@@ -31,6 +37,9 @@ export class Runtime {
         this.vars = vars;
         this.specs = specs;
         this.coverageDir = coverageDir;
+        this.recorders = recorders;
+        this.recordDir = recordDir;
+        this.containers = containers;
         this.#http = this.#client();
     }
     #client() {
@@ -56,9 +65,11 @@ export class Runtime {
         return this.#http;
     }
     static async start(opts, shared) {
-        const engine = engineFor(opts);
+        const engine = await engineFor(opts);
         const url = await ensureWorkerDatabase(engine, shared.adminUrl, shared.template, shared.prefix);
         const stubs = new Map();
+        const recorders = new Map();
+        const containers = new Map();
         const services = new Map();
         let db;
         try {
@@ -71,16 +82,31 @@ export class Runtime {
                 specs.stubs.set(name, await OpenApiSpec.load(path.resolve(opts.root, file), file));
             for (const name of opts.stubs)
                 stubs.set(name, await Stub.start(name));
-            for (const name of opts.openapi.autoReply) {
-                const spec = specs.stubs.get(name);
-                stubs.get(name).fallback((call) => spec.exampleResponse(call.method, call.path));
+            for (const [name, r] of Object.entries(opts.recordings))
+                recorders.set(name, await Recorder.load(name, path.resolve(opts.root, r.file), r.upstream, r.record));
+            // A registered route wins, then a recording of the real service, then an answer made up from its spec.
+            for (const [name, stub] of stubs) {
+                const recorder = recorders.get(name);
+                const spec = opts.openapi.autoReply.includes(name) ? specs.stubs.get(name) : undefined;
+                if (!recorder && !spec)
+                    continue;
+                stub.fallback(async (call) => (await recorder?.answer(call)) ?? spec?.exampleResponse(call.method, call.path), recorder?.hint());
             }
             db = await Db.connect(await engine.driver(url), url, {
                 schemas: opts.db.schemas,
                 keep: opts.db.keep,
                 seedFile: opts.db.seed && path.resolve(opts.root, opts.db.seed),
             });
+            const started = await Promise.allSettled(Object.entries(opts.containers).map(async ([name, c]) => containers.set(name, await Dependency.start(name, c))));
+            const failed = started.find((r) => r.status === "rejected");
+            if (failed)
+                throw failed.reason;
             const vars = { "db.url": url };
+            for (const [name, c] of containers) {
+                vars[`container.${name}`] = c.address;
+                vars[`container.${name}.host`] = c.host;
+                vars[`container.${name}.port`] = String(c.port);
+            }
             for (const [name, stub] of stubs)
                 vars[`stub.${name}`] = stub.url;
             for (const [name, service] of Object.entries(opts.services)) {
@@ -90,12 +116,13 @@ export class Runtime {
                 vars[`service.${name}.port`] = String(started.port);
             }
             const app = await App.start(opts.app, opts.root, vars);
-            return new Runtime(app, services, db, stubs, opts, vars, specs, shared.coverageDir);
+            return new Runtime(app, services, db, stubs, opts, vars, specs, shared.coverageDir, recorders, shared.recordDir, containers);
         }
         catch (e) {
             await Promise.all([...services.values()].map((s) => s.stop()));
             await db?.close();
             await Promise.all([...stubs.values()].map((s) => s.close()));
+            await Promise.allSettled([...containers.values()].map((c) => c.stop()));
             throw e;
         }
     }
@@ -118,6 +145,13 @@ export class Runtime {
                 }
                 return service;
             },
+            container: (name) => {
+                const c = this.containers.get(name);
+                if (!c)
+                    throw new Error(`slicetest: unknown container "${name}". Declared containers: ${[...this.containers.keys()].join(", ") || "(none)"}`);
+                return c;
+            },
+            trace: async (opts) => mask(buildTrace(this.http.history, this.stubs.values(), await this.db.changesSinceStart()), opts),
         };
     }
     /** The app and every service, for checks that apply to all of them. */
@@ -141,6 +175,9 @@ export class Runtime {
         await this.db.reset();
         for (const stub of this.stubs.values())
             stub.reset();
+        for (const recorder of this.recorders.values())
+            recorder.reset();
+        await Promise.all([...this.containers.values()].map((c) => c.reset()));
         this.http.reset();
         for (const p of this.#processes())
             p.beginScenario();
@@ -195,6 +232,7 @@ export class Runtime {
             return [
                 ...calls.map((c) => `  ${s.name}: ${c.method} ${c.path}${c.query.size ? `?${c.query}` : ""}`),
                 `    registered on ${s.name}: ${routes.length ? routes.join(", ") : "(none)"}`,
+                ...(this.recorders.has(s.name) ? [`    ${this.recorders.get(s.name).hint()}`] : []),
             ];
         });
     }
@@ -233,11 +271,17 @@ export class Runtime {
         if (this.coverageDir && this.#covered.size > 0) {
             await writeFile(path.join(this.coverageDir, `${process.pid}-${randomUUID()}.json`), JSON.stringify([...this.#covered])).catch(() => { });
         }
+        for (const [name, recorder] of this.recorders) {
+            if (this.recordDir && recorder.added().length > 0) {
+                await writeFile(path.join(this.recordDir, `${name}.${process.pid}-${randomUUID()}.json`), JSON.stringify(recorder.added())).catch(() => { });
+            }
+        }
         const results = await Promise.allSettled([
             this.app.stop(),
             ...[...this.services.values()].map((s) => s.stop()),
             this.db.close(),
             ...[...this.stubs.values()].map((s) => s.close()),
+            ...[...this.containers.values()].map((c) => c.stop()),
         ]);
         const failed = results.find((r) => r.status === "rejected");
         if (failed)

package/dist/stub.d.ts

@@ -81,7 +81,7 @@ export declare class Stub {
      * Return undefined to leave a call unanswered (it then fails the scenario as usual).
      * Kept across scenarios, unlike routes.
      */
-    fallback(respond: ((call: RecordedCall) => StubResponse | undefined) | undefined): this;
+    fallback(respond: ((call: RecordedCall) => StubResponse | undefined | Promise<StubResponse | undefined>) | undefined, hint?: string): this;
     close(): Promise<void>;
 }
 /** `expected` is contained in `actual`: objects compare key by key, arrays element-wise. */

package/dist/stub.js

@@ -10,6 +10,8 @@ export class Stub {
     #routes = [];
     #calls = [];
     #fallback;
+    /** Appended to the 501 answer for a call nothing could answer. */
+    #hint;
     url = "";
     constructor(name) {
         this.name = name;
@@ -86,8 +88,9 @@ export class Stub {
      * Return undefined to leave a call unanswered (it then fails the scenario as usual).
      * Kept across scenarios, unlike routes.
      */
-    fallback(respond) {
+    fallback(respond, hint) {
         this.#fallback = respond;
+        this.#hint = hint;
         return this;
     }
     async close() {
@@ -125,9 +128,17 @@ export class Stub {
             break;
         }
         if (!route) {
-            const out = this.#fallback?.(call);
+            let out;
+            try {
+                out = await this.#fallback?.(call);
+            }
+            catch (e) {
+                res.writeHead(502, { "content-type": "text/plain" }).end(e.message);
+                return;
+            }
             if (!out) {
-                res.writeHead(501, { "content-type": "text/plain" }).end(`slicetest: no stub for ${call.method} ${call.path}`);
+                const hint = this.#hint ? ` (${this.#hint})` : "";
+                res.writeHead(501, { "content-type": "text/plain" }).end(`slicetest: no stub for ${call.method} ${call.path}${hint}`);
                 return;
             }
             call.matched = true;

package/dist/trace.d.ts

@@ -0,0 +1,35 @@
+import type { Changes } from "./db.js";
+import type { HttpResponse } from "./http.js";
+import type { Stub } from "./stub.js";
+/**
+ * Everything one scenario did at the three boundaries: the requests it made to
+ * the app, the calls the app made to stubs, and the rows it changed. Meant for
+ * `expect(await trace()).toMatchSnapshot()`: resets make ids deterministic,
+ * and `mask` replaces the values that aren't (timestamps, UUIDs).
+ */
+export interface Trace {
+    http: {
+        request: string;
+        status: number;
+        body?: unknown;
+    }[];
+    stubs: Record<string, {
+        request: string;
+        body?: unknown;
+        status?: number;
+    }[]>;
+    db: Changes;
+}
+export interface MaskOptions {
+    /** Keys whose values are always replaced, e.g. `["token", "password_hash"]`. Matched at any depth. */
+    keys?: string[];
+    /** Also mask strings matching these patterns, e.g. `[/^tok_\w+$/]`. */
+    patterns?: RegExp[];
+}
+/**
+ * A copy of `value` with the parts that change from run to run replaced by
+ * placeholders: dates (`Date` objects and ISO strings) by `[date]`, UUIDs by
+ * `[uuid]`, and the values of `keys` / strings matching `patterns` by `[masked]`.
+ */
+export declare function mask<T>(value: T, opts?: MaskOptions): T;
+export declare function buildTrace(history: readonly HttpResponse[], stubs: Iterable<Stub>, db: Changes): Trace;

package/dist/trace.js

@@ -0,0 +1,57 @@
+const ISO_DATE = /^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}(:\d{2}(\.\d+)?)?(Z|[+-]\d{2}:?\d{2})?)?$/;
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+/**
+ * A copy of `value` with the parts that change from run to run replaced by
+ * placeholders: dates (`Date` objects and ISO strings) by `[date]`, UUIDs by
+ * `[uuid]`, and the values of `keys` / strings matching `patterns` by `[masked]`.
+ */
+export function mask(value, opts = {}) {
+    const keys = new Set(opts.keys ?? []);
+    const walk = (v) => {
+        if (v instanceof Date)
+            return "[date]";
+        if (typeof v === "bigint")
+            return v.toString();
+        if (typeof v === "string") {
+            if (UUID.test(v))
+                return "[uuid]";
+            if (ISO_DATE.test(v))
+                return "[date]";
+            if (opts.patterns?.some((p) => ((p.lastIndex = 0), p.test(v))))
+                return "[masked]";
+            return v;
+        }
+        if (Array.isArray(v))
+            return v.map(walk);
+        if (v && typeof v === "object") {
+            return Object.fromEntries(Object.entries(v).map(([k, x]) => [k, keys.has(k) && x != null ? "[masked]" : walk(x)]));
+        }
+        return v;
+    };
+    return walk(value);
+}
+export function buildTrace(history, stubs, db) {
+    const trace = {
+        http: history.map((r) => {
+            const url = new URL(r.url, "http://app");
+            const body = r.json !== undefined ? r.json : r.text || undefined;
+            return { request: `${r.method} ${url.pathname}${url.search}`, status: r.status, ...(body !== undefined ? { body } : {}) };
+        }),
+        stubs: {},
+        db,
+    };
+    for (const stub of stubs) {
+        const calls = stub.calls();
+        if (calls.length === 0)
+            continue;
+        trace.stubs[stub.name] = calls.map((c) => {
+            const body = c.json !== undefined ? c.json : c.body || undefined;
+            return {
+                request: `${c.method} ${c.path}${c.query.size ? `?${c.query}` : ""}`,
+                ...(body !== undefined ? { body } : {}),
+                ...(c.response ? { status: c.response.status } : {}),
+            };
+        });
+    }
+    return trace;
+}

package/dist/yaml-runtime.js

@@ -45,6 +45,8 @@ function describeStep(step) {
         return "changes";
     if ("checkpoint" in step)
         return "checkpoint";
+    if ("snapshot" in step)
+        return "snapshot";
     if ("log" in step)
         return `log ${step.from ? `from ${step.from} ` : ""}/${step.log}/`;
     return "sql";
@@ -73,6 +75,10 @@ async function runStep(step, ctx, vars) {
         await ctx.db.checkpoint();
         return;
     }
+    if ("snapshot" in step) {
+        expect(await ctx.trace({ keys: step.mask })).toMatchSnapshot();
+        return;
+    }
     if ("log" in step) {
         const target = step.from ? ctx.service(step.from) : ctx.app;
         await target.waitForLog(new RegExp(interpolate(step.log, vars)), step.within ?? 5000);

package/dist/yaml.d.ts

@@ -19,7 +19,7 @@ export interface YamlScenario {
     timeout?: number;
     steps: Step[];
 }
-export type Step = (StubStep | RequestStep | InsertStep | SqlStep | DbStep | ReceivedStep | ChangesStep | CheckpointStep | LogStep) & {
+export type Step = (StubStep | RequestStep | InsertStep | SqlStep | DbStep | ReceivedStep | ChangesStep | CheckpointStep | LogStep | SnapshotStep) & {
     line: number;
     name?: string;
 };
@@ -123,6 +123,12 @@ export interface LogStep {
 export interface CheckpointStep {
     checkpoint: true;
 }
+/** Compare the scenario's trace (requests, stub calls, database changes) with its stored snapshot. */
+export interface SnapshotStep {
+    snapshot: true;
+    /** Keys whose values are masked in addition to dates and UUIDs. */
+    mask?: string[];
+}
 export declare class YamlScenarioError extends Error {
 }
 export declare function parseScenarioFile(text: string, file: string): YamlFile;

package/dist/yaml.js

@@ -9,6 +9,7 @@ const KINDS = {
     changes: ["within"],
     log: ["from", "within"],
     checkpoint: [],
+    snapshot: ["mask"],
 };
 const EXPECT_KEYS = {
     request: ["status", "headers", "json", "text"],
@@ -111,6 +112,12 @@ function parseStep(node, fail, lineOf) {
         if (raw.checkpoint !== true)
             fail(at(kind), "use `checkpoint: true`");
     }
+    else if (kind === "snapshot") {
+        if (raw.snapshot !== true)
+            fail(at(kind), "use `snapshot: true`");
+        if (raw.mask !== undefined && !(Array.isArray(raw.mask) && raw.mask.every((k) => typeof k === "string")))
+            fail(at("mask"), "`mask:` must be a list of keys, e.g. [token]");
+    }
     else if (typeof raw[kind] !== "string" || !raw[kind])
         fail(at(kind), `\`${kind}:\` must be a non-empty string`);
     const keysOf = (key, allowedKeys) => {