IF Commons GitHub

logical/conformance/kit

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0005-anyfs-posix-conformance FR-001

The small kit the cases of the suite are written with: a failure that says what differed, the bytes of a text, and the reading of an outcome, an error and a fidelity. The kit imports nothing but the types of the library, so the suite can run in the tests of any store that has a view.

Source: commons/anyfs-posix/src/logical/conformance/kit.ts

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

Casetypeno test imports it
type Case = {
  readonly id: string;
  readonly title: string;
  readonly needs: readonly Capability[];
  readonly lacks: readonly Capability[];
  readonly traced: boolean;
  readonly run: (make: Make) => Promise<void>;
};

A case: its id, what it says, the capabilities the store must have and must not have, whether it needs a trace, and the code.

ConformanceFailureclassno test imports it
class ConformanceFailure extends Error

A case failed: the sentence says what differed.

MemberTypeWhat it is
namestring
messagestring
stack?string
cause?unknown
Maketypeno test imports it
type Make = () => Promise<World>;

What a case is given: a function that makes a new world.

Worldtype
type World = {
  readonly posix: Posix;
  /** The operations of the store since the last reset, where the world records them. */
  readonly trace?: () => readonly OpName[];
  readonly reset?: () => void;
};

What a case runs against: a new, empty view, and where the store allows it the operations the store was asked for since the last reset.

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

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