be able to add legible tags based on original repo name using --repo-based-tags flag

.github/workflows/gh-test-external-registry.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - develop
   pull_request_target:
-    types: [opened, reopened, synchronize]
+    types: [opened, reopened, synchronize, edited]
 permissions:
   contents: read
   actions: none

pkg/imgpkg/cmd/copy.go

@@ -36,6 +36,7 @@ type CopyOptions struct {
 
 	Concurrency             int
 	IncludeNonDistributable bool
+	UseRepoBasedTags        bool
 }
 
 // NewCopyOptions constructor for building a CopyOptions, holding values derived via flags
@@ -60,7 +61,16 @@ func NewCopyCmd(o *CopyOptions) *cobra.Command {
     # NOTE: if not using ~/.docker.config for authn, use env vars as described  #
     # in https://carvel.dev/imgpkg/docs/v0.24.0/auth/#via-environment-variables #
     # ##########################################################################
-    imgpkg copy -i dkalinin/app1-image --to-repo internal-registry/app1-image`,
+    imgpkg copy -i dkalinin/app1-image --to-repo internal-registry/app1-image
+
+    # Copy using image --repo-based-tags flag
+    imgpkg copy -i registry.foo.bar/some/application/app \
+                --to-repo other-reg.faz.baz/my-app --repo-based-tags
+
+    # If the above source repo has a tag sha256:669e010b58baf5beb2836b253c1fd5768333f0d1dbcb834f7c07a4dc93f474be,
+    # a new tag some-application-app-sha256-669e010b58baf5beb2836b253c1fd5768333f0d1dbcb834f7c07a4dc93f474be.imgpkg
+    # will be created in the destination repo. Note that the part of the new tag preceeding '-sha256' will be truncated to
+    # the last 49 charachters`,
 	}
 
 	o.ImageFlags.SetCopy(cmd)
@@ -74,6 +84,8 @@ func NewCopyCmd(o *CopyOptions) *cobra.Command {
 	cmd.Flags().IntVar(&o.Concurrency, "concurrency", 5, "Concurrency")
 	cmd.Flags().BoolVar(&o.IncludeNonDistributable, "include-non-distributable-layers", false,
 		"Include non-distributable layers when copying an image/bundle")
+	cmd.Flags().BoolVar(&o.UseRepoBasedTags, "repo-based-tags", false,
+		"Allow imgpkg to use repository-based tags for convenience")
 	return cmd
 }
 
@@ -97,7 +109,13 @@ func (c *CopyOptions) Run() error {
 	levelLogger := util.NewUILevelLogger(util.LogWarn, prefixedLogger)
 	imagesUploaderLogger := util.NewProgressBar(levelLogger, "done uploading images", "Error uploading images")
 
-	imageSet := ctlimgset.NewImageSet(c.Concurrency, prefixedLogger)
+	var tagGen util.TagGenerator
+	tagGen = util.DefaultTagGenerator{}
+	if c.UseRepoBasedTags {
+		tagGen = util.RepoBasedTagGenerator{}
+	}
+
+	imageSet := ctlimgset.NewImageSet(c.Concurrency, prefixedLogger, tagGen)
 	tarImageSet := ctlimgset.NewTarImageSet(imageSet, c.Concurrency, prefixedLogger)
 
 	var signatureRetriever SignatureRetriever

pkg/imgpkg/cmd/copy_repo_src.go

@@ -155,7 +155,6 @@ func (c CopyRepoSrc) getAllSourceImages() (*ctlimgset.UnprocessedImageRefs, []*c
 
 func (c CopyRepoSrc) getProvidedSourceImages() (*ctlimgset.UnprocessedImageRefs, []*ctlbundle.Bundle, error) {
 	unprocessedImageRefs := ctlimgset.NewUnprocessedImageRefs()
-
 	switch {
 	case c.LockInputFlags.LockFilePath != "":
 		bundleLock, imagesLock, err := lockconfig.NewLockFromPath(c.LockInputFlags.LockFilePath)
@@ -229,17 +228,17 @@ func (c CopyRepoSrc) getProvidedSourceImages() (*ctlimgset.UnprocessedImageRefs,
 		}
 
 		for _, img := range imagesRef.ImageRefs() {
-			unprocessedImageRefs.Add(ctlimgset.UnprocessedImageRef{DigestRef: img.PrimaryLocation()})
+			unprocessedImageRefs.Add(ctlimgset.UnprocessedImageRef{DigestRef: img.PrimaryLocation(), OrigRef: img.Image})
 		}
 
 		unprocessedImageRefs.Add(ctlimgset.UnprocessedImageRef{
 			DigestRef: bundle.DigestRef(),
 			Tag:       bundle.Tag(),
 			Labels: map[string]string{
 				rootBundleLabelKey: "",
-			}},
+			},
+			OrigRef: bundle.DigestRef()},
 		)
-
 		return unprocessedImageRefs, allBundles, nil
 	}
 }

pkg/imgpkg/cmd/copy_repo_src_test.go

@@ -49,7 +49,8 @@ func TestMain(m *testing.M) {
 	defer confUI.Flush()
 	uiLogger := util.NewUILevelLogger(util.LogWarn, confUI)
 
-	imageSet := imageset.NewImageSet(1, confUI)
+	tagGen := util.DefaultTagGenerator{}
+	imageSet := imageset.NewImageSet(1, confUI, tagGen)
 
 	subject = CopyRepoSrc{
 		ui:                 uiLogger,

pkg/imgpkg/imagedesc/described_reader.go

@@ -23,11 +23,11 @@ func (r DescribedReader) Read() []ImageOrIndex {
 		switch {
 		case td.Image != nil:
 			var img ImageWithRef = NewDescribedImage(*td.Image, r.layerProvider)
-			result = append(result, ImageOrIndex{Image: &img, Labels: td.Image.Labels})
+			result = append(result, ImageOrIndex{Image: &img, Labels: td.Image.Labels, OrigRef: td.OrigRef()})
 
 		case td.ImageIndex != nil:
 			idx := r.buildIndex(*td.ImageIndex)
-			result = append(result, ImageOrIndex{Index: &idx, Labels: td.ImageIndex.Labels})
+			result = append(result, ImageOrIndex{Index: &idx, Labels: td.ImageIndex.Labels, OrigRef: td.OrigRef()})
 
 		default:
 			panic("Unknown item")

pkg/imgpkg/imagedesc/image_ref_descriptors.go

@@ -28,9 +28,10 @@ type Registry interface {
 }
 
 type Metadata struct {
-	Ref    regname.Reference
-	Tag    string
-	Labels map[string]string
+	Ref     regname.Reference
+	Tag     string
+	Labels  map[string]string
+	OrigRef string
 }
 
 type ImageRefDescriptors struct {
@@ -120,6 +121,7 @@ func (ids *ImageRefDescriptors) buildImageIndex(ref Metadata, regDesc regv1.Desc
 		Digest:    regDesc.Digest.String(),
 		Tag:       ref.Tag,
 		Labels:    ref.Labels,
+		OrigRef:   ref.OrigRef,
 	}
 
 	imgIndex, err := ids.registry.Index(ref.Ref)
@@ -141,13 +143,13 @@ func (ids *ImageRefDescriptors) buildImageIndex(ref Metadata, regDesc regv1.Desc
 
 	for _, manDesc := range imgIndexManifest.Manifests {
 		if ids.isImageIndex(manDesc) {
-			imgIndexTd, err := ids.buildImageIndex(Metadata{ids.buildRef(ref.Ref, manDesc.Digest.String()), ref.Tag, ref.Labels}, manDesc)
+			imgIndexTd, err := ids.buildImageIndex(Metadata{ids.buildRef(ref.Ref, manDesc.Digest.String()), ref.Tag, ref.Labels, ref.OrigRef}, manDesc)
 			if err != nil {
 				return ImageIndexDescriptor{}, err
 			}
 			td.Indexes = append(td.Indexes, imgIndexTd)
 		} else {
-			imgTd, err := ids.buildImage(Metadata{ids.buildRef(ref.Ref, manDesc.Digest.String()), ref.Tag, ref.Labels})
+			imgTd, err := ids.buildImage(Metadata{ids.buildRef(ref.Ref, manDesc.Digest.String()), ref.Tag, ref.Labels, ref.OrigRef})
 			if err != nil {
 				return ImageIndexDescriptor{}, err
 			}
@@ -201,8 +203,9 @@ func (ids *ImageRefDescriptors) buildImage(ref Metadata) (ImageDescriptor, error
 			Digest:    manifestDigest.String(),
 			Raw:       string(manifestBlob),
 		},
-		Tag:    ref.Tag,
-		Labels: ref.Labels,
+		Tag:     ref.Tag,
+		Labels:  ref.Labels,
+		OrigRef: ref.OrigRef,
 	}
 
 	layers, err := img.Layers()

pkg/imgpkg/imagedesc/types.go

@@ -21,8 +21,9 @@ type ImageOrIndex struct {
 	Index *ImageIndexWithRef
 
 	Labels map[string]string
-}
 
+	OrigRef string
+}
 type ImageWithRef interface {
 	regv1.Image
 	Ref() string
@@ -57,6 +58,7 @@ type ImageIndexDescriptor struct {
 	Digest    string
 	Raw       string
 	Tag       string
+	OrigRef   string
 
 	Labels map[string]string
 }
@@ -68,8 +70,8 @@ type ImageDescriptor struct {
 	Config   ConfigDescriptor
 	Manifest ManifestDescriptor
 	Tag      string
-
-	Labels map[string]string
+	OrigRef  string
+	Labels   map[string]string
 }
 
 type ImageLayerDescriptor struct {
@@ -110,6 +112,19 @@ func (td ImageOrImageIndexDescriptor) SortKey() string {
 	}
 }
 
+// OrigRef returns ImagesLock's image value
+// of an Image or an ImageIndex
+func (td ImageOrImageIndexDescriptor) OrigRef() string {
+	switch {
+	case td.Image != nil:
+		return (*td.Image).OrigRef
+	case td.ImageIndex != nil:
+		return (*td.ImageIndex).OrigRef
+	default:
+		panic("Unknown item")
+	}
+}
+
 func (td ImageIndexDescriptor) SortKey() string { return td.Digest }
 func (td ImageDescriptor) SortKey() string      { return td.Manifest.Digest + "/" + td.Config.Digest }
 

pkg/imgpkg/imagedigest/imagedigest.go

@@ -0,0 +1,39 @@
+// Copyright 2020 VMware, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+package imagedigest
+
+import (
+	regname "github.com/google/go-containerregistry/pkg/name"
+)
+
+// DigestWrap holds regname.Digest and orig reference
+// retrieved from ImagesLock's image field
+type DigestWrap struct {
+	regnameDigest regname.Digest
+	origRef       string
+}
+
+// DigestWrap sets regnameDigest and origRef fields' values
+func (dw *DigestWrap) DigestWrap(imgIdxRef string, origRef string) error {
+	regnameDigest, err := regname.NewDigest(imgIdxRef)
+	if err != nil {
+		return err
+	}
+	dw.regnameDigest = regnameDigest
+	dw.origRef = origRef
+
+	return nil
+}
+
+// RegnameDigest returns regnameDigest value of
+// DigestWrap instance
+func (dw *DigestWrap) RegnameDigest() regname.Digest {
+	return dw.regnameDigest
+}
+
+// OrigRef returns origRef value of
+// DigestWrap instance
+func (dw *DigestWrap) OrigRef() string {
+	return dw.origRef
+}

pkg/imgpkg/imageset/image_set.go

@@ -12,6 +12,7 @@ import (
 	regv1 "github.com/google/go-containerregistry/pkg/v1"
 	regremote "github.com/google/go-containerregistry/pkg/v1/remote"
 	"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/imagedesc"
+	"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/imagedigest"
 	"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/internal/util"
 	"github.com/vmware-tanzu/carvel-imgpkg/pkg/imgpkg/registry"
 )
@@ -23,16 +24,16 @@ type Logger interface {
 type ImageSet struct {
 	concurrency int
 	ui          goui.UI
+	tagGen      util.TagGenerator
 }
 
 // NewImageSet constructor for creating an ImageSet
-func NewImageSet(concurrency int, ui goui.UI) ImageSet {
-	return ImageSet{concurrency, ui}
+func NewImageSet(concurrency int, ui goui.UI, tagGen util.TagGenerator) ImageSet {
+	return ImageSet{concurrency, ui, tagGen}
 }
 
 func (i ImageSet) Relocate(foundImages *UnprocessedImageRefs,
 	importRepo regname.Repository, registry registry.ImagesReaderWriter) (*ProcessedImages, error) {
-
 	ids, err := i.Export(foundImages, registry)
 	if err != nil {
 		return nil, err
@@ -60,7 +61,7 @@ func (i ImageSet) Export(foundImages *UnprocessedImageRefs,
 		}
 
 		i.ui.BeginLinef("will export %s\n", img.DigestRef)
-		refs = append(refs, imagedesc.Metadata{Ref: ref, Tag: img.Tag, Labels: img.Labels})
+		refs = append(refs, imagedesc.Metadata{Ref: ref, Tag: img.Tag, Labels: img.Labels, OrigRef: img.OrigRef})
 	}
 
 	ids, err := imagedesc.NewImageRefDescriptors(refs, imagesMetadata)
@@ -147,19 +148,24 @@ func checkForAnyAsyncErrors(imgOrIndexes []imagedesc.ImageOrIndex, errCh chan er
 }
 
 func (i ImageSet) getImageOrImageIndexForMultiWrite(item imagedesc.ImageOrIndex, importRepo regname.Repository, registry registry.ImagesReaderWriter) (regname.Tag, regremote.Taggable, error) {
-	uploadTagRef, err := util.BuildDefaultUploadTagRef(item, importRepo)
+	digestWrap := imagedigest.DigestWrap{}
+	err := digestWrap.DigestWrap(item.Ref(), item.OrigRef)
+	if err != nil {
+		return regname.Tag{}, nil, err
+	}
+	uploadTagRef, err := i.tagGen.GenerateTag(digestWrap, importRepo)
 	if err != nil {
 		return regname.Tag{}, nil, err
 	}
 
 	var artifactToWrite regremote.Taggable
+
 	switch {
 	case item.Image != nil:
 		artifactToWrite, err = i.mountableImage(*item.Image, uploadTagRef, registry)
 		if err != nil {
 			return regname.Tag{}, nil, err
 		}
-
 	case item.Index != nil:
 		artifactToWrite = *item.Index
 	default:
@@ -211,7 +217,7 @@ func (i *ImageSet) verifyImageOrIndex(item imagedesc.ImageOrIndex, importRepo re
 		regImageIndex = *item.Index
 	}
 	return ProcessedImage{
-		UnprocessedImageRef: UnprocessedImageRef{existingRef.Name(), item.Tag(), item.Labels},
+		UnprocessedImageRef: UnprocessedImageRef{existingRef.Name(), item.Tag(), item.Labels, item.OrigRef},
 		DigestRef:           importDigestRef.Name(),
 		Image:               regImage,
 		ImageIndex:          regImageIndex,
@@ -230,7 +236,12 @@ func (i *ImageSet) verifyItemCopied(item imagedesc.ImageOrIndex, importRepo regn
 	}
 
 	// AWS ECR doesnt like using digests for manifest uploads
-	uploadTagRef, err := util.BuildDefaultUploadTagRef(item, importRepo)
+	digestWrap := imagedigest.DigestWrap{}
+	err = digestWrap.DigestWrap(item.Ref(), item.OrigRef)
+	if err != nil {
+		return regname.Digest{}, nil
+	}
+	uploadTagRef, err := i.tagGen.GenerateTag(digestWrap, importRepo)
 	if err != nil {
 		return regname.Digest{}, err
 	}
@@ -248,7 +259,6 @@ func (i *ImageSet) verifyItemCopied(item imagedesc.ImageOrIndex, importRepo regn
 
 func (i *ImageSet) verifyTagDigest(
 	uploadTagRef regname.Reference, importDigestRef regname.Digest, registry registry.ImagesReaderWriter) error {
-
 	resultURL, err := getResolvedImageURL(uploadTagRef.Name(), registry)
 	if err != nil {
 		return fmt.Errorf("Verifying imported image %s: %s", uploadTagRef.Name(), err)

pkg/imgpkg/imageset/unprocessed_image_refs.go

@@ -14,8 +14,8 @@ import (
 type UnprocessedImageRef struct {
 	DigestRef string
 	Tag       string
-
-	Labels map[string]string
+	Labels    map[string]string
+	OrigRef   string
 }
 
 func (u UnprocessedImageRef) Key() string {