controller: consider managed state annotation in new pvc controller

This patch adds the missing logic to ignore reconciles for unmanaged
resources.

Signed-off-by: Niraj Yadav <niryadav@redhat.com>

Author: black-dragon74

internal/controller/csiaddons/pvc_new_controller.go

@@ -185,6 +185,15 @@ func (r *PVCReconiler) reconcileFeature(
 	}
 	logger.Info("determined the state to reconcile with", "shouldExist", shouldExist, "exists", exists)
 
+	// We allow the user to mark a feature as unmanged by editing an existing resource
+	// and setting the CSIAddonsStateAnnotation to: unmanaged
+	// Return and do nothing in such cases
+	if exists && !utils.IsManagedByController(existingObj) {
+		logger.Info("The existing object is not managed by the controller, doing nothing for it.", "objName", existingObj.GetName(), "objNamespace", existingObj.GetNamespace())
+
+		return nil
+	}
+
 	// Object should not be present in the cluster, garbage collect or return
 	if !shouldExist {
 		if exists {

internal/controller/utils/annotations.go

@@ -18,6 +18,7 @@ package utils
 
 import (
 	csiaddonsv1alpha1 "github.com/csi-addons/kubernetes-csi-addons/api/csiaddons/v1alpha1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 var (
@@ -53,3 +54,13 @@ func AnnotationValueChanged(oldAnnotations, newAnnotations map[string]string, ke
 	}
 	return false
 }
+
+// IsManagedByController checks whether an object is managed by the controller.
+// It returns false if the object has the CSIAddonsStateAnnotation set to a value
+// other than CSIAddonsStateManaged. If the annotation is missing it returns true.
+func IsManagedByController(obj client.Object) bool {
+	if v, ok := obj.GetAnnotations()[CSIAddonsStateAnnotation]; ok && v != CSIAddonsStateManaged {
+		return false
+	}
+	return true
+}

internal/controller/utils/annotations_test.go

@@ -16,7 +16,14 @@ limitations under the License.
 
 package utils
 
-import "testing"
+import (
+	"testing"
+
+	csiaddonsv1alpha1 "github.com/csi-addons/kubernetes-csi-addons/api/csiaddons/v1alpha1"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
 
 func TestAnnotationValueChanged(t *testing.T) {
 	tests := []struct {
@@ -86,3 +93,66 @@ func TestAnnotationValueChanged(t *testing.T) {
 		})
 	}
 }
+
+func TestIsManagedByController(t *testing.T) {
+	tests := []struct {
+		name     string
+		obj      client.Object
+		expected bool
+	}{
+		{
+			name: "No annotations",
+			obj: &csiaddonsv1alpha1.EncryptionKeyRotationCronJob{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: nil,
+				},
+			},
+			expected: true,
+		},
+		{
+			name: "No CSIAddonsStateAnnotation",
+			obj: &csiaddonsv1alpha1.EncryptionKeyRotationCronJob{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{"other": "value"},
+				},
+			},
+			expected: true,
+		},
+		{
+			name: "CSIAddonsStateAnnotation set to managed",
+			obj: &csiaddonsv1alpha1.EncryptionKeyRotationCronJob{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{CSIAddonsStateAnnotation: CSIAddonsStateManaged},
+				},
+			},
+			expected: true,
+		},
+		{
+			name: "CSIAddonsStateAnnotation set to unmanaged",
+			obj: &csiaddonsv1alpha1.EncryptionKeyRotationCronJob{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{CSIAddonsStateAnnotation: "unmanaged"},
+				},
+			},
+			expected: false,
+		},
+		{
+			name: "CSIAddonsStateAnnotation set to empty string",
+			obj: &csiaddonsv1alpha1.EncryptionKeyRotationCronJob{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: map[string]string{CSIAddonsStateAnnotation: ""},
+				},
+			},
+			expected: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := IsManagedByController(tt.obj)
+			if result != tt.expected {
+				t.Errorf("IsManagedByController() = %v, want %v", result, tt.expected)
+			}
+		})
+	}
+}