IF Commons GitHub

attestation/plan

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0001-quality-evidence FR-042

Pre-registered test plans (commons 0001-quality-evidence FR-042): a plan names its cases and what makes each pass, is kept on the quality branch (in a commit that Git signs where it is set to sign) BEFORE the run it governs, and the run records the plan's hash. A run that did not follow its plan is a finding: it names a plan the branch does not hold, the plan was registered after the run, a case ran that the plan does not hold, or a planned case did not run (which the run must report as not_run, with its reason).

The plan's hash is the SHA-256 of its canonical JSON (RFC 8785), so that the same plan is the same hash on every host. The order of two records is the order of the commits that keep them: PlanRegistration.order and PlanRun.order are the positions of those commits on the branch, which the host layer reads from Git; nothing here reads a clock.

import { planHash } from "./plan.ts";
// const hash = await planHash({ title: "release", cases: [{ name: "a", requirements: ["0001-quality-evidence FR-013"], acceptance: "passes" }] });

Source: commons/quality/src/attestation/plan.ts

5 of 13 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

PLAN_ATTRconst
const PLAN_ATTR: "ifc.quality.plan.sha256"

The resource attribute a run carries to name the plan that governs it: the SHA-256 of the plan (FR-042).

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

planHashfunction
function planHash(plan: ObjectOf<{ title: Decoder<string>; cases: Decoder<readonly ObjectOf<{ name: Decoder<string>; requirements: Decoder<readonly Brand<string, "RequirementId">[]>; acceptance: Decoder<string>; }, { file: Decoder<string>; }>[]>; }, Record<never, never>>): Promise<Result<Sha256, string>>

The hash of a plan: the SHA-256 of its canonical JSON.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

readPlanfunction
function readPlan(text: string): Result<ObjectOf<{ title: Decoder<string>; cases: Decoder<readonly ObjectOf<{ name: Decoder<string>; requirements: Decoder<readonly Brand<string, "RequirementId">[]>; acceptance: Decoder<string>; }, { file: Decoder<string>; }>[]>; }, Record<never, never>>, string>

A plan read from the file a person committed (ifqs-plan/1: a title and its cases), or why it is not one.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

planOfRecordfunctionno test imports it
function planOfRecord(text: string): string | undefined

The plan a run's record names, where it names one: the resource attribute ifc.quality.plan.sha256.

planEventfunctionno test imports it
function planEvent(events: readonly (import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind… (35441 characters)
function planEvent(events: readonly (import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"plan-registered">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; plan: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ title: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; cases: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; requirements: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">[]>; acceptance: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { file: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>[]>; }, Record<never, never>>>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"sample-drawn">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; subject: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent-reviews" | "records" | "runs">; rule: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"hash-ranked/1">; seed: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; population: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ count: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; sha256: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "Sha256">>; }, Record<never, never>>>; size: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; items: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly string[]>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { ratePermille: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"sample-attested">; sample: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; results: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ item: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; verdict: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"fail" | "pass">; }, { note: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>[]>; person: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, {}> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"mutation-run">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; tool: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { version: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; results: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; mutants: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; killed: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; survived: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }, { timeout: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; noCoverage: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; equivalent: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }>[]>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-opened">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; cause: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"budget-spent" | "failed" | "probe-failed" | "stale">; reason: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; evidence: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{}, { traceId: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; path: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; openedBy: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"system">; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent">; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"role">; role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, {}> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-linked">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; problem: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ number: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }, { repo: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-opened">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; nonconformance: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; action: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; test: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Record<never, never>>>; correctiveRevision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; openedBy: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"system">; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent">; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"role">; role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { author: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-verified">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; traceId: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-closed">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; decision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; person: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-closed">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; capa: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"statement">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent" | "person">; who: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { note: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"review">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent" | "person">; who: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { sample: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<boolean>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"probe">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; outcome: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"fail" | "pass">; source: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>)[], plan: ObjectOf<{ title: Decoder<string>; cases: Decoder<readonly ObjectOf<{ name: Decoder<string>; requirements: Decoder<readonly Brand<string, "RequirementId">[]>; acceptance: Decoder<string>; }, { file: Decoder<string>; }>[]>; }, Record<never, never>>, by: ObjectOf<{ name: Decoder<string>; }, { role: Decoder<string>; }>, day: string): Result<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"plan-registered">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; plan: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ title: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; cases: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; requirements: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">[]>; acceptance: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { file: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>[]>; }, Record<never, never>>>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"sample-drawn">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; subject: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent-reviews" | "records" | "runs">; rule: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"hash-ranked/1">; seed: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; population: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ count: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; sha256: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "Sha256">>; }, Record<never, never>>>; size: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; items: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly string[]>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { ratePermille: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"sample-attested">; sample: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; results: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ item: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; verdict: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"fail" | "pass">; }, { note: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>[]>; person: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, {}> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"mutation-run">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; tool: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, { version: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; results: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<readonly import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; mutants: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; killed: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; survived: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }, { timeout: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; noCoverage: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; equivalent: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }>[]>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Record<never, never>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-opened">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; cause: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"budget-spent" | "failed" | "probe-failed" | "stale">; reason: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; evidence: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{}, { traceId: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; path: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; openedBy: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"system">; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent">; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"role">; role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, {}> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-linked">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; problem: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ number: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<number>; }, { repo: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-opened">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; nonconformance: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; action: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; test: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Record<never, never>>>; correctiveRevision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; openedBy: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"system">; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent">; name: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"role">; role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { author: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-verified">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; traceId: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; revision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"capa-closed">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; decision: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; person: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { role: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }>>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"nonconformance-closed">; id: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; capa: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"statement">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent" | "person">; who: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { note: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"review">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; by: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"agent" | "person">; who: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, { sample: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<boolean>; }> | import("/home/runner/work/.github/.github/commons/core/src/decode").ObjectOf<{ kind: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"probe">; requirement: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/core/src/brand").Brand<string, "RequirementId">>; outcome: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<"fail" | "pass">; source: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<string>; day: import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<import("/home/runner/work/.github/.github/commons/quality/src/pure/time").Day>; }, Readonly<Record<string, import("/home/runner/work/.github/.github/commons/core/src/decode").Decoder<unknown>>>>, string>

The event that registers a plan, with the next identifier; refused where it does not follow the ledger (FR-042).

PlanRegistrationtypeno test imports it
type PlanRegistration = {
  readonly id: string;
  readonly sha256: Sha256;
  readonly plan: TestPlan;
  readonly order: number;
  readonly signed: boolean;
};

A plan as the branch holds it: its hash, where its commit stands on the branch and whether that commit is signed.

registrationsfunctionno test imports it
function registrations(a: Assurance, commits: ReadonlyMap<number, { readonly order: number; readonly signed: boolean; }>): Promise<Result<readonly PlanRegistration[], string>>

The registrations of an assurance's plans, hashed; order and signed are what the host read of each plan's commit.

PlanRuntypeno test imports it
type PlanRun = {
  readonly traceId: string;
  readonly plan?: string;
  readonly order: number;
  readonly cases: readonly { readonly name: string; readonly outcome: string }[];
};

A run as the plan's judgement reads it: the plan it names, where its commit stands on the branch and its cases.

PlanFindingtypeno test imports it
type PlanFinding = | { readonly kind: "unknown-plan"; readonly run: string; readonly plan: string } | { readonly kin… (492 characters)
type PlanFinding =
  | { readonly kind: "unknown-plan"; readonly run: string; readonly plan: string }
  | { readonly kind: "registered-after"; readonly run: string; readonly plan: string }
  | { readonly kind: "unsigned-plan"; readonly run: string; readonly plan: string }
  | { readonly kind: "case-not-in-plan"; readonly run: string; readonly plan: string; readonly name: string }
  | { readonly kind: "planned-not-run"; readonly run: string; readonly plan: string; readonly name: string };

What a run that did not follow its plan did (FR-042).

formatPlanFindingfunction
function formatPlanFinding(f: PlanFinding): string

A finding as one sentence.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

PlanOptionstypeno test imports it
type PlanOptions = { readonly requireSigned?: boolean };

What the judgement of a run is given besides the run.

judgePlanRunfunctionno test imports it
function judgePlanRun(plans: readonly PlanRegistration[], run: PlanRun, options?: PlanOptions): readonly PlanFinding[]

Whether a run followed the plan it names (FR-042): the plan is registered, before the run and (where asked) signed; every case of the run is a case of the plan; every case of the plan is in the run, as a result or as not_run. A run that names no plan has no finding: a plan is optional, and a run that does not use one is judged as any other.

notRunOfPlanfunction
function notRunOfPlan(id: string, plan: ObjectOf<{ title: Decoder<string>; cases: Decoder<readonly ObjectOf<{ name: Decoder<string>; requirements: Decoder<readonly Brand<string, "RequirementId">[]>; acceptance: Decoder<string>; }, { file: Decoder<string>; }>[]>; }, Record<never, never>>, ran: readonly string[]): readonly NotRun[]

The cases of a plan that a run did not report, as the not_run cases the run must carry (FR-042): each with the requirements the plan gives it and the reason that the plan holds it and the run did not run it. A run is kept with these so that nothing planned goes unseen.

Imported by 5 tests of the run (5 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.