IF Commons GitHub

pure/names

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

The words of the quality system's record (commons 0021-ifqs): the outcome of a case (the five of 0008-test-evidence FR-001 and not_run, FR-019), the grade of evidence E0 to E5 (FR-026) with its rank, the names of the attributes this specification adds to the record, the layout of the quality branch and its notes (FR-021 to FR-023), and the names ISO/IEC 25010 and ISO/IEC/IEEE 29119-3 give (FR-017). Pure: nothing here reads a host.

The outcome and grade words are the outcomeWord and the keys of the code lists in commons/ontology/ifqs/ifqs.ts (ifqs:TestOutcome, ifqs:EvidenceGrade); a test (quality-record.test.ts) asserts that they are equal, so that the two cannot drift apart.

import { gradeRank, isGrade } from "./names.ts";
isGrade("E4") && gradeRank("E4") > gradeRank("E3"); // true

Source: commons/quality/src/pure/names.ts

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

QualityOutcometypeno test imports it
type QualityOutcome = Outcome | "not_run";

What became of a case: 0008-test-evidence's five outcomes and not_run, a planned case that never started, with its reason (0001-quality-evidence FR-019).

QUALITY_OUTCOMESconst
const QUALITY_OUTCOMES: readonly QualityOutcome[]

Every outcome of a case, in the order reports list them.

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

isQualityOutcomefunctionno test imports it
function isQualityOutcome(text: string): text is QualityOutcome

Whether a text is an outcome of a case, not_run included.

Gradetypeno test imports it
type Grade = "E0" | "E1" | "E2" | "E3" | "E4" | "E5";

The grade of a piece of evidence (0001-quality-evidence FR-026): none, stated, reviewed, tested, attested, observed.

GRADESconst
const GRADES: readonly Grade[]

Every grade, lowest first.

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

isGradefunctionno test imports it
function isGrade(text: string): text is Grade

Whether a text is a grade.

gradeRankfunction
function gradeRank(g: Grade): number

The rank of a grade, 0 to 5 (ifqs:gradeRank).

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

higherGradefunction
function higherGrade(a: Grade, b: Grade): Grade

The higher of two grades.

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

gradeWordsfunctionno test imports it
function gradeWords(g: Grade): string

What each grade says, as a few words that are shown beside it.

showGradefunction
function showGrade(g: Grade): string

A grade as it is shown: E3 tested.

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

ATTRconst
const ATTR: { readonly grade: "ifc.quality.grade"; readonly previous: "ifc.quality.previous.sha256"; readonly characteristic: "ifc.test.characteristic"; readonly notRun: "ifc.quality.not_run"; readonly rule: "ifc.check.rule"; readonly line: "code.line.number"; }

The attributes this specification adds to the record (0021-ifqs Assumptions: names of this specification, not of OpenTelemetry).

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

QUALITY_BRANCHconst
const QUALITY_BRANCH: "quality"

The name of the orphan branch the evidence is kept on (FR-021).

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

NOTES_REFconst
const NOTES_REF: "refs/notes/quality"

The notes reference that links a tested commit to its evidence (FR-023).

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

EVIDENCE_ROOTconstno test imports it
const EVIDENCE_ROOT: "quality/evidence"

The folder of the evidence files on the branch (FR-021).

CASE_EVENTconstno test imports it
const CASE_EVENT: "ifc.test.case"

The event name of a case's log record (0008-test-evidence).

RUN_GRADEconst
const RUN_GRADE: Grade

The grade a case that ran to a result carries: a run proved it, and the record exists (FR-026).

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

NO_GRADEconstno test imports it
const NO_GRADE: Grade

The grade of what never proved anything: a case that did not run, or did not end (FR-026).

CHARACTERISTICSconst
const CHARACTERISTICS: readonly string[]

The quality characteristics of ISO/IEC 25010:2023, the words ifc.test.characteristic takes (FR-017). The standard's text is not copied; these are its names for the characteristics.

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

isCharacteristicfunctionno test imports it
function isCharacteristic(text: string): boolean

Whether a text is the name of a characteristic.

DOCUMENTSconst
const DOCUMENTS: { readonly completion: "Test Completion Report"; readonly status: "Test Status Report"; readonly incident: "Test Incident Report"; }

The document names of ISO/IEC/IEEE 29119-3 that a report of a run bears (FR-017).

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

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