From eb16dde4c3acc2e140bff96ed43e3fc0fc554c90 Mon Sep 17 00:00:00 2001
From: Fabrice Reix <fabrice.reix@orange.com>
Date: Sat, 16 Nov 2024 10:31:14 +0100
Subject: [PATCH] Treat Hurl string as template

---
 docs/spec/grammar/hurl.grammar                | 31 +++----
 packages/hurl_core/src/parser/filename.rs     |  5 +-
 .../hurl_core/src/parser/filename_password.rs |  5 +-
 packages/hurl_core/src/parser/json.rs         |  4 +-
 packages/hurl_core/src/parser/key_string.rs   |  5 +-
 packages/hurl_core/src/parser/mod.rs          |  1 +
 packages/hurl_core/src/parser/option.rs       | 10 +--
 packages/hurl_core/src/parser/placeholder.rs  | 85 +++++++++++++++++++
 .../hurl_core/src/parser/predicate_value.rs   |  4 +-
 packages/hurl_core/src/parser/template.rs     | 64 +-------------
 10 files changed, 121 insertions(+), 93 deletions(-)
 create mode 100644 packages/hurl_core/src/parser/placeholder.rs

diff --git a/docs/spec/grammar/hurl.grammar b/docs/spec/grammar/hurl.grammar
index af95b3c190b..fcc83373306 100644
--- a/docs/spec/grammar/hurl.grammar
+++ b/docs/spec/grammar/hurl.grammar
@@ -225,11 +225,11 @@ very-verbose-option: "very-verbose" ":" boolean-option lt
 
 variable-definition: variable-name "=" variable-value
 
-boolean-option: boolean | template
+boolean-option: boolean | placeholder
 
-integer-option: integer | template
+integer-option: integer | placeholder
 
-duration-option: (integer duration-unit?)  | template
+duration-option: (integer duration-unit?)  | placeholder
 
 duration-unit: "ms" | "s" | "m"
 
@@ -364,7 +364,7 @@ predicate-value:
   | oneline-file
   | oneline-hex
   | quoted-string
-  | template
+  | placeholder
 
 
 # Bytes
@@ -391,7 +391,7 @@ oneline-hex: "hex," hexdigit* ";"
 
 # Strings
 
-quoted-string: "\"" (quoted-string-content | template)* "\""
+quoted-string: "\"" (quoted-string-content | placeholder)* "\""
 
 quoted-string-content: (quoted-string-text | quoted-string-escaped-char)*
 
@@ -400,7 +400,7 @@ quoted-string-text: ~["\\]+
 quoted-string-escaped-char: "\\" ("\"" | "\\" | "\b" | "\f" | "\n" | "\r" | "\t" | "\u" unicode-char)
 
 
-key-string: (key-string-content | template)+
+key-string: (key-string-content | placeholder)+
 
 key-string-content: (key-string-text | key-string-escaped-char)*
 
@@ -409,7 +409,7 @@ key-string-text: (alphanum | "_" | "-" | "." | "[" | "]" | "@" | "$") +
 key-string-escaped-char: "\\" ("#" | ":" | "\\" | "\b" | "\f" | "\n" | "\r" | "\t" | "\u" unicode-char )
 
 
-value-string: (value-string-content | template)*
+value-string: (value-string-content | placeholder)*
 
 value-string-content: (value-string-text | value-string-escaped-char)*
 
@@ -418,7 +418,7 @@ value-string-text: ~[#\n\\]+
 value-string-escaped-char: "\\" ("#" | "\\" | "\b" | "\f" | "\n" | "\r" | "\t" | "\u" unicode-char )
 
 
-oneline-string: "`" (oneline-string-content | template)* "`"
+oneline-string: "`" (oneline-string-content | placeholder)* "`"
 
 oneline-string-content: (oneline-string-text | oneline-string-escaped-char)*
 
@@ -429,7 +429,7 @@ oneline-string-escaped-char: "\\" ("`" | "#" | "\\" | "b" | "f" | "u" unicode-ch
 
 multiline-string:
   "```" multiline-string-type? ("," multiline-string-attribute)* lt
-  (multiline-string-content | template)* lt
+  (multiline-string-content | placeholder)* lt
   "```"
 
 multiline-string-type:
@@ -449,7 +449,7 @@ multiline-string-text:  ~[\\]+ ~"```"
 
 multiline-string-escaped-char: "\\" ( "\\" | "b" | "f" | "n" | "r" | "t" | "`" | "u" unicode-char)
 
-filename: (filename-content | template)*
+filename: (filename-content | placeholder)*
 
 filename-content: (filename-text | filename-escaped-char)*
 
@@ -458,7 +458,7 @@ filename-text: ~[#;{} \n\\]+
 filename-escaped-char: "\\" ( "\\" | "b" | "f" | "n" | "r" | "t" | "#" | ";"| " " | "{" | "}" | "u" unicode-char)
 
 
-filename-password: (filename-password-content | template)*
+filename-password: (filename-password-content | placeholder)*
 
 filename-password-content: (filename-password-text | filename-password-escaped-char)*
 
@@ -470,10 +470,11 @@ unicode-char: "{" hexdigit+ "}"
 
 
 
+
 # JSON
 
 json-value:
-    template
+    placeholder
   | json-object
   | json-array
   | json-string
@@ -487,7 +488,7 @@ json-key-value: json-string ":" json-value
 
 json-array: "[" json-value ("," json-value)* "]"
 
-json-string: "\"" (json-string-content | template)* "\""
+json-string: "\"" (json-string-content | placeholder)* "\""
 
 json-string-content: json-string-text | json-string-escaped-char
 
@@ -499,9 +500,9 @@ json-string-escaped-char:
 json-number: integer fraction? exponent?
 
 
-# Template / Expression
+#  Expression
 
-template: "{{" expr "}}"
+placeholder: "{{" expr "}}"
 
 expr: (variable-name | function) (sp filter)*
 
diff --git a/packages/hurl_core/src/parser/filename.rs b/packages/hurl_core/src/parser/filename.rs
index c8f45811bba..28f1add618c 100644
--- a/packages/hurl_core/src/parser/filename.rs
+++ b/packages/hurl_core/src/parser/filename.rs
@@ -18,10 +18,11 @@
 use crate::ast::*;
 use crate::parser::error::*;
 use crate::parser::primitives::try_literal;
-use crate::parser::template;
 use crate::parser::{string, ParseResult};
 use crate::reader::Reader;
 
+use super::placeholder;
+
 /// Parse a filename.
 ///
 /// A few characters need to be escaped such as space
@@ -34,7 +35,7 @@ pub fn parse(reader: &mut Reader) -> ParseResult<Template> {
     let mut elements = vec![];
     loop {
         let start = reader.cursor();
-        match template::parse(reader) {
+        match placeholder::parse(reader) {
             Ok(expr) => {
                 let element = TemplateElement::Expression(expr);
                 elements.push(element);
diff --git a/packages/hurl_core/src/parser/filename_password.rs b/packages/hurl_core/src/parser/filename_password.rs
index 3fb12847854..2941f491006 100644
--- a/packages/hurl_core/src/parser/filename_password.rs
+++ b/packages/hurl_core/src/parser/filename_password.rs
@@ -18,10 +18,11 @@
 use crate::ast::*;
 use crate::parser::error::*;
 use crate::parser::primitives::try_literal;
-use crate::parser::template;
 use crate::parser::{string, ParseResult};
 use crate::reader::Reader;
 
+use super::placeholder;
+
 /// Parse a filename with an optional password
 ///
 /// This is very similar to the filename parser.
@@ -35,7 +36,7 @@ pub fn parse(reader: &mut Reader) -> ParseResult<Template> {
     let mut elements = vec![];
     loop {
         let start = reader.cursor();
-        match template::parse(reader) {
+        match placeholder::parse(reader) {
             Ok(expr) => {
                 let element = TemplateElement::Expression(expr);
                 elements.push(element);
diff --git a/packages/hurl_core/src/parser/json.rs b/packages/hurl_core/src/parser/json.rs
index c20d4fcbf00..a634cd872fe 100644
--- a/packages/hurl_core/src/parser/json.rs
+++ b/packages/hurl_core/src/parser/json.rs
@@ -23,7 +23,7 @@ use crate::parser::template::*;
 use crate::parser::ParseResult;
 use crate::reader::{Pos, Reader};
 
-use super::template;
+use super::placeholder;
 
 pub fn parse(reader: &mut Reader) -> ParseResult<JsonValue> {
     choice(
@@ -272,7 +272,7 @@ pub fn number_value(reader: &mut Reader) -> ParseResult<JsonValue> {
 }
 
 fn expression_value(reader: &mut Reader) -> ParseResult<JsonValue> {
-    let exp = template::parse(reader)?;
+    let exp = placeholder::parse(reader)?;
     Ok(JsonValue::Expression(exp))
 }
 
diff --git a/packages/hurl_core/src/parser/key_string.rs b/packages/hurl_core/src/parser/key_string.rs
index 27a4db0859c..e949c3982ec 100644
--- a/packages/hurl_core/src/parser/key_string.rs
+++ b/packages/hurl_core/src/parser/key_string.rs
@@ -18,16 +18,17 @@
 use crate::ast::*;
 use crate::parser::error::*;
 use crate::parser::primitives::*;
-use crate::parser::template;
 use crate::parser::{string, ParseResult};
 use crate::reader::Reader;
 
+use super::placeholder;
+
 pub fn parse(reader: &mut Reader) -> ParseResult<Template> {
     let start = reader.cursor();
 
     let mut elements = vec![];
     loop {
-        match template::parse(reader) {
+        match placeholder::parse(reader) {
             Ok(expr) => {
                 let element = TemplateElement::Expression(expr);
                 elements.push(element);
diff --git a/packages/hurl_core/src/parser/mod.rs b/packages/hurl_core/src/parser/mod.rs
index 2fd4f38a361..e4228c1272e 100644
--- a/packages/hurl_core/src/parser/mod.rs
+++ b/packages/hurl_core/src/parser/mod.rs
@@ -46,6 +46,7 @@ mod multiline;
 mod number;
 mod option;
 mod parsers;
+mod placeholder;
 mod predicate;
 mod predicate_value;
 mod primitives;
diff --git a/packages/hurl_core/src/parser/option.rs b/packages/hurl_core/src/parser/option.rs
index 79371bea93e..212c35dbeaa 100644
--- a/packages/hurl_core/src/parser/option.rs
+++ b/packages/hurl_core/src/parser/option.rs
@@ -26,7 +26,7 @@ use crate::parser::{filename, filename_password, ParseResult};
 use crate::reader::Reader;
 use crate::typing::Count;
 
-use super::template;
+use super::placeholder;
 
 /// Parse an option in an `[Options]` section.
 pub fn parse(reader: &mut Reader) -> ParseResult<EntryOption> {
@@ -293,7 +293,7 @@ fn boolean_option(reader: &mut Reader) -> ParseResult<BooleanOption> {
         Ok(v) => Ok(BooleanOption::Literal(v)),
         Err(_) => {
             reader.seek(start);
-            let exp = template::parse(reader).map_err(|e| {
+            let exp = placeholder::parse(reader).map_err(|e| {
                 let kind = ParseErrorKind::Expecting {
                     value: "true|false".to_string(),
                 };
@@ -310,7 +310,7 @@ fn natural_option(reader: &mut Reader) -> ParseResult<NaturalOption> {
         Ok(v) => Ok(NaturalOption::Literal(v)),
         Err(_) => {
             reader.seek(start);
-            let exp = template::parse(reader).map_err(|e| {
+            let exp = placeholder::parse(reader).map_err(|e| {
                 let kind = ParseErrorKind::Expecting {
                     value: "integer >= 0".to_string(),
                 };
@@ -327,7 +327,7 @@ fn count_option(reader: &mut Reader) -> ParseResult<CountOption> {
         Ok(v) => Ok(CountOption::Literal(v)),
         Err(_) => {
             reader.seek(start);
-            let exp = template::parse(reader).map_err(|e| {
+            let exp = placeholder::parse(reader).map_err(|e| {
                 let kind = ParseErrorKind::Expecting {
                     value: "integer >= -1".to_string(),
                 };
@@ -345,7 +345,7 @@ fn duration_option(reader: &mut Reader) -> ParseResult<DurationOption> {
         Err(e) => {
             if e.recoverable {
                 reader.seek(start);
-                let exp = template::parse(reader).map_err(|e| {
+                let exp = placeholder::parse(reader).map_err(|e| {
                     let kind = ParseErrorKind::Expecting {
                         value: "integer".to_string(),
                     };
diff --git a/packages/hurl_core/src/parser/placeholder.rs b/packages/hurl_core/src/parser/placeholder.rs
new file mode 100644
index 00000000000..9ae0502e46c
--- /dev/null
+++ b/packages/hurl_core/src/parser/placeholder.rs
@@ -0,0 +1,85 @@
+use super::{expr, ParseResult};
+/*
+ * Hurl (https://hurl.dev)
+ * Copyright (C) 2024 Orange
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+use crate::ast::*;
+use crate::parser::primitives::*;
+use crate::reader::Reader;
+
+/// Parse a placeholder {{ expr }}
+pub fn parse(reader: &mut Reader) -> ParseResult<Expr> {
+    try_literal("{{", reader)?;
+    let expression = expr::parse(reader)?;
+    literal("}}", reader)?;
+    Ok(expression)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::{parser::ParseErrorKind, reader::Pos};
+
+    #[test]
+    fn test_expr() {
+        let mut reader = Reader::new("{{ name}}");
+        assert_eq!(
+            parse(&mut reader).unwrap(),
+            Expr {
+                space0: Whitespace {
+                    value: String::from(" "),
+                    source_info: SourceInfo::new(Pos::new(1, 3), Pos::new(1, 4)),
+                },
+                variable: Variable {
+                    name: String::from("name"),
+                    source_info: SourceInfo::new(Pos::new(1, 4), Pos::new(1, 8)),
+                },
+                space1: Whitespace {
+                    value: String::new(),
+                    source_info: SourceInfo::new(Pos::new(1, 8), Pos::new(1, 8)),
+                },
+            }
+        );
+    }
+
+    #[test]
+    fn test_expr_error() {
+        let mut reader = Reader::new("{{host>}}");
+        let error = parse(&mut reader).err().unwrap();
+        assert_eq!(error.pos, Pos { line: 1, column: 7 });
+        assert_eq!(
+            error.kind,
+            ParseErrorKind::Expecting {
+                value: String::from("}}")
+            }
+        );
+        assert!(!error.recoverable);
+    }
+
+    #[test]
+    fn test_expr_error_eof() {
+        let mut reader = Reader::new("{{host");
+        let error = parse(&mut reader).err().unwrap();
+        assert_eq!(error.pos, Pos { line: 1, column: 7 });
+        assert_eq!(
+            error.kind,
+            ParseErrorKind::Expecting {
+                value: String::from("}}")
+            }
+        );
+        assert!(!error.recoverable);
+    }
+}
diff --git a/packages/hurl_core/src/parser/predicate_value.rs b/packages/hurl_core/src/parser/predicate_value.rs
index f8e0db962ee..af10bfa9358 100644
--- a/packages/hurl_core/src/parser/predicate_value.rs
+++ b/packages/hurl_core/src/parser/predicate_value.rs
@@ -24,7 +24,7 @@ use crate::parser::string::*;
 use crate::parser::{ParseError, ParseErrorKind, ParseResult};
 use crate::reader::Reader;
 
-use super::template;
+use super::placeholder;
 
 pub fn predicate_value(reader: &mut Reader) -> ParseResult<PredicateValue> {
     choice(
@@ -53,7 +53,7 @@ pub fn predicate_value(reader: &mut Reader) -> ParseResult<PredicateValue> {
                 Ok(value) => Ok(PredicateValue::Base64(value)),
                 Err(e) => Err(e),
             },
-            |p1| match template::parse(p1) {
+            |p1| match placeholder::parse(p1) {
                 Ok(value) => Ok(PredicateValue::Expression(value)),
                 Err(e) => Err(e),
             },
diff --git a/packages/hurl_core/src/parser/template.rs b/packages/hurl_core/src/parser/template.rs
index 78c7c66c5e1..684261bf0fb 100644
--- a/packages/hurl_core/src/parser/template.rs
+++ b/packages/hurl_core/src/parser/template.rs
@@ -15,8 +15,7 @@
  * limitations under the License.
  *
  */
-use crate::ast::{Expr, SourceInfo, TemplateElement};
-use crate::parser::primitives::{literal, try_literal};
+use crate::ast::{SourceInfo, TemplateElement};
 use crate::parser::{error, expr, ParseResult};
 use crate::reader::{Pos, Reader};
 
@@ -25,16 +24,6 @@ pub struct EncodedString {
     pub chars: Vec<(char, String, Pos)>,
 }
 
-/// Parse a template
-///
-/// A template starts with '{{' and ends with '}}'
-pub fn parse(reader: &mut Reader) -> ParseResult<Expr> {
-    try_literal("{{", reader)?;
-    let expression = expr::parse(reader)?;
-    literal("}}", reader)?;
-    Ok(expression)
-}
-
 pub fn templatize(encoded_string: EncodedString) -> ParseResult<Vec<TemplateElement>> {
     enum State {
         String,
@@ -136,61 +125,10 @@ pub fn templatize(encoded_string: EncodedString) -> ParseResult<Vec<TemplateElem
 
 #[cfg(test)]
 mod tests {
-    use error::ParseErrorKind;
 
     use super::*;
     use crate::ast::{Expr, Variable, Whitespace};
 
-    #[test]
-    fn test_expr() {
-        let mut reader = Reader::new("{{ name}}");
-        assert_eq!(
-            parse(&mut reader).unwrap(),
-            Expr {
-                space0: Whitespace {
-                    value: String::from(" "),
-                    source_info: SourceInfo::new(Pos::new(1, 3), Pos::new(1, 4)),
-                },
-                variable: Variable {
-                    name: String::from("name"),
-                    source_info: SourceInfo::new(Pos::new(1, 4), Pos::new(1, 8)),
-                },
-                space1: Whitespace {
-                    value: String::new(),
-                    source_info: SourceInfo::new(Pos::new(1, 8), Pos::new(1, 8)),
-                },
-            }
-        );
-    }
-
-    #[test]
-    fn test_expr_error() {
-        let mut reader = Reader::new("{{host>}}");
-        let error = parse(&mut reader).err().unwrap();
-        assert_eq!(error.pos, Pos { line: 1, column: 7 });
-        assert_eq!(
-            error.kind,
-            ParseErrorKind::Expecting {
-                value: String::from("}}")
-            }
-        );
-        assert!(!error.recoverable);
-    }
-
-    #[test]
-    fn test_expr_error_eof() {
-        let mut reader = Reader::new("{{host");
-        let error = parse(&mut reader).err().unwrap();
-        assert_eq!(error.pos, Pos { line: 1, column: 7 });
-        assert_eq!(
-            error.kind,
-            ParseErrorKind::Expecting {
-                value: String::from("}}")
-            }
-        );
-        assert!(!error.recoverable);
-    }
-
     #[test]
     fn test_templatize_empty_string() {
         let encoded_string = EncodedString {