Skip to main content

ReportCommand

Enum ReportCommand 

Source
pub enum ReportCommand {
    Tests {
        suite: PathBuf,
        crate_output: Option<PathBuf>,
    },
    Benchmarks {
        from: PathBuf,
    },
    Ui {
        from: PathBuf,
    },
    UiSnapshot {
        limit: usize,
        budget_seconds: u64,
    },
    CockpitSnapshot {
        limit: usize,
        budget_seconds: u64,
    },
}
Expand description

The reports this executable can render. Each reads evidence a run already produced and writes a surface; none of them runs anything or decides what passed.

Variants§

§

Tests

The test run: the behavioural cases’ report, and the crate’s own totals

Fields

§suite: PathBuf

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

§crate_output: Option<PathBuf>

The output of cargo test, for its totals

§

Benchmarks

The benchmark run: a results document, or the accepted baseline

Fields

§from: PathBuf

A results document from majordomus bench, or a baseline under the layer

§

Ui

The UI conformance audit, rendered as a section of the test surface (/tests/ui)

Fields

§from: PathBuf

A results document from scripts/ui audit

§

UiSnapshot

The UI itself, read once at this commit and written as static pages a publication carries at /ui (ADR 0141)

Fields

§limit: usize

The most pages to write: every screen and panel first, then what they link to

§budget_seconds: u64

The most seconds to spend on the pages the screens link to; the screens and panels are written whatever they cost

§

CockpitSnapshot

The Cockpit itself, read once at this commit and written as static pages a publication carries at /cockpit (ADR 0147)

Fields

§limit: usize

The most pages to write: every static route first, then the pages the UI’s snapshot links to, then what those link to

§budget_seconds: u64

The most seconds to spend on the pages the static routes link to; the routes themselves are written whatever they cost

Trait Implementations§

Source§

impl Debug for ReportCommand

Source§

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

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

impl FromArgMatches for ReportCommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for ReportCommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut] Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut] Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

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> 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, 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