isoloom-spec 0.11.1

The Isoloom spec: model, parsing, normalization and validation.
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

use super::*;

fn scanned(yaml: &str) -> Vec<Problem> {
    scan(&serde_yaml_ng::from_str(yaml).unwrap())
}

#[test]
fn a_docker_block_gets_its_app() {
    let p = scanned("machines:\n  web:\n    docker: { build: build/web, init: [flag.sh] }\n");
    assert_eq!((p[0].code, p[0].path.as_str()), (Code::RemovedField, "machines.web.docker"));
    let fix = p[0].fix.as_deref().unwrap();
    assert!(
        fix.contains("`app: { build: build/web }`") && fix.contains("setup") && fix.contains("input"),
        "{fix}"
    );
    let idle = scanned("machines:\n  bench:\n    docker: { image: alpine:3.20, idle: true }\n");
    assert!(idle[0].fix.as_deref().unwrap().contains("`os: <family>@<version>` alone"));
}

#[test]
fn a_vm_block_gets_its_os_and_steps() {
    let p = scanned("machines:\n  cache:\n    vm: { os: debian@12, provision: [a.sh, reboot, b.yml], tpm: true }\n");
    let fix = p[0].fix.as_deref().unwrap();
    assert!(
        fix.contains("`os: debian@12`") && fix.contains("[{ run: a.sh }, reboot, { playbook: b.yml }]") && fix.contains("tpm: required"),
        "{fix}"
    );
}

#[test]
fn a_list_of_ports_becomes_a_map() {
    let p = scanned("machines:\n  web:\n    ports: [{ port: 80, http: true, publish: 8080 }, { port: 3206, name: portal, publish: 3206, fixed: true }]\n");
    assert_eq!(p[0].code, Code::InvalidValue);
    let fix = p[0].fix.as_deref().unwrap();
    assert!(fix.contains("p80: { port: 80, protocol: http, publish: 8080 }"), "{fix}");
    assert!(fix.contains("portal: { port: 3206, publish: { host: 3206, fixed: true } }"), "{fix}");
}

#[test]
fn moved_keys_name_their_new_place() {
    let p = scanned(
        "networks:\n  lab: { cidr: 192.168.1.0/24, docker: { cidr: 10.1.0.0/24 } }\nvolumes:\n  data: { external: shared }\ncommon:\n  vm: { os: debian }\n  inputs: [FLAG]\ncontroller: { image: { vagrant: x } }\nmachines:\n  web: { arch: arm64, inputs: [FLAG], external: { address: 1.2.3.4 } }\n",
    );
    let paths: Vec<&str> = p.iter().map(|p| p.path.as_str()).collect();
    for path in [
        "machines.web.external",
        "machines.web.inputs",
        "machines.web.arch",
        "common.inputs",
        "common.vm",
        "networks.lab.docker",
        "volumes.data.external",
        "controller.image",
    ] {
        assert!(paths.contains(&path), "{path} in {paths:?}");
    }
    assert!(p.iter().all(|p| p.fix.is_some()));
}

#[test]
fn a_spec_in_the_new_form_has_none() {
    assert_eq!(scanned("machines:\n  web: { os: debian@12, app: { image: nginx }, ports: { web: 80 } }\n"), []);
}

#[test]
fn a_docker_build_with_its_dockerfile_keeps_it_in_full() {
    for extra in ["dockerfile: web.Dockerfile", "args: { A: b }", "target: prod"] {
        let p = scanned(&format!("machines:\n  web:\n    docker: {{ build: build/web, {extra} }}\n"));
        let fix = p[0].fix.as_deref().unwrap();
        assert!(
            fix.contains("`app: { build: { context: build/web, dockerfile, target, args } }`"),
            "{extra}: {fix}"
        );
    }
    let lxc = scanned("machines:\n  web:\n    docker: { image: nginx, lxc: true }\n");
    assert!(
        lxc[0]
            .fix
            .as_deref()
            .unwrap()
            .contains("`overrides: { proxmox: { machines: { web: { lxc: true } } } }`")
    );
    let idle_off = scanned("machines:\n  web:\n    docker: { image: nginx, idle: false }\n");
    assert_eq!(idle_off[0].fix.as_deref(), Some("`app: { image: nginx }`"));
}

#[test]
fn listed_ports_keep_their_protocol_in_the_map() {
    let fix = |port: &str| scanned(&format!("machines:\n  web:\n    ports: [{port}]\n"))[0].fix.clone().unwrap();
    assert_eq!(fix("{ port: 53, protocol: udp, http: true }"), "`ports: { p53: { port: 53, protocol: udp } }`");
    assert_eq!(fix("{ port: 443, http: true, tls: true }"), "`ports: { p443: { port: 443, protocol: https } }`");
    assert_eq!(fix("{ port: 80, http: true }"), "`ports: { p80: { port: 80, protocol: http } }`");
    assert_eq!(fix("{ port: 636, tls: true }"), "`ports: { p636: { port: 636, protocol: tls } }`");
    assert_eq!(fix("{ port: 22 }"), "`ports: { p22: { port: 22 } }`");
}