helm-schema-k8s 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use serde_json::json;
use test_util::prelude::sim_assert_eq;

use super::*;

fn universe_from_crd_documents<I: IntoIterator<Item = serde_json::Value>>(
    documents: I,
) -> LocalSchemaUniverse {
    let mut universe = LocalSchemaUniverse::default();
    for document in documents {
        for resource_schema in crate::resource_schemas_from_crd_document_with_source(
            &document,
            "chart-local",
            String::new(),
        ) {
            universe.insert_resource_schema(resource_schema);
        }
    }
    universe
}

fn resource(api_version: &str) -> ResourceRef {
    ResourceRef::concrete(api_version.to_string(), "Widget".to_string())
}

fn widget_universe() -> LocalSchemaUniverse {
    universe_from_crd_documents([json!({
        "apiVersion": "apiextensions.k8s.io/v1",
        "kind": "CustomResourceDefinition",
        "spec": {
            "group": "example.com",
            "names": {"kind": "Widget"},
            "versions": [
                {
                    "name": "v1",
                    "served": true,
                    "schema": {
                        "openAPIV3Schema": {
                            "type": "object",
                            "properties": {
                                "spec": {
                                    "type": "object",
                                    "properties": {
                                        "size": {"type": "integer"}
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        }
    })])
}

#[test]
fn resolves_served_crd_version_schema_from_universe() {
    let provider = ChartLocalCrdSchemaProvider::new(widget_universe());

    let schema = provider.lookup(
        &resource("example.com/v1"),
        &YamlPath(vec!["spec".to_string(), "size".to_string()]),
    );

    let ProviderLookupResult::Found { schema, .. } = schema else {
        panic!("chart-local provider should resolve spec.size");
    };
    sim_assert_eq!(
        have: schema.into_schema(),
        want: json!({"type": "integer"})
    );
}

#[test]
fn lookup_attaches_chart_local_provider_source() {
    let mut universe = LocalSchemaUniverse::default();
    for resource_schema in crate::resource_schemas_from_crd_document_with_source(
        &json!({
            "apiVersion": "apiextensions.k8s.io/v1",
            "kind": "CustomResourceDefinition",
            "spec": {
                "group": "example.com",
                "names": {"kind": "Widget"},
                "versions": [
                    {
                        "name": "v1",
                        "served": true,
                        "schema": {
                            "openAPIV3Schema": {
                                "type": "object",
                                "properties": {
                                    "spec": {
                                        "type": "object",
                                        "properties": {
                                            "size": {"type": "integer"}
                                        }
                                    }
                                }
                            }
                        }
                    }
                ]
            }
        }),
        "chart-static-crd",
        "/chart/crds/widgets.yaml",
    ) {
        universe.insert_resource_schema(resource_schema);
    }
    let provider = ChartLocalCrdSchemaProvider::new(universe);

    let result = provider.lookup(
        &resource("example.com/v1"),
        &YamlPath(vec!["spec".to_string(), "size".to_string()]),
    );
    let ProviderLookupResult::Found { schema, .. } = result else {
        panic!("chart-local lookup should resolve spec.size");
    };
    let source = schema.source().expect("chart-local source should attach");

    sim_assert_eq!(have: source.origin(), want: ProviderOrigin::ChartLocalCrd);
    sim_assert_eq!(have: source.source_id(), want: "chart-static-crd");
    sim_assert_eq!(have: source.filename(), want: "/chart/crds/widgets.yaml");
    sim_assert_eq!(have: source.pointer(), want: "/properties/spec/properties/size");
}

#[test]
fn api_version_guess_uses_chart_local_crd_origin() {
    let provider = ChartLocalCrdSchemaProvider::new(widget_universe()).with_api_version_guess(true);

    sim_assert_eq!(
        have: provider.infer_api_version_candidates("Widget"),
        want: vec![ApiVersionCandidate {
            api_version: "example.com/v1".to_string(),
            source: InferenceSource::ChartLocalCrd,
            origin: ProviderOrigin::ChartLocalCrd,
        }]
    );
}