fix: unescape dots in env names (#2452)

Signed-off-by: Thorsten Klein <[email protected]>

Author: iwilltry42

pkg/controller/appdefinition/deploy.go

@@ -177,15 +177,15 @@ func toEnv(envs []v1.EnvVar, appEnvs []v1.NameValue, interpolator *secrets.Inter
 			if appEnvNames.Has(env.Name) {
 				continue
 			}
-			if strings.Contains(env.Secret.Name, ".") {
+			if secrets.HasUnescapedDot(env.Secret.Name) {
 				interpolated, noDotInKey := interpolator.ToEnv(env.Name, fmt.Sprintf("@{secrets.%s.%s}", env.Secret.Name, env.Secret.Key))
 				if noDotInKey {
 					interpolated.Name = strings.ReplaceAll(interpolated.Name, "\\.", ".") // restore dots that were escaped during unmarshalling
 					result = append(result, interpolated)
 				}
 			} else {
 				result = append(result, corev1.EnvVar{
-					Name: env.Name,
+					Name: strings.ReplaceAll(env.Name, "\\.", "."), // restore dots that were escaped during unmarshalling
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{

pkg/controller/appdefinition/deploy_test.go

@@ -131,6 +131,13 @@ func TestEnvironment(t *testing.T) {
 								Name:  "foo\\.bar",
 								Value: "baz",
 							},
+							{
+								Name: "foo\\.bar\\.baz",
+								Secret: v1.SecretReference{
+									Name: "somesecret",
+									Key:  "somesecretkey",
+								},
+							},
 						},
 					},
 				},
@@ -150,6 +157,17 @@ func TestEnvironment(t *testing.T) {
 			Name:  "foo.bar",
 			Value: "baz",
 		},
+		{
+			Name: "foo.bar.baz",
+			ValueFrom: &corev1.EnvVarSource{
+				SecretKeyRef: &corev1.SecretKeySelector{
+					Key: "somesecretkey",
+					LocalObjectReference: corev1.LocalObjectReference{
+						Name: "somesecret",
+					},
+				},
+			},
+		},
 	}, dep.Spec.Template.Spec.Containers[0].Env)
 }
 

pkg/secrets/interpolation.go

@@ -561,8 +561,8 @@ func (i *Interpolator) getContainerOrJobName() string {
 	return i.jobName
 }
 
-// hasUnescapedDot checks if a string contains an unescaped dot (i.e., a dot not escaped by a backslash).
-func hasUnescapedDot(s string) bool {
+// HasUnescapedDot checks if a string contains an unescaped dot (i.e., a dot not escaped by a backslash).
+func HasUnescapedDot(s string) bool {
 	for i := 0; i < len(s); i++ {
 		if s[i] == '.' {
 			// Match if it's the first character or not escaped by a backslash
@@ -584,7 +584,7 @@ func (i *Interpolator) ToEnv(key, value string) (corev1.EnvVar, bool) {
 		return corev1.EnvVar{
 			Name:  key,
 			Value: value,
-		}, !hasUnescapedDot(key)
+		}, !HasUnescapedDot(key)
 	}
 
 	newValue, err := i.Replace(value)
@@ -593,13 +593,13 @@ func (i *Interpolator) ToEnv(key, value string) (corev1.EnvVar, bool) {
 		return corev1.EnvVar{
 			Name:  newKey,
 			Value: value,
-		}, !hasUnescapedDot(key)
+		}, !HasUnescapedDot(key)
 	}
 	if value == newValue {
 		return corev1.EnvVar{
 			Name:  newKey,
 			Value: value,
-		}, !hasUnescapedDot(newKey)
+		}, !HasUnescapedDot(newKey)
 	}
 
 	return corev1.EnvVar{
@@ -612,7 +612,7 @@ func (i *Interpolator) ToEnv(key, value string) (corev1.EnvVar, bool) {
 				Key: i.addContent(newValue),
 			},
 		},
-	}, !hasUnescapedDot(newKey)
+	}, !HasUnescapedDot(newKey)
 }
 
 func (i *Interpolator) Objects() []kclient.Object {