Struct Finding 

pub struct Finding {
    pub claim: String,
    pub status: String,
    pub state: ProofState,
    pub reason: String,
    pub reproduce: Option<String>,
}

A claim whose declared status the evidence does not support.

Only a guaranteed claim can produce one: the other statuses already say that a current proof is not what they are claiming. A finding says what was claimed, what the evidence supports instead, and — where running something would settle it — what to run.

use majordomus_cli::evidence::{Finding, ProofState};

let finding = Finding {
    claim: "scope-integrity".into(),
    status: "guaranteed".into(),
    state: ProofState::NotRun,
    reason: "the claim guarantees a behaviour and names a test, and no run of that \
             test has ever been recorded"
        .into(),
    reproduce: Some("bash test/run.sh 07_scope".into()),
};

// the gap is the finding: what the matrix declares against what the ledger holds
assert_ne!(finding.status, finding.state.label());
assert!(finding.reproduce.unwrap().starts_with("bash test/run.sh"));

Example

use majordomus_cli::evidence::{Finding, ProofState};
let f = Finding {
    claim: "some-claim".into(),
    status: "guaranteed".into(),
    state: ProofState::NotRun,
    reason: "the claim names a test nobody has run".into(),
    reproduce: Some("bash test/run.sh 07_scope".into()),
};
assert_eq!(f.state, ProofState::NotRun);

Fields

claim: String

The claim.

status: String

What the claim says it is.

state: ProofState

What the evidence supports.

reason: String

Why this is a finding.

reproduce: Option<String>

What to run, when running something would settle it.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Finding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Finding

impl JsonSchema for Finding

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 PartialEq for Finding

fn eq(&self, other: &Finding) -> 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 Serialize for Finding

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 Finding