Modules
wingbox-acceptance: acceptance criteria run against the records
Before a change is accepted, a team has to show that the checks its own criteria require did pass, and the report of it must say no more than the records do. This library runs the acceptance criteria and writes the report from the records.
There is no package named wingbox-acceptance to install yet. Its first part, the manifest of required tests, is delivered through the pull request check, 1.5.0 and later; wingbox-acceptance is the library these capabilities are going into.
What it is for
- The tests a change must pass are declared by the team, whatever the graph finds for that change.
- An acceptance report that is generated from the records, in a form for a machine and a form for a reader that cannot disagree.
- A fixed set of negative cases, each with the verdict it must end in, to show that the layer never says more than it checked.
What it takes in and gives out
Takes in
- The evidence records of the runs.
- The tests a change must pass, in a manifest kept in the repository.
- Negative cases with their expected verdicts, written apart from the code they test.
Gives out
- Today: each required test with its evidence, in the plan, in the comment and in the record of the pull request check.
- In development: the acceptance report, as JSON and in a readable form, generated from the same result.
The rules it holds to
The first two hold in the pull request check since 1.5.0; all are requirements of the library.
- A required test without a passed record is never a pass, whatever else passed.
- The requirements are read from the base commit, so a change cannot drop a requirement it is judged by.
- The report is generated from the records, never written by hand. Rendering cannot upgrade a result or create an approval.
- Acceptance is a person's act. The tool never makes it.
- No language model, in the library or in its tests.
Status
What is true today. Available: in a released version. Merged, in the next release: on the main branch, not released. In development: an open issue on GitHub.
| Capability | State | Source |
|---|---|---|
| A manifest of required tests, read from the base commit: the tests a change of given paths must pass | Available Pull request check 1.5.0 and later | |
| The acceptance report: one result rendered as JSON and as a readable report that cannot disagree | In development | |
| A suite of negative cases with expected verdicts written apart from the code | In development | |
| A test specification approved before any result is looked at | In development |
See more
- wingbox-evidence: Normalises and verifies technical evidence: the record of a run, where its inputs come from, and what was and was not analysed.
- wingbox-controls: Formal rules and the mapping to ISO/IEC 27001, ISO/IEC 42001 and SOC 2, with the limits of what code evidence can show.
- What a run gives a team that prepares for an audit
- The pull request check
- The architecture task on GitHub