fix(controller): always keep CachedImage IsCached status updated

Author: plaffitt

controllers/cachedimage_controller.go

@@ -197,26 +197,34 @@ func (r *CachedImageReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	}
 
 	// Removing forceUpdate annotation
-	forceUpdate := cachedImage.Annotations[cachedImageAnnotationForceUpdateName]
+	forceUpdate := cachedImage.Annotations[cachedImageAnnotationForceUpdateName] == "true"
 	patch := client.MergeFrom(cachedImage.DeepCopy())
-	if forceUpdate == "true" {
+	if forceUpdate {
 		delete(cachedImage.Annotations, cachedImageAnnotationForceUpdateName)
 	}
 	err = r.Patch(context.Background(), &cachedImage, patch)
 	if err != nil {
 		return ctrl.Result{}, err
 	}
 
+	isCached, err := registry.ImageIsCached(cachedImage.Spec.SourceImage)
+	if err != nil {
+		return ctrl.Result{}, err
+	}
+
+	err = updateStatusRaw(r.Client, &cachedImage, func(status *kuikv1alpha1.CachedImageStatus) {
+		cachedImage.Status.IsCached = isCached
+	})
+	if err != nil {
+		return ctrl.Result{}, err
+	}
+
 	// Adding image to registry
-	isCached := false
-	if forceUpdate != "true" {
-		isCached, err = registry.ImageIsCached(cachedImage.Spec.SourceImage)
-		if err != nil {
-			log.Error(err, "could not determine if the image present in cache")
-			return ctrl.Result{}, err
-		}
+	putImageInCache := true
+	if isCached && !forceUpdate {
+		putImageInCache = false
 	}
-	if !isCached {
+	if putImageInCache {
 		r.Recorder.Eventf(&cachedImage, "Normal", "Caching", "Start caching image %s", cachedImage.Spec.SourceImage)
 		err = r.cacheImage(&cachedImage)
 		if err != nil {
@@ -261,21 +269,25 @@ func (r *CachedImageReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 }
 
 func updateStatus(c client.Client, cachedImage *kuikv1alpha1.CachedImage, upstreamDescriptor *remote.Descriptor, update func(*kuikv1alpha1.CachedImageStatus)) error {
-	patch := client.MergeFrom(cachedImage.DeepCopy())
-
-	cachedImage.Status.AvailableUpstream = upstreamDescriptor != nil
-	cachedImage.Status.LastSync = metav1.NewTime(time.Now())
+	return updateStatusRaw(c, cachedImage, func(status *kuikv1alpha1.CachedImageStatus) {
+		cachedImage.Status.AvailableUpstream = upstreamDescriptor != nil
+		cachedImage.Status.LastSync = metav1.NewTime(time.Now())
 
-	update(&cachedImage.Status)
+		update(&cachedImage.Status)
 
-	if upstreamDescriptor != nil {
-		cachedImage.Status.UpstreamDigest = upstreamDescriptor.Digest.Hex
-		cachedImage.Status.UpToDate = cachedImage.Status.Digest == upstreamDescriptor.Digest.Hex
-	} else {
-		cachedImage.Status.UpstreamDigest = ""
-		cachedImage.Status.UpToDate = false
-	}
+		if upstreamDescriptor != nil {
+			cachedImage.Status.UpstreamDigest = upstreamDescriptor.Digest.Hex
+			cachedImage.Status.UpToDate = cachedImage.Status.Digest == upstreamDescriptor.Digest.Hex
+		} else {
+			cachedImage.Status.UpstreamDigest = ""
+			cachedImage.Status.UpToDate = false
+		}
+	})
+}
 
+func updateStatusRaw(c client.Client, cachedImage *kuikv1alpha1.CachedImage, update func(*kuikv1alpha1.CachedImageStatus)) error {
+	patch := client.MergeFrom(cachedImage.DeepCopy())
+	update(&cachedImage.Status)
 	return c.Status().Patch(context.Background(), cachedImage, patch)
 }
 

internal/registry/registry.go

@@ -94,7 +94,11 @@ func ImageIsCached(imageName string) (bool, error) {
 		return false, err
 	}
 
-	return imageExists(reference)
+	exists, err := imageExists(reference)
+	if err != nil {
+		err = fmt.Errorf("could not determine if the image present in cache: %w", err)
+	}
+	return exists, err
 }
 
 func DeleteImage(imageName string) error {

internal/registry/registry_test.go

@@ -145,6 +145,10 @@ func Test_ImageIsCached(t *testing.T) {
 			Endpoint = server.Addr()
 			isCached, err := ImageIsCached(tt.image)
 			if tt.wantErr != "" {
+				err2 := errors.Unwrap(err)
+				if err2 != nil {
+					err = err2
+				}
 				g.Expect(err).To(BeAssignableToTypeOf(tt.errType))
 				g.Expect(err).To(MatchError(ContainSubstring(tt.wantErr)))
 			} else {