rns-cli 0.2.2

CLI tools for the Reticulum Network Stack
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use std::fs;
use std::path::{Path, PathBuf};
use std::time::{SystemTime, UNIX_EPOCH};

pub struct ReadyFile {
    path: PathBuf,
}

impl ReadyFile {
    pub fn new(path: Option<&str>) -> Result<Option<Self>, String> {
        let Some(path) = path else {
            return Ok(None);
        };
        let ready_file = Self {
            path: PathBuf::from(path),
        };
        ready_file.clear()?;
        Ok(Some(ready_file))
    }

    pub fn mark_ready(&self, process: &str, detail: &str) -> Result<(), String> {
        self.write_status(process, "ready", detail)
    }

    pub fn mark_draining(&self, process: &str, detail: &str) -> Result<(), String> {
        self.write_status(process, "draining", detail)
    }

    fn write_status(&self, process: &str, status: &str, detail: &str) -> Result<(), String> {
        if let Some(parent) = self.path.parent() {
            fs::create_dir_all(parent).map_err(|err| {
                format!(
                    "failed to create readiness dir {}: {}",
                    parent.display(),
                    err
                )
            })?;
        }

        let body = format!(
            "version=1\nstatus={}\nprocess={}\npid={}\ntimestamp_ms={}\ndetail={}\n",
            status,
            process,
            std::process::id(),
            now_unix_ms(),
            escape_value(detail),
        );
        fs::write(&self.path, body).map_err(|err| {
            format!(
                "failed to write readiness file {}: {}",
                self.path.display(),
                err
            )
        })
    }

    pub fn clear(&self) -> Result<(), String> {
        match fs::remove_file(&self.path) {
            Ok(()) => Ok(()),
            Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(()),
            Err(err) => Err(format!(
                "failed to remove readiness file {}: {}",
                self.path.display(),
                err
            )),
        }
    }

    pub fn path(&self) -> &Path {
        &self.path
    }
}

impl Drop for ReadyFile {
    fn drop(&mut self) {
        let _ = self.clear();
    }
}

fn now_unix_ms() -> u128 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_millis()
}

fn escape_value(value: &str) -> String {
    value.replace('\\', "\\\\").replace('\n', "\\n")
}

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

    #[test]
    fn ready_file_lifecycle_writes_and_clears_contract_file() {
        let tempdir = tempfile::tempdir().unwrap();
        let path = tempdir.path().join("sentineld.ready");
        let path_string = path.display().to_string();
        let ready_file = ReadyFile::new(Some(&path_string))
            .unwrap()
            .expect("ready file should be configured");

        ready_file
            .mark_ready(
                "rns-sentineld",
                "hooks loaded and provider bridge connected",
            )
            .unwrap();

        let body = fs::read_to_string(ready_file.path()).unwrap();
        assert!(body.contains("version=1"));
        assert!(body.contains("status=ready"));
        assert!(body.contains("process=rns-sentineld"));
        assert!(body.contains("detail=hooks loaded and provider bridge connected"));

        ready_file.clear().unwrap();
        assert!(!ready_file.path().exists());
    }

    #[test]
    fn ready_file_can_report_draining_state() {
        let tempdir = tempfile::tempdir().unwrap();
        let path = tempdir.path().join("statsd.ready");
        let path_string = path.display().to_string();
        let ready_file = ReadyFile::new(Some(&path_string))
            .unwrap()
            .expect("ready file should be configured");

        ready_file
            .mark_draining("rns-statsd", "stopping ingest and flushing stats database")
            .unwrap();

        let body = fs::read_to_string(ready_file.path()).unwrap();
        assert!(body.contains("status=draining"));
        assert!(body.contains("process=rns-statsd"));
        assert!(body.contains("detail=stopping ingest and flushing stats database"));
    }

    #[test]
    fn ready_file_new_clears_stale_file() {
        let tempdir = tempfile::tempdir().unwrap();
        let path = tempdir.path().join("statsd.ready");
        fs::write(&path, "stale").unwrap();

        let path_string = path.display().to_string();
        let ready_file = ReadyFile::new(Some(&path_string))
            .unwrap()
            .expect("ready file should be configured");

        assert!(!ready_file.path().exists());
    }
}