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
11// `commands_exec` (subject `commands.exec.<job_id>`) was removed in
12// v0.22.1. The STREAM_EXEC stream now catches the existing
13// `commands.{all,group.X,pc.Y}` subjects directly, so the dedicated
14// per-exec subject isn't needed any more. See
15// `kanade-agent::command_replay` for how reconnecting agents catch
16// up on missed messages.
17
18pub fn results(request_id: &str) -> String {
19    format!("results.{request_id}")
20}
21
22pub fn heartbeat(pc_id: &str) -> String {
23    format!("heartbeat.{pc_id}")
24}
25
26/// `kill.<exec_id>` — Spec §2.6 Layer 3 abort signal. The exec_id is
27/// the deployment / scheduler-fire UUID (formerly named `job_id`
28/// pre-v0.29; renamed for accuracy — every `Command.exec_id` is a
29/// per-deploy UUID, not a job-catalog id).
30pub fn kill(exec_id: &str) -> String {
31    format!("kill.{exec_id}")
32}
33
34pub fn inventory(pc_id: &str, category: &str) -> String {
35    format!("inventory.{pc_id}.{category}")
36}
37
38pub const INVENTORY_HW: &str = "hw";
39pub const INVENTORY_SW: &str = "sw";
40pub const INVENTORY_NET: &str = "net";
41
42/// `logs.fetch.<pc_id>` — request/reply: operator (or backend) sends
43/// a `LogsRequest`; the addressed agent replies with the tail of its
44/// local log file. On-demand only, no stream.
45pub fn logs_fetch(pc_id: &str) -> String {
46    format!("logs.fetch.{pc_id}")
47}
48
49// v0.14: subject::inventory_request was retired alongside the
50// hardcoded inventory loop. On-demand collection now goes through
51// the normal exec path (`kanade exec configs/jobs/inventory-
52// hw.yaml`) — Command + ExecResult + the inventory-fact projector
53// give operators the same effect with no extra subject.
54
55#[cfg(test)]
56mod tests {
57    use super::*;
58
59    #[test]
60    fn commands_all_constant() {
61        assert_eq!(COMMANDS_ALL, "commands.all");
62    }
63
64    #[test]
65    fn commands_group_formats_name() {
66        assert_eq!(commands_group("canary"), "commands.group.canary");
67        assert_eq!(commands_group("wave1"), "commands.group.wave1");
68    }
69
70    #[test]
71    fn commands_pc_formats_id() {
72        assert_eq!(commands_pc("minipc"), "commands.pc.minipc");
73        assert_eq!(commands_pc("PC1234"), "commands.pc.PC1234");
74    }
75
76    #[test]
77    fn results_formats_request_id() {
78        assert_eq!(results("req-1"), "results.req-1");
79    }
80
81    #[test]
82    fn heartbeat_formats_pc_id() {
83        assert_eq!(heartbeat("minipc"), "heartbeat.minipc");
84    }
85
86    #[test]
87    fn kill_formats_exec_id() {
88        assert_eq!(kill("exec-uuid-1"), "kill.exec-uuid-1");
89    }
90
91    #[test]
92    fn logs_fetch_formats_pc_id() {
93        assert_eq!(logs_fetch("minipc"), "logs.fetch.minipc");
94    }
95
96    #[test]
97    fn inventory_formats_pc_id_and_category() {
98        assert_eq!(inventory("minipc", "hw"), "inventory.minipc.hw");
99        assert_eq!(inventory("minipc", INVENTORY_HW), "inventory.minipc.hw");
100        assert_eq!(inventory("minipc", INVENTORY_SW), "inventory.minipc.sw");
101        assert_eq!(inventory("minipc", INVENTORY_NET), "inventory.minipc.net");
102    }
103}