Repo extra identity (#2)

* repo extra identity

* Test repo extra identity

* change doc

* integrate review

Co-authored-by: Robert Graeff <robert.graeff@sap.com>

Author: achimweigel

docs/imagevector_cd_overwrite.md

@@ -69,7 +69,7 @@ componentReferences:
 
 Generic images are images that do not directly result in a resource.
 They will be matched with another component descriptor that actually defines the images.
-The other component descriptor MUST have the "imagevector.gardener.cloud/name" label in order to be matched.
+The other component descriptor MUST have the extraIdentity "imagevector-gardener-cloud+repository" in order to be matched.
 
 <pre>
 meta:
@@ -94,9 +94,8 @@ component:
     type: ociImage
     extraIdentity:
       "imagevector-gardener-cloud+tag": "v1.19.4"
+      "imagevector-gardener-cloud+repository": "k8s.gcr.io/hyperkube"
     labels:
-    - name: imagevector.gardener.cloud/name
-      value: hyperkube
     - name: imagevector.gardener.cloud/repository
       value: k8s.gcr.io/hyperkube
     access:

pkg/overwrite.go

@@ -448,6 +448,14 @@ func (io *imageOverwrite) findGenericImageResource(ctx context.Context, image Im
 
 func resourceMatchesGenericImage(ctx context.Context, image ImageEntry, res cdv2.Resource) (bool, error) {
 	log := logr.FromContextOrDiscard(ctx)
+
+	// this check should become the only check in the future
+	// all subsequent checks are only intermediate fallbacks
+	extraIdentityRepo, ok := res.GetIdentity()[RepositoryExtraIdentity]
+	if ok && extraIdentityRepo == image.Repository {
+		return true, nil
+	}
+
 	var imageName string
 	_, err := getLabel(res.GetLabels(), NameLabel, &imageName)
 	if err != nil {

pkg/overwrite_test.go

@@ -265,6 +265,40 @@ var _ = Describe("GenerateOverwrite", func() {
 		})))
 	})
 
+	It("should generate image sources from generic images based on extra identity", func() {
+		ivReader, err := os.Open("./testdata/resources/31-generic.yaml")
+		Expect(err).ToNot(HaveOccurred())
+		defer func() {
+			Expect(ivReader.Close()).ToNot(HaveOccurred())
+		}()
+
+		cd := readComponentDescriptor("./testdata/00-component/component-descriptor.yaml")
+		err = pkg.ParseImageVector(context.TODO(), nil, cd, ivReader, &pkg.ParseImageOptions{
+			GenericDependencies: []string{"hyperkube"},
+		})
+		Expect(err).ToNot(HaveOccurred())
+
+		list := readComponentDescriptors("./testdata/04-generic-images/component-descriptor2.yaml")
+		imageVector, err := pkg.GenerateImageOverwrite(context.TODO(), nil, cd, pkg.GenerateImageOverwriteOptions{
+			Components: list,
+		})
+		Expect(err).ToNot(HaveOccurred())
+
+		Expect(imageVector.Images).To(HaveLen(2))
+		Expect(imageVector.Images).To(ContainElement(MatchFields(IgnoreExtras, Fields{
+			"Name":          Equal("kube-apiserver"),
+			"Repository":    Equal("eu.gcr.io/gardener-project/hyperkube"),
+			"Tag":           PointTo(Equal("v1.16.15-mod1")),
+			"TargetVersion": PointTo(Equal("1.16.15")),
+		})))
+		Expect(imageVector.Images).To(ContainElement(MatchFields(IgnoreExtras, Fields{
+			"Name":          Equal("kube-apiserver"),
+			"Repository":    Equal("eu.gcr.io/gardener-project/hyperkube"),
+			"Tag":           PointTo(Equal("v1.15.12-mod1")),
+			"TargetVersion": PointTo(Equal("1.15.12")),
+		})))
+	})
+
 	It("should generate a simple image with digest from a component descriptor", func() {
 		imageVector, err := pkg.GenerateImageOverwrite(context.TODO(),
 			nil,

pkg/testdata/04-generic-images/component-descriptor2.yaml

@@ -0,0 +1,41 @@
+meta:
+  schemaVersion: 'v2'
+
+component:
+  name: 'github.com/gardener/kubernetes-versions'
+  version: 'v0.100.0'
+
+  repositoryContexts:
+  - type: 'ociRegistry'
+    baseUrl: 'eu.gcr.io/gardener-project/components/dev'
+
+  provider: 'internal'
+
+  sources: []
+
+  componentReferences: []
+
+  resources:
+    - access:
+        imageReference: eu.gcr.io/gardener-project/hyperkube:v1.16.15-mod1
+        type: ociRegistry
+      extraIdentity:
+        imagevector-gardener-cloud+tag: v1.16.15
+        imagevector-gardener-cloud+repository: k8s.gcr.io/hyperkube
+      name: hyperkube
+      relation: external
+      type: ociImage
+      version: 1.16.15
+
+    - access:
+        imageReference: eu.gcr.io/gardener-project/hyperkube:v1.15.12-mod1
+        type: ociRegistry
+      extraIdentity:
+        imagevector-gardener-cloud+tag: v1.15.12
+        imagevector-gardener-cloud+repository: k8s.gcr.io/hyperkube
+      name: hyperkube
+      relation: external
+      type: ociImage
+      version: 1.15.12
+
+

pkg/testdata/resources/31-generic.yaml

@@ -0,0 +1,5 @@
+images:
+  - name: kube-apiserver
+    repository: k8s.gcr.io/hyperkube
+    sourceRepository: github.com/kubernetes/kubernetes
+    targetVersion: < 1.17

pkg/types.go

@@ -41,7 +41,8 @@ var (
 	RuntimeVersionLabel   = Label("runtime-version")
 	ImagesLabel           = Label("images")
 
-	TagExtraIdentity = ExtraIdentityKey("tag")
+	TagExtraIdentity        = ExtraIdentityKey("tag")
+	RepositoryExtraIdentity = ExtraIdentityKey("repository")
 )
 
 // GardenerCIOriginalRefLabel describes the lable of the gardener ci that is used to identify the original ref of a resource.