isoloom-spec 1.0.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

use super::*;

fn app(yaml: &str) -> Result<App, String> {
    serde_yaml_ng::from_str(yaml).map_err(|e| e.to_string())
}

#[test]
fn an_app_is_an_image_a_build_an_appliance_or_steps() {
    assert_eq!(app("{ image: nginx:1.27 }").unwrap().container, Some(Recipe::Image("nginx:1.27".into())));
    let Some(Recipe::Build(folder)) = app("{ build: build/web }").unwrap().container else {
        panic!()
    };
    assert_eq!((folder.context.as_str(), folder.dockerfile), ("build/web", None));
    let Some(Recipe::Build(full)) = app("{ build: { context: build/web, dockerfile: w.Dockerfile, args: { TAG: x } } }")
        .unwrap()
        .container
    else {
        panic!()
    };
    assert_eq!(full.dockerfile.as_deref(), Some("w.Dockerfile"));
    let appliance = app("{ appliance: cisco-iol, image: vrnetlab/cisco_iol:17, config: r1.cfg }").unwrap();
    assert!(matches!(
        appliance.container,
        Some(Recipe::Appliance(ApplianceRecipe { kind: Appliance::CiscoIol, .. }))
    ));
    let steps = app("{ steps: [{ packages: [nginx] }, { copy: { from: site/, to: /var/www/ } }, { run: p.sh, creates: /done }, reboot, { playbook: p.yml }] }")
        .unwrap()
        .steps;
    assert_eq!(steps.len(), 5);
    assert_eq!(steps[3], Step::Reboot);
    assert!(steps[3].container_refusal().is_some() && steps[0].container_refusal().is_none());
}

#[test]
fn two_recipes_give_each_form_its_own() {
    let a = app("{ image: example/board:2.1, steps: [{ run: provision/board.sh }] }").unwrap();
    assert!(a.container.is_some() && a.steps.len() == 1);
}

#[test]
fn recipes_that_cannot_go_together_are_refused() {
    for (yaml, why) in [
        ("{ image: a, build: b }", "both given"),
        ("{}", "needs a recipe"),
        ("{ appliance: cisco-iol }", "runs its `image`"),
        ("{ appliance: cisco-dynamips, image: x, firmware: f }", "no `image`"),
        ("{ appliance: cisco-dynamips }", "needs the `firmware`"),
        ("{ image: a, config: c }", "goes with `appliance`"),
        ("{ image: a, firmware: f }", "cisco-dynamips"),
        ("{ steps: [{ run: a.sh, copy: { from: a, to: /a } }] }", "does one thing"),
        ("{ steps: [{ creates: /a }] }", "goes with `run`"),
        ("{ steps: [a.sh] }", "{ run: a.sh }"),
        ("{ steps: [{ shell: a }] }", "unknown field `shell`"),
    ] {
        let e = app(yaml).unwrap_err();
        assert!(e.contains(why), "{yaml}: {e}");
    }
}

#[test]
fn a_build_or_a_step_of_the_wrong_shape_says_what_is_expected() {
    let build = app("{ build: [a] }").unwrap_err();
    assert!(build.contains("a project folder, or `{ context, dockerfile, target, args }`"), "{build}");
    let step = app("{ steps: [[a]] }").unwrap_err();
    assert!(
        step.contains("`reboot`, or a map with one of `run`, `copy`, `packages`, `playbook`, `repository`"),
        "{step}"
    );
    let nothing = app("{ steps: [{}] }").unwrap_err();
    assert!(nothing.contains("a step needs one of `run`, `copy`, `packages`, `playbook`"), "{nothing}");
}

#[test]
fn a_step_without_a_container_form_says_why() {
    let refusal = |yaml: &str| app(yaml).unwrap().steps[0].container_refusal();
    assert_eq!(refusal("{ steps: [{ playbook: p.yml }] }"), Some("a playbook step runs in a VM only in 1.0"));
    assert_eq!(
        refusal("{ steps: [{ run: iis.PS1 }] }"),
        Some("a PowerShell script means Windows, which has no container form in 1.0")
    );
    assert_eq!(refusal("{ steps: [{ run: web.sh }] }"), None);
    assert_eq!(refusal("{ steps: [{ copy: { from: a, to: /a } }] }"), None);
}