pipedash-plugin-fluxcd 0.4.0

FluxCD plugin for Pipedash
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
119
120
121
122
123
124
125
126
127
128
129
130
131

use pipedash_plugin_api::{
    ComponentHealth,
    HealthLevel,
};
use serde::Deserialize;

#[derive(Default, Deserialize)]
pub(crate) struct Deployment {
    #[serde(default)]
    spec: DeploymentSpec,
    #[serde(default)]
    status: DeploymentStatus,
}

#[derive(Default, Deserialize)]
struct DeploymentSpec {
    replicas: Option<i64>,
}

#[derive(Default, Deserialize)]
#[serde(rename_all = "camelCase")]
struct DeploymentStatus {
    available_replicas: Option<i64>,
    #[serde(default)]
    conditions: Vec<DeploymentCondition>,
}

#[derive(Deserialize)]
struct DeploymentCondition {
    #[serde(rename = "type")]
    kind: String,
    status: String,
}

impl Deployment {
    fn available_condition_is_false(&self) -> bool {
        self.status
            .conditions
            .iter()
            .any(|condition| condition.kind == "Available" && condition.status == "False")
    }

    pub fn health(&self, name: &str) -> Option<ComponentHealth> {
        let desired = self.spec.replicas;
        let available = self.status.available_replicas;
        let (level, detail) = match (desired, available) {
            (Some(0), _) => (HealthLevel::MajorOutage, "scaled to zero".to_string()),
            (_, Some(0)) => (HealthLevel::MajorOutage, "not running".to_string()),
            (Some(desired), Some(available)) if available < desired => (
                HealthLevel::Degraded,
                format!("{available}/{desired} replicas available"),
            ),
            (Some(_), Some(_)) => return None,
            _ if self.available_condition_is_false() => {
                (HealthLevel::MajorOutage, "not available".to_string())
            }
            _ => return None,
        };

        Some(ComponentHealth {
            name: name.to_string(),
            level,
            detail: Some(detail),
        })
    }
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use super::*;

    fn deployment(value: serde_json::Value) -> Deployment {
        serde_json::from_value(value).unwrap()
    }

    fn outcome(value: serde_json::Value) -> Option<(HealthLevel, String)> {
        deployment(value)
            .health("source-controller")
            .map(|health| (health.level, health.detail.unwrap_or_default()))
    }

    #[test]
    fn replica_counts_decide_before_conditions() {
        let available_false = json!([{ "type": "Available", "status": "False" }]);

        assert_eq!(
            outcome(json!({ "spec": { "replicas": 0 }, "status": { "availableReplicas": 1 } })),
            Some((HealthLevel::MajorOutage, "scaled to zero".to_string()))
        );
        assert_eq!(
            outcome(json!({ "spec": { "replicas": 2 }, "status": { "availableReplicas": 0 } })),
            Some((HealthLevel::MajorOutage, "not running".to_string()))
        );
        assert_eq!(
            outcome(json!({
                "spec": { "replicas": 3 },
                "status": { "availableReplicas": 2, "conditions": available_false }
            })),
            Some((HealthLevel::Degraded, "2/3 replicas available".to_string()))
        );
        assert_eq!(
            outcome(json!({
                "spec": { "replicas": 3 },
                "status": { "availableReplicas": 3, "conditions": available_false }
            })),
            None
        );
    }

    #[test]
    fn missing_counts_fall_back_to_the_available_condition() {
        assert_eq!(
            outcome(json!({
                "spec": { "replicas": 1 },
                "status": { "conditions": [{ "type": "Available", "status": "False" }] }
            }))
            .map(|(level, _)| level),
            Some(HealthLevel::MajorOutage)
        );
        assert_eq!(
            outcome(json!({
                "spec": { "replicas": 1 },
                "status": { "conditions": [{ "type": "Available", "status": "True" }] }
            })),
            None
        );
        assert_eq!(outcome(json!({})), None);
    }
}