Fix ServerMaintenance not deleted when referenced Server is gone

Closes #367

Signed-off-by: Stefan Hipfel <stefan.hipfel@sap.com>

Author: stefanhipfel

internal/controller/servermaintenance_controller.go

@@ -73,6 +73,10 @@ func (r *ServerMaintenanceReconciler) reconcile(ctx context.Context, maintenance
 	server := &metalv1alpha1.Server{}
 	if err := r.Get(ctx, client.ObjectKey{Name: maintenance.Spec.ServerRef.Name}, server); err != nil {
 		if apierrors.IsNotFound(err) {
+			log.V(1).Info("Referenced Server not found, deleting ServerMaintenance")
+			if err := r.Delete(ctx, maintenance); err != nil {
+				return ctrl.Result{}, client.IgnoreNotFound(err)
+			}
 			return ctrl.Result{}, nil
 		}
 		return ctrl.Result{}, fmt.Errorf("failed to get Server: %w", err)
@@ -353,7 +357,10 @@ func (r *ServerMaintenanceReconciler) delete(ctx context.Context, maintenance *m
 	}
 	server, err := GetServerByName(ctx, r.Client, maintenance.Spec.ServerRef.Name)
 	if err != nil {
-		return ctrl.Result{}, err
+		if !apierrors.IsNotFound(err) {
+			return ctrl.Result{}, err
+		}
+		server = nil
 	}
 	if err := r.cleanup(ctx, server); err != nil {
 		return ctrl.Result{}, err

internal/controller/servermaintenance_controller_test.go

@@ -10,6 +10,7 @@ import (
 	. "github.com/onsi/gomega"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 )
 
@@ -57,7 +58,7 @@ var _ = Describe("ServerMaintenance Controller", func() {
 	})
 
 	AfterEach(func(ctx SpecContext) {
-		Expect(k8sClient.Delete(ctx, server)).To(Succeed())
+		Expect(client.IgnoreNotFound(k8sClient.Delete(ctx, server))).To(Succeed())
 		Expect(k8sClient.Delete(ctx, bmcSecret)).To(Succeed())
 		EnsureCleanState()
 	})
@@ -554,4 +555,59 @@ var _ = Describe("ServerMaintenance Controller", func() {
 		Expect(k8sClient.Delete(ctx, unsetPriorityMaintenance)).To(Succeed())
 		Expect(k8sClient.Delete(ctx, serverClaim)).To(Succeed())
 	})
+
+	It("should delete ServerMaintenance when its referenced Server no longer exists", func(ctx SpecContext) {
+		By("Creating a ServerMaintenance object")
+		serverMaintenance := &metalv1alpha1.ServerMaintenance{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "test-server-maintenance-orphan",
+				Namespace: ns.Name,
+			},
+			Spec: metalv1alpha1.ServerMaintenanceSpec{
+				ServerRef: &corev1.LocalObjectReference{Name: server.Name},
+				Policy:    metalv1alpha1.ServerMaintenancePolicyEnforced,
+			},
+		}
+		Expect(k8sClient.Create(ctx, serverMaintenance)).To(Succeed())
+
+		By("Deleting the Server")
+		Expect(k8sClient.Delete(ctx, server)).To(Succeed())
+		Eventually(Get(server)).ShouldNot(Succeed())
+
+		By("Expecting the ServerMaintenance to be deleted automatically")
+		Eventually(Get(serverMaintenance)).ShouldNot(Succeed())
+	})
+
+	It("should complete deletion of ServerMaintenance with finalizer when referenced Server is gone", func(ctx SpecContext) {
+		By("Patching server to Initial State so ServerMaintenance can add its finalizer")
+		Eventually(UpdateStatus(server, func() {
+			server.Status.State = metalv1alpha1.ServerStateInitial
+		})).Should(Succeed())
+
+		By("Creating a ServerMaintenance object")
+		serverMaintenance := &metalv1alpha1.ServerMaintenance{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "test-server-maintenance-finalizer",
+				Namespace: ns.Name,
+			},
+			Spec: metalv1alpha1.ServerMaintenanceSpec{
+				ServerRef: &corev1.LocalObjectReference{Name: server.Name},
+				Policy:    metalv1alpha1.ServerMaintenancePolicyEnforced,
+			},
+		}
+		Expect(k8sClient.Create(ctx, serverMaintenance)).To(Succeed())
+
+		By("Waiting for the finalizer to be added")
+		Eventually(Object(serverMaintenance)).Should(HaveField("Finalizers", ContainElement(serverMaintenanceFinalizer)))
+
+		By("Deleting the Server first")
+		Expect(k8sClient.Delete(ctx, server)).To(Succeed())
+		Eventually(Get(server)).ShouldNot(Succeed())
+
+		By("Deleting the ServerMaintenance")
+		Expect(k8sClient.Delete(ctx, serverMaintenance)).To(Succeed())
+
+		By("Expecting the ServerMaintenance finalizer to be removed and resource to be deleted")
+		Eventually(Get(serverMaintenance)).ShouldNot(Succeed())
+	})
 })