aegis-tool 0.3.3

Aegis SSH client and managed host agent.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use anyhow::{Result, bail};

use super::{command_output_full_failure_detail, full_error};

pub(super) struct RedeployJob {
    unit: String,
    job: capulus::managed::JobId,
}

impl RedeployJob {
    pub(super) fn new(unit: String, job: String) -> Result<Self> {
        let job = capulus::managed::JobId::parse(&job)?;
        if unit != format!("aegis-redeploy-{job}.service") {
            bail!("Capulus returned invalid redeploy unit \u{60}{unit}\u{60}");
        }
        Ok(Self { unit, job })
    }

    pub(super) fn unit(&self) -> &str {
        &self.unit
    }

    pub(super) fn probe_command(&self) -> String {
        format!(
            "/usr/local/bin/aegis advanced redeploy-status {} --json\n",
            super::sh_quote(&self.job.to_string())
        )
    }

    pub(super) fn probe_local(&self) -> RedeployJobState {
        match crate::managed::status(self.job) {
            Ok(status) => capulus_job_state(status),
            Err(error) => {
                RedeployJobState::Unknown(format!("managed redeploy status probe failed: {error}"))
            }
        }
    }

    pub(super) fn state_from_remote_output(
        &self,
        output: Result<crate::command::CommandOutput>,
    ) -> RedeployJobState {
        match output {
            Ok(output) if output.status.success() => {
                match serde_json::from_str::<capulus::managed::RedeployJob>(output.stdout.trim()) {
                    Ok(status) if status.job == self.job && status.product == "aegis" => {
                        capulus_job_state(status)
                    }
                    Ok(_) => RedeployJobState::Unknown(
                        "managed redeploy status returned the wrong job identity".to_string(),
                    ),
                    Err(error) => RedeployJobState::Unknown(format!(
                        "managed redeploy status returned invalid JSON: {error}"
                    )),
                }
            }
            Ok(output) => RedeployJobState::Unknown(format!(
                "managed redeploy status probe failed: {}",
                command_output_full_failure_detail(&output)
            )),
            Err(error) => RedeployJobState::Unknown(format!(
                "managed redeploy status probe failed: {}",
                full_error(&error)
            )),
        }
    }
}

fn capulus_job_state(status: capulus::managed::RedeployJob) -> RedeployJobState {
    let detail = format!("redeploy: {:?}: {}", status.phase, status.detail);
    match status.phase {
        capulus::managed::JobPhase::Complete => RedeployJobState::Complete(detail),
        capulus::managed::JobPhase::Failed => {
            let rollback = status
                .rollback_succeeded
                .map(|succeeded| {
                    if succeeded {
                        "; rollback succeeded"
                    } else {
                        "; rollback failed"
                    }
                })
                .unwrap_or_default();
            RedeployJobState::Failed(format!("{detail}{rollback}"))
        }
        _ => RedeployJobState::Active(detail),
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub(super) enum RedeployJobState {
    Active(String),
    Complete(String),
    Failed(String),
    Unknown(String),
}

impl RedeployJobState {
    pub(super) fn detail(&self) -> &str {
        match self {
            Self::Active(detail)
            | Self::Complete(detail)
            | Self::Failed(detail)
            | Self::Unknown(detail) => detail,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::RedeployJob;

    #[test]
    fn jobs_require_the_exact_capulus_transient_unit() {
        let job = "0123456789abcdef0123456789abcdef";
        let managed =
            RedeployJob::new(format!("aegis-redeploy-{job}.service"), job.to_string()).unwrap();

        assert_eq!(
            format!("/usr/local/bin/aegis advanced redeploy-status {job} --json\n"),
            managed.probe_command()
        );
        assert!(
            RedeployJob::new("aegis-redeploy-other.service".to_string(), job.to_string()).is_err()
        );
        assert!(
            RedeployJob::new(
                format!("aegis-redeploy-{job}.service"),
                "../../etc/passwd".to_string()
            )
            .is_err()
        );
    }
}