✨ Add ContainsFinalizer helper to the controllerutil

Author: dmvolod

pkg/controller/controllerutil/controllerutil.go

@@ -280,3 +280,24 @@ func RemoveFinalizerWithError(o runtime.Object, finalizer string) error {
 	RemoveFinalizer(m, finalizer)
 	return nil
 }
+
+// ContainsFinalizer checks a metav1 object that the provided finalizer is present.
+func ContainsFinalizer(o metav1.Object, finalizer string) bool {
+	f := o.GetFinalizers()
+	for _, e := range f {
+		if e == finalizer {
+			return true
+		}
+	}
+	return false
+}
+
+// ContainsFinalizerWithError checks a metav1 object that the provided finalizer is present.
+// It returns an error if the provided object cannot provide an accessor.
+func ContainsFinalizerWithError(o runtime.Object, finalizer string) (bool, error) {
+	m, err := meta.Accessor(o)
+	if err != nil {
+		return false, err
+	}
+	return ContainsFinalizer(m, finalizer), nil
+}

pkg/controller/controllerutil/controllerutil_test.go

@@ -422,6 +422,13 @@ var _ = Describe("Controllerutil", func() {
 			})
 		})
 
+		Describe("ContainsFinalizerWithError", func() {
+			It("should return an error if object can't provide accessor", func() {
+				_, err := controllerutil.ContainsFinalizerWithError(obj, testFinalizer)
+				Expect(err).To(HaveOccurred())
+			})
+		})
+
 		Describe("AddFinalizer", func() {
 			deploy = &appsv1.Deployment{
 				ObjectMeta: metav1.ObjectMeta{
@@ -446,6 +453,18 @@ var _ = Describe("Controllerutil", func() {
 				Expect(deploy.ObjectMeta.GetFinalizers()).To(Equal([]string{}))
 			})
 		})
+
+		Describe("ContainsFinalizer", func() {
+			It("should check that finalizer is present", func() {
+				controllerutil.AddFinalizer(deploy, testFinalizer)
+				Expect(controllerutil.ContainsFinalizer(deploy, testFinalizer)).To(Equal(true))
+			})
+
+			It("should check that finalizer is not present after RemoveFinalizer call", func() {
+				controllerutil.RemoveFinalizer(deploy, testFinalizer)
+				Expect(controllerutil.ContainsFinalizer(deploy, testFinalizer)).To(Equal(false))
+			})
+		})
 	})
 })