nyl 0.4.1

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

use crate::resources::path_glob::path_matches_glob;

/// Known ArgoCD Application field-path patterns.
///
/// This inventory is periodically updated from the ArgoCD Application CRD.
/// Paths use dotted notation with quoted segments where needed.
const VALID_APPLICATION_PATH_PATTERNS: &[&str] = &[
    "apiVersion",
    "kind",
    "metadata.name",
    "metadata.namespace",
    "metadata.labels.**",
    "metadata.annotations.**",
    "metadata.finalizers.**",
    "spec.project",
    "spec.source.repoURL",
    "spec.source.path",
    "spec.source.targetRevision",
    "spec.source.chart",
    "spec.source.helm.**",
    "spec.source.kustomize.**",
    "spec.source.directory.**",
    "spec.source.jsonnet.**",
    "spec.source.plugin.name",
    "spec.source.plugin.env.**",
    "spec.sources.**",
    "spec.destination.server",
    "spec.destination.name",
    "spec.destination.namespace",
    "spec.syncPolicy.**",
    "spec.ignoreDifferences.**",
    "spec.revisionHistoryLimit",
    "spec.info.**",
];

/// Known ArgoCD Application field-path patterns whose values are arrays and can
/// therefore support `+field` append semantics in NylRelease overrides.
const VALID_APPLICATION_ARRAY_FIELD_PATTERNS: &[&str] = &[
    "metadata.finalizers",
    "spec.source.helm.valueFiles",
    "spec.source.helm.parameters",
    "spec.source.helm.fileParameters",
    "spec.source.kustomize.images",
    "spec.source.kustomize.replicas",
    "spec.source.kustomize.components",
    "spec.source.kustomize.patches",
    "spec.source.jsonnet.extVars",
    "spec.source.jsonnet.tlas",
    "spec.source.plugin.env",
    "spec.sources",
    "spec.syncPolicy.syncOptions",
    "spec.ignoreDifferences",
    "spec.info",
];

pub fn is_supported_application_field_path(path: &str) -> bool {
    VALID_APPLICATION_PATH_PATTERNS
        .iter()
        .any(|pattern| path_matches_glob(path, pattern).unwrap_or(false))
}

pub fn is_supported_application_array_field_path(path: &str) -> bool {
    VALID_APPLICATION_ARRAY_FIELD_PATTERNS
        .iter()
        .any(|pattern| path_matches_glob(path, pattern).unwrap_or(false))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::resources::path_glob::validate_path_glob_pattern;

    #[test]
    fn test_supported_field_path() {
        assert!(is_supported_application_field_path("spec.syncPolicy.automated.prune"));
        assert!(is_supported_application_field_path(
            "metadata.annotations.\"foo.bar/baz\""
        ));
    }

    #[test]
    fn test_unsupported_field_path() {
        assert!(!is_supported_application_field_path("spec.notRealField.foo"));
    }

    #[test]
    fn test_supported_array_field_path() {
        assert!(is_supported_application_array_field_path("spec.syncPolicy.syncOptions"));
        assert!(is_supported_application_array_field_path("spec.info"));
    }

    #[test]
    fn test_unsupported_array_field_path() {
        assert!(!is_supported_application_array_field_path("spec.syncPolicy.automated"));
    }

    #[test]
    fn test_array_field_patterns_are_subset_of_path_patterns() {
        for pattern in VALID_APPLICATION_ARRAY_FIELD_PATTERNS {
            assert!(
                is_supported_application_field_path(pattern),
                "array field pattern '{}' is not covered by VALID_APPLICATION_PATH_PATTERNS",
                pattern
            );
        }
    }

    #[test]
    fn test_field_catalog_patterns_are_valid() {
        for pattern in VALID_APPLICATION_PATH_PATTERNS {
            validate_path_glob_pattern(pattern).unwrap_or_else(|e| {
                panic!("invalid field catalog pattern '{}': {}", pattern, e);
            });
        }
        for pattern in VALID_APPLICATION_ARRAY_FIELD_PATTERNS {
            validate_path_glob_pattern(pattern).unwrap_or_else(|e| {
                panic!("invalid array field catalog pattern '{}': {}", pattern, e);
            });
        }
    }
}