Skip to main content

EvidenceRecordInput

Struct EvidenceRecordInput 

Source
pub struct EvidenceRecordInput {
    pub suite: Option<String>,
    pub crate_output: Option<String>,
    pub origin: Option<String>,
    pub provenance: Vec<String>,
    pub coverage: Option<String>,
    pub ledger: Option<LedgerTarget>,
    pub run_record: Option<String>,
}
Expand description

A run to record into the ledger.

Paths to what the runners already wrote, not a run to perform: the recorder reads a report, carries into each result what that run measured about its own checkout, and merges it. The reports are optional and may be given together; an absent origin is local, and an absent ledger is the tracked one.

use majordomus_cli::capability::builtin::evidence::EvidenceRecordInput;

let input: EvidenceRecordInput =
    serde_json::from_str(r#"{"suite": "tmp/report.tsv"}"#).unwrap();
assert_eq!(input.suite.as_deref(), Some("tmp/report.tsv"));
assert!(input.crate_output.is_none() && input.origin.is_none());

// what was not given is not written back as null: the shape a client reads is the
// shape it sent
assert_eq!(
    serde_json::to_string(&input).unwrap(),
    r#"{"suite":"tmp/report.tsv"}"#
);

Fields§

§suite: Option<String>

The runner’s TSV report: MJ_TEST_REPORT=<file> bash test/run.sh.

§crate_output: Option<String>

A file holding cargo test’s output, for the crate’s own integration tests.

§origin: Option<String>

Where the run happened: local (the default), ci or release.

§provenance: Vec<String>

A measurement per report: the file majordomus evidence stamp wrote at the end of that run, as <file> or <producer>=<file> (suite, crate, coverage). Without a producer word, the producer is the file’s own, else the only report given.

§coverage: Option<String>

A coverage summary: what scripts/rust-coverage --summary-json wrote.

§ledger: Option<LedgerTarget>

The ledger to merge into: repo (the default, the tracked ledger) or local (the ignored one under .ai/local/, which moves no verdict).

§run_record: Option<String>

Also write the run record to this file.

Trait Implementations§

Source§

impl BenchmarkCases for EvidenceRecordInput

Source§

fn benchmark_cases(_: &CaseContext<'_>) -> Vec<NamedCase<Self>>

The cases, in a stable order. An empty list means “nothing to benchmark in this repository”, which the coverage check reports as missing.
Source§

fn benchmark_cases_json(ctx: &CaseContext<'_>) -> Vec<NamedCase<Value>>

The cases as JSON, the shape every runner serialises from.
Source§

impl Clone for EvidenceRecordInput

Source§

fn clone(&self) -> EvidenceRecordInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EvidenceRecordInput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EvidenceRecordInput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for EvidenceRecordInput

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl Serialize for EvidenceRecordInput

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more