Support dashes in Helm values (#4841)

Co-authored-by: Ralf Pannemans <[email protected]>
SAP · Feb 21, 2024 · 54426d1 · 54426d1
1 parent d0f99c3
commit 54426d1
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 10 deletions.
diff --git a/cmd/kubernetesDeploy.go b/cmd/kubernetesDeploy.go
@@ -453,15 +453,23 @@ func (dv *deploymentValues) asHelmValues() map[string]interface{} {
 	}
 }
 
-func createKey(parts ...string) string {
+func createKey(replacer *strings.Replacer, parts ...string) string {
 	escapedParts := make([]string, 0, len(parts))
-	replacer := strings.NewReplacer(".", "_", "-", "_")
+
 	for _, part := range parts {
 		escapedParts = append(escapedParts, replacer.Replace(part))
 	}
 	return strings.Join(escapedParts, ".")
 }
 
+func createGoKey(parts ...string) string {
+	return createKey(strings.NewReplacer(".", "_", "-", "_"), parts...)
+}
+
+func createHelmKey(parts ...string) string {
+	return createKey(strings.NewReplacer(".", "_"), parts...)
+}
+
 func getTempDirForKubeCtlJSON() string {
 	tmpFolder, err := os.MkdirTemp(".", "temp-")
 	if err != nil {
@@ -552,11 +560,13 @@ func defineDeploymentValues(config kubernetesDeployOptions, containerRegistry st
 				tag = fmt.Sprintf("%s@%s", tag, config.ImageDigests[i])
 			}
 
-			dv.add(createKey("image", key, "repository"), fmt.Sprintf("%v/%v", containerRegistry, name))
-			dv.add(createKey("image", key, "tag"), tag)
+			dv.add(createGoKey("image", key, "repository"), fmt.Sprintf("%v/%v", containerRegistry, name))
+			dv.add(createGoKey("image", key, "tag"), tag)
 			// usable for subcharts:
-			dv.add(createKey(key, "image", "repository"), fmt.Sprintf("%v/%v", containerRegistry, name))
-			dv.add(createKey(key, "image", "tag"), tag)
+			dv.add(createGoKey(key, "image", "repository"), fmt.Sprintf("%v/%v", containerRegistry, name))
+			dv.add(createGoKey(key, "image", "tag"), tag)
+			dv.add(createHelmKey(key, "image", "repository"), fmt.Sprintf("%v/%v", containerRegistry, name))
+			dv.add(createHelmKey(key, "image", "tag"), tag)
 
 			if len(config.ImageNames) == 1 {
 				dv.singleImage = true
@@ -584,8 +594,8 @@ func defineDeploymentValues(config kubernetesDeployOptions, containerRegistry st
 		dv.add("image.repository", fmt.Sprintf("%v/%v", containerRegistry, containerImageName))
 		dv.add("image.tag", containerImageTag)
 
-		dv.add(createKey("image", containerImageName, "repository"), fmt.Sprintf("%v/%v", containerRegistry, containerImageName))
-		dv.add(createKey("image", containerImageName, "tag"), containerImageTag)
+		dv.add(createGoKey("image", containerImageName, "repository"), fmt.Sprintf("%v/%v", containerRegistry, containerImageName))
+		dv.add(createGoKey("image", containerImageName, "tag"), containerImageTag)
 	}
 
 	return dv, nil

diff --git a/cmd/kubernetesDeploy_test.go b/cmd/kubernetesDeploy_test.go
@@ -724,10 +724,45 @@ func TestRunKubernetesDeploy(t *testing.T) {
 
 		assert.Equal(t, "helm", mockUtils.Calls[1].Exec, "Wrong upgrade command")
 
-		assert.Contains(t, mockUtils.Calls[1].Params, `image.myImage.repository=my.registry:55555/myImage,image.myImage.tag=myTag,myImage.image.repository=my.registry:55555/myImage,myImage.image.tag=myTag,image.myImage_sub1.repository=my.registry:55555/myImage-sub1,image.myImage_sub1.tag=myTag,myImage_sub1.image.repository=my.registry:55555/myImage-sub1,myImage_sub1.image.tag=myTag,image.myImage_sub2.repository=my.registry:55555/myImage-sub2,image.myImage_sub2.tag=myTag,myImage_sub2.image.repository=my.registry:55555/myImage-sub2,myImage_sub2.image.tag=myTag,secret.name=testSecret,secret.dockerconfigjson=ThisIsOurBase64EncodedSecret==,imagePullSecrets[0].name=testSecret`, "Wrong upgrade parameters")
+		assert.Contains(t, mockUtils.Calls[1].Params, `image.myImage.repository=my.registry:55555/myImage,image.myImage.tag=myTag,myImage.image.repository=my.registry:55555/myImage,myImage.image.tag=myTag,myImage.image.repository=my.registry:55555/myImage,myImage.image.tag=myTag,image.myImage_sub1.repository=my.registry:55555/myImage-sub1,image.myImage_sub1.tag=myTag,myImage_sub1.image.repository=my.registry:55555/myImage-sub1,myImage_sub1.image.tag=myTag,myImage_sub1.image.repository=my.registry:55555/myImage-sub1,myImage_sub1.image.tag=myTag,image.myImage_sub2.repository=my.registry:55555/myImage-sub2,image.myImage_sub2.tag=myTag,myImage_sub2.image.repository=my.registry:55555/myImage-sub2,myImage_sub2.image.tag=myTag,myImage_sub2.image.repository=my.registry:55555/myImage-sub2,myImage_sub2.image.tag=myTag,secret.name=testSecret,secret.dockerconfigjson=ThisIsOurBase64EncodedSecret==,imagePullSecrets[0].name=testSecret`, "Wrong upgrade parameters")
 
 	})
 
+	t.Run("test helm v3 - with one image containing - in name", func(t *testing.T) {
+		opts := kubernetesDeployOptions{
+			ContainerRegistryURL:      "https://my.registry:55555",
+			ContainerRegistryUser:     "registryUser",
+			ContainerRegistryPassword: "dummy",
+			ContainerRegistrySecret:   "testSecret",
+			ChartPath:                 "path/to/chart",
+			DeploymentName:            "deploymentName",
+			DeployTool:                "helm3",
+			ForceUpdates:              true,
+			HelmDeployWaitSeconds:     400,
+			HelmValues:                []string{"values1.yaml", "values2.yaml"},
+			ImageNames:                []string{"my-Image"},
+			ImageNameTags:             []string{"my-Image:myTag"},
+			KubeContext:               "testCluster",
+			Namespace:                 "deploymentNamespace",
+			DockerConfigJSON:          ".pipeline/docker/config.json",
+		}
+
+		dockerConfigJSON := `{"kind": "Secret","data":{".dockerconfigjson": "ThisIsOurBase64EncodedSecret=="}}`
+
+		mockUtils := newKubernetesDeployMockUtils()
+		mockUtils.StdoutReturn = map[string]string{
+			`kubectl create secret generic testSecret --from-file=.dockerconfigjson=.pipeline/docker/config.json --type=kubernetes.io/dockerconfigjson --insecure-skip-tls-verify=true --dry-run=client --output=json`: dockerConfigJSON,
+		}
+
+		var stdout bytes.Buffer
+
+		require.NoError(t, runKubernetesDeploy(opts, &telemetry.CustomData{}, mockUtils, &stdout))
+
+		assert.Equal(t, "helm", mockUtils.Calls[1].Exec, "Wrong upgrade command")
+		assert.Contains(t, mockUtils.Calls[1].Params[11], "my-Image.image.tag=myTag")
+		assert.Contains(t, mockUtils.Calls[1].Params[11], "my-Image.image.repository=")
+	})
+
 	t.Run("test helm v3 - with one image in  multiple images array", func(t *testing.T) {
 		opts := kubernetesDeployOptions{
 			ContainerRegistryURL:      "https://my.registry:55555",
@@ -774,7 +809,7 @@ func TestRunKubernetesDeploy(t *testing.T) {
 
 		assert.Equal(t, "helm", mockUtils.Calls[1].Exec, "Wrong upgrade command")
 
-		assert.Contains(t, mockUtils.Calls[1].Params, `image.myImage.repository=my.registry:55555/myImage,image.myImage.tag=myTag,myImage.image.repository=my.registry:55555/myImage,myImage.image.tag=myTag,image.repository=my.registry:55555/myImage,image.tag=myTag,secret.name=testSecret,secret.dockerconfigjson=ThisIsOurBase64EncodedSecret==,imagePullSecrets[0].name=testSecret`, "Wrong upgrade parameters")
+		assert.Contains(t, mockUtils.Calls[1].Params, `image.myImage.repository=my.registry:55555/myImage,image.myImage.tag=myTag,myImage.image.repository=my.registry:55555/myImage,myImage.image.tag=myTag,myImage.image.repository=my.registry:55555/myImage,myImage.image.tag=myTag,image.repository=my.registry:55555/myImage,image.tag=myTag,secret.name=testSecret,secret.dockerconfigjson=ThisIsOurBase64EncodedSecret==,imagePullSecrets[0].name=testSecret`, "Wrong upgrade parameters")
 
 	})