helm-schema-gen 0.0.6

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
140
141
142
143
144
145
146

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

use super::*;

#[test]
fn candidate_preserves_provider_source_leaf_schema() {
    let source_schema = json!({ "$ref": "#/definitions/StringMap" });
    let fragment = ProviderSchemaFragment::new(json!({
        "type": "object",
        "additionalProperties": { "type": "string" }
    }))
    .with_source_definition_schema(
        ProviderSchemaSource::kubernetes_openapi(
            "default",
            "v1.35.0",
            "source.json",
            "/definitions/Container/properties/env",
        ),
        source_schema.clone(),
        source_schema.clone(),
    );

    let candidate = ProviderSchemaCandidate::from_provider_fragment(fragment);

    sim_assert_eq!(
        have: candidate.source().map(ProviderSchemaSource::pointer),
        want: Some("/definitions/Container/properties/env")
    );
    sim_assert_eq!(
        have: candidate.source_definition_schema(),
        want: None,
        "source leaf refs to provider-document siblings are not self-contained at output root"
    );
}

#[test]
fn candidate_exposes_provider_source_leaf_with_only_internal_refs() {
    let source_schema = json!({
        "type": "object",
        "properties": {
            "labels": { "$ref": "#/$defs/StringMap" }
        },
        "$defs": {
            "StringMap": {
                "type": "object",
                "additionalProperties": { "type": "string" }
            }
        }
    });
    let fragment = ProviderSchemaFragment::new(json!({
        "type": "object",
        "properties": {
            "labels": {
                "type": "object",
                "additionalProperties": { "type": "string" }
            }
        }
    }))
    .with_source_definition_schema(
        ProviderSchemaSource::kubernetes_openapi(
            "default",
            "v1.35.0",
            "source.json",
            "/definitions/Metadata",
        ),
        source_schema.clone(),
        source_schema.clone(),
    );

    let candidate = ProviderSchemaCandidate::from_provider_fragment(fragment);

    sim_assert_eq!(have: candidate.source_definition_schema(), want: Some(&source_schema));
}

#[test]
fn rewrites_internal_source_refs_for_root_definition_location() {
    let source_schema = json!({
        "type": "object",
        "properties": {
            "labels": { "$ref": "#/$defs/StringMap" }
        },
        "$defs": {
            "StringMap": {
                "type": "object",
                "additionalProperties": { "type": "string" }
            }
        }
    });

    let rewritten =
        rewrite_internal_refs_for_root_definition(&source_schema, "provider/source~name")
            .expect("internal refs can be relocated under a root definition");

    sim_assert_eq!(
        have: rewritten.pointer("/properties/labels/$ref"),
        want: Some(&Value::String(
            "#/$defs/provider~1source~0name/$defs/StringMap".to_string()
        ))
    );
}

#[test]
fn source_ref_rewrite_ignores_ref_shaped_enum_data() {
    let source_schema = json!({
        "type": "object",
        "enum": [
            { "$ref": "#/not/a/schema/ref" }
        ],
        "properties": {
            "name": { "type": "string" }
        }
    });

    let rewritten = rewrite_internal_refs_for_root_definition(&source_schema, "providerSource")
        .expect("ref-shaped enum data is not schema structure");

    sim_assert_eq!(
        have: rewritten.pointer("/enum/0/$ref"),
        want: Some(&Value::String("#/not/a/schema/ref".to_string()))
    );
}

#[test]
fn source_ref_rewrite_treats_property_names_as_schema_map_keys() {
    let source_schema = json!({
        "type": "object",
        "$defs": {
            "StringValue": { "type": "string" }
        },
        "properties": {
            "enum": { "$ref": "#/$defs/StringValue" }
        }
    });

    let rewritten = rewrite_internal_refs_for_root_definition(&source_schema, "providerSource")
        .expect("property schemas are traversed independent of property name");

    sim_assert_eq!(
        have: rewritten.pointer("/properties/enum/$ref"),
        want: Some(&Value::String(
            "#/$defs/providerSource/$defs/StringValue".to_string()
        ))
    );
}