sherpack-engine 0.4.0

Jinja2 templating engine for Sherpack with Kubernetes-specific filters
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
//! Pack renderer with subchart support
//!
//! This module provides `PackRenderer`, which orchestrates the rendering
//! of a pack and all its subcharts with proper value scoping.

use indexmap::IndexMap;
use std::collections::HashMap;

use serde_json::Value as JsonValue;
use sherpack_core::{Dependency, LoadedPack, TemplateContext, Values};

use crate::engine::Engine;
use crate::error::{EngineError, RenderIssue, RenderReport, TemplateError};
use crate::subchart::{DiscoveryResult, SubchartConfig, SubchartInfo};

/// Result of rendering a pack (with or without subcharts)
#[derive(Debug)]
pub struct PackRenderResult {
    /// Rendered manifests by filename (IndexMap preserves insertion order)
    /// Subchart manifests are prefixed: "redis/deployment.yaml"
    pub manifests: IndexMap<String, String>,

    /// Post-install notes (from parent pack only)
    pub notes: Option<String>,

    /// Discovery information about subcharts
    pub discovery: DiscoveryResult,
}

/// Orchestrates rendering of a pack and its subcharts
pub struct PackRenderer {
    engine: Engine,
    config: SubchartConfig,
}

impl PackRenderer {
    /// Create a new PackRenderer with default config
    pub fn new(engine: Engine) -> Self {
        Self {
            engine,
            config: SubchartConfig::default(),
        }
    }

    /// Create with custom configuration
    pub fn with_config(engine: Engine, config: SubchartConfig) -> Self {
        Self { engine, config }
    }

    /// Create a builder for more options
    pub fn builder() -> PackRendererBuilder {
        PackRendererBuilder::default()
    }

    /// Get a reference to the underlying engine
    pub fn engine(&self) -> &Engine {
        &self.engine
    }

    /// Get a reference to the config
    pub fn config(&self) -> &SubchartConfig {
        &self.config
    }

    /// Discover subcharts in a pack
    ///
    /// This scans the subcharts directory (default: `charts/`) for valid packs
    /// and evaluates their conditions against the provided values.
    pub fn discover_subcharts(&self, pack: &LoadedPack, values: &JsonValue) -> DiscoveryResult {
        let mut result = DiscoveryResult::new();
        let subcharts_dir = pack.root.join(&self.config.subcharts_dir);

        // Build a map of dependencies by name for condition lookup
        let deps_by_name: HashMap<&str, &Dependency> = pack
            .pack
            .dependencies
            .iter()
            .map(|d| (d.effective_name(), d))
            .collect();

        // Check if subcharts directory exists
        if !subcharts_dir.exists() {
            // Not an error - pack may not have subcharts
            return result;
        }

        // Scan the subcharts directory
        let entries = match std::fs::read_dir(&subcharts_dir) {
            Ok(e) => e,
            Err(e) => {
                result.warnings.push(format!(
                    "Failed to read subcharts directory '{}': {}",
                    subcharts_dir.display(),
                    e
                ));
                return result;
            }
        };

        for entry in entries {
            let entry = match entry {
                Ok(e) => e,
                Err(e) => {
                    result
                        .warnings
                        .push(format!("Failed to read directory entry: {}", e));
                    continue;
                }
            };

            let path = entry.path();
            if !path.is_dir() {
                continue;
            }

            let dir_name = match path.file_name().and_then(|n| n.to_str()) {
                Some(n) => n.to_string(),
                None => continue,
            };

            // Try to load as a pack
            let subchart_pack = match LoadedPack::load(&path) {
                Ok(p) => p,
                Err(e) => {
                    result
                        .warnings
                        .push(format!("Failed to load subchart '{}': {}", dir_name, e));
                    continue;
                }
            };

            // Find matching dependency definition
            let dependency = deps_by_name.get(dir_name.as_str()).cloned().cloned();

            // Determine effective name (alias if set)
            let name = dependency
                .as_ref()
                .and_then(|d| d.alias.clone())
                .unwrap_or_else(|| dir_name.clone());

            // Evaluate condition
            let (enabled, disabled_reason) = self.evaluate_condition(&dependency, values);

            result.subcharts.push(SubchartInfo {
                name,
                path,
                pack: subchart_pack,
                enabled,
                dependency,
                disabled_reason,
            });
        }

        // Check for missing subcharts from dependencies
        for dep in &pack.pack.dependencies {
            if dep.enabled {
                let name = dep.effective_name();
                let found = result.subcharts.iter().any(|s| s.name == name);
                if !found {
                    result.missing.push(name.to_string());
                }
            }
        }

        // Sort by name for deterministic output
        result.subcharts.sort_by(|a, b| a.name.cmp(&b.name));

        result
    }

    /// Evaluate if a subchart is enabled based on its condition
    fn evaluate_condition(
        &self,
        dependency: &Option<Dependency>,
        values: &JsonValue,
    ) -> (bool, Option<String>) {
        let Some(dep) = dependency else {
            // No dependency definition = always enabled
            return (true, None);
        };

        // Check static enabled flag
        if !dep.enabled {
            return (
                false,
                Some("Statically disabled (enabled: false)".to_string()),
            );
        }

        // Check condition
        if let Some(condition) = &dep.condition {
            let condition_met = evaluate_condition_path(condition, values);
            if !condition_met {
                return (
                    false,
                    Some(format!("Condition '{}' evaluated to false", condition)),
                );
            }
        }

        (true, None)
    }

    /// Render a pack and all enabled subcharts
    ///
    /// This is the main entry point. It:
    /// 1. Discovers all subcharts
    /// 2. Evaluates conditions against values
    /// 3. Renders enabled subcharts with scoped values
    /// 4. Renders the parent pack
    /// 5. Combines all manifests
    pub fn render(
        &self,
        pack: &LoadedPack,
        context: &TemplateContext,
    ) -> Result<PackRenderResult, EngineError> {
        let result = self.render_collect_errors(pack, context);

        if result.report.has_errors() {
            // Return first error
            let first_error = result
                .report
                .errors_by_template
                .into_values()
                .next()
                .and_then(|errors| errors.into_iter().next());

            return Err(match first_error {
                Some(err) => EngineError::Template(Box::new(err)),
                None => EngineError::Template(Box::new(TemplateError::simple(
                    "Unknown template error during subchart rendering",
                ))),
            });
        }

        Ok(PackRenderResult {
            manifests: result.manifests,
            notes: result.notes,
            discovery: result.discovery,
        })
    }

    /// Render with full error collection
    pub fn render_collect_errors(
        &self,
        pack: &LoadedPack,
        context: &TemplateContext,
    ) -> PackRenderResultWithReport {
        self.render_recursive(pack, context, 0)
    }

    /// Internal recursive renderer
    fn render_recursive(
        &self,
        pack: &LoadedPack,
        context: &TemplateContext,
        depth: usize,
    ) -> PackRenderResultWithReport {
        let mut report = RenderReport::new();
        let mut all_manifests = IndexMap::new();
        let mut notes = None;

        // Check depth limit
        if depth > self.config.max_depth {
            report.add_warning(
                "subchart",
                format!(
                    "Maximum subchart depth ({}) exceeded, stopping recursion",
                    self.config.max_depth
                ),
            );
            return PackRenderResultWithReport {
                manifests: all_manifests,
                notes,
                report,
                discovery: DiscoveryResult::new(),
            };
        }

        // Discover subcharts
        let discovery = self.discover_subcharts(pack, &context.values);

        // Add discovery warnings to report
        for warning in &discovery.warnings {
            report.add_warning("subchart_discovery", warning.clone());
        }

        // Handle missing subcharts
        for missing in &discovery.missing {
            if self.config.strict {
                report.add_error(
                    format!("<subchart:{}>", missing),
                    TemplateError::simple(format!(
                        "Missing subchart '{}' referenced in dependencies",
                        missing
                    )),
                );
            } else {
                report.add_warning(
                    "subchart_missing",
                    format!(
                        "Subchart '{}' not found in {}/",
                        missing, self.config.subcharts_dir
                    ),
                );
            }
        }

        // Render each enabled subchart
        for subchart in &discovery.subcharts {
            if !subchart.enabled {
                // Log why it was skipped
                if let Some(reason) = &subchart.disabled_reason {
                    report.add_issue(RenderIssue::warning(
                        "subchart_disabled",
                        format!("Subchart '{}' disabled: {}", subchart.name, reason),
                    ));
                }
                continue;
            }

            // Load subchart's default values
            let subchart_defaults = if subchart.pack.values_path.exists() {
                match Values::from_file(&subchart.pack.values_path) {
                    Ok(v) => v,
                    Err(e) => {
                        report.add_warning(
                            "subchart_values",
                            format!("Failed to load values.yaml for '{}': {}", subchart.name, e),
                        );
                        Values::new()
                    }
                }
            } else {
                Values::new()
            };

            // Scope values for this subchart
            let scoped_values =
                Values::for_subchart_json(subchart_defaults, &context.values, &subchart.name);

            // Create context for subchart
            let subchart_context = TemplateContext::new(
                scoped_values,
                context.release.clone(),
                &subchart.pack.pack.metadata,
            );

            // Recursively render subchart (handles its own subcharts)
            let subchart_result =
                self.render_recursive(&subchart.pack, &subchart_context, depth + 1);

            // Merge subchart manifests with prefix
            for (name, manifest) in subchart_result.manifests {
                let prefixed_name = format!("{}/{}", subchart.name, name);
                all_manifests.insert(prefixed_name, manifest);
            }

            // Merge subchart errors with prefix
            for (template, errors) in subchart_result.report.errors_by_template {
                let prefixed = format!("{}/{}", subchart.name, template);
                for error in errors {
                    report.add_error(prefixed.clone(), error);
                }
            }

            // Merge issues
            for issue in subchart_result.report.issues {
                report.add_issue(issue);
            }

            // Subchart notes are typically not shown (only parent's notes)
        }

        // Render parent pack
        let parent_result = self.engine.render_pack_collect_errors(pack, context);

        // Merge parent manifests (after subcharts for proper ordering)
        all_manifests.extend(parent_result.manifests);
        notes = parent_result.notes;

        // Merge parent report
        for (template, errors) in parent_result.report.errors_by_template {
            for error in errors {
                report.add_error(template.clone(), error);
            }
        }
        for issue in parent_result.report.issues {
            report.add_issue(issue);
        }
        for success in parent_result.report.successful_templates {
            report.add_success(success);
        }

        PackRenderResultWithReport {
            manifests: all_manifests,
            notes,
            report,
            discovery,
        }
    }
}

/// Result type that includes discovery info and error report
#[derive(Debug)]
pub struct PackRenderResultWithReport {
    /// Rendered manifests (may be partial if errors occurred)
    pub manifests: IndexMap<String, String>,

    /// Post-install notes
    pub notes: Option<String>,

    /// Error and warning report
    pub report: RenderReport,

    /// Subchart discovery results
    pub discovery: DiscoveryResult,
}

impl PackRenderResultWithReport {
    /// Check if rendering was fully successful (no errors)
    pub fn is_success(&self) -> bool {
        !self.report.has_errors()
    }
}

/// Builder for PackRenderer
#[derive(Default)]
pub struct PackRendererBuilder {
    strict_mode: bool,
    max_depth: Option<usize>,
    subcharts_dir: Option<String>,
}

impl PackRendererBuilder {
    /// Enable strict mode for the engine (fail on undefined variables)
    pub fn strict(mut self, strict: bool) -> Self {
        self.strict_mode = strict;
        self
    }

    /// Set maximum depth for nested subcharts
    pub fn max_depth(mut self, depth: usize) -> Self {
        self.max_depth = Some(depth);
        self
    }

    /// Set the subcharts directory name (default: "charts")
    pub fn subcharts_dir(mut self, dir: impl Into<String>) -> Self {
        self.subcharts_dir = Some(dir.into());
        self
    }

    /// Build the PackRenderer
    pub fn build(self) -> PackRenderer {
        let engine = if self.strict_mode {
            Engine::strict()
        } else {
            Engine::lenient()
        };

        let mut config = SubchartConfig::default();
        if let Some(depth) = self.max_depth {
            config.max_depth = depth;
        }
        if let Some(dir) = self.subcharts_dir {
            config.subcharts_dir = dir;
        }
        if self.strict_mode {
            config.strict = true;
        }

        PackRenderer { engine, config }
    }
}

/// Evaluate a dot-path condition against values
///
/// Supports paths like "redis.enabled", "features.cache.memory"
fn evaluate_condition_path(condition: &str, values: &serde_json::Value) -> bool {
    let parts: Vec<&str> = condition.split('.').collect();

    let mut current = values;
    for part in &parts {
        match current.get(part) {
            Some(v) => current = v,
            None => return false,
        }
    }

    // Coerce to boolean
    match current {
        serde_json::Value::Bool(b) => *b,
        serde_json::Value::Null => false,
        serde_json::Value::String(s) => !s.is_empty() && s != "false" && s != "0",
        serde_json::Value::Number(n) => n.as_f64().map(|f| f != 0.0).unwrap_or(false),
        serde_json::Value::Array(a) => !a.is_empty(),
        serde_json::Value::Object(o) => !o.is_empty(),
    }
}

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

    #[test]
    fn test_evaluate_condition_path_bool() {
        let values = serde_json::json!({
            "redis": {
                "enabled": true
            },
            "postgresql": {
                "enabled": false
            }
        });

        assert!(evaluate_condition_path("redis.enabled", &values));
        assert!(!evaluate_condition_path("postgresql.enabled", &values));
    }

    #[test]
    fn test_evaluate_condition_path_missing() {
        let values = serde_json::json!({
            "redis": {}
        });

        assert!(!evaluate_condition_path("redis.enabled", &values));
        assert!(!evaluate_condition_path("nonexistent.path", &values));
    }

    #[test]
    fn test_evaluate_condition_path_truthy() {
        let values = serde_json::json!({
            "string_yes": "yes",
            "string_empty": "",
            "number_one": 1,
            "number_zero": 0,
            "array_full": [1, 2],
            "array_empty": []
        });

        assert!(evaluate_condition_path("string_yes", &values));
        assert!(!evaluate_condition_path("string_empty", &values));
        assert!(evaluate_condition_path("number_one", &values));
        assert!(!evaluate_condition_path("number_zero", &values));
        assert!(evaluate_condition_path("array_full", &values));
        assert!(!evaluate_condition_path("array_empty", &values));
    }

    #[test]
    fn test_pack_renderer_builder() {
        let renderer = PackRenderer::builder()
            .strict(true)
            .max_depth(5)
            .subcharts_dir("deps")
            .build();

        assert_eq!(renderer.config.max_depth, 5);
        assert_eq!(renderer.config.subcharts_dir, "deps");
        assert!(renderer.config.strict);
    }

    #[test]
    fn test_pack_render_result_with_report_success() {
        let result = PackRenderResultWithReport {
            manifests: IndexMap::new(),
            notes: None,
            report: RenderReport::new(),
            discovery: DiscoveryResult::new(),
        };

        assert!(result.is_success());
    }

    #[test]
    fn test_discover_subcharts_with_fixture() {
        use std::path::PathBuf;

        let fixture_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .parent()
            .unwrap()
            .parent()
            .unwrap()
            .join("fixtures/pack-with-subcharts");

        if !fixture_path.exists() {
            // Skip if fixture doesn't exist
            return;
        }

        let pack = LoadedPack::load(&fixture_path).expect("Failed to load fixture");
        let renderer = PackRenderer::new(Engine::lenient());

        let values = serde_json::json!({
            "redis": { "enabled": true },
            "postgresql": { "enabled": false }
        });

        let discovery = renderer.discover_subcharts(&pack, &values);

        // Should find both subcharts
        assert_eq!(discovery.subcharts.len(), 2);

        // Redis should be enabled
        let redis = discovery.subcharts.iter().find(|s| s.name == "redis");
        assert!(redis.is_some());
        assert!(redis.unwrap().enabled);

        // PostgreSQL should be disabled (statically disabled in Pack.yaml)
        let pg = discovery.subcharts.iter().find(|s| s.name == "postgresql");
        assert!(pg.is_some());
        assert!(!pg.unwrap().enabled);
    }

    #[test]
    fn test_render_pack_with_subcharts() {
        use sherpack_core::ReleaseInfo;
        use std::path::PathBuf;

        let fixture_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .parent()
            .unwrap()
            .parent()
            .unwrap()
            .join("fixtures/pack-with-subcharts");

        if !fixture_path.exists() {
            return;
        }

        let pack = LoadedPack::load(&fixture_path).expect("Failed to load fixture");
        let renderer = PackRenderer::new(Engine::lenient());

        let values = Values::from_yaml(
            r#"
global:
  imageRegistry: docker.io
  pullPolicy: IfNotPresent
app:
  name: my-application
  replicas: 2
  image:
    repository: myapp
    tag: "1.0.0"
redis:
  enabled: true
  replicas: 3
  auth:
    enabled: true
    password: secret123
postgresql:
  enabled: false
"#,
        )
        .expect("Failed to parse values");

        let release = ReleaseInfo::for_install("test-release", "default");
        let context = TemplateContext::new(values, release, &pack.pack.metadata);

        let result = renderer.render(&pack, &context).expect("Render failed");

        // Should have parent manifest
        assert!(result.manifests.contains_key("deployment.yaml"));

        // Should have redis subchart manifest (prefixed)
        assert!(result.manifests.contains_key("redis/deployment.yaml"));

        // Should NOT have postgresql manifest (disabled)
        let has_postgresql = result
            .manifests
            .keys()
            .any(|k| k.starts_with("postgresql/"));
        assert!(!has_postgresql, "PostgreSQL should be disabled");

        // Verify redis manifest uses scoped values
        let redis_manifest = result.manifests.get("redis/deployment.yaml").unwrap();
        assert!(
            redis_manifest.contains("replicas: 3"),
            "Should use parent's redis.replicas=3"
        );
        assert!(
            redis_manifest.contains("REDIS_PASSWORD"),
            "Auth should be enabled"
        );

        // Verify parent manifest has correct content
        let parent_manifest = result.manifests.get("deployment.yaml").unwrap();
        assert!(parent_manifest.contains("test-release-my-application"));
        assert!(parent_manifest.contains("REDIS_HOST"));
        assert!(
            !parent_manifest.contains("DATABASE_HOST"),
            "PostgreSQL env should not be present"
        );
    }

    #[test]
    fn test_subchart_global_values_passed() {
        use sherpack_core::ReleaseInfo;
        use std::path::PathBuf;

        let fixture_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .parent()
            .unwrap()
            .parent()
            .unwrap()
            .join("fixtures/pack-with-subcharts");

        if !fixture_path.exists() {
            return;
        }

        let pack = LoadedPack::load(&fixture_path).expect("Failed to load fixture");
        let renderer = PackRenderer::new(Engine::lenient());

        let values = Values::from_yaml(
            r#"
global:
  imageRegistry: my-registry.io
  pullPolicy: Always
app:
  name: my-app
  replicas: 1
  image:
    repository: myapp
    tag: "1.0"
redis:
  enabled: true
postgresql:
  enabled: false
"#,
        )
        .expect("Failed to parse values");

        let release = ReleaseInfo::for_install("test", "default");
        let context = TemplateContext::new(values, release, &pack.pack.metadata);

        let result = renderer.render(&pack, &context).expect("Render failed");

        // Redis manifest should use global.imageRegistry
        let redis_manifest = result.manifests.get("redis/deployment.yaml").unwrap();
        assert!(
            redis_manifest.contains("my-registry.io"),
            "Should use global imageRegistry"
        );
    }
}