Struct EvidenceCoverage 

pub struct EvidenceCoverage {
    pub commit: CommitId,
    pub working_tree: TreeState,
    pub measurement: String,
    pub test_code: String,
    pub whole_crate: EvidenceCoverageDimensions,
    pub domain: EvidenceCoverageDomain,
    pub files: BTreeMap<String, EvidenceCoverageDimensions>,
    pub floors: EvidenceCoverageFloors,
}

One coverage measurement, bound to the commit and tree it was measured on.

Built only by EvidenceCoverage::from_summary or deserialised; either way commit is a CommitId, so a record without a full commit cannot exist.

use majordomus_cli::evidence::EvidenceCoverage;
let bad = serde_json::json!({"commit": "abc", "working_tree": "clean"});
assert!(serde_json::from_value::<EvidenceCoverage>(bad).is_err());

Fields

commit: CommitId

The commit the measurement ran at.

working_tree: TreeState

The tree the coverage run’s own measurement stated, unknown without one.

measurement: String

The producer of the summary: scripts/rust-coverage.

test_code: String

Whether test code is counted: excluded.

whole_crate: EvidenceCoverageDimensions

The whole crate.

domain: EvidenceCoverageDomain

The session domain.

files: BTreeMap<String, EvidenceCoverageDimensions>

Every file with executable code under test, by repository-relative path.

floors: EvidenceCoverageFloors

The floors stated when it was recorded.

Implementations

impl EvidenceCoverage

pub fn from_summary( text: &str, commit: CommitId, working_tree: TreeState, floors: EvidenceCoverageFloors, ) -> Result<EvidenceCoverage, String>

The summary text bound to commit and working_tree, with floors; refused when the text is not a schema-1 summary.

use majordomus_cli::evidence::{CommitId, EvidenceCoverage, TreeState};
let id = CommitId::parse(&"a".repeat(40)).unwrap();
let err = EvidenceCoverage::from_summary(r#"{"schema":2}"#, id, TreeState::Clean,
    Default::default()).unwrap_err();
assert!(err.contains("schema"), "{err}");

pub fn is_current_for(&self, commit: &str, presented_tree: TreeState) -> bool

Whether this measurement describes commit as presented: only its own commit, and only when its tree and the presented tree are both clean.

let c = "b".repeat(40);
let cov = EvidenceCoverage::from_summary(&text, CommitId::parse(&c).unwrap(),
    TreeState::Unknown, Default::default()).unwrap();
assert!(!cov.is_current_for(&c, TreeState::Clean), "its own tree was not measured");

pub fn below_floor(&self) -> Vec<&'static str>

Which of the crate and the domain are below the line floor recorded with them.

let floors = EvidenceCoverageFloors { crate_lines: Some(40.0), domain_lines: Some(60.0) };
let cov = EvidenceCoverage::from_summary(&text, CommitId::parse(&"c".repeat(40)).unwrap(),
    TreeState::Clean, floors).unwrap();
assert_eq!(cov.below_floor(), vec!["domain"]);

Trait Implementations

impl Clone for EvidenceCoverage

fn clone(&self) -> EvidenceCoverage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EvidenceCoverage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EvidenceCoverage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EvidenceCoverage

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 EvidenceCoverage

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

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 EvidenceCoverage