helm-schema 0.0.4

Generate an accurate JSON schema for any helm chart
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

use color_eyre::eyre;
use indoc::indoc;

use super::build_composed_values_yaml;
use crate::chart::ChartContext;
use crate::chart::discover_chart_contexts;
use test_util::prelude::sim_assert_eq;
use vfs::VfsPath;

fn yaml_pointer<'a>(doc: &'a serde_yaml::Value, path: &[&str]) -> Option<&'a serde_yaml::Value> {
    let mut current = doc;
    for segment in path {
        let map = current.as_mapping()?;
        current = map.get(serde_yaml::Value::String((*segment).to_string()))?;
    }
    Some(current)
}

fn discover(chart_dir: &VfsPath) -> eyre::Result<Vec<ChartContext>> {
    Ok(discover_chart_contexts(chart_dir)?)
}

#[test]
fn composed_subchart_globals_preserve_parent_explicit_null_defaults() -> eyre::Result<()> {
    let chart_dir = VfsPath::new(vfs::MemoryFS::new());
    test_util::write(
        &chart_dir.join("Chart.yaml")?,
        indoc! {"
            apiVersion: v2
            name: root
            version: 0.1.0
        "},
    )?;
    test_util::write(
        &chart_dir.join("values.yaml")?,
        indoc! {"
            global:
              imageRegistry:
        "},
    )?;
    test_util::write(
        &chart_dir.join("charts/child/Chart.yaml")?,
        indoc! {"
            apiVersion: v2
            name: child
            version: 0.1.0
        "},
    )?;
    test_util::write(
        &chart_dir.join("charts/child/values.yaml")?,
        indoc! {"
            global:
              imageRegistry: docker.io
        "},
    )?;

    let composed =
        build_composed_values_yaml(&discover(&chart_dir)?, true)?.expect("composed values yaml");
    let doc: serde_yaml::Value = serde_yaml::from_str(&composed)?;

    assert!(
        yaml_pointer(&doc, &["global", "imageRegistry"]).is_some_and(serde_yaml::Value::is_null),
        "root explicit null should remain authoritative: {doc:?}"
    );
    assert!(
        yaml_pointer(&doc, &["child", "global", "imageRegistry"])
            .is_some_and(serde_yaml::Value::is_null),
        "subchart global mirror should preserve the parent explicit null: {doc:?}"
    );

    Ok(())
}

#[test]
fn composed_subchart_globals_hoist_when_parent_key_is_absent() -> eyre::Result<()> {
    let chart_dir = VfsPath::new(vfs::MemoryFS::new());
    test_util::write(
        &chart_dir.join("Chart.yaml")?,
        indoc! {"
            apiVersion: v2
            name: root
            version: 0.1.0
        "},
    )?;
    test_util::write(&chart_dir.join("values.yaml")?, "{}\n")?;
    test_util::write(
        &chart_dir.join("charts/child/Chart.yaml")?,
        indoc! {"
            apiVersion: v2
            name: child
            version: 0.1.0
        "},
    )?;
    test_util::write(
        &chart_dir.join("charts/child/values.yaml")?,
        indoc! {"
            global:
              imageRegistry: docker.io
        "},
    )?;

    let composed =
        build_composed_values_yaml(&discover(&chart_dir)?, true)?.expect("composed values yaml");
    let doc: serde_yaml::Value = serde_yaml::from_str(&composed)?;

    sim_assert_eq!(
        have: yaml_pointer(&doc, &["global", "imageRegistry"]),
        want: Some(&serde_yaml::Value::String("docker.io".to_string()))
    );
    sim_assert_eq!(
        have: yaml_pointer(&doc, &["child", "global", "imageRegistry"]),
        want: Some(&serde_yaml::Value::String("docker.io".to_string()))
    );

    Ok(())
}