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
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
//! Template engine based on MiniJinja
//!
//! This module provides the core rendering engine for Sherpack templates,
//! built on top of MiniJinja with Helm-compatible filters and functions.

use indexmap::IndexMap;
use minijinja::Environment;
use sherpack_core::{LoadedPack, SandboxedFileProvider, TemplateContext};
use std::collections::HashMap;

use crate::error::{EngineError, RenderReport, RenderResultWithReport, Result, TemplateError};
use crate::files_object::create_files_value_from_provider;
use crate::filters;
use crate::functions;

/// Prefix character for helper templates (skipped during rendering)
const HELPER_TEMPLATE_PREFIX: char = '_';

/// Pattern to identify NOTES templates
const NOTES_TEMPLATE_PATTERN: &str = "notes";

/// Result of rendering a pack
#[derive(Debug)]
pub struct RenderResult {
    /// Rendered manifests by filename (IndexMap preserves insertion order)
    pub manifests: IndexMap<String, String>,

    /// Post-install notes (if NOTES.txt exists)
    pub notes: Option<String>,
}

/// Template engine builder
pub struct EngineBuilder {
    strict_mode: bool,
    secret_state: Option<crate::secrets::SecretFunctionState>,
    lookup_state: Option<crate::cluster_reader::LookupState>,
}

impl Default for EngineBuilder {
    fn default() -> Self {
        Self::new()
    }
}

impl EngineBuilder {
    pub fn new() -> Self {
        Self {
            strict_mode: true,
            secret_state: None,
            lookup_state: None,
        }
    }

    /// Set strict mode (fail on undefined variables)
    pub fn strict(mut self, strict: bool) -> Self {
        self.strict_mode = strict;
        self
    }

    /// Set the secret state for `generate_secret()` function support
    ///
    /// When set, templates can use `generate_secret("name", length)` to generate
    /// deterministic secrets that persist across renders.
    pub fn with_secret_state(mut self, state: crate::secrets::SecretFunctionState) -> Self {
        self.secret_state = Some(state);
        self
    }

    /// Enable cluster-aware `lookup()` by providing a reader.
    ///
    /// When set, the `lookup(apiVersion, kind, namespace, name)` template
    /// function will query the cluster via the provided reader. Without
    /// this, `lookup()` always returns an empty dict (matching `helm template`).
    ///
    /// # Determinism warning
    ///
    /// Templates that use `lookup` are non-deterministic — the same Pack
    /// rendered against different clusters produces different manifests.
    /// Sherpack records a warning every time `lookup` returns a non-empty
    /// result; surface those warnings via `LookupState::take_warnings()`
    /// after the render.
    pub fn with_cluster_reader(
        mut self,
        reader: std::sync::Arc<dyn crate::cluster_reader::ClusterReader>,
    ) -> Self {
        self.lookup_state = Some(crate::cluster_reader::LookupState::new(reader));
        self
    }

    /// Build the engine
    pub fn build(self) -> Engine {
        Engine {
            strict_mode: self.strict_mode,
            secret_state: self.secret_state,
            lookup_state: self.lookup_state,
        }
    }
}

/// The template engine
pub struct Engine {
    strict_mode: bool,
    secret_state: Option<crate::secrets::SecretFunctionState>,
    lookup_state: Option<crate::cluster_reader::LookupState>,
}

impl Engine {
    /// Create a new engine
    ///
    /// # Arguments
    /// * `strict_mode` - If true, uses Chainable undefined behavior (Helm-compatible).
    ///   If false, uses Lenient mode (empty strings for undefined).
    ///
    /// # Prefer using convenience methods
    /// For clearer code, prefer `Engine::strict()` or `Engine::lenient()`.
    pub fn new(strict_mode: bool) -> Self {
        Self {
            strict_mode,
            secret_state: None,
            lookup_state: None,
        }
    }

    /// Create a strict mode engine (Helm-compatible, recommended)
    ///
    /// Uses `UndefinedBehavior::Chainable` which allows accessing properties
    /// on undefined values, returning undefined instead of error.
    #[must_use]
    pub fn strict() -> Self {
        Self {
            strict_mode: true,
            secret_state: None,
            lookup_state: None,
        }
    }

    /// Create a lenient mode engine
    ///
    /// Uses `UndefinedBehavior::Lenient` which returns empty strings
    /// for undefined values.
    #[must_use]
    pub fn lenient() -> Self {
        Self {
            strict_mode: false,
            secret_state: None,
            lookup_state: None,
        }
    }

    /// Create a builder for more configuration options
    #[must_use]
    pub fn builder() -> EngineBuilder {
        EngineBuilder::new()
    }

    /// Get a reference to the secret state (if any)
    pub fn secret_state(&self) -> Option<&crate::secrets::SecretFunctionState> {
        self.secret_state.as_ref()
    }

    /// Create a configured MiniJinja environment
    fn create_environment(&self) -> Environment<'static> {
        let mut env = Environment::new();

        // Configure behavior
        // Use Chainable mode by default - allows accessing properties on undefined values
        // (returns undefined instead of error), matching Helm's Go template behavior.
        // This is essential for converted charts where values may be optional.
        if self.strict_mode {
            env.set_undefined_behavior(minijinja::UndefinedBehavior::Chainable);
        } else {
            env.set_undefined_behavior(minijinja::UndefinedBehavior::Lenient);
        }

        // Register custom filters
        env.add_filter("toyaml", filters::toyaml);
        env.add_filter("tojson", filters::tojson);
        env.add_filter("tojson_pretty", filters::tojson_pretty);
        env.add_filter("fromjson", filters::fromjson);
        env.add_filter("fromyaml", filters::fromyaml);
        env.add_filter("b64encode", filters::b64encode);
        env.add_filter("b64decode", filters::b64decode);
        env.add_filter("quote", filters::quote);
        env.add_filter("squote", filters::squote);
        env.add_filter("nindent", filters::nindent);
        env.add_filter("indent", filters::indent);
        env.add_filter("required", filters::required);
        env.add_filter("empty", filters::empty);
        env.add_filter("haskey", filters::haskey);
        env.add_filter("keys", filters::keys);
        env.add_filter("merge", filters::merge);
        env.add_filter("sha256", filters::sha256sum);
        env.add_filter("trunc", filters::trunc);
        env.add_filter("trimprefix", filters::trimprefix);
        env.add_filter("trimsuffix", filters::trimsuffix);
        env.add_filter("snakecase", filters::snakecase);
        env.add_filter("kebabcase", filters::kebabcase);
        env.add_filter("tostrings", filters::tostrings);
        env.add_filter("semver_match", filters::semver_match);
        env.add_filter("int", filters::int);
        env.add_filter("float", filters::float);
        env.add_filter("abs", filters::abs);

        // Path filters
        env.add_filter("basename", filters::basename);
        env.add_filter("dirname", filters::dirname);
        env.add_filter("extname", filters::extname);
        env.add_filter("cleanpath", filters::cleanpath);

        // Regex filters
        env.add_filter("regex_match", filters::regex_match);
        env.add_filter("regex_replace", filters::regex_replace);
        env.add_filter("regex_find", filters::regex_find);
        env.add_filter("regex_find_all", filters::regex_find_all);

        // Dict filters
        env.add_filter("values", filters::values);
        env.add_filter("pick", filters::pick);
        env.add_filter("omit", filters::omit);

        // List filters
        env.add_filter("append", filters::append);
        env.add_filter("prepend", filters::prepend);
        env.add_filter("concat", filters::concat);
        env.add_filter("without", filters::without);
        env.add_filter("compact", filters::compact);

        // Math filters
        env.add_filter("floor", filters::floor);
        env.add_filter("ceil", filters::ceil);

        // Crypto filters
        env.add_filter("sha1", filters::sha1sum);
        env.add_filter("sha512", filters::sha512sum);
        env.add_filter("md5", filters::md5sum);

        // String filters
        env.add_filter("repeat", filters::repeat);
        env.add_filter("camelcase", filters::camelcase);
        env.add_filter("pascalcase", filters::pascalcase);
        env.add_filter("substr", filters::substr);
        env.add_filter("wrap", filters::wrap);
        env.add_filter("hasprefix", filters::hasprefix);
        env.add_filter("hassuffix", filters::hassuffix);

        // Register global functions
        env.add_function("fail", functions::fail);
        env.add_function("dict", functions::dict);
        env.add_function("list", functions::list);
        env.add_function("get", functions::get);
        env.add_function("set", functions::set);
        env.add_function("unset", functions::unset);
        env.add_function("dig", functions::dig);
        env.add_function("coalesce", functions::coalesce);
        env.add_function("ternary", functions::ternary);
        env.add_function("uuidv4", functions::uuidv4);
        env.add_function("tostring", functions::tostring);
        env.add_function("toint", functions::toint);
        env.add_function("tofloat", functions::tofloat);
        env.add_function("now", functions::now);
        env.add_function("printf", functions::printf);
        env.add_function("tpl", functions::tpl);
        env.add_function("tpl_ctx", functions::tpl_ctx);
        env.add_function("lookup", functions::lookup);
        env.add_function("fromjson", filters::fromjson);
        env.add_function("fromyaml", filters::fromyaml);

        // Register generate_secret function if secret state is available
        if let Some(ref secret_state) = self.secret_state {
            secret_state.register(&mut env);
        }

        // If a cluster reader is configured, replace the no-op `lookup`
        // stub above with a real implementation backed by the reader.
        if let Some(ref lookup_state) = self.lookup_state {
            lookup_state.register(&mut env);
        }

        env
    }

    /// Get a reference to the lookup state (if any).
    ///
    /// Use this after rendering to extract `take_warnings()` and surface
    /// any non-determinism notices to the user.
    pub fn lookup_state(&self) -> Option<&crate::cluster_reader::LookupState> {
        self.lookup_state.as_ref()
    }

    /// Render a single template string
    pub fn render_string(
        &self,
        template: &str,
        context: &TemplateContext,
        template_name: &str,
    ) -> Result<String> {
        let env = self.create_environment();

        // Add template to environment
        let mut env = env;
        env.add_template_owned(template_name.to_string(), template.to_string())
            .map_err(|e| {
                EngineError::Template(Box::new(TemplateError::from_minijinja(
                    e,
                    template_name,
                    template,
                )))
            })?;

        // Get template and render
        let tmpl = env.get_template(template_name).map_err(|e| {
            EngineError::Template(Box::new(TemplateError::from_minijinja(
                e,
                template_name,
                template,
            )))
        })?;

        // Build context
        let ctx = minijinja::context! {
            values => &context.values,
            release => &context.release,
            pack => &context.pack,
            capabilities => &context.capabilities,
            template => &context.template,
        };

        tmpl.render(ctx).map_err(|e| {
            EngineError::Template(Box::new(TemplateError::from_minijinja(
                e,
                template_name,
                template,
            )))
        })
    }

    /// Render all templates in a pack
    ///
    /// This is a convenience wrapper around `render_pack_collect_errors` that
    /// returns the first error encountered, suitable for most use cases.
    pub fn render_pack(
        &self,
        pack: &LoadedPack,
        context: &TemplateContext,
    ) -> Result<RenderResult> {
        let result = self.render_pack_collect_errors(pack, context);

        // If there were any errors, return the first one
        if result.report.has_errors() {
            // Get the first error from the report
            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")))
                }
            });
        }

        Ok(RenderResult {
            manifests: result.manifests,
            notes: result.notes,
        })
    }

    /// Render all templates in a pack, collecting all errors instead of stopping at the first
    ///
    /// Unlike `render_pack`, this method continues after errors and returns
    /// a comprehensive report of all issues found.
    pub fn render_pack_collect_errors(
        &self,
        pack: &LoadedPack,
        context: &TemplateContext,
    ) -> RenderResultWithReport {
        let mut report = RenderReport::new();
        let mut manifests = IndexMap::new();
        let mut notes = None;

        let template_files = match pack.template_files() {
            Ok(files) => files,
            Err(e) => {
                report.add_error(
                    "<pack>".to_string(),
                    TemplateError::simple(format!("Failed to list templates: {}", e)),
                );
                return RenderResultWithReport {
                    manifests,
                    notes,
                    report,
                };
            }
        };

        // Create environment with all templates loaded
        let mut env = self.create_environment();
        let templates_dir = &pack.templates_dir;

        // Track template sources for error reporting
        let mut template_sources: HashMap<String, String> = HashMap::new();

        // Load all templates - continue even if some fail to parse
        for file_path in &template_files {
            let rel_path = file_path.strip_prefix(templates_dir).unwrap_or(file_path);
            let template_name = rel_path.to_string_lossy().into_owned();

            let content = match std::fs::read_to_string(file_path) {
                Ok(c) => c,
                Err(e) => {
                    report.add_error(
                        template_name,
                        TemplateError::simple(format!("Failed to read template: {}", e)),
                    );
                    continue;
                }
            };

            // Store content first, then add to environment
            // This avoids cloning content twice
            if let Err(e) = env.add_template_owned(template_name.clone(), content.clone()) {
                report.add_error(
                    template_name.clone(),
                    TemplateError::from_minijinja_enhanced(
                        e,
                        &template_name,
                        &content,
                        Some(&context.values),
                    ),
                );
            }
            // Store after attempting to add (content is still valid)
            template_sources.insert(template_name, content);
        }

        // Add context as globals so imported macros can access them
        // This is necessary because MiniJinja macros don't automatically get the render context
        env.add_global("values", minijinja::Value::from_serialize(&context.values));
        env.add_global(
            "release",
            minijinja::Value::from_serialize(&context.release),
        );
        env.add_global("pack", minijinja::Value::from_serialize(&context.pack));
        env.add_global(
            "capabilities",
            minijinja::Value::from_serialize(&context.capabilities),
        );
        env.add_global(
            "template",
            minijinja::Value::from_serialize(&context.template),
        );

        // Add Files API - provides sandboxed access to pack files from templates
        // Usage: {{ files.get("config/app.conf") }}, files.exists(), files.glob(), files.lines()
        match SandboxedFileProvider::new(&pack.root) {
            Ok(provider) => {
                env.add_global("files", create_files_value_from_provider(provider));
            }
            Err(e) => {
                report.add_warning(
                    "files_api",
                    format!(
                        "Files API unavailable: {}. Templates using `files.*` will fail.",
                        e
                    ),
                );
            }
        }

        // Build render context (still needed for direct template rendering)
        let ctx = minijinja::context! {
            values => &context.values,
            release => &context.release,
            pack => &context.pack,
            capabilities => &context.capabilities,
            template => &context.template,
        };

        // Render each non-helper template, collecting errors
        for file_path in &template_files {
            let rel_path = file_path.strip_prefix(templates_dir).unwrap_or(file_path);
            let template_name = rel_path.to_string_lossy().into_owned();

            // Skip helper templates (prefixed with '_')
            let file_stem = rel_path
                .file_name()
                .map(|s| s.to_string_lossy())
                .unwrap_or_default();

            if file_stem.starts_with(HELPER_TEMPLATE_PREFIX) {
                continue;
            }

            // Try to get template (may have failed during loading)
            let tmpl = match env.get_template(&template_name) {
                Ok(t) => t,
                Err(_) => {
                    // Error already recorded during loading
                    continue;
                }
            };

            // Try to render
            match tmpl.render(&ctx) {
                Ok(rendered) => {
                    // Process successful render
                    if template_name
                        .to_lowercase()
                        .contains(NOTES_TEMPLATE_PATTERN)
                    {
                        notes = Some(rendered);
                    } else {
                        let trimmed = rendered.trim();
                        if !trimmed.is_empty() && trimmed != "---" {
                            let output_name = template_name
                                .trim_end_matches(".j2")
                                .trim_end_matches(".jinja2");
                            manifests.insert(output_name.to_string(), rendered);
                        }
                    }
                    report.add_success(template_name);
                }
                Err(e) => {
                    // Get template source for error context
                    // Use empty string only if template was never loaded (shouldn't happen)
                    let content = template_sources
                        .get(&template_name)
                        .map(String::as_str)
                        .unwrap_or("");

                    report.add_error(
                        template_name.clone(),
                        TemplateError::from_minijinja_enhanced(
                            e,
                            &template_name,
                            content,
                            Some(&context.values),
                        ),
                    );
                }
            }
        }

        RenderResultWithReport {
            manifests,
            notes,
            report,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use semver::Version;
    use sherpack_core::{PackMetadata, ReleaseInfo, Values};

    fn create_test_context() -> TemplateContext {
        let values = Values::from_yaml(
            r#"
image:
  repository: nginx
  tag: "1.25"
replicas: 3
"#,
        )
        .unwrap();

        let release = ReleaseInfo::for_install("myapp", "default");

        let pack = PackMetadata {
            name: "mypack".to_string(),
            version: Version::new(1, 0, 0),
            description: None,
            app_version: Some("2.0.0".to_string()),
            kube_version: None,
            home: None,
            icon: None,
            sources: vec![],
            keywords: vec![],
            maintainers: vec![],
            annotations: Default::default(),
        };

        TemplateContext::new(values, release, &pack)
    }

    #[test]
    fn test_render_simple() {
        let engine = Engine::new(true);
        let ctx = create_test_context();

        let template = "replicas: {{ values.replicas }}";
        let result = engine.render_string(template, &ctx, "test.yaml").unwrap();

        assert_eq!(result, "replicas: 3");
    }

    #[test]
    fn test_render_with_filters() {
        let engine = Engine::new(true);
        let ctx = create_test_context();

        let template = r#"image: {{ values.image | toyaml | nindent(2) }}"#;
        let result = engine.render_string(template, &ctx, "test.yaml").unwrap();

        assert!(result.contains("repository: nginx"));
        assert!(result.contains("tag:"));
    }

    #[test]
    fn test_render_release_info() {
        let engine = Engine::new(true);
        let ctx = create_test_context();

        let template = "name: {{ release.name }}\nnamespace: {{ release.namespace }}";
        let result = engine.render_string(template, &ctx, "test.yaml").unwrap();

        assert!(result.contains("name: myapp"));
        assert!(result.contains("namespace: default"));
    }

    #[test]
    fn test_chainable_undefined_returns_empty() {
        // With UndefinedBehavior::Chainable, undefined keys return empty string
        // This matches Helm's behavior for optional values
        let engine = Engine::new(true);
        let ctx = create_test_context();

        let template = "value: {{ values.undefined_key }}";
        let result = engine.render_string(template, &ctx, "test.yaml");

        // Chainable mode: undefined attributes return empty, not error
        assert!(result.is_ok());
        let output = result.unwrap();
        assert_eq!(output.trim(), "value:");
    }

    #[test]
    fn test_chainable_typo_returns_empty() {
        // With UndefinedBehavior::Chainable, even top-level undefined vars return empty
        // This is intentional for Helm compatibility (optional values pattern)
        let engine = Engine::new(true);
        let ctx = create_test_context();

        // Common typo: "value" instead of "values"
        let template = "name: {{ value.app.name }}";
        let result = engine.render_string(template, &ctx, "test.yaml");

        // Chainable mode allows this - returns empty
        // Users should rely on linting and unknown filter errors to catch typos
        assert!(result.is_ok());
        let output = result.unwrap();
        assert_eq!(output.trim(), "name:");
    }

    #[test]
    fn test_render_string_unknown_filter() {
        let engine = Engine::new(true);
        let ctx = create_test_context();

        let template = "name: {{ values.image.repository | unknownfilter }}";
        let result = engine.render_string(template, &ctx, "test.yaml");

        assert!(result.is_err());
    }

    #[test]
    fn test_render_result_with_report_structure() {
        use crate::error::{RenderReport, RenderResultWithReport};

        // Test successful result
        let result = RenderResultWithReport {
            manifests: {
                let mut m = IndexMap::new();
                m.insert("deployment.yaml".to_string(), "apiVersion: v1".to_string());
                m
            },
            notes: Some("Install notes".to_string()),
            report: RenderReport::new(),
        };

        assert!(result.is_success());
        assert_eq!(result.manifests.len(), 1);
        assert!(result.notes.is_some());
    }

    #[test]
    fn test_render_result_partial_success() {
        use crate::error::{RenderReport, RenderResultWithReport, TemplateError};

        let mut report = RenderReport::new();
        report.add_success("good.yaml".to_string());
        report.add_error(
            "bad.yaml".to_string(),
            TemplateError::simple("undefined variable"),
        );

        let result = RenderResultWithReport {
            manifests: {
                let mut m = IndexMap::new();
                m.insert("good.yaml".to_string(), "content".to_string());
                m
            },
            notes: None,
            report,
        };

        // Not a success because there was an error
        assert!(!result.is_success());
        // But we still have partial results
        assert_eq!(result.manifests.len(), 1);
        assert!(result.manifests.contains_key("good.yaml"));
    }

    #[test]
    fn test_engine_with_secret_state() {
        use crate::secrets::SecretFunctionState;

        // Create engine with secret state via builder
        let secret_state = SecretFunctionState::new();
        let engine = Engine::builder()
            .strict(true)
            .with_secret_state(secret_state.clone())
            .build();

        let ctx = create_test_context();

        // Template that uses generate_secret
        let template = r#"password: {{ generate_secret("db-password", 16) }}"#;
        let result = engine.render_string(template, &ctx, "test.yaml").unwrap();

        // Should have a 16-char alphanumeric password
        assert!(result.starts_with("password: "));
        let password = result.strip_prefix("password: ").unwrap();
        assert_eq!(password.len(), 16);
        assert!(password.chars().all(|c| c.is_ascii_alphanumeric()));

        // State should be dirty (new secret generated)
        assert!(secret_state.is_dirty());

        // Rendering again should return the same value
        let result2 = engine.render_string(template, &ctx, "test.yaml").unwrap();
        assert_eq!(result, result2);
    }

    #[test]
    fn test_engine_without_secret_state() {
        // Engine without secret state should fail when using generate_secret
        let engine = Engine::strict();
        let ctx = create_test_context();

        let template = r#"password: {{ generate_secret("test", 16) }}"#;
        let result = engine.render_string(template, &ctx, "test.yaml");

        // Should fail because generate_secret is not registered
        assert!(result.is_err());
    }

    #[test]
    fn test_engine_with_loaded_secret_state() {
        use crate::secrets::SecretFunctionState;
        use sherpack_core::SecretState;

        // First "install" - generate secret
        let secret_state1 = SecretFunctionState::new();
        let engine1 = Engine::builder()
            .with_secret_state(secret_state1.clone())
            .build();

        let ctx = create_test_context();
        let template = r#"{{ generate_secret("api-key", 32) }}"#;
        let secret = engine1.render_string(template, &ctx, "test.yaml").unwrap();

        // Extract and serialize state
        let persisted = secret_state1.take_state();
        let json = serde_json::to_string(&persisted).unwrap();

        // "Upgrade" - load existing state
        let loaded: SecretState = serde_json::from_str(&json).unwrap();
        let secret_state2 = SecretFunctionState::with_state(loaded);
        let engine2 = Engine::builder()
            .with_secret_state(secret_state2.clone())
            .build();

        // Should return same secret
        let secret2 = engine2.render_string(template, &ctx, "test.yaml").unwrap();
        assert_eq!(secret, secret2);

        // State should NOT be dirty (secret already existed)
        assert!(!secret_state2.is_dirty());
    }

    // -------- Cluster reader integration --------

    /// Mock reader for engine integration tests.
    struct MockClusterReader {
        data: std::collections::HashMap<(String, String, String, String), serde_json::Value>,
    }

    impl crate::cluster_reader::ClusterReader for MockClusterReader {
        fn lookup_one(&self, av: &str, k: &str, ns: &str, n: &str) -> Option<serde_json::Value> {
            self.data
                .get(&(av.into(), k.into(), ns.into(), n.into()))
                .cloned()
        }

        fn lookup_list(&self, _: &str, _: &str, _: &str) -> Vec<serde_json::Value> {
            Vec::new()
        }
    }

    #[test]
    fn test_lookup_returns_empty_without_reader() {
        let engine = Engine::new(true);
        let ctx = create_test_context();
        let template =
            r#"{% set s = lookup("v1", "Secret", "default", "tls") %}got: {{ s | tojson }}"#;
        let out = engine.render_string(template, &ctx, "t.yaml").unwrap();
        assert_eq!(out, "got: {}");
    }

    #[test]
    fn test_lookup_uses_reader_when_set() {
        let mut data = std::collections::HashMap::new();
        data.insert(
            (
                "v1".to_string(),
                "Secret".to_string(),
                "default".to_string(),
                "tls".to_string(),
            ),
            serde_json::json!({"data": {"tls.crt": "xyz"}}),
        );
        let reader = std::sync::Arc::new(MockClusterReader { data });

        let engine = Engine::builder().with_cluster_reader(reader).build();
        let ctx = create_test_context();
        let template = r#"{% set s = lookup("v1", "Secret", "default", "tls") %}cert: {{ s.data["tls.crt"] }}"#;
        let out = engine.render_string(template, &ctx, "t.yaml").unwrap();
        assert_eq!(out, "cert: xyz");

        // Render produced a non-empty lookup result → one warning recorded
        let warnings = engine.lookup_state().unwrap().take_warnings();
        assert_eq!(warnings.len(), 1);
    }

    #[test]
    fn test_lookup_missing_resource_returns_empty_dict() {
        let reader = std::sync::Arc::new(MockClusterReader {
            data: std::collections::HashMap::new(),
        });
        let engine = Engine::builder().with_cluster_reader(reader).build();
        let ctx = create_test_context();
        let template = r#"{% set s = lookup("v1", "Secret", "default", "missing") %}{% if s %}has{% else %}empty{% endif %}"#;
        let out = engine.render_string(template, &ctx, "t.yaml").unwrap();
        assert_eq!(out, "empty");
        // No warnings for empty lookups
        assert!(engine.lookup_state().unwrap().take_warnings().is_empty());
    }
}