IF Commons GitHub

physical/prove-run

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0008-repoctl-prove FR-011

The run of a proof plan (commons repoctl 0008-repoctl-prove FR-001, FR-011, FR-012): the proofs of the tiers that run here, each a program in its folder, except the proofs of tests, whose tests are selected by what changed (the imports of each test, the requirements the changed files name, the symbols a seam's library imports), left out where a quarantine holds them, taken from the cache where their key is in it, and run each as its own program. The tiers run in order, and the proofs of a tier several at a time.

A proof of tests passes where every test selected for it passed; its detail says how many ran, how many came from the cache and how many were left out. What is left out is reported with its reason, so that a run says why it is safe.

import { quarantineOf } from "./prove-run.ts";
typeof quarantineOf; // "function"

Source: commons/repoctl/src/physical/prove-run.ts

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

physical.quarantineOffunctionno test imports it
function quarantineOf(w: World): Promise<{ readonly entries: readonly QuarantineEntry[]; } | { readonly problem: string; }>

The quarantine record of the repository: its entries, or none where there is no record; a record that is wrong is an error.

physical.RunWantedtypeno test imports it
type RunWanted = { readonly tiers: readonly ProofTier[]; readonly cache: ResultCache; readonly quarantine: readonly QuarantineEntry[]; readonly today: string; readonly width: number };

What a run was asked: the tiers, the cache, the quarantine, today (YYYY-MM-DD) and how many programs at a time.

physical.ProofReporttypeno test imports it
type ProofReport = { readonly proof: PlannedProof; readonly outcome: ProofOutcome };

A proof with how it ended.

physical.RunReporttypeno test imports it
type RunReport = { readonly reports: readonly ProofReport[]; readonly left: readonly SkippedProof[]; readonly expired: readonly QuarantineEntry[] };

What a run did: each proof's report, what the selection left out and why, and the quarantine entries that have expired.

physical.runPlanfunctionno test imports it
function runPlan(w: World, planned: Planned, base: string, wanted: RunWanted): Promise<RunReport>

Runs the proofs of a plan that the tiers ask for.

quarantineOffunctionno test imports it
function quarantineOf(w: World): Promise<{ readonly entries: readonly QuarantineEntry[]; } | { readonly problem: string; }>

The quarantine record of the repository: its entries, or none where there is no record; a record that is wrong is an error.

RunWantedtypeno test imports it
type RunWanted = { readonly tiers: readonly ProofTier[]; readonly cache: ResultCache; readonly quarantine: readonly QuarantineEntry[]; readonly today: string; readonly width: number };

What a run was asked: the tiers, the cache, the quarantine, today (YYYY-MM-DD) and how many programs at a time.

ProofReporttypeno test imports it
type ProofReport = { readonly proof: PlannedProof; readonly outcome: ProofOutcome };

A proof with how it ended.

RunReporttypeno test imports it
type RunReport = { readonly reports: readonly ProofReport[]; readonly left: readonly SkippedProof[]; readonly expired: readonly QuarantineEntry[] };

What a run did: each proof's report, what the selection left out and why, and the quarantine entries that have expired.

runPlanfunction
function runPlan(w: World, planned: Planned, base: string, wanted: RunWanted): Promise<RunReport>

Runs the proofs of a plan that the tiers ask for.

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

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