fix: don't unescape dollars in environment variable placeholders (#241)

Signed-off-by: Ben Meier <[email protected]>
score-spec · Jan 15, 2025 · a4fe4a4 · a4fe4a4
1 parent 935a22a
commit a4fe4a4
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/examples/02-environment/README.md b/examples/02-environment/README.md
@@ -21,6 +21,7 @@ containers:
       GREETING: Hello
       NAME: ${resources.env.NAME}
       WORKLOAD_NAME: ${metadata.name}
+      ESCAPED: $$_$${fizzbuzz}
 
 resources:
   env:
@@ -48,6 +49,7 @@ services:
         entrypoint:
             - /bin/sh
         environment:
+            ESCAPED: $$_$${fizzbuzz}
             GREETING: Hello
             NAME: ${NAME}
             WORKLOAD_NAME: hello-world

diff --git a/examples/02-environment/score.yaml b/examples/02-environment/score.yaml
@@ -12,6 +12,7 @@ containers:
       GREETING: Hello
       NAME: ${resources.env.NAME}
       WORKLOAD_NAME: ${metadata.name}
+      ESCAPED: $$_$${fizzbuzz}
 
 resources:
   env:

diff --git a/internal/command/generate_examples_test.go b/internal/command/generate_examples_test.go
@@ -68,6 +68,7 @@ services:
         entrypoint:
             - /bin/sh
         environment:
+            ESCAPED: $$_$${fizzbuzz}
             GREETING: Hello
             NAME: ${NAME}
             WORKLOAD_NAME: hello-world

diff --git a/internal/compose/convert.go b/internal/compose/convert.go
@@ -68,13 +68,20 @@ func ConvertSpec(state *project.State, spec *score.Workload) (*compose.Project,
 	}
 	sort.Strings(containerNames)
 
+	variablesSubstitutor := framework.Substituter{
+		Replacer: deferredSubstitutionFunction,
+		UnEscaper: func(s string) (string, error) {
+			return s, nil
+		},
+	}
+
 	var firstService string
 	for _, containerName := range containerNames {
 		cSpec := spec.Containers[containerName]
 
 		var env = make(compose.MappingWithEquals, len(cSpec.Variables))
 		for key, val := range cSpec.Variables {
-			resolved, err := framework.SubstituteString(val, deferredSubstitutionFunction)
+			resolved, err := variablesSubstitutor.SubstituteString(val)
 			if err != nil {
 				return nil, fmt.Errorf("containers.%s.variables.%s: %w", containerName, key, err)
 			}

diff --git a/internal/compose/convert_test.go b/internal/compose/convert_test.go
@@ -156,7 +156,7 @@ func TestScoreConvert(t *testing.T) {
 						Image:    "busybox",
 						Environment: compose.MappingWithEquals{
 							"DEBUG":             stringPtr("${DEBUG}"),
-							"LOGS_LEVEL":        stringPtr("${LOGS_LEVEL}"),
+							"LOGS_LEVEL":        stringPtr("$${LOGS_LEVEL}"),
 							"DOMAIN_NAME":       stringPtr("${SOME_DNS_DOMAIN_NAME?required}"),
 							"CONNECTION_STRING": stringPtr("postgresql://${APP_DB_HOST?required}:${APP_DB_PORT?required}/${APP_DB_NAME?required}"),
 						},
@@ -229,7 +229,7 @@ func TestScoreConvert(t *testing.T) {
 						Image:    "busybox",
 						Environment: compose.MappingWithEquals{
 							"DEBUG":             stringPtr("${DEBUG}"),
-							"LOGS_LEVEL":        stringPtr("${LOGS_LEVEL}"),
+							"LOGS_LEVEL":        stringPtr("$${LOGS_LEVEL}"),
 							"DOMAIN_NAME":       stringPtr("${SOME_DNS_DOMAIN_NAME?required}"),
 							"CONNECTION_STRING": stringPtr("mysql://${APP_DB_HOST?required}:${APP_DB_PORT?required}/${APP_DB_NAME?required}"),
 						},