krabka-metadata 0.7.0

Versioned metadata record types + immutable image for Krabka
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

use thiserror::Error;
use uuid::Uuid;

#[derive(Debug, Error, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum MetadataError {
    #[error("topic '{0}' already exists")]
    TopicExists(String),

    #[error("unknown topic '{0}'")]
    UnknownTopic(String),

    #[error("invalid partition {partition} on topic '{topic}'")]
    InvalidPartition { topic: String, partition: i32 },

    #[error("invalid record: {0}")]
    InvalidRecord(&'static str),

    /// A `V1TopicFreeze` record carried an empty scope. A literal scope names
    /// one topic and a prefix scope names a namespace, so neither can be
    /// empty. An empty prefix would cover every topic in the cluster.
    #[error("topic freeze scope is empty")]
    EmptyFreezeScope,

    /// A `V1BreakGlassProposal` record replaced, reordered, or dropped an
    /// approval already stored for the proposal. Two approvers who read the
    /// same image each submit the list they read plus their own entry, so
    /// only an append keeps both.
    #[error("break-glass proposal {0} does not extend the stored approvals")]
    BreakGlassApprovalsNotAnExtension(Uuid),

    /// A `V1BreakGlassProposal` record changed a proposal whose approval is
    /// already spent. One approval authorizes one transition.
    #[error("break-glass proposal {0} is already consumed")]
    BreakGlassProposalConsumed(Uuid),

    /// A `V1BreakGlassProposal` record changed a proposal that the proposer
    /// withdrew.
    #[error("break-glass proposal {0} is withdrawn")]
    BreakGlassProposalWithdrawn(Uuid),
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn display_topic_exists() {
        let e = MetadataError::TopicExists("my-topic".into());
        assert2::assert!(e.to_string() == "topic 'my-topic' already exists");
    }

    #[test]
    fn display_invalid_partition() {
        let e = MetadataError::InvalidPartition {
            topic: "t".into(),
            partition: 7,
        };
        assert2::assert!(e.to_string().contains("partition 7"));
    }

    #[test]
    fn display_freeze_and_break_glass_rejections() {
        let id = Uuid::from_u128(0xB1);
        for (label, error, want) in [
            (
                "empty freeze scope",
                MetadataError::EmptyFreezeScope,
                "topic freeze scope is empty".to_string(),
            ),
            (
                "approvals that do not extend",
                MetadataError::BreakGlassApprovalsNotAnExtension(id),
                format!("break-glass proposal {id} does not extend the stored approvals"),
            ),
            (
                "consumed proposal",
                MetadataError::BreakGlassProposalConsumed(id),
                format!("break-glass proposal {id} is already consumed"),
            ),
            (
                "withdrawn proposal",
                MetadataError::BreakGlassProposalWithdrawn(id),
                format!("break-glass proposal {id} is withdrawn"),
            ),
        ] {
            assert2::check!(error.to_string() == want, "{label}");
        }
    }
}