Enum ProofState 

pub enum ProofState {
    Proven,
    InputsUnchanged,
    Stale,
    Failing,
    NotRun,
    Unrunnable,
    NoTest,
}

What the repository can say about one claim’s proof, right now.

Ordered from strongest to weakest, so a summary that sorts by this reads as a ranking.

use majordomus_cli::evidence::ProofState;

let mut states = vec![ProofState::NotRun, ProofState::Stale, ProofState::Proven];
states.sort();
assert_eq!(
    states,
    vec![ProofState::Proven, ProofState::Stale, ProofState::NotRun]
);

// the two strongest are deliberately not one state: `inputs unchanged` is the absence
// of a known invalidation, and collapsing it into `proven` is the unaccountable badge
assert_ne!(ProofState::Proven, ProofState::InputsUnchanged);
assert!(ProofState::Proven < ProofState::InputsUnchanged);
assert!(ProofState::InputsUnchanged.passing());

Example

use majordomus_cli::evidence::ProofState;
assert!(ProofState::Proven.passing());
assert!(!ProofState::NotRun.passing());
assert!(!ProofState::InputsUnchanged.meaning().is_empty());

Variants

Proven

A passing run, and nothing has changed since it — the diff against the execution’s own commit is empty but for the ledger. Proof of the tree in front of you.

InputsUnchanged

A passing run, and nothing this claim names has changed since. Not proof at HEAD: something the claim does not name may have broken it.

Stale

A passing run, but something this claim names has changed since. The proof is older than its subject.

Failing

The latest run of this claim’s test did not pass.

NotRun

The claim names a test a runner owns, and no run of it has ever been recorded.

Unrunnable

The claim names a path no runner in this repository drives. Nothing can record it, so nothing can prove it this way.

NoTest

The claim names no test at all. Correct for a planned or rejected claim, and a defect for any other.

Implementations

impl ProofState

pub fn label(self) -> &'static str

The word every surface prints for this state, and the key the report’s totals are counted under.

One spelling, defined here, so that the badge, the terminal rendering and the JSON cannot disagree about what they are showing the same reader.

use majordomus_cli::evidence::ProofState;
assert_eq!(ProofState::Proven.label(), "proven");
assert_eq!(ProofState::InputsUnchanged.label(), "inputs unchanged");
assert_ne!(ProofState::Proven.label(), ProofState::InputsUnchanged.label());

pub fn token(self) -> &'static str

The design-token word for this state: its serialised name with _ written as -.

A surface that colours a state asks for its token and nothing else, so the mapping from a state to a design token is this one spelling rather than a table in each renderer.

use majordomus_cli::evidence::ProofState;
assert_eq!(ProofState::Proven.token(), "proven");
assert_eq!(ProofState::InputsUnchanged.token(), "inputs-unchanged");
assert_eq!(ProofState::NoTest.token(), "no-test");

pub fn meaning(self) -> &'static str

One sentence: what the state means, for the reader who clicked the badge. This is the derivation, in words, and it lives here so that every surface says the same thing rather than each inventing its own gloss.

The sentence for ProofState::InputsUnchanged is the one that has to be carried everywhere, because it is the state a surface is tempted to render as a plain green.

use majordomus_cli::evidence::ProofState;

let m = ProofState::InputsUnchanged.meaning();
assert!(m.contains("not proof against the current commit"), "{m}");
assert_ne!(m, ProofState::Proven.meaning());

pub fn passing(self) -> bool

Does this state carry a passing execution behind it, of any freshness?

Freshness and outcome are two questions, and this answers only the second. A count of passing claims is honest; a count that called them all proven would not be.

use majordomus_cli::evidence::ProofState;
assert!(ProofState::Proven.passing());
assert!(ProofState::Stale.passing(), "a pass older than its subject is still a pass");
assert!(!ProofState::Failing.passing());
assert!(!ProofState::NotRun.passing());
assert!(!ProofState::Unrunnable.passing());

Trait Implementations

impl Clone for ProofState

fn clone(&self) -> ProofState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ProofState

impl Debug for ProofState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProofState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProofState

impl JsonSchema for ProofState

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for ProofState

fn cmp(&self, other: &ProofState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProofState

fn eq(&self, other: &ProofState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ProofState

fn partial_cmp(&self, other: &ProofState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ProofState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProofState