alloy-assurance 0.3.0

Shared assurance facade for the Alloy workspace
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use serde::{Deserialize, Serialize};

/// Describes the current Sprint 3 scope for this crate.
#[must_use]
pub const fn scope() -> &'static str {
    "phase-1-v0.1"
}

/// Canonical on-disk replay bundle schema version for generalized Phase 1 artifacts.
#[must_use]
pub const fn canonical_replay_schema_version() -> &'static str {
    "phase-1-v0.1"
}

/// Stable schema identifier for the restart/re-query replay payload.
#[must_use]
pub const fn restart_requery_schema_id() -> &'static str {
    "sr.iridium.restart-requery.v1"
}

/// Result class for evidence consumers.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum ScenarioOutcome {
    /// All checks passed.
    Pass,
    /// One or more checks failed.
    Fail,
    /// Mixed outcome across sub-checks.
    Mixed,
}

impl ScenarioOutcome {
    /// Returns the stable wire spelling for the outcome.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Pass => "pass",
            Self::Fail => "fail",
            Self::Mixed => "mixed",
        }
    }
}

/// Failure taxonomy for replayable evidence.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum FailureClassification {
    /// No failure was observed.
    None,
    /// Capability gap or unsupported plan shape.
    CapabilityMismatch,
    /// Failure across restart and re-query consistency.
    RestartConsistency,
    /// Recovery regression observed during restart or recovery.
    RecoveryRegression,
    /// Cache-transition issue.
    CacheTransition,
    /// Transport or orchestration issue.
    TransportFault,
}

impl FailureClassification {
    /// Returns the stable wire spelling for the failure class.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::None => "none",
            Self::CapabilityMismatch => "capability-mismatch",
            Self::RestartConsistency => "restart-consistency",
            Self::RecoveryRegression => "recovery-regression",
            Self::CacheTransition => "cache-transition",
            Self::TransportFault => "transport-fault",
        }
    }
}

/// Evidence severity and gating level.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum EvidenceLevel {
    /// Informational only.
    Informational,
    /// Intended to catch regressions before release.
    RegressionProtecting,
    /// Blocks release claims on failure.
    ReleaseBlocking,
}

/// Phase 1 scenario classes supported by the replay schema.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum ScenarioClass {
    /// Restart and recovery path.
    RestartRecovery,
    /// Capability rejection path.
    CapabilityRejection,
    /// Cache-mode transition path.
    CacheTransition,
    /// Transport fault path.
    TransportFault,
}

impl ScenarioClass {
    /// Returns the stable wire spelling for the scenario class.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::RestartRecovery => "restart-recovery",
            Self::CapabilityRejection => "capability-rejection",
            Self::CacheTransition => "cache-transition",
            Self::TransportFault => "transport-fault",
        }
    }
}