Merge pull request #1471 from hongweiliu17/STONEINTG-1501

fix(STONEINTG-1501): remove updating GCL from component snapshot

Author: hongweiliu17

gitops/snapshot.go

@@ -1505,7 +1505,11 @@ func UpdateComponentImageAndSource(ctx context.Context, adapterClient client.Cli
 			buildTimeStr = strconv.FormatInt(pr.Status.StartTime.Unix(), 10)
 		}
 	}
-	if _, ok := object.(*applicationapiv1alpha1.Snapshot); ok {
+	// set the last build time annotation according to the time.Now() when the GCL is updated by override snapshot not build pipelinerun
+	if snapshot, ok := object.(*applicationapiv1alpha1.Snapshot); ok {
+		if !IsOverrideSnapshot(snapshot) {
+			return fmt.Errorf("snapshot %s/%s is not an override snapshot, GCL can be updated from build pipelinerun for push event or override snapshot only", snapshot.Namespace, snapshot.Name)
+		}
 		buildTimeStr = strconv.FormatInt(time.Now().Unix(), 10)
 	}
 	return AnnotateComponent(ctx, component, BuildPipelineLastBuiltTime, buildTimeStr, adapterClient)

gitops/snapshot_test.go

@@ -898,6 +898,7 @@ var _ = Describe("Gitops functions for managing Snapshots", Ordered, func() {
 	})
 
 	It("Ensure UpdateComponentImageAndSource can update component containerImage and source", func() {
+		hasSnapshot.Labels[gitops.SnapshotTypeLabel] = "override"
 		componentSource := applicationapiv1alpha1.ComponentSource{
 			ComponentSourceUnion: applicationapiv1alpha1.ComponentSourceUnion{
 				GitSource: &applicationapiv1alpha1.GitSource{

internal/controller/snapshot/snapshot_adapter.go

@@ -432,18 +432,7 @@ func (a *Adapter) EnsureGlobalCandidateImageUpdated() (controller.OperationResul
 		return controller.ContinueProcessing()
 	}
 
-	var err error
-
-	if gitops.IsComponentSnapshot(a.snapshot) {
-		if a.isSnapshotOlderThanLastBuild(a.snapshot) {
-			a.logger.Info("The Glocal Candidate list was updated in newer build pipelinerun or snapshot")
-		} else {
-			err = a.updateGCLForComponentSnapshot()
-		}
-	} else if gitops.IsOverrideSnapshot(a.snapshot) {
-		err = a.updateGCLForOverrideSnapshot()
-	}
-
+	err := a.updateGCLForOverrideSnapshot()
 	if err != nil {
 		return controller.RequeueWithError(err)
 	}
@@ -472,8 +461,8 @@ func (a *Adapter) EnsureGlobalCandidateImageUpdated() (controller.OperationResul
 
 // shouldUpdateGlobalCandidateList checks if the snapshot should update the global candidate list
 func (a *Adapter) shouldUpdateGlobalCandidateList() bool {
-	if !gitops.IsComponentSnapshotCreatedByPACPushEvent(a.snapshot) && !gitops.IsOverrideSnapshot(a.snapshot) {
-		a.logger.Info("The Snapshot was neither created for a single component push event nor override type, not updating the global candidate list.")
+	if !gitops.IsOverrideSnapshot(a.snapshot) {
+		a.logger.Info("The Snapshot was not override type, will not update the global candidate list.")
 		return false
 	}
 
@@ -486,34 +475,6 @@ func (a *Adapter) shouldUpdateGlobalCandidateList() bool {
 	return true
 }
 
-// updateGCLForComponentSnapshot updates global candidate list for component snapshots
-func (a *Adapter) updateGCLForComponentSnapshot() error {
-	var componentToUpdate *applicationapiv1alpha1.Component
-	var err error
-
-	err = retry.OnError(retry.DefaultRetry, func(_ error) bool { return true }, func() error {
-		componentToUpdate, err = a.loader.GetComponentFromSnapshot(a.context, a.client, a.snapshot)
-		return err
-	})
-	if err != nil {
-		_, loaderError := h.HandleLoaderError(a.logger, err, fmt.Sprintf("Component or '%s' label", tektonconsts.ComponentNameLabel), "Snapshot")
-		if loaderError != nil {
-			return loaderError
-		}
-		return nil // Continue processing if no loader error
-	}
-
-	// Find and update the matching snapshot component
-	for _, snapshotComponent := range a.snapshot.Spec.Components {
-		snapshotComponent := snapshotComponent //G601
-		if snapshotComponent.Name == componentToUpdate.Name {
-			return gitops.UpdateComponentImageAndSource(a.context, a.client, a.snapshot, componentToUpdate, snapshotComponent.Source, snapshotComponent.ContainerImage)
-		}
-	}
-
-	return nil
-}
-
 // updateGCLForOverrideSnapshot handles updating global candidate list for override snapshots
 func (a *Adapter) updateGCLForOverrideSnapshot() error {
 	for _, snapshotComponent := range a.snapshot.Spec.Components {

internal/controller/snapshot/snapshot_adapter_test.go

@@ -1178,7 +1178,7 @@ var _ = Describe("Snapshot Adapter", Ordered, func() {
 				adapter.logger = log
 				adapter.snapshot = hasOverRideSnapshot
 
-				// don't update Global Candidate List for a snapshot if it is neither component snapshot nor override snapshot
+				// don't update Global Candidate List for a snapshot if it is not override snapshot
 				hasOverRideSnapshot.Labels[gitops.SnapshotTypeLabel] = ""
 				hasOverRideSnapshot.Spec.Components = []applicationapiv1alpha1.SnapshotComponent{
 					{
@@ -1202,7 +1202,7 @@ var _ = Describe("Snapshot Adapter", Ordered, func() {
 				Expect(err).ShouldNot(HaveOccurred())
 				Expect(result.CancelRequest).To(BeFalse())
 				Expect(result.RequeueRequest).To(BeFalse())
-				expectedLogEntry := "The Snapshot was neither created for a single component push event nor override type, not updating the global candidate list."
+				expectedLogEntry := "The Snapshot was not override type, will not update the global candidate list"
 				Expect(buf.String()).Should(ContainSubstring(expectedLogEntry))
 
 				// update Glocal Candidate List for the component in a override snapshot
@@ -1217,36 +1217,6 @@ var _ = Describe("Snapshot Adapter", Ordered, func() {
 				expectedLogEntry = "containerImage cannot be updated to component Global Candidate List due to invalid digest in containerImage"
 				Expect(buf.String()).Should(ContainSubstring(expectedLogEntry))
 			})
-
-			It("ensures global Component Image and lastPromotedImage updated when push snapshot is created", func() {
-				// ensure last promoted image is empty string
-				hasComp.Status.LastPromotedImage = ""
-				var buf bytes.Buffer
-				log := helpers.IntegrationLogger{Logger: buflogr.NewWithBuffer(&buf)}
-				adapter.logger = log
-				adapter.snapshot = hasSnapshot
-				Expect(gitops.IsSnapshotMarkedAsAddedToGlobalCandidateList(hasSnapshot)).To(BeFalse())
-				result, err := adapter.EnsureGlobalCandidateImageUpdated()
-				Expect(err).ShouldNot(HaveOccurred())
-				Expect(result.CancelRequest).To(BeFalse())
-
-				Eventually(func() bool {
-					err := k8sClient.Get(ctx, types.NamespacedName{
-						Name:      hasSnapshot.Name,
-						Namespace: "default",
-					}, hasSnapshot)
-					return err == nil && gitops.IsSnapshotMarkedAsAddedToGlobalCandidateList(hasSnapshot)
-				}, time.Second*10).Should(BeTrue())
-
-				// Check if the adapter function detects that it already promoted the snapshot component
-				result, err = adapter.EnsureGlobalCandidateImageUpdated()
-				Expect(err).ShouldNot(HaveOccurred())
-				Expect(result.CancelRequest).To(BeFalse())
-
-				expectedLogEntry := "The Snapshot's component was previously added to the global candidate list, skipping adding it."
-
-				Expect(buf.String()).Should(ContainSubstring(expectedLogEntry))
-			})
 		})
 
 		When("pull request updates repo with integration test", func() {