bamts-verification 0.1.0

Verification and compliance test suite for BamTS
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
116
117
118

pub mod corpus;
pub mod formal_bridge;
pub mod formal_gates;
pub mod ledger;
pub mod workspace_guard;

use std::fmt;

pub type Result<T, E = VerificationError> = std::result::Result<T, E>;

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum Gate {
    G0,
    G1,
    G2,
    G3,
    G4,
    G5,
    G6,
}

impl Gate {
    pub const FORMAL_ORDER: [Self; 6] =
        [Self::G1, Self::G2, Self::G5, Self::G3, Self::G4, Self::G6];

    pub fn parse(value: &str) -> Result<Self> {
        match value {
            "G0" => Ok(Self::G0),
            "G1" => Ok(Self::G1),
            "G2" => Ok(Self::G2),
            "G3" => Ok(Self::G3),
            "G4" => Ok(Self::G4),
            "G5" => Ok(Self::G5),
            "G6" => Ok(Self::G6),
            _ => Err(VerificationError::new(
                ErrorCode::Usage,
                format!("unknown gate `{value}`"),
            )),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct GateReport {
    pub gate: Gate,
    pub checks: usize,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ErrorCode {
    Usage,
    Io,
    Json,
    Toml,
    Schema,
    Digest,
    Duplicate,
    SetMismatch,
    Transition,
    Workspace,
    GateDependency,
    ToolMissing,
    ToolFailed,
    Replay,
}

impl ErrorCode {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Usage => "E_USAGE",
            Self::Io => "E_IO",
            Self::Json => "E_JSON",
            Self::Toml => "E_TOML",
            Self::Schema => "E_SCHEMA",
            Self::Digest => "E_DIGEST",
            Self::Duplicate => "E_DUPLICATE",
            Self::SetMismatch => "E_SET_MISMATCH",
            Self::Transition => "E_TRANSITION",
            Self::Workspace => "E_WORKSPACE",
            Self::GateDependency => "E_GATE_DEPENDENCY",
            Self::ToolMissing => "E_TOOL_MISSING",
            Self::ToolFailed => "E_TOOL_FAILED",
            Self::Replay => "E_REPLAY",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct VerificationError {
    code: ErrorCode,
    detail: String,
}

impl VerificationError {
    pub fn new(code: ErrorCode, detail: impl Into<String>) -> Self {
        Self {
            code,
            detail: detail.into(),
        }
    }

    pub const fn code(&self) -> ErrorCode {
        self.code
    }
}

impl fmt::Display for VerificationError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            formatter,
            "bamts-verification: {}: {}",
            self.code.as_str(),
            self.detail
        )
    }
}

impl std::error::Error for VerificationError {}