slicetest 0.1.0 → 0.3.0

package/dist/openapi.js

@@ -0,0 +1,337 @@
+import { readFile } from "node:fs/promises";
+import { Ajv } from "ajv";
+import { Ajv2020 } from "ajv/dist/2020.js";
+import addFormatsModule from "ajv-formats";
+import { parse } from "yaml";
+const addFormats = (addFormatsModule.default ?? addFormatsModule);
+const METHODS = ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
+/**
+ * An OpenAPI 3.0 / 3.1 document, used to check that real traffic matches it:
+ * the app's responses against the app's own spec, and the app's calls to a
+ * stubbed service (and the stub's canned replies) against that service's spec.
+ */
+export class OpenApiSpec {
+    file;
+    doc;
+    #ajv;
+    #validators = new Map();
+    #ops = [];
+    #basePaths;
+    #documentOrder = [];
+    constructor(file, doc) {
+        this.file = file;
+        this.doc = doc;
+        const v31 = String(doc.openapi ?? "").startsWith("3.1");
+        this.#ajv = v31 ? new Ajv2020({ strict: false, allErrors: true }) : new Ajv({ strict: false, allErrors: true });
+        addFormats(this.#ajv);
+        for (const f of ["int32", "int64", "float", "double", "byte", "binary", "password"])
+            this.#ajv.addFormat(f, true);
+        this.#ajv.addSchema(v31 ? doc : nullableToType(structuredClone(doc)), "spec");
+        for (const [template, item] of Object.entries(doc.paths ?? {})) {
+            for (const method of METHODS)
+                if (item[method])
+                    this.#documentOrder.push({ template, method, op: item[method] });
+        }
+        // Concrete segments before templated ones, so /polls/new wins over /polls/{id}.
+        const templates = Object.keys(doc.paths ?? {}).sort((a, b) => a.split("{").length - b.split("{").length);
+        for (const template of templates) {
+            const re = new RegExp(`^${template.split(/\{[^}]+\}/).map(escape).join("[^/]+")}/?$`);
+            for (const method of METHODS) {
+                const op = doc.paths[template][method];
+                if (op)
+                    this.#ops.push({ re, op: { template, method, op } });
+            }
+        }
+        // Paths in the spec are relative to the server URL, e.g. /v1 for https://api.example.com/v1.
+        this.#basePaths = [
+            ...new Set((doc.servers ?? [])
+                .map((s) => new URL(s.url ?? "/", "http://x").pathname.replace(/\/$/, ""))
+                .filter(Boolean)),
+        ];
+    }
+    /** `file` is read; `label` (default: `file`) is how messages refer to it. */
+    static async load(file, label = file) {
+        let doc;
+        try {
+            doc = parse(await readFile(file, "utf8"));
+        }
+        catch (e) {
+            throw new Error(`slicetest: can't read OpenAPI spec ${label}: ${e.message}`);
+        }
+        if (!doc || typeof doc !== "object" || !("openapi" in doc)) {
+            throw new Error(`slicetest: ${label} is not an OpenAPI 3 document (no "openapi" field)`);
+        }
+        return new OpenApiSpec(label, doc);
+    }
+    find(method, path) {
+        const m = method.toLowerCase();
+        for (const candidate of [path, ...this.#basePaths.filter((b) => path.startsWith(b)).map((b) => path.slice(b.length) || "/")]) {
+            const hit = this.#ops.find((o) => o.op.method === m && o.re.test(candidate));
+            if (hit)
+                return hit.op;
+        }
+        return undefined;
+    }
+    /** Problems with a response to `method path`; empty when it matches the spec. */
+    /** The documented response (`200`, `4XX`, `default`) that `status` falls under, for coverage. */
+    responseKey(method, path, status) {
+        const found = this.find(method, path);
+        if (!found)
+            return undefined;
+        const key = pickResponse(found.op.responses ?? {}, status);
+        return key && `${method.toUpperCase()} ${found.template} ${key}`;
+    }
+    /** Every documented response as `METHOD /template key`, in document order. */
+    responseKeys() {
+        return this.#documentOrder.flatMap(({ template, method, op }) => Object.keys(op.responses ?? {}).map((key) => `${method.toUpperCase()} ${template} ${key}`));
+    }
+    checkResponse(method, path, res) {
+        const found = this.find(method, path);
+        if (!found)
+            return [`${method} ${path} is not in ${this.file}`];
+        const { template, op } = found;
+        const status = String(res.status);
+        const responses = op.responses ?? {};
+        const key = pickResponse(responses, res.status ?? 0);
+        if (!key)
+            return [`${method} ${template} responded ${status}, which ${this.file} doesn't document (documented: ${Object.keys(responses).join(", ") || "none"})`];
+        const [response, at] = this.#resolve(responses[key], ["paths", template, found.method, "responses", key]);
+        return this.#checkContent(response?.content, res, [...at, "content"], `${method} ${template} → ${status}`);
+    }
+    /**
+     * A response the real service could send to `method path`: the lowest
+     * documented 2xx, with its example if the spec has one, else a value built
+     * from its schema. Undefined when the operation isn't in the spec.
+     */
+    exampleResponse(method, path) {
+        const found = this.find(method, path);
+        if (!found)
+            return undefined;
+        const responses = found.op.responses ?? {};
+        const key = Object.keys(responses)
+            .filter((k) => /^2\d\d$/.test(k))
+            .sort()[0] ?? Object.keys(responses).find((k) => /^2xx$/i.test(k));
+        if (!key)
+            return undefined;
+        const status = key.length === 3 && /^\d+$/.test(key) ? Number(key) : 200;
+        const response = this.#deref(responses[key]);
+        const content = response?.content ?? {};
+        const media = Object.keys(content).find(isJson) ?? Object.keys(content)[0];
+        if (!media)
+            return { status };
+        const m = content[media] ?? {};
+        const named = m.examples && Object.values(m.examples)[0];
+        const body = m.example !== undefined
+            ? m.example
+            : named !== undefined
+                ? (this.#deref(named)?.value ?? null)
+                : 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);
+        if (!s || typeof s !== "object" || depth > 8)
+            return null;
+        if (s.example !== undefined)
+            return s.example;
+        if (Array.isArray(s.examples) && s.examples.length)
+            return s.examples[0];
+        if (s.default !== undefined)
+            return s.default;
+        if (s.const !== undefined)
+            return s.const;
+        if (Array.isArray(s.enum) && s.enum.length)
+            return s.enum[0];
+        if (Array.isArray(s.allOf)) {
+            return Object.assign({}, ...s.allOf.map((part) => this.#sample(part, depth + 1)).filter((v) => v && typeof v === "object"));
+        }
+        const first = s.oneOf?.[0] ?? s.anyOf?.[0];
+        if (first)
+            return this.#sample(first, depth + 1);
+        const type = Array.isArray(s.type) ? s.type.find((t) => t !== "null") : s.type;
+        switch (type ?? (s.properties ? "object" : s.items ? "array" : undefined)) {
+            case "object":
+                return Object.fromEntries(Object.entries(s.properties ?? {}).map(([k, v]) => [k, this.#sample(v, depth + 1)]));
+            case "array":
+                return Array.from({ length: Math.max(1, s.minItems ?? 1) }, () => this.#sample(s.items, depth + 1));
+            case "integer":
+            case "number":
+                return typeof s.minimum === "number" ? s.minimum : typeof s.exclusiveMinimum === "number" ? s.exclusiveMinimum + 1 : 0;
+            case "boolean":
+                return true;
+            case "string":
+                return sampleString(s);
+            default:
+                return null;
+        }
+    }
+    /** Problems with a request the app sent to `method path`. */
+    checkRequest(method, path, req) {
+        const found = this.find(method, path);
+        if (!found)
+            return [`${method} ${path} is not in ${this.file}`];
+        const { template, op } = found;
+        const errors = [];
+        const params = [...(this.doc.paths[template].parameters ?? []), ...(op.parameters ?? [])].map((p) => this.#deref(p));
+        for (const p of params) {
+            if (p?.in === "query" && p.required && !req.query?.has(p.name))
+                errors.push(`${method} ${template}: required query parameter "${p.name}" is missing`);
+        }
+        const [body, at] = this.#resolve(op.requestBody, ["paths", template, found.method, "requestBody"]);
+        if (!body)
+            return errors;
+        if (req.body === "" || req.body === undefined) {
+            if (body.required)
+                errors.push(`${method} ${template}: the request body is required`);
+            return errors;
+        }
+        return [...errors, ...this.#checkContent(body.content, req, [...at, "content"], `${method} ${template} request`)];
+    }
+    #checkContent(content, msg, pointer, label) {
+        if (!content || Object.keys(content).length === 0)
+            return [];
+        const type = (msg.contentType ?? "").split(";")[0].trim().toLowerCase();
+        // Without a content-type (e.g. a stub replying with a bare string) there's nothing to hold the body to.
+        if (!type)
+            return [];
+        const media = Object.keys(content).find((k) => k.toLowerCase() === type) ??
+            Object.keys(content).find((k) => k.endsWith("/*") && type.startsWith(k.slice(0, -1))) ??
+            Object.keys(content).find((k) => k === "*/*");
+        if (!media)
+            return [`${label}: content-type "${type || "(none)"}" is not one of ${Object.keys(content).join(", ")}`];
+        if (!content[media]?.schema || !isJson(media))
+            return [];
+        if (typeof msg.body === "string")
+            return [`${label}: body is not valid JSON`];
+        const validate = this.#validator([...pointer, media, "schema"]);
+        if (validate(msg.body))
+            return [];
+        return (validate.errors ?? []).slice(0, 5).map((e) => `${label}: ${e.instancePath || "body"} ${e.message}${e.params && "additionalProperty" in e.params ? ` "${e.params.additionalProperty}"` : ""}`);
+    }
+    #validator(pointer) {
+        const ref = `spec#/${pointer.map((p) => p.replace(/~/g, "~0").replace(/\//g, "~1")).join("/")}`;
+        let v = this.#validators.get(ref);
+        if (!v) {
+            v = this.#ajv.compile({ $ref: ref });
+            this.#validators.set(ref, v);
+        }
+        return v;
+    }
+    /** Follow a local `$ref` such as `#/components/responses/NotFound`. */
+    #deref(node) {
+        return this.#resolve(node, [])[0];
+    }
+    /** The node behind any `$ref`s, and its location in the document (for compiling schemas under it). */
+    #resolve(node, at, depth = 0) {
+        if (!node || typeof node.$ref !== "string" || !node.$ref.startsWith("#/") || depth > 10)
+            return [node, at];
+        const pointer = node.$ref
+            .slice(2)
+            .split("/")
+            .map((p) => p.replace(/~1/g, "/").replace(/~0/g, "~"));
+        const target = pointer.reduce((cur, key) => cur?.[key], this.doc);
+        return this.#resolve(target, pointer, depth + 1);
+    }
+}
+const FORMATS = {
+    "date-time": "2026-01-01T00:00:00Z",
+    date: "2026-01-01",
+    time: "00:00:00Z",
+    email: "user@example.com",
+    uri: "https://example.com",
+    url: "https://example.com",
+    uuid: "00000000-0000-4000-8000-000000000000",
+    hostname: "example.com",
+    ipv4: "192.0.2.1",
+    ipv6: "2001:db8::1",
+};
+function sampleString(s) {
+    const base = (s.format && FORMATS[s.format]) ?? "string";
+    return base.length >= (s.minLength ?? 0) ? base : base.padEnd(s.minLength, "x");
+}
+function pickResponse(responses, status) {
+    const s = String(status);
+    return [s, `${s[0]}XX`, `${s[0]}xx`, "default"].find((k) => k in responses);
+}
+/**
+ * Coverage report: which documented responses the scenarios produced.
+ * `hits` are `responseKey()` values collected from every worker.
+ */
+export function formatCoverage(spec, hits) {
+    const keys = spec.responseKeys();
+    const byOp = new Map();
+    for (const k of keys) {
+        const i = k.lastIndexOf(" ");
+        const op = k.slice(0, i);
+        byOp.set(op, [...(byOp.get(op) ?? []), k.slice(i + 1)]);
+    }
+    const width = Math.max(0, ...[...byOp.keys()].map((op) => op.indexOf(" ") > -1 ? op.length - op.indexOf(" ") - 1 : 0));
+    const lines = [...byOp].map(([op, statuses]) => {
+        const i = op.indexOf(" ");
+        const marks = statuses.map((s) => `${s} ${hits.has(`${op} ${s}`) ? "✓" : "✗"}`).join("  ");
+        return `  ${op.slice(0, i).padEnd(6)} ${op.slice(i + 1).padEnd(width)}  ${marks}`;
+    });
+    const covered = keys.filter((k) => hits.has(k)).length;
+    const percent = keys.length ? Math.round((covered / keys.length) * 100) : 100;
+    return { covered, total: keys.length, percent, text: `slicetest: OpenAPI coverage (${spec.file}): ${covered}/${keys.length} documented responses (${percent}%)\n${lines.join("\n")}` };
+}
+function isJson(media) {
+    return /[/+]json$/i.test(media) || media === "*/*";
+}
+function escape(s) {
+    return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+/** OpenAPI 3.0's `nullable: true` → JSON Schema's `type: [T, "null"]`. */
+function nullableToType(node) {
+    if (Array.isArray(node))
+        return node.map(nullableToType);
+    if (!node || typeof node !== "object")
+        return node;
+    for (const [k, v] of Object.entries(node))
+        node[k] = nullableToType(v);
+    if (node.nullable === true) {
+        if (node.enum && !node.enum.includes(null))
+            node.enum = [...node.enum, null];
+        if (typeof node.type === "string")
+            node.type = [node.type, "null"];
+        else if (!node.type) {
+            const inner = { ...node };
+            delete inner.nullable;
+            return { anyOf: [inner, { type: "null" }] };
+        }
+    }
+    return node;
+}

package/dist/provided.d.ts

@@ -6,6 +6,8 @@ declare module "vitest" {
             adminUrl: string;
             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,34 +1,53 @@
 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;
     stub: (name: string) => Stub;
     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 {
     #private;
     app: App;
+    readonly services: Map<string, App>;
     readonly db: Db;
     readonly stubs: Map<string, Stub>;
     private readonly opts;
     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: {
         adminUrl: string;
         template: string;
         prefix: string;
+        coverageDir?: string;
+        recordDir?: string;
     }): Promise<Runtime>;
     context(): ScenarioContext;
     beforeScenario(): Promise<void>;
     /** Failures that the scenario body can't see on its own. */
     afterScenario(): Promise<void>;
     /** What happened during the current scenario, printed when it fails. */
-    diagnostics(): string;
+    diagnostics(): Promise<string>;
     stop(): Promise<void>;
 }