Merge pull request #97 from tmccombs/template-escapes

fix: Properly escape things that should be escaped

Author: tmccombs

convert/convert.go

@@ -219,14 +219,23 @@ func (c *converter) convertUnary(v *hclsyntax.UnaryOpExpr) (interface{}, error)
 	return ctyjson.SimpleJSONValue{Value: val}, nil
 }
 
+// Escape sequences that have special meaning in hcl json
+// such as ${ that come from literals, that shouldn't have
+// real interpolation
+func escapeLiteral(lit string) string {
+	lit = strings.Replace(lit, "${", "$${", -1)
+	lit = strings.Replace(lit, "%{", "%%{", -1)
+	return lit
+}
+
 func (c *converter) convertTemplate(t *hclsyntax.TemplateExpr) (string, error) {
 	if t.IsStringLiteral() {
 		// safe because the value is just the string
 		v, err := t.Value(nil)
 		if err != nil {
 			return "", err
 		}
-		return v.AsString(), nil
+		return escapeLiteral(v.AsString()), nil
 	}
 	var builder strings.Builder
 	for _, part := range t.Parts {
@@ -251,7 +260,7 @@ func (c *converter) convertStringPart(expr hclsyntax.Expression) (string, error)
 		if err != nil {
 			return "", err
 		}
-		return s.AsString(), nil
+		return escapeLiteral(s.AsString()), nil
 	case *hclsyntax.TemplateExpr:
 		return c.convertTemplate(v)
 	case *hclsyntax.TemplateWrapExpr:

convert/convert_test.go

@@ -305,6 +305,29 @@ func TestBlocksWithAndWithoutLabels(t *testing.T) {
 	}
 }
 
+// https://github.com/tmccombs/hcl2json/issues/96
+func TestTemplateEscapes(t *testing.T) {
+	input := `
+		v = "$${one}"
+		x = "${var.y} $${oh}"
+		y = "%{ if true }%%{hi}%{ endif }"
+		z = "%%{oh"
+	`
+
+	expected := `{
+	"v": "$${one}",
+	"x": "${var.y} $${oh}",
+	"y": "%{if true}%%{hi}%{endif}",
+	"z": "%%{oh"
+}`
+
+	converted, err := Bytes([]byte(input), "", Options{})
+	if err != nil {
+		t.Fatal("Failed to parse: ", err)
+	}
+	compareTest(t, converted, expected)
+}
+
 func compareTest(t *testing.T, input []byte, expected string) {
 	var indented bytes.Buffer
 	if err := json.Indent(&indented, input, "", "\t"); err != nil {