do not add tag to path when mirroring (#12)

Author: apesternikov

mirror/defs.bzl

@@ -4,6 +4,13 @@ load("@rules_gitops//gitops:provider.bzl", "GitopsPushInfo")
 load("@com_adobe_rules_gitops//skylib:push.bzl", "K8sPushInfo")
 load("@rules_gitops//skylib:runfile.bzl", "get_runfile_path")
 
+def _replace_colon_except_last_segment(input_string):
+    segments = input_string.split("/")
+    for i in range(len(segments) - 1):
+        segments[i] = segments[i].replace(":", "")
+    output_string = "/".join(segments)
+    return output_string
+
 def _mirror_image_impl(ctx):
     digest = ctx.attr.digest
     src_image = ctx.attr.src_image
@@ -25,17 +32,11 @@ def _mirror_image_impl(ctx):
     if ctx.attr.dst:
         dst = ctx.expand_make_variables("dst", ctx.attr.dst, {})
         dst = dst.split("@", 1)[0]
-        v = dst.split(":", 1)
-        dst_without_hash = v[0]
-        if len(v) > 1:
-            fail("dst should not include a tag, only a repository")
+        dst_without_hash = _replace_colon_except_last_segment(dst)
     else:
         if not ctx.attr.dst_prefix:
             fail("either dst or dst_prefix must be defined in mirror_image")
-        v = s.split(":", 1)
-        src_repository = v[0]
-        if len(v) > 1:
-            src_repository = src_repository + "/" + v[1]
+        src_repository = _replace_colon_except_last_segment(s)
         dst_prefix = ctx.expand_make_variables("dst_prefix", ctx.attr.dst_prefix, {})
         dst_without_hash = dst_prefix.strip("/") + "/" + src_repository
 

mirror/tests/BUILD.bazel

@@ -32,6 +32,7 @@ assert_contains(
 oci_push(
     name = "push_image",
     image = ":image",
+    remote_tags = ["tag1"],
     repository = "localhost:1338/image",
     visibility = ["//visibility:public"],
 )
@@ -45,6 +46,15 @@ mirror_image(
     visibility = ["//visibility:public"],
 )
 
+mirror_image(
+    name = "image_mirror_with_tag",
+    digest = "sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+    dst_prefix = "localhost:1338/mirror2",
+    src_image = "localhost:1338/image:tag1",
+    tags = ["manual"],  # test should be tagged manual since it requires a running registry
+    visibility = ["//visibility:public"],
+)
+
 kustomize(
     name = "kustomize1",
     images = [
@@ -105,13 +115,13 @@ k8s_deploy_rg(
 assert_contains(
     name = "adobe_gitops_deploy_has_mirrored_image",
     actual = ":adobe_gitops_deploy",
-    expected = "image: localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+    expected = "image: localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
 )
 
 assert_contains(
     name = "fasterci_gitops_deploy_has_mirrored_image",
     actual = ":fasterci_gitops_deploy",
-    expected = "image: localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+    expected = "image: localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
 )
 
 exports_files([
@@ -159,7 +169,7 @@ sh_test(
     name = "adobe_gitops_apply_test",
     srcs = ["gitops_setup_test.sh"],
     args = [
-        "$(location :adobe_gitops_deploy.apply) localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+        "$(location :adobe_gitops_deploy.apply) localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
     ],
     data = [
         ":adobe_gitops_deploy.apply",
@@ -195,7 +205,7 @@ sh_test(
     name = "fasterci_gitops_setup_test",
     srcs = ["gitops_setup_test.sh"],
     args = [
-        "$(location :fasterci_gitops.setup) localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+        "$(location :fasterci_gitops.setup) localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
     ],
     data = [
         ":fasterci_gitops.setup",
@@ -220,7 +230,7 @@ sh_test(
     name = "fasterci_gitops_apply_test",
     srcs = ["gitops_setup_test.sh"],
     args = [
-        "$(location :fasterci_gitops_deploy.apply) localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+        "$(location :fasterci_gitops_deploy.apply) localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
     ],
     data = [
         ":fasterci_gitops_deploy.apply",
@@ -237,3 +247,47 @@ sh_test(
     },
     tags = ["exclusive"],  # this test starts a registry on fixed port 1338
 )
+
+sh_test(
+    name = "image_mirror_with_tag_test",
+    srcs = ["gitops_setup_test.sh"],
+    args = [
+        "$(location :image_mirror_with_tag) localhost:1338/mirror2/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc",
+    ],
+    data = [
+        ":image_mirror_with_tag",
+        ":kubectl",
+        ":push_image",
+        "@com_github_google_go_containerregistry//cmd/crane",
+        "@com_github_google_go_containerregistry//cmd/registry",
+    ],
+    env = {
+        "KUBECTL": "$(location :kubectl)",
+        "PUSH_IMAGE": "$(location :push_image)",
+        "CRANE_BIN": "$(location @com_github_google_go_containerregistry//cmd/crane)",
+        "REGISTRY_BIN": "$(location @com_github_google_go_containerregistry//cmd/registry)",
+    },
+    tags = ["exclusive"],  # this test starts a registry on fixed port 1338
+)
+
+sh_test(
+    name = "image_mirror_with_tag_test2",
+    srcs = ["gitops_setup_test.sh"],
+    args = [
+        "$(location :image_mirror_with_tag) localhost:1338/mirror2/localhost1338/image:tag1",
+    ],
+    data = [
+        ":image_mirror_with_tag",
+        ":kubectl",
+        ":push_image",
+        "@com_github_google_go_containerregistry//cmd/crane",
+        "@com_github_google_go_containerregistry//cmd/registry",
+    ],
+    env = {
+        "KUBECTL": "$(location :kubectl)",
+        "PUSH_IMAGE": "$(location :push_image)",
+        "CRANE_BIN": "$(location @com_github_google_go_containerregistry//cmd/crane)",
+        "REGISTRY_BIN": "$(location @com_github_google_go_containerregistry//cmd/registry)",
+    },
+    tags = ["exclusive"],  # this test starts a registry on fixed port 1338
+)

mirror/tests/kustomize1.golden

@@ -12,7 +12,7 @@ spec:
         app: myapp
     spec:
       containers:
-      - image: localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc
+      - image: localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc
         name: myapp
         ports:
         - containerPort: 8080

mirror/tests/kustomize2.golden

@@ -12,7 +12,7 @@ spec:
         app: myapp
     spec:
       containers:
-      - image: localhost:1338/mirror/localhost/1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc
+      - image: localhost:1338/mirror/localhost1338/image@sha256:b812c0570a7c369b2863c64e22760dc1b1dbc025a739f02db376bac62862f4cc
         name: myapp
         ports:
         - containerPort: 8080

pkg/mirror/mirror.go

@@ -37,28 +37,16 @@ func ExecuteContext(ctx context.Context, fromLocation, to, digest string) error
 	if err != nil {
 		return err
 	}
-	// check if dst exists already
-	if _, ok := dstRef.(name.Tag); ok {
-		logs.Progress.Printf("fetching manifest for %s", dstRef)
-		dst, err := remote.Get(dstRef, remote.WithAuthFromKeychain(authn.DefaultKeychain), remote.WithContext(ctx))
-		if err == nil {
-			// if the dst manifest exists, check if it's the same as the src
-			if dst.Digest.String() == hash.String() {
-				logs.Progress.Printf("found manifest for %s digest %s", dstRef, dst.Digest)
-				return nil
-			}
-			logs.Progress.Printf("manifest digest for %s expected %s got %s", shaDstRef, hash, dst.Digest)
-		}
-	} else {
-		logs.Progress.Printf("fetching manifest for %s", shaDstRef)
-		_, err = remote.Head(shaDstRef, remote.WithAuthFromKeychain(authn.DefaultKeychain), remote.WithContext(ctx))
-		if err == nil {
-			// if the dst manifest exists, check if it's the same as the src
-			logs.Progress.Printf("found manifest for %s", shaDstRef)
-			return nil
-		}
-
+	// check if dst exists already.
+	// We are not verifying if the dst has the same tag
+	logs.Progress.Printf("fetching manifest for %s", shaDstRef)
+	_, err = remote.Head(shaDstRef, remote.WithAuthFromKeychain(authn.DefaultKeychain), remote.WithContext(ctx))
+	if err == nil {
+		// if the dst manifest exists, check if it's the same as the src
+		logs.Progress.Printf("found manifest for %s", shaDstRef)
+		return nil
 	}
+
 	logs.Progress.Printf("fetching manifest for %s", ref)
 	src, err := remote.Get(ref, remote.WithAuthFromKeychain(authn.DefaultKeychain), remote.WithContext(ctx))
 	if err != nil {