fix(STONEINTG-1317): annotate snapshot for the missed component

* annotate the components to snapshot when they are not included in
  snasphot due to missing valid container image or git source

Signed-off-by: Hongwei Liu <[email protected]>

Author: hongweiliu17

gitops/snapshot.go

@@ -833,6 +833,7 @@ func HasSnapshotRerunLabelChanged(objectOld, objectNew client.Object) bool {
 func PrepareSnapshot(ctx context.Context, adapterClient client.Client, application *applicationapiv1alpha1.Application, applicationComponents *[]applicationapiv1alpha1.Component, component *applicationapiv1alpha1.Component, newContainerImage string, newComponentSource *applicationapiv1alpha1.ComponentSource) (*applicationapiv1alpha1.Snapshot, error) {
 	log := log.FromContext(ctx)
 	var snapshotComponents []applicationapiv1alpha1.SnapshotComponent
+	var invalidComponents []string
 	for _, applicationComponent := range *applicationComponents {
 		applicationComponent := applicationComponent // G601
 		containerImage := applicationComponent.Status.LastPromotedImage
@@ -856,6 +857,7 @@ func PrepareSnapshot(ctx context.Context, adapterClient client.Client, applicati
 			componentSource, err = GetComponentSourceFromComponent(&applicationComponent)
 			if err != nil {
 				log.Error(err, "component cannot be added to snapshot for application due to missing git source", "component.Name", applicationComponent.Name)
+				invalidComponents = append(invalidComponents, applicationComponent.Name)
 				continue
 			}
 		}
@@ -866,13 +868,15 @@ func PrepareSnapshot(ctx context.Context, adapterClient client.Client, applicati
 		// including a component that is incomplete.
 		if containerImage == "" {
 			log.Info("component cannot be added to snapshot for application due to missing containerImage", "component.Name", applicationComponent.Name)
+			invalidComponents = append(invalidComponents, applicationComponent.Name)
 			continue
 		} else {
 			// if the containerImage doesn't have a valid digest, the component
 			// will not be added to snapshot
 			err = ValidateImageDigest(containerImage)
 			if err != nil {
 				log.Error(err, "component cannot be added to snapshot for application due to invalid digest in containerImage", "component.Name", applicationComponent.Name)
+				invalidComponents = append(invalidComponents, applicationComponent.Name)
 				continue
 			}
 			snapshotComponents = append(snapshotComponents, applicationapiv1alpha1.SnapshotComponent{
@@ -884,7 +888,7 @@ func PrepareSnapshot(ctx context.Context, adapterClient client.Client, applicati
 	}
 
 	if len(snapshotComponents) == 0 {
-		return nil, helpers.NewMissingValidComponentError(component.Name)
+		return nil, helpers.NewMissingValidComponentError(strings.Join(invalidComponents, ", "))
 	}
 	snapshot := NewSnapshot(application, &snapshotComponents)
 
@@ -895,6 +899,12 @@ func PrepareSnapshot(ctx context.Context, adapterClient client.Client, applicati
 		}
 	}
 
+	if len(invalidComponents) > 0 {
+		if err := metadata.SetAnnotation(snapshot, helpers.CreateSnapshotAnnotationName, fmt.Sprintf("Component(s) '%s' is(are) not included in snapshot due to missing valid containerImage or git source", strings.Join(invalidComponents, ", "))); err != nil {
+			return nil, fmt.Errorf("failed to set annotation %s: %w", SnapshotGitSourceRepoURLAnnotation, err)
+		}
+	}
+
 	err := ctrl.SetControllerReference(application, snapshot, adapterClient.Scheme())
 	if err != nil {
 		return nil, err

gitops/snapshot_test.go

@@ -102,8 +102,9 @@ var _ = Describe("Gitops functions for managing Snapshots", Ordered, func() {
 				Namespace: namespace,
 			},
 			Spec: applicationapiv1alpha1.ComponentSpec{
-				ComponentName: "bad-component",
-				Application:   applicationName,
+				ComponentName:  "bad-component",
+				Application:    applicationName,
+				ContainerImage: sampleImage,
 			},
 		}
 		Expect(k8sClient.Create(ctx, badComp)).Should(Succeed())
@@ -678,7 +679,7 @@ var _ = Describe("Gitops functions for managing Snapshots", Ordered, func() {
 				},
 			},
 		}
-		allApplicationComponents := &[]applicationapiv1alpha1.Component{*hasComp, *hasComp2}
+		allApplicationComponents := &[]applicationapiv1alpha1.Component{*hasComp, *hasComp2, *badComp}
 		snapshot, err := gitops.PrepareSnapshot(ctx, k8sClient, hasApp, allApplicationComponents, hasComp, validImagePullSpec, componentSource)
 		Expect(snapshot).NotTo(BeNil())
 		Expect(err).NotTo(HaveOccurred())
@@ -688,6 +689,7 @@ var _ = Describe("Gitops functions for managing Snapshots", Ordered, func() {
 			snapshotComponent := snapshotComponent
 			Expect(snapshotComponent.ContainerImage).NotTo(Equal(invalidImagePullSpec))
 		}
+		Expect(snapshot.Annotations["test.appstudio.openshift.io/create-snapshot-status"]).To(Equal("Component(s) 'second-component, bad-component' is(are) not included in snapshot due to missing valid containerImage or git source"))
 	})
 
 	It("Return false when the image url contains invalid digest", func() {

helpers/errorhandlers.go

@@ -80,10 +80,10 @@ func IsInvalidImageDigestError(err error) bool {
 	return getReason(err) == ReasonInvalidImageDigestError
 }
 
-func NewMissingValidComponentError(componentName string) error {
+func NewMissingValidComponentError(componentNames string) error {
 	return &IntegrationError{
 		Reason:  ReasonMissingValidComponentError,
-		Message: fmt.Sprintf("The only one component %s is invalid, valid .Status.LastPromotedImage is missing", componentName),
+		Message: fmt.Sprintf("The component(s) '%s' is(are) invalid due to missing valid container image or git source", componentNames),
 	}
 }
 

helpers/errorhandlers_test.go

@@ -98,7 +98,7 @@ var _ = Describe("Helpers for error handlers", Ordered, func() {
 		It("Can define MissingValidComponentError", func() {
 			err := helpers.NewMissingValidComponentError("componentName")
 			Expect(helpers.IsMissingValidComponentError(err)).To(BeTrue())
-			Expect(err.Error()).To(Equal("The only one component componentName is invalid, valid .Status.LastPromotedImage is missing"))
+			Expect(err.Error()).To(Equal("The component(s) 'componentName' is(are) invalid due to missing valid container image or git source"))
 		})
 
 		It("Can handle non integration error", func() {

internal/controller/buildpipeline/buildpipeline_adapter_test.go

@@ -519,9 +519,9 @@ var _ = Describe("Pipeline Adapter", Ordered, func() {
 			snapshot, err := gitops.PrepareSnapshot(adapter.context, adapter.client, hasApp, applicationComponents, hasComp, imagePullSpec, componentSource)
 			Expect(snapshot).NotTo(BeNil())
 			Expect(err).ToNot(HaveOccurred())
-			Expect(snapshot).NotTo(BeNil())
 			Expect(snapshot.Spec.Components).To(HaveLen(1), "One component should have been added to snapshot.  Other component should have been omited due to empty ContainerImage field or missing valid digest")
 			Expect(snapshot.Spec.Components[0].Name).To(Equal(hasComp.Name), "The built component should have been added to the snapshot")
+			Expect(snapshot.Annotations[helpers.CreateSnapshotAnnotationName]).To(Equal("Component(s) 'another-component-sample' is(are) not included in snapshot due to missing valid containerImage or git source"))
 		})
 
 		It("ensures that snapshot has label pointing to build pipelinerun", func() {