Skip to main content

Crate smix_contract

Crate smix_contract 

Source
Expand description

What an app owes, with an id, so coverage can be reconciled.

The requirement is usually already written down — in the comment above a flow, in a ticket, in a design note. What it does not have is an identity, and without one nothing can answer “is this covered on both platforms” except a person reading two test suites side by side and remembering.

This crate is the identity and the arithmetic. It reads contracts and per-platform claims and answers three sets: nobody claims, one platform claims, both claim.

It reports who claimed, never who verified. Those are different words. A claim says a test suite means to cover a requirement; it does not say the test is good, or that it passed, or that the two platforms’ tests check the same thing — which is not mechanically decidable, and pretending otherwise would make this one more cheap signal standing in for the thing to be proven. The output uses the word it can support.

Re-exports§

pub use ratchet::Baseline;
pub use ratchet::Regression;
pub use ratchet::baseline_of;
pub use ratchet::regressions;
pub use reconcile::Claim;
pub use reconcile::PartialClaim;
pub use reconcile::Reconciliation;
pub use reconcile::reconcile;
pub use render::render;
pub use scan::scan_claims;
pub use tree::platform_of;
pub use tree::reconcile_tree;

Modules§

ratchet
Forbidding the loss of coverage, without demanding its increase.
reconcile
Joining claims to contracts, and refusing to call an empty corpus agreement.
render
The verdict, written for whoever reads it next — which is usually not a person.
scan
Reading claims out of source, where the person editing the test sees them.
tree
Reconciling a whole tree, in every notation it holds at once.

Structs§

Contract
One requirement the app owes, and the id that lets it be claimed.

Enums§

ContractError
Why a contract file was refused.

Functions§

parse_claims
Read a claim file: which platform means to cover which contract.
parse_contracts
Read a contract file.