Skip to main content

kanade_shared/
subject.rs

1pub const COMMANDS_ALL: &str = "commands.all";
2
3pub fn commands_group(name: &str) -> String {
4    format!("commands.group.{name}")
5}
6
7pub fn commands_pc(pc_id: &str) -> String {
8    format!("commands.pc.{pc_id}")
9}
10
11pub fn commands_deploy(job_id: &str) -> String {
12    format!("commands.deploy.{job_id}")
13}
14
15pub fn results(request_id: &str) -> String {
16    format!("results.{request_id}")
17}
18
19pub fn heartbeat(pc_id: &str) -> String {
20    format!("heartbeat.{pc_id}")
21}
22
23pub fn kill(job_id: &str) -> String {
24    format!("kill.{job_id}")
25}
26
27pub fn inventory(pc_id: &str, category: &str) -> String {
28    format!("inventory.{pc_id}.{category}")
29}
30
31pub const INVENTORY_HW: &str = "hw";
32pub const INVENTORY_SW: &str = "sw";
33pub const INVENTORY_NET: &str = "net";
34
35/// `logs.fetch.<pc_id>` — request/reply: operator (or backend) sends
36/// a `LogsRequest`; the addressed agent replies with the tail of its
37/// local log file. On-demand only, no stream.
38pub fn logs_fetch(pc_id: &str) -> String {
39    format!("logs.fetch.{pc_id}")
40}
41
42#[cfg(test)]
43mod tests {
44    use super::*;
45
46    #[test]
47    fn commands_all_constant() {
48        assert_eq!(COMMANDS_ALL, "commands.all");
49    }
50
51    #[test]
52    fn commands_group_formats_name() {
53        assert_eq!(commands_group("canary"), "commands.group.canary");
54        assert_eq!(commands_group("wave1"), "commands.group.wave1");
55    }
56
57    #[test]
58    fn commands_pc_formats_id() {
59        assert_eq!(commands_pc("minipc"), "commands.pc.minipc");
60        assert_eq!(commands_pc("PC1234"), "commands.pc.PC1234");
61    }
62
63    #[test]
64    fn commands_deploy_formats_job_id() {
65        let job = "3c3c56b3-c83e-4c27-9fa9-4a75e1f5da6f";
66        assert_eq!(
67            commands_deploy(job),
68            "commands.deploy.3c3c56b3-c83e-4c27-9fa9-4a75e1f5da6f"
69        );
70    }
71
72    #[test]
73    fn results_formats_request_id() {
74        assert_eq!(results("req-1"), "results.req-1");
75    }
76
77    #[test]
78    fn heartbeat_formats_pc_id() {
79        assert_eq!(heartbeat("minipc"), "heartbeat.minipc");
80    }
81
82    #[test]
83    fn kill_formats_job_id() {
84        assert_eq!(kill("testjob1"), "kill.testjob1");
85    }
86
87    #[test]
88    fn logs_fetch_formats_pc_id() {
89        assert_eq!(logs_fetch("minipc"), "logs.fetch.minipc");
90    }
91
92    #[test]
93    fn inventory_formats_pc_id_and_category() {
94        assert_eq!(inventory("minipc", "hw"), "inventory.minipc.hw");
95        assert_eq!(inventory("minipc", INVENTORY_HW), "inventory.minipc.hw");
96        assert_eq!(inventory("minipc", INVENTORY_SW), "inventory.minipc.sw");
97        assert_eq!(inventory("minipc", INVENTORY_NET), "inventory.minipc.net");
98    }
99}