isoloom-plan 1.0.1

The target-neutral plan of a lab: the spec lowered per target, the environment a backend renders, its checks and requirements.
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268

//! Where each lowered field came from: a problem found on the lowered spec (its networks,
//! addresses, volumes, checks) is reported at the field the author wrote. Indexed fields
//! (a machine's ports, files, steps) are recorded as lowering writes them; renamed ones
//! (`docker.image` from `app.image`, `vm.os` from `os`) follow fixed rules.

use isoloom_spec::syntax::{self, FieldPath, Step};

/// Lowered paths back to written ones.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct Trail {
    /// (lowered prefix, written path), the longest prefix wins.
    entries: Vec<(String, String)>,
}

impl Trail {
    fn record(&mut self, lowered: String, written: String) {
        self.entries.push((lowered, written));
    }

    /// A machine's `kind` (`files` or `secrets`) item `lowered` came from its `files[written]`.
    pub(super) fn file(&mut self, machine: &str, kind: &str, lowered: usize, written: usize) {
        self.record(format!("machines.{machine}.{kind}[{lowered}]"), format!("machines.{machine}.files[{written}]"));
    }

    /// A machine's ports, steps, setup scripts and environment inputs.
    pub(super) fn machine(&mut self, name: &str, m: &syntax::Machine) {
        let at = format!("machines.{name}");
        for (i, p) in m.ports.keys().enumerate() {
            self.record(format!("{at}.ports[{i}]"), format!("{at}.ports.{p}"));
        }
        if let Some(app) = m.app() {
            let vm_steps = app
                .steps
                .iter()
                .enumerate()
                .filter(|(_, s)| matches!(s, Step::Run { .. } | Step::Reboot | Step::Playbook(_)));
            for (lowered, (written, _)) in vm_steps.enumerate() {
                self.record(format!("{at}.vm.provision[{lowered}]"), format!("{at}.app.steps[{written}]"));
            }
        }
        for i in 0..m.setup.len() {
            self.record(format!("{at}.docker.init[{i}]"), format!("{at}.setup[{i}]"));
        }
        let inputs = m.environment.iter().filter(|(_, v)| matches!(v, syntax::EnvValue::Input(_)));
        for (i, (var, _)) in inputs.enumerate() {
            self.record(format!("{at}.inputs[{i}]"), format!("{at}.environment.{var}"));
        }
    }

    /// The spec's inputs, and the secrets lowering made of the files they fill.
    pub(super) fn inputs(&mut self, source: &syntax::Spec) {
        for (i, name) in source.inputs.0.keys().enumerate() {
            self.record(format!("inputs[{i}]"), format!("inputs.{name}"));
            self.record(format!("secrets.{}", super::machine::input_secret(name.as_str())), format!("inputs.{name}"));
        }
    }

    /// The written path of lowered path `path`.
    #[must_use]
    pub fn path(&self, path: &str) -> FieldPath {
        let within = |prefix: &str| path == prefix || path.strip_prefix(prefix).is_some_and(|r| r.starts_with(['.', '[']));
        let best = self
            .entries
            .iter()
            .filter(|(lowered, _)| within(lowered))
            .max_by_key(|(lowered, _)| lowered.len());
        match best {
            Some((lowered, written)) => FieldPath::new(format!("{written}{}", rename_inside(path.get(lowered.len()..).unwrap_or_default()))),
            None => FieldPath::new(rename(path)),
        }
    }
}

/// The written name of a field inside a recorded one (a port's `publish`, a file's `target`).
fn rename_inside(rest: &str) -> String {
    match rest {
        ".http" | ".tls" => ".protocol".into(),
        ".fixed" => ".publish".into(),
        ".target" => ".path".into(),
        ".source" => String::new(),
        other => other.to_owned(),
    }
}

/// The written path of a lowered one with no recorded index: the fixed renames.
fn rename(path: &str) -> String {
    let parts: Vec<&str> = path.splitn(3, '.').collect();
    match parts.as_slice() {
        ["machines", m, rest] => machine_field(m, rest),
        ["networks", n, rest] => match rest.split_once('.').map_or((*rest, ""), |(a, b)| (a, b)) {
            ("docker", "") => format!("overrides.docker.networks.{n}"),
            ("docker", inner) => format!("overrides.docker.networks.{n}.{inner}"),
            ("external", _) => format!("overrides.docker.networks.{n}.external"),
            _ => path.to_owned(),
        },
        ["volumes", v, "external"] => format!("overrides.docker.volumes.{v}.external"),
        ["volumes", v, rest] if rest.starts_with("virtiofs") => format!("overrides.proxmox.volumes.{v}.{rest}"),
        ["controller", "image", ..] => "overrides.vagrant.controller".into(),
        _ => path.to_owned(),
    }
}

/// A machine field's written path.
fn machine_field(m: &str, rest: &str) -> String {
    let at = format!("machines.{m}");
    let (head, tail) = rest
        .split_once(['.', '['])
        .map_or((rest, ""), |(h, _)| (h, rest.get(h.len()..).unwrap_or_default()));
    let image = |key: &str| -> String {
        match key {
            "vagrant" => format!("overrides.vagrant.machines.{m}.box"),
            "vagrant_version" => format!("overrides.vagrant.machines.{m}.box_version"),
            "qemu" | "hyperv" => format!("overrides.vagrant.machines.{m}.boxes.{key}"),
            "box_url" | "box_server_url" | "winrm" | "winssh" => format!("overrides.vagrant.machines.{m}.{key}"),
            "proxmox" => format!("overrides.proxmox.machines.{m}.image"),
            "" => format!("overrides.vagrant.machines.{m}"),
            cloud => format!("overrides.{cloud}.machines.{m}.image"),
        }
    };
    match (head, tail) {
        ("docker", t) => match t.trim_start_matches('.').split(['.', '[']).next().unwrap_or_default() {
            "image" | "appliance" | "config" | "firmware" => format!("{at}.app{t}"),
            "build" | "dockerfile" | "target" | "args" => format!("{at}.app.build"),
            "init" => format!("{at}.setup{}", t.trim_start_matches(".init")),
            "lxc" => format!("overrides.proxmox.machines.{m}.lxc"),
            "idle" => format!("{at}.os"),
            _ => format!("{at}.app"),
        },
        ("vm", t) => match t
            .trim_start_matches('.')
            .split_once('.')
            .map_or((t.trim_start_matches('.'), ""), |(a, b)| (a, b))
        {
            ("os" | "", _) => format!("{at}.os"),
            ("image", key) => image(key),
            ("tpm", _) => format!("{at}.hardware.tpm"),
            ("boot", "") => format!("{at}.hardware.boot"),
            ("boot", inner) => format!("{at}.hardware.boot.{inner}"),
            (field, _) if field.starts_with("provision") => format!("{at}.app.steps{}", field.trim_start_matches("provision")),
            _ => format!("{at}.app"),
        },
        ("arch" | "gpus" | "devices" | "nested_virtualization", t) => format!("{at}.hardware.{head}{t}"),
        ("working_dir", _) => format!("{at}.command.cwd"),
        ("external", _) => format!("overrides.external.machines.{m}.ssh"),
        ("more_addresses", t) => format!("{at}.networks{t}"),
        _ => format!("{at}.{rest}"),
    }
}

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

    use super::*;

    /// A machine's name, as the spec allows them.
    fn machine() -> impl Strategy<Value = String> {
        "[a-z][a-z0-9-]{0,10}"
    }

    proptest! {
        #[test]
        fn a_recorded_file_points_at_its_written_index_and_field(
            m in machine(),
            (lowered, written) in (0usize..20, 0usize..20),
            (inside, renamed) in prop::sample::select(vec![("", ""), (".uid", ".uid"), (".mode", ".mode"), (".target", ".path"), (".source", "")]),
        ) {
            let mut t = Trail::default();
            t.file(&m, "secrets", lowered, written);
            let path = t.path(&format!("machines.{m}.secrets[{lowered}]{inside}"));
            prop_assert_eq!(path.to_string(), format!("machines.{m}.files[{written}]{renamed}"));
        }

        #[test]
        fn the_longest_recorded_prefix_wins(m in machine(), i in 1usize..9) {
            let mut t = Trail::default();
            t.record(format!("machines.{m}.ports[{i}]"), format!("machines.{m}.ports.short"));
            t.record(format!("machines.{m}.ports[{i}0]"), format!("machines.{m}.ports.long"));
            prop_assert_eq!(t.path(&format!("machines.{m}.ports[{i}0].fixed")).to_string(), format!("machines.{m}.ports.long.publish"));
            prop_assert_eq!(t.path(&format!("machines.{m}.ports[{i}].fixed")).to_string(), format!("machines.{m}.ports.short.publish"));
        }

        #[test]
        fn a_path_nothing_renames_is_kept(head in prop::sample::select(vec!["checks", "reach", "message", "targets", "groups"]), rest in "(\\[[0-9]{1,2}\\])?(\\.[a-z_]{1,8}){0,3}") {
            let path = format!("{head}{rest}");
            prop_assert_eq!(Trail::default().path(&path).to_string(), path);
        }
    }

    #[test]
    fn renamed_fields_point_at_what_the_author_wrote() {
        let t = Trail::default();
        for (lowered, written) in [
            ("machines.web.docker.image", "machines.web.app.image"),
            ("machines.web.docker.dockerfile", "machines.web.app.build"),
            ("machines.web.docker.init[1]", "machines.web.setup[1]"),
            ("machines.web.docker.lxc", "overrides.proxmox.machines.web.lxc"),
            ("machines.web.vm.os", "machines.web.os"),
            ("machines.web.vm.tpm", "machines.web.hardware.tpm"),
            ("machines.web.vm.image.vagrant", "overrides.vagrant.machines.web.box"),
            ("machines.web.vm.image.aws", "overrides.aws.machines.web.image"),
            ("machines.web.arch", "machines.web.hardware.arch"),
            ("machines.web.working_dir", "machines.web.command.cwd"),
            ("machines.web.networks.lab", "machines.web.networks.lab"),
            ("networks.lab.docker.cidr", "overrides.docker.networks.lab.cidr"),
            ("volumes.data.virtiofs.cache", "overrides.proxmox.volumes.data.virtiofs.cache"),
            ("controller.image.vagrant", "overrides.vagrant.controller"),
            ("networks.lab.docker", "overrides.docker.networks.lab"),
            ("networks.lab.external", "overrides.docker.networks.lab.external"),
            ("networks.lab.cidr", "networks.lab.cidr"),
            ("volumes.data.external", "overrides.docker.volumes.data.external"),
            ("volumes.data.persistent", "volumes.data.persistent"),
            ("machines.web.docker.idle", "machines.web.os"),
            ("machines.web.docker.args.X", "machines.web.app.build"),
            ("machines.web.docker.generated", "machines.web.app"),
            ("machines.web.vm", "machines.web.os"),
            ("machines.web.vm.boot", "machines.web.hardware.boot"),
            ("machines.web.vm.boot.network", "machines.web.hardware.boot.network"),
            ("machines.web.vm.provision[2]", "machines.web.app.steps[2]"),
            ("machines.web.vm.setup", "machines.web.app"),
            ("machines.web.vm.image", "overrides.vagrant.machines.web"),
            ("machines.web.vm.image.vagrant_version", "overrides.vagrant.machines.web.box_version"),
            ("machines.web.vm.image.qemu", "overrides.vagrant.machines.web.boxes.qemu"),
            ("machines.web.vm.image.winrm", "overrides.vagrant.machines.web.winrm"),
            ("machines.web.vm.image.proxmox", "overrides.proxmox.machines.web.image"),
            ("machines.web.gpus", "machines.web.hardware.gpus"),
            ("machines.web.external.address", "overrides.external.machines.web.ssh"),
            ("machines.web.more_addresses.lan", "machines.web.networks.lan"),
            ("machines.web.environment.A", "machines.web.environment.A"),
            ("checks[2].from", "checks[2].from"),
        ] {
            assert_eq!(t.path(lowered).as_str(), written, "{lowered}");
        }
    }

    #[test]
    fn lowering_records_a_machines_ports_vm_steps_setup_and_inputs() {
        let lab = crate::testing::lab(
            "version: 1\nname: t\ninputs: { A: { sensitive: false }, B: {} }\nmachines:\n  web:\n    os: debian@12\n    ports: { site: 80, admin: 8080 }\n    environment: { X: x, A: { input: A } }\n    setup: [s.sh, t.sh]\n    app: { steps: [{ packages: [curl] }, { run: a.sh }, { copy: { from: f, to: /f } }, reboot] }\n",
        );
        let mut t = Trail::default();
        if let Some(m) = lab.source().machines.get("web") {
            t.machine("web", m);
        }
        t.inputs(lab.source());
        for (lowered, written) in [
            ("machines.web.ports[1].publish", "machines.web.ports.admin.publish"),
            ("machines.web.vm.provision[0]", "machines.web.app.steps[1]"),
            ("machines.web.vm.provision[1]", "machines.web.app.steps[3]"),
            ("machines.web.docker.init[1]", "machines.web.setup[1]"),
            ("machines.web.inputs[0]", "machines.web.environment.A"),
            ("inputs[1]", "inputs.B"),
            ("secrets.input-b", "inputs.B"),
        ] {
            assert_eq!(t.path(lowered).as_str(), written, "{lowered}");
        }
    }

    #[test]
    fn recorded_items_point_at_their_written_index() {
        let mut t = Trail::default();
        t.file("web", "secrets", 0, 2);
        t.record("machines.web.ports[0]".into(), "machines.web.ports.site".into());
        assert_eq!(t.path("machines.web.secrets[0].target").as_str(), "machines.web.files[2].path");
        assert_eq!(t.path("machines.web.ports[0].fixed").as_str(), "machines.web.ports.site.publish");
        assert_eq!(t.path("machines.web.ports[0]").as_str(), "machines.web.ports.site");
    }
}