nyl 0.4.0

Kubernetes manifest generator with Helm integration
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

/// Integration tests for resource validation and error reporting
use nyl::resources::{HelmChart, NylRelease};
use nyl::util::SourceContext;
use std::path::PathBuf;

#[test]
fn test_unknown_field_in_helmchart() {
    // Create a HelmChart with an unknown field
    let yaml = r#"
apiVersion: nyl.niklasrosenstein.github.com/v1
kind: HelmChart
metadata:
  name: test-app
spec:
  chart:
    name: mychart
  unknownField: this-should-fail
"#;

    let source_ctx = SourceContext::new(PathBuf::from("/test/manifests/app.yaml"));
    let result: nyl::Result<HelmChart> = source_ctx.parse_yaml(yaml);

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    println!("Error message: {err_msg}");

    // Verify error message contains file path
    assert!(err_msg.contains("app.yaml"), "Error should contain file path");
    // Verify it mentions unknown field
    assert!(
        err_msg.contains("unknown field") || err_msg.contains("Unknown field"),
        "Error should mention unknown field: {err_msg}"
    );
    // Verify it has a hint
    assert!(err_msg.contains("Hint:"), "Error should contain a hint");
}

#[test]
fn test_unknown_field_in_nested_struct() {
    // Create a HelmChart with an unknown field in the chart spec
    let yaml = r#"
apiVersion: nyl.niklasrosenstein.github.com/v1
kind: HelmChart
metadata:
  name: test-app
spec:
  chart:
    name: mychart
    version: "1.0.0"
    invalidField: should-fail
"#;

    let source_ctx = SourceContext::new(PathBuf::from("/test/manifests/nested.yaml"));
    let result: nyl::Result<HelmChart> = source_ctx.parse_yaml(yaml);

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    println!("Error message: {err_msg}");

    // Verify error message contains useful information
    assert!(err_msg.contains("nested.yaml"), "Error should contain file path");
    assert!(
        err_msg.contains("unknown field") || err_msg.contains("Unknown field"),
        "Error should mention unknown field: {err_msg}"
    );
    assert!(err_msg.contains("Hint:"), "Error should contain a hint");
}

#[test]
fn test_type_mismatch_error() {
    // Create a HelmChart with a type mismatch (metadata should be object, not string)
    let yaml = r#"
apiVersion: nyl.niklasrosenstein.github.com/v1
kind: HelmChart
metadata: "this should be an object not a string"
spec:
  chart:
    name: mychart
"#;

    let source_ctx = SourceContext::new(PathBuf::from("/test/manifests/types.yaml"));
    let result: nyl::Result<HelmChart> = source_ctx.parse_yaml(yaml);

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    println!("Error message: {err_msg}");

    // Verify error message contains file path and hints about type
    assert!(err_msg.contains("types.yaml"), "Error should contain file path");
    assert!(err_msg.contains("Hint:"), "Error should contain a hint");
}

#[test]
fn test_nyl_release_unknown_field() {
    // Create a NylRelease with an unknown field
    let yaml = r#"
apiVersion: nyl.niklasrosenstein.github.com/v1
kind: NylRelease
metadata:
  name: my-release
  namespace: production
  extraField: not-allowed
"#;

    let source_ctx = SourceContext::new(PathBuf::from("/test/manifests/release.yaml"));
    let result: nyl::Result<NylRelease> = source_ctx.parse_yaml(yaml);

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    println!("Error message: {err_msg}");

    assert!(err_msg.contains("release.yaml"), "Error should contain file path");
    assert!(
        err_msg.contains("unknown field") || err_msg.contains("Unknown field"),
        "Error should mention unknown field: {err_msg}"
    );
    assert!(err_msg.contains("Hint:"), "Error should contain a hint");
}

#[test]
fn test_valid_manifest_succeeds() {
    // Create a valid HelmChart
    let yaml = r#"
apiVersion: nyl.niklasrosenstein.github.com/v1
kind: HelmChart
metadata:
  name: test-app
spec:
  chart:
    name: mychart
  values:
    replicaCount: 2
"#;

    let source_ctx = SourceContext::new(PathBuf::from("/test/manifests/valid.yaml"));
    let result: nyl::Result<HelmChart> = source_ctx.parse_yaml(yaml);

    // This should succeed
    assert!(result.is_ok(), "Valid manifest should parse successfully");
    let chart = result.unwrap();
    assert_eq!(chart.metadata.name, "test-app");
}

#[test]
fn test_error_message_has_helpful_hint() {
    // Test that the error message provides actionable hints
    let yaml = r#"
apiVersion: nyl.niklasrosenstein.github.com/v1
kind: HelmChart
metadata:
  name: test-app
spec:
  chart:
    name: mychart
  char: wrong-field-name
"#;

    let source_ctx = SourceContext::new(PathBuf::from("/test/manifests/typo.yaml"));
    let result: nyl::Result<HelmChart> = source_ctx.parse_yaml(yaml);

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    println!("Error message: {err_msg}");

    // The hint should suggest checking for typos
    assert!(
        err_msg.contains("typo") || err_msg.contains("API documentation"),
        "Error should suggest checking for typos or documentation: {err_msg}"
    );
}