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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
use serde::{Deserialize, Serialize};
use std::hash::{Hash, Hasher};

use crate::{NylError, Result};

/// Group, Version, Kind tuple for Kubernetes resources
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct GroupVersionKind {
    pub group: String,
    pub version: String,
    pub kind: String,
}

impl GroupVersionKind {
    /// Parse GVK from apiVersion and kind fields
    /// apiVersion can be "v1" or "apps/v1"
    pub fn from_api_version_kind(api_version: &str, kind: &str) -> Result<Self> {
        let (group, version) = if api_version.contains('/') {
            let parts: Vec<&str> = api_version.splitn(2, '/').collect();
            (parts[0].to_string(), parts[1].to_string())
        } else {
            (String::new(), api_version.to_string())
        };

        Ok(Self {
            group,
            version,
            kind: kind.to_string(),
        })
    }

    /// Convert to apiVersion string (e.g., "v1" or "apps/v1")
    pub fn to_api_version(&self) -> String {
        if self.group.is_empty() {
            self.version.clone()
        } else {
            format!("{}/{}", self.group, self.version)
        }
    }

    /// Convert to full string representation (e.g., "v1/ConfigMap" or "apps/v1/Deployment")
    pub fn format(&self) -> String {
        format!("{}/{}", self.to_api_version(), self.kind)
    }
}

impl std::fmt::Display for GroupVersionKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}/{}", self.to_api_version(), self.kind)
    }
}

impl Hash for GroupVersionKind {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.group.hash(state);
        self.version.hash(state);
        self.kind.hash(state);
    }
}

/// Unique identifier for a Kubernetes resource
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ResourceKey {
    pub gvk: GroupVersionKind,
    pub namespace: Option<String>,
    pub name: String,
}

impl ResourceKey {
    /// Extract ResourceKey from a JSON manifest
    pub fn from_json_value(value: &serde_json::Value) -> Result<Self> {
        let api_version = extract_api_version(value)?;
        let kind = extract_kind(value)?;
        let gvk = GroupVersionKind::from_api_version_kind(&api_version, &kind)?;

        let name = extract_name(value)?;
        let namespace = extract_namespace(value);

        Ok(Self { gvk, namespace, name })
    }

    /// Convert to string representation (e.g., "ConfigMap default/myconfig")
    pub fn format(&self) -> String {
        let ns_name = if let Some(ns) = &self.namespace {
            format!("{}/{}", ns, self.name)
        } else {
            self.name.clone()
        };
        format!("{} {}", self.gvk.kind, ns_name)
    }
}

impl std::fmt::Display for ResourceKey {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let ns_name = if let Some(ns) = &self.namespace {
            format!("{}/{}", ns, self.name)
        } else {
            self.name.clone()
        };
        write!(f, "{} {}", self.gvk.kind, ns_name)
    }
}

/// Outcome of applying a resource
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ApplyOutcome {
    /// Resource was created
    Created { resource_key: ResourceKey },
    /// Resource was updated
    Updated { resource_key: ResourceKey },
    /// Resource was unchanged
    Unchanged { resource_key: ResourceKey },
    /// Dry run mode - shows what would happen
    DryRun { would_be: Box<ApplyOutcome> },
}

impl ApplyOutcome {
    /// Get the resource key
    pub fn resource_key(&self) -> &ResourceKey {
        match self {
            ApplyOutcome::Created { resource_key }
            | ApplyOutcome::Updated { resource_key }
            | ApplyOutcome::Unchanged { resource_key } => resource_key,
            ApplyOutcome::DryRun { would_be } => would_be.resource_key(),
        }
    }

    /// Get the resource kind
    pub fn kind(&self) -> &str {
        &self.resource_key().gvk.kind
    }

    /// Get the resource name
    pub fn name(&self) -> &str {
        &self.resource_key().name
    }

    /// Get the resource namespace
    pub fn namespace(&self) -> Option<&str> {
        self.resource_key().namespace.as_deref()
    }

    /// Check if this is a dry run outcome
    pub fn is_dry_run(&self) -> bool {
        matches!(self, ApplyOutcome::DryRun { .. })
    }
}

// Helper functions for extracting fields from manifests

/// Extract apiVersion from a manifest
pub fn extract_api_version(value: &serde_json::Value) -> Result<String> {
    value
        .get("apiVersion")
        .and_then(|v| v.as_str())
        .map(|s| s.to_string())
        .ok_or_else(|| NylError::Config("Manifest missing apiVersion field".to_string()))
}

/// Extract kind from a manifest
pub fn extract_kind(value: &serde_json::Value) -> Result<String> {
    value
        .get("kind")
        .and_then(|v| v.as_str())
        .map(|s| s.to_string())
        .ok_or_else(|| NylError::Config("Manifest missing kind field".to_string()))
}

/// Extract name from a manifest
pub fn extract_name(value: &serde_json::Value) -> Result<String> {
    value
        .get("metadata")
        .and_then(|m| m.get("name"))
        .and_then(|v| v.as_str())
        .map(|s| s.to_string())
        .ok_or_else(|| NylError::Config("Manifest missing metadata.name field".to_string()))
}

/// Extract namespace from a manifest (returns None for cluster-scoped resources)
pub fn extract_namespace(value: &serde_json::Value) -> Option<String> {
    value
        .get("metadata")
        .and_then(|m| m.get("namespace"))
        .and_then(|v| v.as_str())
        .map(|s| s.to_string())
}

/// Extract GVK from a manifest
pub fn extract_gvk(value: &serde_json::Value) -> Result<GroupVersionKind> {
    let api_version = extract_api_version(value)?;
    let kind = extract_kind(value)?;
    GroupVersionKind::from_api_version_kind(&api_version, &kind)
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn test_gvk_from_api_version_core() {
        let gvk = GroupVersionKind::from_api_version_kind("v1", "ConfigMap").unwrap();
        assert_eq!(gvk.group, "");
        assert_eq!(gvk.version, "v1");
        assert_eq!(gvk.kind, "ConfigMap");
    }

    #[test]
    fn test_gvk_from_api_version_with_group() {
        let gvk = GroupVersionKind::from_api_version_kind("apps/v1", "Deployment").unwrap();
        assert_eq!(gvk.group, "apps");
        assert_eq!(gvk.version, "v1");
        assert_eq!(gvk.kind, "Deployment");
    }

    #[test]
    fn test_gvk_to_api_version_core() {
        let gvk = GroupVersionKind {
            group: String::new(),
            version: "v1".to_string(),
            kind: "ConfigMap".to_string(),
        };
        assert_eq!(gvk.to_api_version(), "v1");
    }

    #[test]
    fn test_gvk_to_api_version_with_group() {
        let gvk = GroupVersionKind {
            group: "apps".to_string(),
            version: "v1".to_string(),
            kind: "Deployment".to_string(),
        };
        assert_eq!(gvk.to_api_version(), "apps/v1");
    }

    #[test]
    fn test_gvk_to_string() {
        let gvk = GroupVersionKind {
            group: "apps".to_string(),
            version: "v1".to_string(),
            kind: "Deployment".to_string(),
        };
        assert_eq!(gvk.to_string(), "apps/v1/Deployment");
    }

    #[test]
    fn test_resource_key_from_json_namespaced() {
        let manifest = json!({
            "apiVersion": "v1",
            "kind": "ConfigMap",
            "metadata": {
                "name": "myconfig",
                "namespace": "default"
            }
        });

        let key = ResourceKey::from_json_value(&manifest).unwrap();
        assert_eq!(key.gvk.kind, "ConfigMap");
        assert_eq!(key.name, "myconfig");
        assert_eq!(key.namespace, Some("default".to_string()));
    }

    #[test]
    fn test_resource_key_from_json_cluster_scoped() {
        let manifest = json!({
            "apiVersion": "v1",
            "kind": "Namespace",
            "metadata": {
                "name": "mynamespace"
            }
        });

        let key = ResourceKey::from_json_value(&manifest).unwrap();
        assert_eq!(key.gvk.kind, "Namespace");
        assert_eq!(key.name, "mynamespace");
        assert_eq!(key.namespace, None);
    }

    #[test]
    fn test_extract_api_version() {
        let manifest = json!({"apiVersion": "apps/v1"});
        assert_eq!(extract_api_version(&manifest).unwrap(), "apps/v1");
    }

    #[test]
    fn test_extract_kind() {
        let manifest = json!({"kind": "Deployment"});
        assert_eq!(extract_kind(&manifest).unwrap(), "Deployment");
    }

    #[test]
    fn test_extract_name() {
        let manifest = json!({"metadata": {"name": "test"}});
        assert_eq!(extract_name(&manifest).unwrap(), "test");
    }

    #[test]
    fn test_extract_namespace_present() {
        let manifest = json!({"metadata": {"namespace": "default"}});
        assert_eq!(extract_namespace(&manifest), Some("default".to_string()));
    }

    #[test]
    fn test_extract_namespace_missing() {
        let manifest = json!({"metadata": {"name": "test"}});
        assert_eq!(extract_namespace(&manifest), None);
    }

    #[test]
    fn test_extract_gvk() {
        let manifest = json!({
            "apiVersion": "apps/v1",
            "kind": "Deployment"
        });

        let gvk = extract_gvk(&manifest).unwrap();
        assert_eq!(gvk.group, "apps");
        assert_eq!(gvk.version, "v1");
        assert_eq!(gvk.kind, "Deployment");
    }

    #[test]
    fn test_resource_key_to_string_namespaced() {
        let key = ResourceKey {
            gvk: GroupVersionKind {
                group: String::new(),
                version: "v1".to_string(),
                kind: "ConfigMap".to_string(),
            },
            namespace: Some("default".to_string()),
            name: "myconfig".to_string(),
        };
        assert_eq!(key.to_string(), "ConfigMap default/myconfig");
    }

    #[test]
    fn test_resource_key_to_string_cluster_scoped() {
        let key = ResourceKey {
            gvk: GroupVersionKind {
                group: String::new(),
                version: "v1".to_string(),
                kind: "Namespace".to_string(),
            },
            namespace: None,
            name: "mynamespace".to_string(),
        };
        assert_eq!(key.to_string(), "Namespace mynamespace");
    }

    #[test]
    fn test_apply_outcome_kind() {
        let resource_key = ResourceKey {
            gvk: GroupVersionKind {
                group: String::new(),
                version: "v1".to_string(),
                kind: "ConfigMap".to_string(),
            },
            namespace: Some("default".to_string()),
            name: "test".to_string(),
        };
        let outcome = ApplyOutcome::Created { resource_key };
        assert_eq!(outcome.kind(), "ConfigMap");
    }

    #[test]
    fn test_apply_outcome_name() {
        let resource_key = ResourceKey {
            gvk: GroupVersionKind {
                group: String::new(),
                version: "v1".to_string(),
                kind: "ConfigMap".to_string(),
            },
            namespace: Some("default".to_string()),
            name: "test".to_string(),
        };
        let outcome = ApplyOutcome::Created { resource_key };
        assert_eq!(outcome.name(), "test");
    }

    #[test]
    fn test_apply_outcome_namespace() {
        let resource_key = ResourceKey {
            gvk: GroupVersionKind {
                group: "apps".to_string(),
                version: "v1".to_string(),
                kind: "Deployment".to_string(),
            },
            namespace: Some("default".to_string()),
            name: "test".to_string(),
        };
        let outcome = ApplyOutcome::Updated { resource_key };
        assert_eq!(outcome.namespace(), Some("default"));
    }

    #[test]
    fn test_apply_outcome_is_dry_run() {
        let resource_key = ResourceKey {
            gvk: GroupVersionKind {
                group: String::new(),
                version: "v1".to_string(),
                kind: "Namespace".to_string(),
            },
            namespace: None,
            name: "test".to_string(),
        };
        let outcome = ApplyOutcome::DryRun {
            would_be: Box::new(ApplyOutcome::Created {
                resource_key: resource_key.clone(),
            }),
        };
        assert!(outcome.is_dry_run());

        let outcome2 = ApplyOutcome::Created { resource_key };
        assert!(!outcome2.is_dry_run());
    }
}