Add generic helper function ResourceIsDeleted

Signed-off-by: Elena Gershkovich <[email protected]>

Author: ELENAGER

controllers/drcluster_controller.go

@@ -321,7 +321,7 @@ func (r *DRClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 
 	u.initializeStatus()
 
-	if drClusterIsDeleted(drcluster) {
+	if util.ResourceIsDeleted(drcluster) {
 		return r.processDeletion(u)
 	}
 
@@ -387,11 +387,6 @@ func (r DRClusterReconciler) processCreateOrUpdate(u *drclusterInstance) (ctrl.R
 	return ctrl.Result{Requeue: requeue || u.requeue}, reconcileError
 }
 
-// Return true if dr cluster was marked for deletion.
-func drClusterIsDeleted(c *ramen.DRCluster) bool {
-	return !c.GetDeletionTimestamp().IsZero()
-}
-
 func (u *drclusterInstance) initializeStatus() {
 	// Save a copy of the instance status to be used for the DRCluster status update comparison
 	u.object.Status.DeepCopyInto(&u.savedInstanceStatus)
@@ -1005,7 +1000,7 @@ func getPeerFromPolicy(ctx context.Context, reconciler *DRClusterReconciler, log
 			continue
 		}
 
-		if !peerCluster.ObjectMeta.DeletionTimestamp.IsZero() {
+		if util.ResourceIsDeleted(peerCluster) {
 			log.Info(fmt.Sprintf("peer cluster %s of cluster %s is being deleted",
 				peerCluster.Name, drCluster.Name))
 			// for now continue. We just need to get one DRCluster with

controllers/drcluster_mmode.go

@@ -351,7 +351,7 @@ func (u *drclusterInstance) pruneMModeMCV(
 
 	// Do not prune if it is part of survivors (or if already pruned)
 	key := util.ClusterScopedResourceNameFromMCVName(inMModeMCV.GetName())
-	if _, ok := survivors[key]; ok || !inMModeMCV.GetDeletionTimestamp().IsZero() {
+	if _, ok := survivors[key]; ok || util.ResourceIsDeleted(inMModeMCV) {
 		u.log.Info("Skipping pruning view", "name", inMModeMCV.GetName())
 
 		return nil

controllers/drplacementcontrol.go

@@ -1275,7 +1275,7 @@ func (d *DRPCInstance) vrgExistsAndPrimary(targetCluster string) bool {
 		return false
 	}
 
-	if !vrg.GetDeletionTimestamp().IsZero() {
+	if rmnutil.ResourceIsDeleted(vrg) {
 		return false
 	}
 
@@ -1804,7 +1804,7 @@ func (d *DRPCInstance) ensureVRGManifestWorkOnClusterDeleted(clusterName string)
 		return !done, fmt.Errorf("failed to retrieve ManifestWork (%w)", err)
 	}
 
-	if !mw.GetDeletionTimestamp().IsZero() {
+	if rmnutil.ResourceIsDeleted(mw) {
 		d.log.Info("Waiting for VRG MW to be fully deleted", "cluster", clusterName)
 		// As long as the Manifestwork still exist, then we are not done
 		return !done, nil

controllers/drplacementcontrol_controller.go

@@ -307,7 +307,7 @@ func DRClusterUpdateOfInterest(oldDRCluster, newDRCluster *rmn.DRCluster) bool {
 	}
 
 	// Exhausted all failover activation checks, the only interesting update is deleting a drcluster.
-	return drClusterIsDeleted(newDRCluster)
+	return rmnutil.ResourceIsDeleted(newDRCluster)
 }
 
 // checkFailoverActivation checks if provided provisioner and storage instance is activated as per the
@@ -354,7 +354,7 @@ func (r *DRPlacementControlReconciler) FilterDRCluster(drcluster *rmn.DRCluster)
 
 	var err error
 
-	if drClusterIsDeleted(drcluster) {
+	if rmnutil.ResourceIsDeleted(drcluster) {
 		drpcCollections, err = DRPCsUsingDRCluster(r.Client, log, drcluster)
 	} else {
 		drpcCollections, err = DRPCsFailingOverToCluster(r.Client, log, drcluster.GetName())
@@ -703,7 +703,7 @@ func (r *DRPlacementControlReconciler) Reconcile(ctx context.Context, req ctrl.R
 	ensureDRPCConditionsInited(&drpc.Status.Conditions, drpc.Generation, "Initialization")
 
 	placementObj, err := getPlacementOrPlacementRule(ctx, r.Client, drpc, logger)
-	if err != nil && !(errors.IsNotFound(err) && !drpc.GetDeletionTimestamp().IsZero()) {
+	if err != nil && !(errors.IsNotFound(err) && rmnutil.ResourceIsDeleted(drpc)) {
 		r.recordFailure(ctx, drpc, placementObj, "Error", err.Error(), logger)
 
 		return ctrl.Result{}, err
@@ -942,8 +942,8 @@ func (r *DRPlacementControlReconciler) createDRPCMetricsInstance(
 
 // isBeingDeleted returns true if either DRPC, user placement, or both are being deleted
 func isBeingDeleted(drpc *rmn.DRPlacementControl, usrPl client.Object) bool {
-	return !drpc.GetDeletionTimestamp().IsZero() ||
-		(usrPl != nil && !usrPl.GetDeletionTimestamp().IsZero())
+	return rmnutil.ResourceIsDeleted(drpc) ||
+		(usrPl != nil && rmnutil.ResourceIsDeleted(usrPl))
 }
 
 func (r *DRPlacementControlReconciler) reconcileDRPCInstance(d *DRPCInstance, log logr.Logger) (ctrl.Result, error) {
@@ -994,7 +994,7 @@ func (r *DRPlacementControlReconciler) getAndEnsureValidDRPolicy(ctx context.Con
 		return nil, fmt.Errorf("failed to get DRPolicy %w", err)
 	}
 
-	if !drPolicy.ObjectMeta.DeletionTimestamp.IsZero() {
+	if rmnutil.ResourceIsDeleted(drPolicy) {
 		// If drpolicy is deleted then return
 		// error to fail drpc reconciliation
 		return nil, fmt.Errorf("drPolicy '%s' referred by the DRPC is deleted, DRPC reconciliation would fail",
@@ -1392,7 +1392,7 @@ func getPlacement(ctx context.Context, k8sclient client.Client,
 func (r *DRPlacementControlReconciler) annotateObject(ctx context.Context,
 	drpc *rmn.DRPlacementControl, obj client.Object, log logr.Logger,
 ) error {
-	if !obj.GetDeletionTimestamp().IsZero() {
+	if rmnutil.ResourceIsDeleted(obj) {
 		return nil
 	}
 
@@ -1565,7 +1565,7 @@ func getVRGsFromManagedClusters(
 
 		clustersQueriedSuccessfully++
 
-		if drClusterIsDeleted(drCluster) {
+		if rmnutil.ResourceIsDeleted(drCluster) {
 			log.Info("Skipping VRG on deleted drcluster", "drcluster", drCluster.Name, "vrg", vrg.Name)
 
 			continue
@@ -2145,7 +2145,7 @@ func AvailableS3Profiles(drClusters []rmn.DRCluster) []string {
 
 	for i := range drClusters {
 		drCluster := &drClusters[i]
-		if drClusterIsDeleted(drCluster) {
+		if rmnutil.ResourceIsDeleted(drCluster) {
 			continue
 		}
 

controllers/drpolicy_controller.go

@@ -95,7 +95,7 @@ func (r *DRPolicyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 
 	secretsUtil := &util.SecretsUtil{Client: r.Client, APIReader: r.APIReader, Ctx: ctx, Log: log}
 	// DRPolicy is marked for deletion
-	if !drpolicy.ObjectMeta.DeletionTimestamp.IsZero() &&
+	if util.ResourceIsDeleted(drpolicy) &&
 		controllerutil.ContainsFinalizer(drpolicy, drPolicyFinalizerName) {
 		return ctrl.Result{}, u.deleteDRPolicy(drclusters, secretsUtil, ramenConfig)
 	}

controllers/util/objectmeta.go

@@ -5,6 +5,7 @@ package util
 
 import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 func ObjectMetaEmbedded(objectMeta *metav1.ObjectMeta) metav1.ObjectMeta {
@@ -17,3 +18,8 @@ func ObjectMetaEmbedded(objectMeta *metav1.ObjectMeta) metav1.ObjectMeta {
 		Finalizers:  objectMeta.Finalizers,
 	}
 }
+
+// Return true if resource was marked for deletion.
+func ResourceIsDeleted(obj client.Object) bool {
+	return !obj.GetDeletionTimestamp().IsZero()
+}

controllers/util/secrets_util.go

@@ -527,7 +527,7 @@ func (sutil *SecretsUtil) ensureS3SecretResources(secretName, namespace string)
 		return nil, sutil.deletePolicyResources(&secret, namespace)
 	}
 
-	if secret.GetDeletionTimestamp().IsZero() {
+	if !ResourceIsDeleted(&secret) {
 		return &secret, nil
 	}
 

controllers/volsync/vshandler_test.go

@@ -25,6 +25,7 @@ import (
 
 	volsyncv1alpha1 "github.com/backube/volsync/api/v1alpha1"
 	ramendrv1alpha1 "github.com/ramendr/ramen/api/v1alpha1"
+	"github.com/ramendr/ramen/controllers/util"
 	"github.com/ramendr/ramen/controllers/volsync"
 )
 
@@ -1060,7 +1061,7 @@ var _ = Describe("VolSync_Handler", func() {
 											Eventually(func() bool {
 												err := k8sClient.Get(ctx, client.ObjectKeyFromObject(testPVC), testPVC)
 												if err == nil {
-													if !testPVC.GetDeletionTimestamp().IsZero() {
+													if util.ResourceIsDeleted(testPVC) {
 														// PVC protection finalizer is added automatically to PVC - but testenv
 														// doesn't have anything that will remove it for us - we're good as long
 														// as the pvc is marked for deletion
@@ -1373,7 +1374,7 @@ var _ = Describe("VolSync_Handler", func() {
 						Eventually(func() bool {
 							err := k8sClient.Get(ctx, client.ObjectKeyFromObject(pvc), pvc)
 							if err == nil {
-								if !pvc.GetDeletionTimestamp().IsZero() {
+								if util.ResourceIsDeleted(pvc) {
 									// PVC protection finalizer is added automatically to PVC - but testenv
 									// doesn't have anything that will remove it for us - we're good as long
 									// as the pvc is marked for deletion

controllers/volumereplicationgroup_controller.go

@@ -524,7 +524,7 @@ func (v *VRGInstance) processVRG() ctrl.Result {
 	v.log = v.log.WithName("vrginstance").WithValues("State", v.instance.Spec.ReplicationState)
 	v.s3StoreAccessorsGet()
 
-	if !v.instance.GetDeletionTimestamp().IsZero() {
+	if rmnutil.ResourceIsDeleted(v.instance) {
 		v.log = v.log.WithValues("Finalize", true)
 
 		return v.processForDeletion()
@@ -546,7 +546,7 @@ func (v *VRGInstance) validateVRGState() error {
 	if v.instance.Spec.ReplicationState != ramendrv1alpha1.Primary &&
 		v.instance.Spec.ReplicationState != ramendrv1alpha1.Secondary {
 		err := fmt.Errorf("invalid or unknown replication state detected (deleted %v, desired replicationState %v)",
-			!v.instance.GetDeletionTimestamp().IsZero(),
+			rmnutil.ResourceIsDeleted(v.instance),
 			v.instance.Spec.ReplicationState)
 
 		v.log.Error(err, "Invalid request detected")
@@ -568,7 +568,7 @@ func (v *VRGInstance) validateVRGMode() error {
 
 	if !sync && !async {
 		err := fmt.Errorf("neither of sync or async mode is enabled (deleted %v)",
-			!v.instance.GetDeletionTimestamp().IsZero())
+			rmnutil.ResourceIsDeleted(v.instance))
 
 		v.log.Error(err, "Invalid request detected")
 
@@ -674,7 +674,7 @@ func (v *VRGInstance) updatePVCList() error {
 		v.vrcUpdated = true
 	}
 
-	if !v.instance.GetDeletionTimestamp().IsZero() {
+	if rmnutil.ResourceIsDeleted(v.instance) {
 		v.separatePVCsUsingVRGStatus(pvcList)
 		v.log.Info(fmt.Sprintf("Separated PVCs (%d) into VolRepPVCs (%d) and VolSyncPVCs (%d)",
 			len(pvcList.Items), len(v.volRepPVCs), len(v.volSyncPVCs)))

controllers/vrg_volrep.go

@@ -168,7 +168,7 @@ func (v *VRGInstance) isPVCReadyForSecondary(pvc *corev1.PersistentVolumeClaim,
 	const ready bool = true
 
 	// If PVC is not being deleted, it is not ready for Secondary, unless action is failover
-	if v.instance.Spec.Action != ramendrv1alpha1.VRGActionFailover && pvc.GetDeletionTimestamp().IsZero() {
+	if v.instance.Spec.Action != ramendrv1alpha1.VRGActionFailover && !rmnutil.ResourceIsDeleted(pvc) {
 		log.Info("VolumeReplication cannot become Secondary, as its PersistentVolumeClaim is not marked for deletion")
 
 		msg := "unable to transition to Secondary as PVC is not deleted"
@@ -364,7 +364,7 @@ func (v *VRGInstance) protectPVC(pvc *corev1.PersistentVolumeClaim, log logr.Log
 	}
 
 	// Annotate that PVC protection is complete, skip if being deleted
-	if pvc.GetDeletionTimestamp().IsZero() {
+	if !rmnutil.ResourceIsDeleted(pvc) {
 		if err := v.addProtectedAnnotationForPVC(pvc, log); err != nil {
 			log.Info("Requeuing, as annotating PersistentVolumeClaim failed", "errorValue", err)
 
@@ -402,7 +402,7 @@ func skipPVC(pvc *corev1.PersistentVolumeClaim, log logr.Logger) (bool, string)
 
 func isPVCDeletedAndNotProtected(pvc *corev1.PersistentVolumeClaim, log logr.Logger) (bool, string) {
 	// If PVC deleted but not yet protected with a finalizer, skip it!
-	if !containsString(pvc.Finalizers, PvcVRFinalizerProtected) && !pvc.GetDeletionTimestamp().IsZero() {
+	if !containsString(pvc.Finalizers, PvcVRFinalizerProtected) && rmnutil.ResourceIsDeleted(pvc) {
 		log.Info("Skipping PersistentVolumeClaim, as it is marked for deletion and not yet protected")
 
 		msg := "Skipping pvc marked for deletion"
@@ -740,7 +740,7 @@ func (v *VRGInstance) reconcileVRsForDeletion() {
 func (v *VRGInstance) pvcUnprotectVolRepIfDeleted(
 	pvc corev1.PersistentVolumeClaim, log logr.Logger,
 ) (pvcDeleted bool) {
-	pvcDeleted = !pvc.GetDeletionTimestamp().IsZero()
+	pvcDeleted = rmnutil.ResourceIsDeleted(&pvc)
 	if !pvcDeleted {
 		return
 	}
@@ -903,7 +903,7 @@ func (v *VRGInstance) reconcileMissingVR(pvc *corev1.PersistentVolumeClaim, log
 
 	err := v.reconciler.Get(v.ctx, vrNamespacedName, volRep)
 	if err == nil {
-		if !volRep.ObjectMeta.DeletionTimestamp.IsZero() {
+		if rmnutil.ResourceIsDeleted(volRep) {
 			log.Info("Requeuing due to processing a VR under deletion")
 
 			return !vrMissing, requeue
@@ -2067,7 +2067,7 @@ func (v *VRGInstance) validateExistingPV(pv *corev1.PersistentVolume) error {
 				pvcNamespacedName.String(), err)
 		}
 
-		if !pvc.DeletionTimestamp.IsZero() {
+		if rmnutil.ResourceIsDeleted(&pvc) {
 			return fmt.Errorf("existing bound PV %s claim %s deletion timestamp non-zero %v", existingPV.GetName(),
 				pvcNamespacedName.String(), pvc.DeletionTimestamp)
 		}
@@ -2122,7 +2122,7 @@ func (v *VRGInstance) validateExistingPVC(pvc *corev1.PersistentVolumeClaim) err
 		return fmt.Errorf("PVC %s exists and is not bound (phase: %s)", pvcNSName.String(), existingPVC.Status.Phase)
 	}
 
-	if !existingPVC.DeletionTimestamp.IsZero() {
+	if rmnutil.ResourceIsDeleted(existingPVC) {
 		return fmt.Errorf("existing bound PVC %s is being deleted", pvcNSName.String())
 	}