cradle-shared 0.1.0

Shared utilities in use by the Cradle agent and cli
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

/// Check result struct
/// Each cradle check should return this struct after execution
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CheckResult {
    /// Calling plugin name
    pub plugin: String,
    /// Check name
    pub check: String,
    /// Result severity (see: [`Severity`])
    pub severity: Severity,
    /// Message included in the check's result
    pub message: String,
    /// Optional details for the message
    pub details: Option<String>,
}

/// Check result severity
/// Specifies how severe the check result should be classified as
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub enum Severity {
    /// Check passed
    Pass,
    /// Informational check
    Info,
    /// Warning check
    Warn,
    /// Check failed
    Fail,
    /// A critical error occurred
    Critical,
}

impl CheckResult {
    /// Small helper to create a pass result (`Severity::Pass`)
    pub fn pass(plugin: &str, check: &str, message: impl Into<String>) -> Self {
        Self {
            plugin: plugin.into(),
            check: check.into(),
            severity: Severity::Pass,
            message: message.into(),
            details: None,
        }
    }

    /// Small helper to create an informational result (`Severity::Info`)
    pub fn info(plugin: &str, check: &str, message: impl Into<String>) -> Self {
        Self {
            plugin: plugin.into(),
            check: check.into(),
            severity: Severity::Info,
            message: message.into(),
            details: None,
        }
    }

    /// Small helper to create a warning result (`Severity::Warn`)
    pub fn warn(plugin: &str, check: &str, message: impl Into<String>) -> Self {
        Self {
            plugin: plugin.into(),
            check: check.into(),
            severity: Severity::Warn,
            message: message.into(),
            details: None,
        }
    }

    /// Small helper to create a failure result (`Severity::Fail`)
    pub fn fail(plugin: &str, check: &str, message: impl Into<String>) -> Self {
        Self {
            plugin: plugin.into(),
            check: check.into(),
            severity: Severity::Fail,
            message: message.into(),
            details: None,
        }
    }

    /// Small helper to create a critical error result (`Severity::Critical`)
    pub fn critical(plugin: &str, check: &str, message: impl Into<String>) -> Self {
        Self {
            plugin: plugin.into(),
            check: check.into(),
            severity: Severity::Critical,
            message: message.into(),
            details: None,
        }
    }

    /// Adds details to the given check result
    pub fn with_details(mut self, details: impl Into<String>) -> Self {
        self.details = Some(details.into());
        self
    }
}