garden-tools 0.5.0

Garden grows and cultivates collections of Git trees Garden lets you define and run commands over collections of configuration-defined multi-worktree Git environments.
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

use anyhow::Result;

#[test]
fn read_includes() -> Result<()> {
    let app = garden::build::context_from_path("tests/data/garden.yaml")?;
    let config = app.get_root_config();

    // var_0 is from the included variables.yaml..
    let actual = garden::eval::value(config, "${var_0}");
    assert_eq!(actual, "zero");
    // var_1 is provided by variables-transitive.yaml and overridden by includes.yaml.
    let actual = garden::eval::value(config, "${var_1}");
    assert_eq!(actual, "ONE");
    // var_2 is provided by variables-transitive.yaml.
    let actual = garden::eval::value(config, "${var_2}");
    assert_eq!(actual, "two");

    // Trees are provided by included configs.
    assert!(config.trees.len() >= 2);
    // trees[0] is included from trees.yaml.
    assert_eq!(config.trees[0].get_name(), "tree-zero");
    // trees[3] is from the main config.
    assert_eq!(config.trees[3].get_name(), "example/tree");

    // Nested include files are relative to the file that included them.
    // If the nested include file is not found relative to the parent include file
    // then a file relative to the config directory can be used.
    let actual = garden::eval::value(config, "${var_included}");
    assert_eq!(actual, "relative to config");

    Ok(())
}

/// Ensure that templates can be included.
#[test]
fn template_includes() -> Result<()> {
    let app = garden::build::context_from_path("tests/data/garden.yaml")?;
    let config_id = app.get_root_id();
    let context = garden::query::find_tree(&app, config_id, "tree-echo", None)?;
    let config = app.get_root_config();

    let tree = &config.trees[context.tree];
    let result = garden::eval::tree_value(config, "${template-variable}", context.tree, None);
    assert_eq!(result, "template");
    let constant = garden::eval::tree_value(config, "${template-constant}", context.tree, None);
    assert_eq!(constant, "constant");
    assert_eq!(tree.commands.len(), 1);
    assert_eq!(tree.commands[0].get_name(), "echo");
    assert_eq!(
        tree.commands[0].get(0).get_expr(),
        "echo Hello, ${TREE_NAME}"
    );

    // Test a template that uses "extend" on a template defined via an include file.
    // The "tree-echo-extended" uses "extend: tree-echo".
    let context = garden::query::find_tree(&app, config_id, "tree-echo-extended", None)?;
    let tree = &config.trees[context.tree];
    let result = garden::eval::tree_value(config, "${template-variable}", context.tree, None);
    let constant = garden::eval::tree_value(config, "${template-constant}", context.tree, None);
    assert_eq!(result, "extended");
    assert_eq!(constant, "constant");
    assert_eq!(tree.commands.len(), 2);
    assert_eq!(tree.commands[0].get_name(), "echo");
    assert_eq!(
        tree.commands[0].get(0).get_expr(),
        "echo Hello, ${TREE_NAME}"
    );
    assert_eq!(tree.commands[1].get_name(), "echo");
    assert_eq!(tree.commands[1].get(0).get_expr(), "echo extended");

    // Test a tree that uses "templates" with a template from a nested include file.
    let context = garden::query::find_tree(&app, config_id, "tree-echo-nested", None)?;
    let tree = &config.trees[context.tree];
    let result = garden::eval::tree_value(config, "${template-variable}", context.tree, None);
    let constant = garden::eval::tree_value(config, "${template-constant}", context.tree, None);
    assert_eq!(constant, "constant");
    assert_eq!(result, "nested");
    assert_eq!(tree.commands.len(), 1);
    assert_eq!(tree.commands[0].get_name(), "echo");
    assert_eq!(
        tree.commands[0].get(0).get_expr(),
        "echo Hello, ${TREE_NAME}"
    );

    // Test a tree that uses "extend" on a tree defined via an include file.
    let context = garden::query::find_tree(&app, config_id, "tree-echo-extended-tree", None)?;
    let result = garden::eval::tree_value(config, "${template-variable}", context.tree, None);
    assert_eq!(result, "extended-tree");

    let result = garden::eval::tree_value(config, "${tree-variable}", context.tree, None);
    assert_eq!(result, "nested");

    let result = garden::eval::tree_value(config, "${tree-override}", context.tree, None);
    assert_eq!(result, "extended-tree");

    Ok(())
}