syncable-cli 0.37.1

A Rust-based CLI that analyzes code repositories and generates Infrastructure as Code configurations
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
//! HL2xxx - Values Validation Rules
//!
//! Rules for validating values.yaml configuration.

use crate::analyzer::helmlint::rules::{LintContext, Rule};
use crate::analyzer::helmlint::types::{CheckFailure, RuleCategory, Severity};

/// Get all HL2xxx rules.
pub fn rules() -> Vec<Box<dyn Rule>> {
    vec![
        Box::new(HL2002),
        Box::new(HL2003),
        Box::new(HL2004),
        Box::new(HL2005),
        Box::new(HL2007),
        Box::new(HL2008),
    ]
}

/// HL2002: Value referenced in template but not defined
pub struct HL2002;

impl Rule for HL2002 {
    fn code(&self) -> &'static str {
        "HL2002"
    }

    fn severity(&self) -> Severity {
        Severity::Warning
    }

    fn name(&self) -> &'static str {
        "undefined-value"
    }

    fn description(&self) -> &'static str {
        "Value is referenced in template but not defined in values.yaml"
    }

    fn check(&self, ctx: &LintContext) -> Vec<CheckFailure> {
        let mut failures = Vec::new();

        // Skip if no values file
        let values = match ctx.values {
            Some(v) => v,
            None => return failures,
        };

        // Check each template reference
        for ref_path in &ctx.template_value_refs {
            // Check if base path exists (allow nested access to undefined)
            let base_path = ref_path.split('.').next().unwrap_or(ref_path);
            if !values.has_path(base_path) && !values.has_path(ref_path) {
                // Check if any parent path exists
                let mut found_parent = false;
                let parts: Vec<&str> = ref_path.split('.').collect();
                for i in 1..parts.len() {
                    let partial = parts[..i].join(".");
                    if values.has_path(&partial) {
                        found_parent = true;
                        break;
                    }
                }

                if !found_parent {
                    failures.push(CheckFailure::new(
                        "HL2002",
                        Severity::Warning,
                        format!(
                            "Value '.Values.{}' is referenced but not defined in values.yaml",
                            ref_path
                        ),
                        "values.yaml",
                        1,
                        RuleCategory::Values,
                    ));
                }
            }
        }

        failures
    }
}

/// HL2003: Value defined but never used
pub struct HL2003;

impl Rule for HL2003 {
    fn code(&self) -> &'static str {
        "HL2003"
    }

    fn severity(&self) -> Severity {
        Severity::Info
    }

    fn name(&self) -> &'static str {
        "unused-value"
    }

    fn description(&self) -> &'static str {
        "Value is defined in values.yaml but never used in templates"
    }

    fn check(&self, ctx: &LintContext) -> Vec<CheckFailure> {
        let mut failures = Vec::new();

        let values = match ctx.values {
            Some(v) => v,
            None => return failures,
        };

        // Check each defined value
        for path in &values.defined_paths {
            // Skip if any template references this path or a child path
            let is_used = ctx
                .template_value_refs
                .iter()
                .any(|ref_path| ref_path == path || ref_path.starts_with(&format!("{}.", path)));

            // Also skip if a parent path is referenced (e.g., toYaml .Values.config)
            let parent_is_used = ctx
                .template_value_refs
                .iter()
                .any(|ref_path| path.starts_with(&format!("{}.", ref_path)));

            if !is_used && !parent_is_used {
                let line = values.line_for_path(path).unwrap_or(1);
                failures.push(CheckFailure::new(
                    "HL2003",
                    Severity::Info,
                    format!("Value '{}' is defined but never used in templates", path),
                    "values.yaml",
                    line,
                    RuleCategory::Values,
                ));
            }
        }

        failures
    }
}

/// HL2004: Sensitive value not marked as secret
pub struct HL2004;

impl Rule for HL2004 {
    fn code(&self) -> &'static str {
        "HL2004"
    }

    fn severity(&self) -> Severity {
        Severity::Warning
    }

    fn name(&self) -> &'static str {
        "sensitive-value-exposed"
    }

    fn description(&self) -> &'static str {
        "Sensitive value should be handled as a Kubernetes Secret"
    }

    fn check(&self, ctx: &LintContext) -> Vec<CheckFailure> {
        let mut failures = Vec::new();

        let values = match ctx.values {
            Some(v) => v,
            None => return failures,
        };

        for path in values.sensitive_paths() {
            // Check if the value has a non-empty default
            if let Some(value) = values.get(path) {
                let has_hardcoded_value = match value {
                    serde_yaml::Value::String(s) => !s.is_empty() && !s.starts_with("$"),
                    _ => false,
                };

                if has_hardcoded_value {
                    let line = values.line_for_path(path).unwrap_or(1);
                    failures.push(CheckFailure::new(
                        "HL2004",
                        Severity::Warning,
                        format!(
                            "Sensitive value '{}' has a hardcoded default. Consider using a Secret reference",
                            path
                        ),
                        "values.yaml",
                        line,
                        RuleCategory::Values,
                    ));
                }
            }
        }

        failures
    }
}

/// HL2005: Port number out of valid range
pub struct HL2005;

impl Rule for HL2005 {
    fn code(&self) -> &'static str {
        "HL2005"
    }

    fn severity(&self) -> Severity {
        Severity::Error
    }

    fn name(&self) -> &'static str {
        "invalid-port"
    }

    fn description(&self) -> &'static str {
        "Port number must be between 1 and 65535"
    }

    fn check(&self, ctx: &LintContext) -> Vec<CheckFailure> {
        let mut failures = Vec::new();

        let values = match ctx.values {
            Some(v) => v,
            None => return failures,
        };

        // Look for common port patterns
        let port_patterns = [
            "port",
            "containerPort",
            "targetPort",
            "hostPort",
            "nodePort",
        ];

        for path in &values.defined_paths {
            let lower_path = path.to_lowercase();
            let is_port_field = port_patterns.iter().any(|p| lower_path.ends_with(p));

            if is_port_field
                && let Some(value) = values.get(path)
                && let Some(port) = extract_port_number(value)
                && !(1..=65535).contains(&port)
            {
                let line = values.line_for_path(path).unwrap_or(1);
                failures.push(CheckFailure::new(
                    "HL2005",
                    Severity::Error,
                    format!(
                        "Invalid port number {} at '{}'. Must be between 1 and 65535",
                        port, path
                    ),
                    "values.yaml",
                    line,
                    RuleCategory::Values,
                ));
            }
        }

        failures
    }
}

/// HL2007: Image tag is 'latest'
pub struct HL2007;

impl Rule for HL2007 {
    fn code(&self) -> &'static str {
        "HL2007"
    }

    fn severity(&self) -> Severity {
        Severity::Warning
    }

    fn name(&self) -> &'static str {
        "image-tag-latest"
    }

    fn description(&self) -> &'static str {
        "Using 'latest' tag is prone to unexpected changes"
    }

    fn check(&self, ctx: &LintContext) -> Vec<CheckFailure> {
        let mut failures = Vec::new();

        let values = match ctx.values {
            Some(v) => v,
            None => return failures,
        };

        // Look for image.tag or similar patterns
        for path in &values.defined_paths {
            let lower_path = path.to_lowercase();
            if (lower_path.ends_with(".tag") || lower_path.ends_with("imagetag"))
                && let Some(serde_yaml::Value::String(tag)) = values.get(path)
                && tag == "latest"
            {
                let line = values.line_for_path(path).unwrap_or(1);
                failures.push(CheckFailure::new(
                            "HL2007",
                            Severity::Warning,
                            format!(
                                "Image tag at '{}' is 'latest'. Pin to a specific version for reproducibility",
                                path
                            ),
                            "values.yaml",
                            line,
                            RuleCategory::Values,
                        ));
            }
        }

        failures
    }
}

/// HL2008: Replica count is zero
pub struct HL2008;

impl Rule for HL2008 {
    fn code(&self) -> &'static str {
        "HL2008"
    }

    fn severity(&self) -> Severity {
        Severity::Warning
    }

    fn name(&self) -> &'static str {
        "zero-replicas"
    }

    fn description(&self) -> &'static str {
        "Replica count is zero which means no pods will be created"
    }

    fn check(&self, ctx: &LintContext) -> Vec<CheckFailure> {
        let mut failures = Vec::new();

        let values = match ctx.values {
            Some(v) => v,
            None => return failures,
        };

        for path in &values.defined_paths {
            let lower_path = path.to_lowercase();
            if (lower_path.ends_with("replicacount") || lower_path.ends_with("replicas"))
                && let Some(value) = values.get(path)
                && let Some(count) = extract_number(value)
                && count == 0
            {
                let line = values.line_for_path(path).unwrap_or(1);
                failures.push(CheckFailure::new(
                    "HL2008",
                    Severity::Warning,
                    format!(
                        "Replica count at '{}' is 0. No pods will be created by default",
                        path
                    ),
                    "values.yaml",
                    line,
                    RuleCategory::Values,
                ));
            }
        }

        failures
    }
}

/// Extract a port number from a YAML value.
fn extract_port_number(value: &serde_yaml::Value) -> Option<i64> {
    match value {
        serde_yaml::Value::Number(n) => n.as_i64(),
        serde_yaml::Value::String(s) => s.parse().ok(),
        _ => None,
    }
}

/// Extract a number from a YAML value.
fn extract_number(value: &serde_yaml::Value) -> Option<i64> {
    match value {
        serde_yaml::Value::Number(n) => n.as_i64(),
        serde_yaml::Value::String(s) => s.parse().ok(),
        _ => None,
    }
}

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

    #[test]
    fn test_extract_port_number() {
        assert_eq!(
            extract_port_number(&serde_yaml::Value::Number(80.into())),
            Some(80)
        );
        assert_eq!(
            extract_port_number(&serde_yaml::Value::String("8080".to_string())),
            Some(8080)
        );
        assert_eq!(extract_port_number(&serde_yaml::Value::Bool(true)), None);
    }
}