Merge pull request #6295 from k0sproject/backport-6243-to-release-1.31

[Backport release-1.31] Add "idempotency" to image repository override

Author: juanluisvaladas

pkg/apis/k0s/v1beta1/images.go

@@ -244,6 +244,17 @@ func getHostName(imageName string) string {
 }
 
 func overrideRepository(repository string, originalImage string) string {
+	if repository == "" {
+		return originalImage
+	}
+
+	// "Idempotency": if the image already starts with the repository prefix, don't override
+	// This is needed sinice in some cases we run the override multiple times, e.g. when
+	// we unmarshal the config multiple times.
+	if strings.HasPrefix(originalImage, repository) {
+		return originalImage
+	}
+
 	if host := getHostName(originalImage); host != "" {
 		return strings.Replace(originalImage, host, repository, 1)
 	}

pkg/apis/k0s/v1beta1/images_test.go

@@ -96,28 +96,77 @@ func TestImagesRepoOverrideInConfiguration(t *testing.T) {
 }
 
 func TestOverrideFunction(t *testing.T) {
-	repository := "my.registry"
-	testCases := []struct {
-		Input  string
-		Output string
-	}{
-		{
-			Input:  "repo/image",
-			Output: "my.registry/repo/image",
-		},
-		{
-			Input:  "registry.com/repo/image",
-			Output: "my.registry/repo/image",
-		},
-		{
-			Input:  "image",
-			Output: "my.registry/image",
-		},
-	}
+	t.Run("overrideRepository without path", func(t *testing.T) {
+		repository := "my.registry"
+		testCases := []struct {
+			Input  string
+			Output string
+		}{
+			{
+				Input:  "repo/image",
+				Output: "my.registry/repo/image",
+			},
+			{
+				Input:  "registry.com/repo/image",
+				Output: "my.registry/repo/image",
+			},
+			{
+				Input:  "image",
+				Output: "my.registry/image",
+			},
+		}
+
+		for _, tc := range testCases {
+			assert.Equal(t, tc.Output, overrideRepository(repository, tc.Input))
+		}
+	})
+	t.Run("overrideRepository with path", func(t *testing.T) {
+		repository := "my.registry/foo"
+		testCases := []struct {
+			Input  string
+			Output string
+		}{
+			{
+				Input:  "repo/image",
+				Output: "my.registry/foo/repo/image",
+			},
+			{
+				Input:  "registry.com/repo/image",
+				Output: "my.registry/foo/repo/image",
+			},
+			{
+				Input:  "image",
+				Output: "my.registry/foo/image",
+			},
+		}
+		for _, tc := range testCases {
+			assert.Equal(t, tc.Output, overrideRepository(repository, tc.Input))
+		}
+	})
+	t.Run("overrideRepository with repo path and double invocation", func(t *testing.T) {
+		repository := "my.registry/foo"
+		testCases := []struct {
+			Input  string
+			Output string
+		}{
+			{
+				Input:  "repo/image",
+				Output: "my.registry/foo/repo/image",
+			},
+			{
+				Input:  "registry.com/repo/image",
+				Output: "my.registry/foo/repo/image",
+			},
+			{
+				Input:  "image",
+				Output: "my.registry/foo/image",
+			},
+		}
+		for _, tc := range testCases {
+			assert.Equal(t, tc.Output, overrideRepository(repository, overrideRepository(repository, tc.Input)))
+		}
+	})
 
-	for _, tc := range testCases {
-		assert.Equal(t, tc.Output, overrideRepository(repository, tc.Input))
-	}
 }
 
 func TestImageSpec_Validate(t *testing.T) {