fix(controllers): hash repository labels longer than 63 chars

closes #33

Author: plaffitt

controllers/pod_controller.go

@@ -269,7 +269,7 @@ func cachedImageFromSourceImage(sourceImage string) (*dcrenixiov1alpha1.CachedIm
 		ObjectMeta: metav1.ObjectMeta{
 			Name: sanitizedName,
 			Labels: map[string]string{
-				dcrenixiov1alpha1.RepositoryLabelName: registry.SanitizeName(named.Name()),
+				dcrenixiov1alpha1.RepositoryLabelName: registry.RepositoryLabel(named.Name()),
 			},
 		},
 		Spec: dcrenixiov1alpha1.CachedImageSpec{

controllers/pod_controller_test.go

@@ -10,6 +10,7 @@ import (
 	. "github.com/onsi/gomega"
 	"gitlab.enix.io/products/docker-cache-registry/api/v1alpha1"
 	dcrenixiov1alpha1 "gitlab.enix.io/products/docker-cache-registry/api/v1alpha1"
+	"gitlab.enix.io/products/docker-cache-registry/internal/registry"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -136,7 +137,7 @@ func Test_cachedImageFromSourceImage(t *testing.T) {
 			g.Expect(cachedImage.Spec.PullSecretNames).To(BeEmpty())
 			g.Expect(cachedImage.Spec.PullSecretsNamespace).To(BeEmpty())
 			g.Expect(cachedImage.Labels).To(Equal(map[string]string{
-				dcrenixiov1alpha1.RepositoryLabelName: tt.expectedRepository,
+				dcrenixiov1alpha1.RepositoryLabelName: registry.RepositoryLabel(tt.expectedRepository),
 			}))
 		})
 	}

internal/proxy/server.go

@@ -186,7 +186,7 @@ func (p *Proxy) proxyRegistry(c *gin.Context, endpoint string, endpointIsOrigin
 }
 
 func (p *Proxy) getBasicAuth(registryDomain string, repository string) (string, error) {
-	repositoryLabel := registry.SanitizeName(registryDomain + "/" + repository)
+	repositoryLabel := registry.RepositoryLabel(registryDomain + "/" + repository)
 	cachedImages := &dcrenixiov1alpha1.CachedImageList{}
 	secret := &corev1.Secret{}
 

internal/registry/registry.go

@@ -1,7 +1,9 @@
 package registry
 
 import (
+	"crypto/sha256"
 	"errors"
+	"fmt"
 	"net/http"
 	"regexp"
 	"strings"
@@ -118,3 +120,13 @@ func SanitizeName(image string) string {
 	nameRegex := regexp.MustCompile(`[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`)
 	return strings.Join(nameRegex.FindAllString(image, -1), "-")
 }
+
+func RepositoryLabel(repositoryName string) string {
+	sanitizedName := SanitizeName(repositoryName)
+
+	if len(sanitizedName) > 63 {
+		return fmt.Sprintf("%x", sha256.Sum224([]byte(sanitizedName)))
+	}
+
+	return sanitizedName
+}

internal/registry/registry_test.go

@@ -0,0 +1,77 @@
+package registry
+
+import (
+	"crypto/sha256"
+	"fmt"
+	"testing"
+
+	. "github.com/onsi/gomega"
+)
+
+func sha224(str string) string {
+	return fmt.Sprintf("%x", sha256.Sum224([]byte(str)))
+}
+
+func TestSanitizeName(t *testing.T) {
+	tests := []struct {
+		name                   string
+		image                  string
+		expectedSanitizedImage string
+	}{
+		{
+			name:                   "Basic",
+			image:                  "docker.io/library/alpine",
+			expectedSanitizedImage: "docker.io-library-alpine",
+		},
+		{
+			name:                   "Advanced",
+			image:                  "some-gitlab-registry.com:5000/group/another-group/project/backend:v1.0.0",
+			expectedSanitizedImage: "some-gitlab-registry.com-5000-group-another-group-project-backend-v1.0.0",
+		},
+	}
+
+	g := NewWithT(t)
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			label := SanitizeName(tt.image)
+			g.Expect(label).To(Equal(tt.expectedSanitizedImage))
+		})
+	}
+}
+
+func TestRepositoryLabel(t *testing.T) {
+	tests := []struct {
+		name           string
+		repositoryName string
+		expectedLabel  string
+	}{
+		{
+			name:           "Basic",
+			repositoryName: "docker.io/library/alpine",
+			expectedLabel:  "docker.io-library-alpine",
+		},
+		{
+			name:           "Long name",
+			repositoryName: "docker.io/rancher/mirrored-prometheus-operator-prometheus-operator",
+			expectedLabel:  sha224("docker.io-rancher-mirrored-prometheus-operator-prometheus-operator"),
+		},
+		{
+			name:           "63 chars",
+			repositoryName: "docker.io/rancher/mirrored-prometheus-operator-prometheus-opera",
+			expectedLabel:  "docker.io-rancher-mirrored-prometheus-operator-prometheus-opera",
+		},
+		{
+			name:           "64 chars",
+			repositoryName: "docker.io/rancher/mirrored-prometheus-operator-prometheus-operat",
+			expectedLabel:  sha224("docker.io-rancher-mirrored-prometheus-operator-prometheus-operat"),
+		},
+	}
+
+	g := NewWithT(t)
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			label := RepositoryLabel(tt.repositoryName)
+			g.Expect(label).To(Equal(tt.expectedLabel))
+		})
+	}
+}