1use std::collections::HashMap;
2
3use anyhow::{Result, anyhow, bail};
4
5use crate::contract::CommandContext;
6
7const MAX_PLACEHOLDER_SCAN: usize = 1024;
10
11pub struct TemplateDelimiters {
13 pub open: &'static [u8],
14 pub close: &'static [u8],
15}
16
17impl Default for TemplateDelimiters {
18 fn default() -> Self {
19 Self {
20 open: b"{{",
21 close: b"}}",
22 }
23 }
24}
25
26pub struct StreamingExpand {
32 buffer: Vec<u8>,
34 overrides: HashMap<String, String>,
36 env: HashMap<String, String>,
38 vars: HashMap<String, oxdock_parser::Value>,
40 in_placeholder: bool,
42 pending_brace: bool,
44 pending_close_brace: bool,
46 pending_escape: bool,
49 pending_escape_brace: bool,
52 delimiters: TemplateDelimiters,
54}
55
56impl StreamingExpand {
57 pub fn new(overrides: &[(String, String)], env: &HashMap<String, String>) -> Self {
60 Self {
61 buffer: Vec::with_capacity(256),
62 overrides: overrides.iter().cloned().collect(),
63 env: env.clone(),
64 vars: HashMap::new(),
65 in_placeholder: false,
66 pending_brace: false,
67 pending_close_brace: false,
68 pending_escape: false,
69 pending_escape_brace: false,
70 delimiters: TemplateDelimiters::default(),
71 }
72 }
73
74 pub fn with_vars(mut self, vars: &HashMap<String, oxdock_parser::Value>) -> Self {
77 self.vars = vars.clone();
78 self
79 }
80
81 pub fn process_bytes(&mut self, input: &[u8], out: &mut Vec<u8>) -> Result<usize> {
84 if input.is_empty() {
85 return Ok(0);
86 }
87
88 let start_len = out.len();
89 let mut i = 0;
90
91 if self.pending_close_brace {
93 self.pending_close_brace = false;
94 if input[0] == self.delimiters.close[1] {
95 let key = extract_key(&self.buffer);
97 let value = lookup(&key, &self.overrides, &self.env, &self.vars)?;
98 out.extend_from_slice(value.as_bytes());
99 self.buffer.clear();
100 self.in_placeholder = false;
101 i = self.delimiters.close.len() - 1; } else {
103 self.buffer.push(self.delimiters.close[0]);
106 i = 0; }
108 }
109
110 if self.pending_brace {
112 self.pending_brace = false;
113 if input[0] == self.delimiters.open[1] {
114 self.in_placeholder = true;
116 self.buffer.clear();
117 i = 1; } else {
119 out.push(self.delimiters.open[0]);
121 }
122 }
123
124 if self.pending_escape_brace {
129 self.pending_escape_brace = false;
130 if !input.is_empty() && input[0] == self.delimiters.open[1] {
131 out.extend_from_slice(b"{{");
132 i = 1;
133 } else {
134 out.push(b'\\');
135 out.push(self.delimiters.open[0]);
136 }
137 }
138
139 if self.pending_escape {
145 self.pending_escape = false;
146 if input.len() >= 2 && input[0] == b'{' && input[1] == b'{' {
147 out.extend_from_slice(b"{{");
148 i = 2;
149 } else if input.len() == 1 && input[0] == self.delimiters.open[0] {
150 self.pending_escape_brace = true;
151 i = 1;
152 } else if !input.is_empty() && input[0] == b'\\' {
153 out.push(b'\\');
154 i = 1;
155 } else {
156 out.push(b'\\');
160 }
161 }
162
163 if self.in_placeholder {
164 i = self.scan_placeholder(input, i, out)?;
166 }
167
168 while i < input.len() {
170 if input[i] == b'\\' {
171 if i + 2 < input.len() && input[i + 1] == b'{' && input[i + 2] == b'{' {
172 out.extend_from_slice(b"{{");
174 i += 3;
175 } else if i + 2 == input.len() && input[i + 1] == self.delimiters.open[0] {
176 self.pending_escape_brace = true;
179 i += 2;
180 } else if i + 1 < input.len() && input[i + 1] == b'\\' {
181 out.push(b'\\');
185 i += 2;
186 } else if i + 1 == input.len() {
187 self.pending_escape = true;
189 i += 1;
190 } else {
191 out.push(b'\\');
193 i += 1;
194 }
195 } else if input[i] == self.delimiters.open[0] {
196 if i + 1 < input.len() && input[i + 1] == self.delimiters.open[1] {
197 self.in_placeholder = true;
199 self.buffer.clear();
200 i += 2;
201 i = self.scan_placeholder(input, i, out)?;
202 } else if i + 1 == input.len() {
203 self.pending_brace = true;
205 i += 1;
206 } else {
207 out.push(self.delimiters.open[0]);
209 i += 1;
210 }
211 } else {
212 let start = i;
215 while i < input.len() && input[i] != self.delimiters.open[0] && input[i] != b'\\' {
216 i += 1;
217 }
218 out.extend_from_slice(&input[start..i]);
219 }
220 }
221
222 Ok(out.len() - start_len)
223 }
224
225 pub fn flush(mut self, out: &mut Vec<u8>) -> Result<()> {
227 if self.pending_close_brace {
229 self.buffer.push(self.delimiters.close[0]);
230 self.pending_close_brace = false;
231 }
232 if self.pending_brace {
234 out.push(self.delimiters.open[0]);
235 self.pending_brace = false;
236 }
237 if self.pending_escape {
239 out.push(b'\\');
240 self.pending_escape = false;
241 }
242 if self.pending_escape_brace {
244 out.push(b'\\');
245 out.push(self.delimiters.open[0]);
246 self.pending_escape_brace = false;
247 }
248 if self.in_placeholder {
250 out.extend_from_slice(self.delimiters.open);
251 self.in_placeholder = false;
252 }
253 out.extend_from_slice(&self.buffer);
255 self.buffer.clear();
256 Ok(())
257 }
258
259 pub fn expand_string(self, input: &str) -> Result<String> {
261 let mut out = Vec::with_capacity(input.len());
262 let mut expander = self;
263 expander.process_bytes(input.as_bytes(), &mut out)?;
264 expander.flush(&mut out)?;
265 Ok(String::from_utf8(out).unwrap_or_default())
266 }
267
268 fn scan_placeholder(&mut self, input: &[u8], mut i: usize, out: &mut Vec<u8>) -> Result<usize> {
271 while i < input.len() {
272 if input[i] == self.delimiters.close[0] {
273 if i + 1 < input.len() && input[i + 1] == self.delimiters.close[1] {
274 let key = extract_key(&self.buffer);
276 let value = lookup(&key, &self.overrides, &self.env, &self.vars)?;
277 out.extend_from_slice(value.as_bytes());
278 self.buffer.clear();
279 self.in_placeholder = false;
280 return Ok(i + 2);
281 }
282 if i + 1 == input.len() {
283 self.pending_close_brace = true;
285 return Ok(i + 1);
286 }
287 }
288 self.buffer.push(input[i]);
289 i += 1;
290
291 if self.buffer.len() > MAX_PLACEHOLDER_SCAN {
293 out.extend_from_slice(self.delimiters.open);
294 out.extend_from_slice(&self.buffer);
295 self.buffer.clear();
296 self.in_placeholder = false;
297 return Ok(i);
298 }
299 }
300 Ok(i)
301 }
302}
303
304fn extract_key(buffer: &[u8]) -> String {
306 String::from_utf8_lossy(buffer).trim().to_string()
307}
308
309fn lookup(
319 raw_key: &str,
320 overrides: &HashMap<String, String>,
321 env: &HashMap<String, String>,
322 vars: &HashMap<String, oxdock_parser::Value>,
323) -> Result<String> {
324 let key = raw_key.trim();
325
326 if let Some(val) = overrides.get(key) {
328 return Ok(val.clone());
329 }
330
331 if let Some(env_key) = key.strip_prefix("env:") {
333 if let Some(val) = overrides.get(env_key).or_else(|| env.get(env_key)) {
334 return Ok(val.clone());
335 }
336 let hint = if vars.contains_key(env_key) {
337 format!("; did you mean '${env_key}' (script variable)?")
338 } else {
339 String::new()
340 };
341 bail!("undefined environment variable: '{env_key}'{hint}");
342 }
343
344 if let Some(var_key) = key.strip_prefix('$') {
346 if var_key.contains('.') {
347 let parts: Vec<&str> = var_key.split('.').collect();
348 return resolve_key_path_strict(&parts, vars);
349 }
350 if let Some(val) = vars.get(var_key) {
351 return Ok(format_value_for_string(val));
352 }
353 let hint = if env.contains_key(var_key) {
354 format!("; did you mean 'env:{var_key}' (environment variable)?")
355 } else if overrides.contains_key(var_key) {
356 format!("; did you mean '{var_key}' (step override)?")
357 } else {
358 String::new()
359 };
360 bail!("undefined script variable: '${var_key}'{hint}");
361 }
362
363 if !key.is_empty()
365 && key
366 .chars()
367 .all(|c| c.is_alphanumeric() || c == '_' || c == '-')
368 {
369 let hint = if vars.contains_key(key) {
370 format!("; did you mean '${key}' (script variable)?")
371 } else if env.contains_key(key) {
372 format!("; did you mean 'env:{key}' (environment variable)?")
373 } else {
374 String::new()
375 };
376 bail!("missing required step override argument: '{key}'{hint}");
377 }
378 bail!(
379 "invalid placeholder format '{key}': script variables must start with '$' and environment variables with 'env:'"
380 );
381}
382
383fn resolve_key_path_strict(
388 parts: &[&str],
389 vars: &HashMap<String, oxdock_parser::Value>,
390) -> Result<String> {
391 let root_key = parts[0];
392 let mut current = vars
393 .get(root_key)
394 .ok_or_else(|| anyhow!("undefined script variable: '${root_key}'"))?;
395
396 for &segment in &parts[1..] {
397 match current {
398 oxdock_parser::Value::Map(map) => {
399 current = map.get(segment).ok_or_else(|| {
400 anyhow!("property '{segment}' not found on object '${root_key}'")
401 })?;
402 }
403 oxdock_parser::Value::List(list) => {
404 let idx: usize = segment.parse().map_err(|_| {
405 anyhow!("invalid array index '{segment}' on list '${root_key}'")
406 })?;
407 current = list.get(idx).ok_or_else(|| {
408 anyhow!(
409 "index {idx} out of bounds for list '${root_key}' (len: {})",
410 list.len()
411 )
412 })?;
413 }
414 _ => bail!("cannot access property '{segment}' on primitive value of '${root_key}'"),
415 }
416 }
417
418 Ok(format_value_for_string(current))
419}
420
421fn format_value_for_string(val: &oxdock_parser::Value) -> String {
423 match val {
424 oxdock_parser::Value::String(s) => s.clone(),
425 oxdock_parser::Value::Int(i) => i.to_string(),
426 oxdock_parser::Value::Float(f) => f.to_string(),
427 oxdock_parser::Value::Bool(b) => b.to_string(),
428 oxdock_parser::Value::Pipe(n) => format!("pipe:{n}"),
429 oxdock_parser::Value::Duration(d) => oxdock_parser::command::format_duration(d),
430 oxdock_parser::Value::Path(p) => p.to_string_lossy().to_string(),
431 oxdock_parser::Value::List(items) => items
432 .iter()
433 .map(format_value_for_string)
434 .collect::<Vec<_>>()
435 .join(" "),
436 oxdock_parser::Value::Map(map) => map
437 .iter()
438 .map(|(k, v)| format!("\"{}\": {}", k, format_value_for_string(v)))
439 .collect::<Vec<_>>()
440 .join(", "),
441 oxdock_parser::Value::TaskHandle(id) => format!("task#{}", id),
442 }
443}
444
445pub(crate) fn expand_with_lookup<F>(input: &str, mut lookup_fn: F) -> String
448where
449 F: FnMut(&str) -> Option<String>,
450{
451 let mut out = String::with_capacity(input.len());
452 let mut chars = input.chars().peekable();
453 while let Some(c) = chars.next() {
454 if c == '{' {
455 if let Some(&'{') = chars.peek() {
456 chars.next(); let mut content = String::new();
458 let mut closed = false;
459 let mut inner_chars = chars.clone();
461 while let Some(ch) = inner_chars.next() {
462 if ch == '}'
463 && let Some(&'}') = inner_chars.peek()
464 {
465 closed = true;
466 break;
467 }
468 content.push(ch);
469 }
470
471 if closed {
472 for _ in 0..content.chars().count() {
476 chars.next();
477 }
478 chars.next(); chars.next(); let key = content.trim();
482 if !key.is_empty() {
483 out.push_str(&lookup_fn(key).unwrap_or_default());
484 }
485 } else {
486 out.push('{');
487 out.push('{');
488 }
489 } else {
490 out.push('{');
491 }
492 } else {
493 out.push(c);
494 }
495 }
496 out
497}
498
499pub fn expand_script_env(input: &str, script_envs: &HashMap<String, String>) -> String {
500 expand_with_lookup(input, |name| {
501 if let Some(key) = name.strip_prefix("env:") {
502 script_envs
503 .get(key)
504 .cloned()
505 .or_else(|| std::env::var(key).ok())
506 } else {
507 None
508 }
509 })
510}
511
512pub fn expand_command_env(input: &str, ctx: &CommandContext) -> String {
513 expand_with_lookup(input, |name| {
514 if let Some(key) = name.strip_prefix("env:") {
515 ctx.envs().get(key).cloned()
516 } else {
517 None
518 }
519 })
520}
521
522#[cfg(test)]
523mod tests {
524 use super::*;
525 use std::collections::HashMap;
526
527 #[test]
528 fn basic_expansion() {
529 let mut env = HashMap::new();
530 env.insert("NAME".into(), "World".into());
531 let expander = StreamingExpand::new(&[], &env);
532 let result = expander.expand_string("Hello {{ env:NAME }}").unwrap();
533 assert_eq!(result, "Hello World");
534 }
535
536 #[test]
537 fn multiple_vars() {
538 let mut env = HashMap::new();
539 env.insert("A".into(), "X".into());
540 env.insert("B".into(), "Y".into());
541 let expander = StreamingExpand::new(&[], &env);
542 let result = expander
543 .expand_string("{{ env:A }} and {{ env:B }}")
544 .unwrap();
545 assert_eq!(result, "X and Y");
546 }
547
548 #[test]
549 fn missing_var() {
550 let env = HashMap::new();
551 let expander = StreamingExpand::new(&[], &env);
552 let result = expander.expand_string("{{ env:MISSING }}");
553 assert!(result.is_err());
554 assert!(
555 result
556 .unwrap_err()
557 .to_string()
558 .contains("undefined environment variable"),
559 "error should mention undefined environment variable"
560 );
561 }
562
563 #[test]
564 fn no_placeholders() {
565 let env = HashMap::new();
566 let expander = StreamingExpand::new(&[], &env);
567 let result = expander.expand_string("plain text").unwrap();
568 assert_eq!(result, "plain text");
569 }
570
571 #[test]
572 fn empty_input() {
573 let env = HashMap::new();
574 let expander = StreamingExpand::new(&[], &env);
575 let result = expander.expand_string("").unwrap();
576 assert_eq!(result, "");
577 }
578
579 #[test]
580 fn override_precedence() {
581 let mut env = HashMap::new();
582 env.insert("KEY".into(), "envval".into());
583 let overrides = vec![("KEY".into(), "override".into())];
584 let expander = StreamingExpand::new(&overrides, &env);
585 let result = expander.expand_string("{{ env:KEY }}").unwrap();
586 assert_eq!(result, "override");
587 }
588
589 #[test]
590 fn override_with_namespace() {
591 let mut env = HashMap::new();
592 env.insert("CRATE".into(), "envval".into());
593 let overrides = vec![("CRATE".into(), "override".into())];
594 let expander = StreamingExpand::new(&overrides, &env);
595 let result = expander.expand_string("{{ env:CRATE }}").unwrap();
596 assert_eq!(result, "override");
597 }
598
599 #[test]
600 fn override_raw_key_match() {
601 let mut env = HashMap::new();
602 env.insert("CRATE".into(), "envval".into());
603 let overrides = vec![("env:CRATE".into(), "override".into())];
604 let expander = StreamingExpand::new(&overrides, &env);
605 let result = expander.expand_string("{{ env:CRATE }}").unwrap();
606 assert_eq!(result, "override");
607 }
608
609 #[test]
610 fn unclosed_placeholder() {
611 let env = HashMap::new();
612 let expander = StreamingExpand::new(&[], &env);
613 let result = expander.expand_string("{{ env:KEY").unwrap();
614 assert_eq!(result, "{{ env:KEY");
615 }
616
617 #[test]
618 fn unclosed_with_prefix() {
619 let env = HashMap::new();
620 let expander = StreamingExpand::new(&[], &env);
621 let result = expander.expand_string("Hello {{ env:KEY").unwrap();
622 assert_eq!(result, "Hello {{ env:KEY");
623 }
624
625 #[test]
626 fn buffer_limit_exceeded() {
627 let env = HashMap::new();
628 let expander = StreamingExpand::new(&[], &env);
629 let mut input = b"{{ ".to_vec();
631 input.extend(std::iter::repeat_n(b'x', 2000));
632 let result = expander
633 .expand_string(&String::from_utf8_lossy(&input))
634 .unwrap();
635 assert!(result.starts_with("{{ "));
637 assert!(result.len() > 1024);
638 }
639
640 #[test]
641 fn escaped_opener_emits_literal() {
642 let mut env = HashMap::new();
643 env.insert("PROJECT".into(), "OxDock".into());
644 let expander = StreamingExpand::new(&[], &env);
645 let result = expander
646 .expand_string("Built with \\{{ env:PROJECT }}")
647 .unwrap();
648 assert_eq!(result, "Built with {{ env:PROJECT }}");
649 }
650
651 #[test]
652 fn escaped_opener_across_chunks() {
653 let mut env = HashMap::new();
654 env.insert("PROJECT".into(), "OxDock".into());
655 let mut expander = StreamingExpand::new(&[], &env);
656 let mut out = Vec::new();
657
658 expander.process_bytes(b"Built with \\", &mut out).unwrap();
660 expander
661 .process_bytes(b"{{ env:PROJECT }}", &mut out)
662 .unwrap();
663 expander.flush(&mut out).unwrap();
664
665 assert_eq!(
666 String::from_utf8_lossy(&out),
667 "Built with {{ env:PROJECT }}"
668 );
669 }
670
671 #[test]
672 fn double_backslash_then_placeholder_expands() {
673 let mut env = HashMap::new();
674 env.insert("PROJECT".into(), "OxDock".into());
675 let expander = StreamingExpand::new(&[], &env);
676 let result = expander.expand_string("\\\\{{ env:PROJECT }}").unwrap();
677 assert_eq!(result, "\\OxDock");
678 }
679
680 #[test]
681 fn trailing_backslash_flushes_literal() {
682 let env = HashMap::new();
683 let expander = StreamingExpand::new(&[], &env);
684 let result = expander.expand_string("end\\").unwrap();
685 assert_eq!(result, "end\\");
686 }
687
688 #[test]
689 fn backslash_before_other_text_is_literal() {
690 let env = HashMap::new();
691 let expander = StreamingExpand::new(&[], &env);
692 let result = expander.expand_string("a\\b \\{ once }").unwrap();
693 assert_eq!(result, "a\\b \\{ once }");
694 }
695
696 #[test]
697 fn escaped_pair_split_across_chunks() {
698 let mut env = HashMap::new();
699 env.insert("PROJECT".into(), "OxDock".into());
700 let mut expander = StreamingExpand::new(&[], &env);
701 let mut out = Vec::new();
702
703 expander.process_bytes(b"\\", &mut out).unwrap();
706 expander
707 .process_bytes(b"\\{{ env:PROJECT }}", &mut out)
708 .unwrap();
709 expander.flush(&mut out).unwrap();
710
711 assert_eq!(String::from_utf8_lossy(&out), "\\OxDock");
712 }
713
714 #[test]
715 fn partial_across_chunks() {
716 let mut env = HashMap::new();
717 env.insert("NAME".into(), "World".into());
718 let mut expander = StreamingExpand::new(&[], &env);
719 let mut out = Vec::new();
720
721 expander.process_bytes(b"{{ env:NA", &mut out).unwrap();
723 expander.process_bytes(b"ME }}", &mut out).unwrap();
724 expander.flush(&mut out).unwrap();
725
726 assert_eq!(String::from_utf8_lossy(&out), "World");
727 }
728
729 #[test]
730 fn trailing_brace_across_chunks() {
731 let mut env = HashMap::new();
732 env.insert("NAME".into(), "World".into());
733 let mut expander = StreamingExpand::new(&[], &env);
734 let mut out = Vec::new();
735
736 expander.process_bytes(b"...", &mut out).unwrap();
738 expander.process_bytes(b"{", &mut out).unwrap();
739 expander.process_bytes(b"{env:NAME}}", &mut out).unwrap();
740 expander.flush(&mut out).unwrap();
741
742 assert_eq!(String::from_utf8_lossy(&out), "...World");
743 }
744
745 #[test]
746 fn trailing_brace_at_eof() {
747 let env = HashMap::new();
748 let mut expander = StreamingExpand::new(&[], &env);
749 let mut out = Vec::new();
750
751 expander.process_bytes(b"hello{", &mut out).unwrap();
752 expander.flush(&mut out).unwrap();
753
754 assert_eq!(String::from_utf8_lossy(&out), "hello{");
755 }
756
757 #[test]
758 fn immediate_flush_guarantee() {
759 let env = HashMap::new();
760 let mut expander = StreamingExpand::new(&[], &env);
761 let mut out = Vec::new();
762
763 let input = std::iter::repeat_n(b'x', 1024 * 1024).collect::<Vec<_>>();
765 expander.process_bytes(&input, &mut out).unwrap();
766 expander.flush(&mut out).unwrap();
767
768 assert_eq!(out.len(), 1024 * 1024);
769 }
770
771 #[test]
772 fn nested_braces() {
773 let mut env = HashMap::new();
774 env.insert("KEY{1}".into(), "val".into());
775 let expander = StreamingExpand::new(&[], &env);
776 let result = expander.expand_string("{{ env:KEY{1} }}").unwrap();
777 assert_eq!(result, "val");
778 }
779
780 #[test]
781 fn split_close_delimiter_across_chunks() {
782 let mut env = HashMap::new();
783 env.insert("NAME".into(), "World".into());
784 let mut expander = StreamingExpand::new(&[], &env);
785 let mut out = Vec::new();
786
787 expander.process_bytes(b"{{ env:NAME", &mut out).unwrap();
789 expander.process_bytes(b"}}", &mut out).unwrap();
790 expander.flush(&mut out).unwrap();
791
792 assert_eq!(String::from_utf8_lossy(&out), "World");
793 }
794
795 #[test]
796 fn split_close_delimiter_with_trailing_content() {
797 let mut env = HashMap::new();
798 env.insert("NAME".into(), "World".into());
799 let mut expander = StreamingExpand::new(&[], &env);
800 let mut out = Vec::new();
801
802 expander.process_bytes(b"{{ env:NAME", &mut out).unwrap();
804 expander.process_bytes(b"}} rest", &mut out).unwrap();
805 expander.flush(&mut out).unwrap();
806
807 assert_eq!(String::from_utf8_lossy(&out), "World rest");
808 }
809
810 #[test]
811 fn empty_input_preserves_pending_state() {
812 let mut env = HashMap::new();
813 env.insert("NAME".into(), "World".into());
814 let mut expander = StreamingExpand::new(&[], &env);
815 let mut out = Vec::new();
816
817 expander.process_bytes(b"{{ env:NAME", &mut out).unwrap();
819 expander.process_bytes(b"", &mut out).unwrap(); expander.process_bytes(b"}}", &mut out).unwrap();
821 expander.flush(&mut out).unwrap();
822
823 assert_eq!(String::from_utf8_lossy(&out), "World");
824 }
825
826 #[test]
827 fn missing_env_var_errors() {
828 let env = HashMap::new();
829 let expander = StreamingExpand::new(&[], &env);
830 let result = expander.expand_string("{{ env:UNDEFINED_VAR }}");
831 assert!(result.is_err());
832 let msg = result.unwrap_err().to_string();
833 assert!(msg.contains("undefined environment variable"), "got: {msg}");
834 assert!(msg.contains("UNDEFINED_VAR"), "got: {msg}");
835 }
836
837 #[test]
838 fn missing_script_var_errors() {
839 let env = HashMap::new();
840 let expander = StreamingExpand::new(&[], &env);
841 let result = expander.expand_string("{{ $undefined_var }}");
842 assert!(result.is_err());
843 let msg = result.unwrap_err().to_string();
844 assert!(msg.contains("undefined script variable"), "got: {msg}");
845 assert!(msg.contains("$undefined_var"), "got: {msg}");
846 }
847
848 #[test]
849 fn missing_key_in_map_errors() {
850 let mut vars = HashMap::new();
851 vars.insert(
852 "cfg".into(),
853 oxdock_parser::Value::Map(std::collections::BTreeMap::from([(
854 "server".into(),
855 oxdock_parser::Value::Map(std::collections::BTreeMap::from([(
856 "port".into(),
857 oxdock_parser::Value::Int(8080),
858 )])),
859 )])),
860 );
861 let expander = StreamingExpand::new(&[], &HashMap::new()).with_vars(&vars);
862 let result = expander.expand_string("{{ $cfg.missing_key }}");
863 assert!(result.is_err());
864 let msg = result.unwrap_err().to_string();
865 assert!(
866 msg.contains("property 'missing_key' not found"),
867 "got: {msg}"
868 );
869 }
870
871 #[test]
872 fn out_of_bounds_array_index_errors() {
873 let mut vars = HashMap::new();
874 vars.insert(
875 "arr".into(),
876 oxdock_parser::Value::List(vec![oxdock_parser::Value::String("a".into())]),
877 );
878 let expander = StreamingExpand::new(&[], &HashMap::new()).with_vars(&vars);
879 let result = expander.expand_string("{{ $arr.5 }}");
880 assert!(result.is_err());
881 let msg = result.unwrap_err().to_string();
882 assert!(msg.contains("index 5 out of bounds"), "got: {msg}");
883 }
884
885 #[test]
886 fn type_mismatch_navigation_errors() {
887 let mut vars = HashMap::new();
888 vars.insert("name".into(), oxdock_parser::Value::String("alice".into()));
889 let expander = StreamingExpand::new(&[], &HashMap::new()).with_vars(&vars);
890 let result = expander.expand_string("{{ $name.sub_field }}");
891 assert!(result.is_err());
892 let msg = result.unwrap_err().to_string();
893 assert!(
894 msg.contains("cannot access property 'sub_field' on primitive"),
895 "got: {msg}"
896 );
897 }
898
899 #[test]
900 fn unprefixed_identifier_errors() {
901 let env = HashMap::new();
902 let expander = StreamingExpand::new(&[], &env);
903 let result = expander.expand_string("{{ bare_word }}");
904 assert!(result.is_err());
905 let msg = result.unwrap_err().to_string();
906 assert!(msg.contains("missing required step override"), "got: {msg}");
907 }
908
909 #[test]
912 fn script_var_does_not_fall_back_to_env() {
913 let mut env = HashMap::new();
914 env.insert("WHO".into(), "from-env".into());
915 let expander = StreamingExpand::new(&[], &env);
916 let result = expander.expand_string("{{ $WHO }}");
918 assert!(result.is_err());
919 let msg = result.unwrap_err().to_string();
920 assert!(msg.contains("undefined script variable"), "got: {msg}");
921 assert!(
922 msg.contains("did you mean 'env:WHO'"),
923 "hint should suggest env: prefix, got: {msg}"
924 );
925 }
926
927 #[test]
928 fn env_var_does_not_fall_back_to_vars() {
929 let mut vars = HashMap::new();
930 vars.insert(
931 "HOST".into(),
932 oxdock_parser::Value::String("from-var".into()),
933 );
934 let expander = StreamingExpand::new(&[], &HashMap::new()).with_vars(&vars);
935 let result = expander.expand_string("{{ env:HOST }}");
937 assert!(result.is_err());
938 let msg = result.unwrap_err().to_string();
939 assert!(msg.contains("undefined environment variable"), "got: {msg}");
940 assert!(
941 msg.contains("did you mean '$HOST'"),
942 "hint should suggest $ prefix, got: {msg}"
943 );
944 }
945
946 #[test]
947 fn step_override_does_not_fall_back_to_vars() {
948 let mut vars = HashMap::new();
949 vars.insert("PORT".into(), oxdock_parser::Value::Int(8080));
950 let expander = StreamingExpand::new(&[], &HashMap::new()).with_vars(&vars);
951 let result = expander.expand_string("{{ PORT }}");
953 assert!(result.is_err());
954 let msg = result.unwrap_err().to_string();
955 assert!(msg.contains("missing required step override"), "got: {msg}");
956 assert!(
957 msg.contains("did you mean '$PORT'"),
958 "hint should suggest $ prefix, got: {msg}"
959 );
960 }
961
962 #[test]
963 fn env_prefix_isolated_from_script_vars() {
964 let mut vars = HashMap::new();
965 vars.insert("MODE".into(), oxdock_parser::Value::String("dev".into()));
966 let expander = StreamingExpand::new(&[], &HashMap::new()).with_vars(&vars);
967 let result = expander.expand_string("{{ env:MODE }}");
969 assert!(result.is_err());
970 let msg = result.unwrap_err().to_string();
971 assert!(msg.contains("undefined environment variable"), "got: {msg}");
972 assert!(
973 msg.contains("did you mean '$MODE'"),
974 "hint should suggest $ prefix, got: {msg}"
975 );
976 }
977
978 #[test]
979 fn dollar_prefix_isolated_from_env() {
980 let mut env = HashMap::new();
981 env.insert("PORT".into(), "3000".into());
982 let expander = StreamingExpand::new(&[], &env);
983 let result = expander.expand_string("{{ $PORT }}");
985 assert!(result.is_err());
986 let msg = result.unwrap_err().to_string();
987 assert!(msg.contains("undefined script variable"), "got: {msg}");
988 assert!(
989 msg.contains("did you mean 'env:PORT'"),
990 "hint should suggest env: prefix, got: {msg}"
991 );
992 }
993
994 #[test]
995 fn empty_placeholder_errors() {
996 let expander = StreamingExpand::new(&[], &HashMap::new());
997 let result = expander.expand_string("{{ }}");
998 assert!(result.is_err());
999 let msg = result.unwrap_err().to_string();
1000 assert!(msg.contains("invalid placeholder format"), "got: {msg}");
1001 }
1002
1003 #[test]
1004 fn malformed_symbol_placeholder_errors() {
1005 let expander = StreamingExpand::new(&[], &HashMap::new());
1006 let result = expander.expand_string("{{ @invalid! }}");
1007 assert!(result.is_err());
1008 let msg = result.unwrap_err().to_string();
1009 assert!(msg.contains("invalid placeholder format"), "got: {msg}");
1010 }
1011
1012 fn render_split(
1015 input: &[u8],
1016 size: usize,
1017 env: &HashMap<String, String>,
1018 ) -> Result<String, anyhow::Error> {
1019 let mut expander = StreamingExpand::new(&[], env);
1020 let mut out = Vec::new();
1021 for chunk in input.chunks(size) {
1022 expander.process_bytes(chunk, &mut out)?;
1023 }
1024 expander.flush(&mut out)?;
1025 Ok(String::from_utf8_lossy(&out).into_owned())
1026 }
1027
1028 #[test]
1029 fn escaped_opener_one_byte_chunks_stays_literal() {
1030 let mut env = HashMap::new();
1031 env.insert("NAME".into(), "World".into());
1032 let out = render_split(b"\\{{ env:NAME }}", 1, &env).unwrap();
1035 assert_eq!(out, "{{ env:NAME }}");
1036 }
1037
1038 #[test]
1039 fn escaped_opener_two_byte_chunks_stays_literal() {
1040 let mut env = HashMap::new();
1041 env.insert("NAME".into(), "World".into());
1042 let out = render_split(b"a\\{{ env:NAME }}b", 2, &env).unwrap();
1044 assert_eq!(out, "a{{ env:NAME }}b");
1045 }
1046
1047 #[test]
1048 fn escaped_opener_split_variants_stay_literal() {
1049 let mut env = HashMap::new();
1050 env.insert("NAME".into(), "World".into());
1051 for chunks in [
1052 vec![b"\\".as_slice(), b"{", b"{ env:NAME }}"],
1053 vec![b"\\{".as_slice(), b"{ env:NAME }}"],
1054 vec![b"\\{{ env:NAME ".as_slice(), b"}}"],
1055 ] {
1056 let mut expander = StreamingExpand::new(&[], &env);
1057 let mut out = Vec::new();
1058 for chunk in chunks {
1059 expander.process_bytes(chunk, &mut out).unwrap();
1060 }
1061 expander.flush(&mut out).unwrap();
1062 assert_eq!(
1063 String::from_utf8_lossy(&out),
1064 "{{ env:NAME }}",
1065 "chunks must not corrupt the escape"
1066 );
1067 }
1068 }
1069
1070 #[test]
1071 fn plain_opener_split_chunks_still_expands() {
1072 let mut env = HashMap::new();
1073 env.insert("NAME".into(), "World".into());
1074 let out = render_split(b"{{ env:NAME }}", 1, &env).unwrap();
1077 assert_eq!(out, "World");
1078 }
1079
1080 #[test]
1081 fn double_backslash_split_chunks_still_expands() {
1082 let mut env = HashMap::new();
1083 env.insert("NAME".into(), "World".into());
1084 let out = render_split(b"\\\\{{ env:NAME }}", 1, &env).unwrap();
1086 assert_eq!(out, "\\World");
1087 }
1088
1089 #[test]
1090 fn trailing_escape_brace_flushes_literal() {
1091 let env = HashMap::new();
1092 let expander = StreamingExpand::new(&[], &env);
1093 let result = expander.expand_string("end\\{").unwrap();
1094 assert_eq!(result, "end\\{");
1095 }
1096
1097 #[test]
1103 fn substituted_override_value_is_not_rescanned() {
1104 let mut env = HashMap::new();
1105 env.insert("OTHER".into(), "world".into());
1106 let overrides = vec![("NAME".into(), "{{ env:OTHER }}".into())];
1107 let expander = StreamingExpand::new(&overrides, &env);
1108 let result = expander.expand_string("Hello {{ NAME }}").unwrap();
1109 assert_eq!(result, "Hello {{ env:OTHER }}");
1110 }
1111
1112 #[test]
1113 fn substituted_env_value_is_not_rescanned() {
1114 let mut env = HashMap::new();
1115 env.insert("NAME".into(), "{{ env:OTHER }}".into());
1116 env.insert("OTHER".into(), "world".into());
1117 let expander = StreamingExpand::new(&[], &env);
1118 let result = expander.expand_string("Hello {{ env:NAME }}").unwrap();
1119 assert_eq!(result, "Hello {{ env:OTHER }}");
1120 }
1121
1122 #[test]
1123 fn substituted_script_var_value_is_not_rescanned() {
1124 let mut vars = HashMap::new();
1125 vars.insert(
1126 "inner".into(),
1127 oxdock_parser::Value::String("{{ env:OTHER }}".into()),
1128 );
1129 let mut env = HashMap::new();
1130 env.insert("OTHER".into(), "world".into());
1131 let expander = StreamingExpand::new(&[], &env).with_vars(&vars);
1132 let result = expander.expand_string("Hello {{ $inner }}").unwrap();
1133 assert_eq!(result, "Hello {{ env:OTHER }}");
1134 }
1135}