Continue executing only if there is nothing to restore

Signed-off-by: Benamar Mekhissi <[email protected]>
(cherry picked from commit b057d15)

Author: BenamarMk

controllers/protectedvolumereplicationgrouplist_controller_test.go

@@ -95,6 +95,7 @@ func protectedVrgListExpectInclude(protectedVrgList *ramen.ProtectedVolumeReplic
 	vrgsExpected []ramen.VolumeReplicationGroup,
 ) {
 	vrgsStatusStateUpdate(protectedVrgList.Status.Items, vrgsExpected)
+	Expect(protectedVrgList.Status.Items).To(ContainElements(vrgsExpected))
 }
 
 func vrgsStatusStateUpdate(vrgsS3, vrgsK8s []ramen.VolumeReplicationGroup) {

controllers/volumereplicationgroup_controller.go

@@ -578,28 +578,32 @@ func (v *VRGInstance) validateVRGMode() error {
 	return nil
 }
 
-func (v *VRGInstance) clusterDataRestore(result *ctrl.Result) error {
+func (v *VRGInstance) clusterDataRestore(result *ctrl.Result) (int, error) {
 	v.log.Info("Restoring PVs and PVCs")
 
-	err := v.restorePVsAndPVCsForVolSync()
+	numRestoredForVS, err := v.restorePVsAndPVCsForVolSync()
 	if err != nil {
 		v.log.Info("VolSync PV/PVC restore failed")
 
-		return fmt.Errorf("failed to restore PV/PVC for VolSync (%w)", err)
+		return numRestoredForVS, fmt.Errorf("failed to restore PV/PVC for VolSync (%w)", err)
 	}
 
-	err = v.restorePVsAndPVCsForVolRep(result)
+	numRestoredForVR, err := v.restorePVsAndPVCsForVolRep(result)
 	if err != nil {
 		v.log.Info("VolRep PV/PVC restore failed")
 
-		return fmt.Errorf("failed to restore PV/PVC for VolRep (%w)", err)
+		return numRestoredForVS + numRestoredForVR, fmt.Errorf("failed to restore PV/PVC for VolRep (%w)", err)
 	}
 
 	// Only after both succeed, we mark ClusterDataReady as true
 	msg := "Restored PVs and PVCs"
+	if numRestoredForVS+numRestoredForVR == 0 {
+		msg = "Nothing to restore"
+	}
+
 	setVRGClusterDataReadyCondition(&v.instance.Status.Conditions, v.instance.Generation, msg)
 
-	return nil
+	return numRestoredForVS + numRestoredForVR, nil
 }
 
 func (v *VRGInstance) listPVCsByVrgPVCSelector() (*corev1.PersistentVolumeClaimList, error) {
@@ -852,12 +856,16 @@ func (v *VRGInstance) processAsPrimary() ctrl.Result {
 
 	if v.shouldRestoreClusterData() {
 		v.result.Requeue = true
-		if err := v.clusterDataRestore(&v.result); err != nil {
+
+		numOfRestoredRes, err := v.clusterDataRestore(&v.result)
+		if err != nil {
 			return v.clusterDataError(err, "Failed to restore PVs/PVCs", v.result)
 		}
 
-		// Restore success -- update status and requeue
-		return v.updateVRGConditionsAndStatus(v.result)
+		// Save status and requeue if we restored any resources (PV/PVCs). Otherwise, continue
+		if numOfRestoredRes != 0 {
+			return v.updateVRGConditionsAndStatus(v.result)
+		}
 	}
 
 	v.reconcileAsPrimary()

controllers/vrg_volrep.go

@@ -1817,30 +1817,31 @@ func (v *VRGInstance) s3KeyPrefix() string {
 	return S3KeyPrefix(v.namespacedName)
 }
 
-func (v *VRGInstance) restorePVsAndPVCsForVolRep(result *ctrl.Result) error {
+func (v *VRGInstance) restorePVsAndPVCsForVolRep(result *ctrl.Result) (int, error) {
 	v.log.Info("Restoring VolRep PVs and PVCs")
 
 	if len(v.instance.Spec.S3Profiles) == 0 {
 		v.log.Info("No S3 profiles configured")
 
 		result.Requeue = true
 
-		return fmt.Errorf("no S3Profiles configured")
+		return 0, fmt.Errorf("no S3Profiles configured")
 	}
 
 	v.log.Info(fmt.Sprintf("Restoring PVs and PVCs to this managed cluster. ProfileList: %v", v.instance.Spec.S3Profiles))
 
-	if err := v.restorePVsAndPVCsFromS3(result); err != nil {
+	count, err := v.restorePVsAndPVCsFromS3(result)
+	if err != nil {
 		errMsg := fmt.Sprintf("failed to restore PVs and PVCs using profile list (%v)", v.instance.Spec.S3Profiles)
 		v.log.Info(errMsg)
 
-		return fmt.Errorf("%s: %w", errMsg, err)
+		return 0, fmt.Errorf("%s: %w", errMsg, err)
 	}
 
-	return nil
+	return count, nil
 }
 
-func (v *VRGInstance) restorePVsAndPVCsFromS3(result *ctrl.Result) error {
+func (v *VRGInstance) restorePVsAndPVCsFromS3(result *ctrl.Result) (int, error) {
 	err := errors.New("s3Profiles empty")
 	NoS3 := false
 
@@ -1891,16 +1892,16 @@ func (v *VRGInstance) restorePVsAndPVCsFromS3(result *ctrl.Result) error {
 
 		v.log.Info(fmt.Sprintf("Restored %d PVs and %d PVCs using profile %s", pvCount, pvcCount, s3ProfileName))
 
-		return v.kubeObjectsRecover(result, s3StoreProfile, objectStore)
+		return pvCount + pvcCount, v.kubeObjectsRecover(result, s3StoreProfile, objectStore)
 	}
 
 	if NoS3 {
-		return nil
+		return 0, nil
 	}
 
 	result.Requeue = true
 
-	return err
+	return 0, err
 }
 
 func (v *VRGInstance) restorePVsFromObjectStore(objectStore ObjectStorer, s3ProfileName string) (int, error) {

controllers/vrg_volsync.go

@@ -15,13 +15,13 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-func (v *VRGInstance) restorePVsAndPVCsForVolSync() error {
+func (v *VRGInstance) restorePVsAndPVCsForVolSync() (int, error) {
 	v.log.Info("VolSync: Restoring VolSync PVs")
 
 	if len(v.instance.Spec.VolSync.RDSpec) == 0 {
 		v.log.Info("No RDSpec entries. There are no PVCs to restore")
 		// No ReplicationDestinations (i.e. no PVCs) to restore
-		return nil
+		return 0, nil
 	}
 
 	numPVsRestored := 0
@@ -59,12 +59,12 @@ func (v *VRGInstance) restorePVsAndPVCsForVolSync() error {
 	}
 
 	if numPVsRestored != len(v.instance.Spec.VolSync.RDSpec) {
-		return fmt.Errorf("failed to restore all PVCs using RDSpec (%v)", v.instance.Spec.VolSync.RDSpec)
+		return numPVsRestored, fmt.Errorf("failed to restore all PVCs using RDSpec (%v)", v.instance.Spec.VolSync.RDSpec)
 	}
 
 	v.log.Info("Success restoring VolSync PVs", "Total", numPVsRestored)
 
-	return nil
+	return numPVsRestored, nil
 }
 
 func (v *VRGInstance) reconcileVolSyncAsPrimary(finalSyncPrepared *bool) (requeue bool) {