chore(controllers): Test CR deletion, Update finalizer behaviour of Dashboard, Datasource, and Folder (#2098)

* chore: Add missing starting/skipping finalize logs

* chore: Align Dashboard, Datasource and Folder finalize to always DELETE:

* test: Delete CRs and reconcile, ignoring dummy-deployment errors

Author: Baarsgaard

controllers/alertrulegroup_controller.go

@@ -292,6 +292,7 @@ func (r *GrafanaAlertRuleGroupReconciler) reconcileWithInstance(ctx context.Cont
 
 func (r *GrafanaAlertRuleGroupReconciler) finalize(ctx context.Context, group *grafanav1beta1.GrafanaAlertRuleGroup) error {
 	log := logf.FromContext(ctx)
+	log.Info("Finalizing GrafanaAlertRuleGroup")
 
 	isCleanupInGrafanaRequired := true
 

controllers/dashboard_controller.go

@@ -219,26 +219,24 @@ func (r *GrafanaDashboardReconciler) Reconcile(ctx context.Context, req ctrl.Req
 
 func (r *GrafanaDashboardReconciler) finalize(ctx context.Context, cr *v1beta1.GrafanaDashboard) error {
 	log := logf.FromContext(ctx)
+	log.Info("Finalizing GrafanaDashboard")
+
+	uid := content.CustomUIDOrUID(cr, cr.Status.UID)
 
 	instances, err := GetScopedMatchingInstances(ctx, r.Client, cr)
 	if err != nil {
 		return fmt.Errorf("fetching instances: %w", err)
 	}
 
 	for _, grafana := range instances {
-		found, uid := grafana.Status.Dashboards.Find(cr.Namespace, cr.Name)
-		if !found {
-			continue
-		}
-
 		grafanaClient, err := client2.NewGeneratedGrafanaClient(ctx, r.Client, &grafana)
 		if err != nil {
 			return fmt.Errorf("creating grafana http client: %w", err)
 		}
 
 		isCleanupInGrafanaRequired := true
 
-		resp, err := grafanaClient.Dashboards.GetDashboardByUID(*uid)
+		resp, err := grafanaClient.Dashboards.GetDashboardByUID(uid)
 		if err != nil {
 			var notFound *dashboards.GetDashboardByUIDNotFound
 			if !errors.As(err, &notFound) {
@@ -254,7 +252,7 @@ func (r *GrafanaDashboardReconciler) finalize(ctx context.Context, cr *v1beta1.G
 				dash = resp.GetPayload()
 			}
 
-			_, err = grafanaClient.Dashboards.DeleteDashboardByUID(*uid) //nolint:errcheck
+			_, err = grafanaClient.Dashboards.DeleteDashboardByUID(uid) //nolint:errcheck
 			if err != nil {
 				var notFound *dashboards.DeleteDashboardByUIDNotFound
 				if !errors.As(err, &notFound) {

controllers/datasource_controller.go

@@ -214,28 +214,28 @@ func (r *GrafanaDatasourceReconciler) deleteOldDatasource(ctx context.Context, c
 }
 
 func (r *GrafanaDatasourceReconciler) finalize(ctx context.Context, cr *v1beta1.GrafanaDatasource) error {
+	log := logf.FromContext(ctx)
+	log.Info("Finalizing GrafanaDatasource")
+
 	instances, err := GetScopedMatchingInstances(ctx, r.Client, cr)
 	if err != nil {
 		return fmt.Errorf("fetching instances: %w", err)
 	}
 
-	for _, grafana := range instances {
-		found, uid := grafana.Status.Datasources.Find(cr.Namespace, cr.Name)
-		if !found {
-			continue
-		}
+	uid := cr.CustomUIDOrUID()
 
+	for _, grafana := range instances {
 		grafanaClient, err := client2.NewGeneratedGrafanaClient(ctx, r.Client, &grafana)
 		if err != nil {
 			return err
 		}
 
-		_, err = grafanaClient.Datasources.DeleteDataSourceByUID(*uid) // nolint:errcheck
+		_, err = grafanaClient.Datasources.DeleteDataSourceByUID(uid) // nolint:errcheck
 
 		var notFound *datasources.DeleteDataSourceByUIDNotFound
 		if err != nil {
 			if !errors.As(err, &notFound) {
-				return fmt.Errorf("deleting datasource %s: %w", *uid, err)
+				return fmt.Errorf("deleting datasource %s: %w", uid, err)
 			}
 		}
 

controllers/folder_controller.go

@@ -151,6 +151,11 @@ func (r *GrafanaFolderReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 }
 
 func (r *GrafanaFolderReconciler) finalize(ctx context.Context, folder *grafanav1beta1.GrafanaFolder) error {
+	log := logf.FromContext(ctx)
+	log.Info("Finalizing GrafanaFolder")
+
+	uid := folder.CustomUIDOrUID()
+
 	instances, err := GetScopedMatchingInstances(ctx, r.Client, folder)
 	if err != nil {
 		return fmt.Errorf("fetching instances: %w", err)
@@ -160,17 +165,12 @@ func (r *GrafanaFolderReconciler) finalize(ctx context.Context, folder *grafanav
 	params := folders.NewDeleteFolderParams().WithForceDeleteRules(&reftrue)
 
 	for _, grafana := range instances {
-		found, uid := grafana.Status.Folders.Find(folder.Namespace, folder.Name)
-		if !found {
-			continue
-		}
-
 		grafanaClient, err := client2.NewGeneratedGrafanaClient(ctx, r.Client, &grafana)
 		if err != nil {
 			return err
 		}
 
-		_, err = grafanaClient.Folders.DeleteFolder(params.WithFolderUID(*uid)) //nolint
+		_, err = grafanaClient.Folders.DeleteFolder(params.WithFolderUID(uid)) //nolint
 		if err != nil {
 			var notFound *folders.DeleteFolderNotFound
 			if !errors.As(err, &notFound) {

controllers/librarypanel_controller.go

@@ -237,7 +237,7 @@ func (r *GrafanaLibraryPanelReconciler) reconcileWithInstance(ctx context.Contex
 
 func (r *GrafanaLibraryPanelReconciler) finalize(ctx context.Context, libraryPanel *v1beta1.GrafanaLibraryPanel) error {
 	log := logf.FromContext(ctx)
-	log.Info("finalizing GrafanaLibraryPanel")
+	log.Info("Finalizing GrafanaLibraryPanel")
 
 	uid := content.CustomUIDOrUID(libraryPanel, libraryPanel.Status.UID)
 

controllers/notificationpolicy_controller.go

@@ -308,6 +308,7 @@ func (r *GrafanaNotificationPolicyReconciler) reconcileWithInstance(ctx context.
 
 func (r *GrafanaNotificationPolicyReconciler) finalize(ctx context.Context, notificationPolicy *v1beta1.GrafanaNotificationPolicy) error {
 	log := logf.FromContext(ctx)
+	log.Info("Finalizing GrafanaNotificationPolicy")
 
 	instances, err := GetScopedMatchingInstances(ctx, r.Client, notificationPolicy)
 	if err != nil {

controllers/suite_test.go

@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"path/filepath"
 	"slices"
+	"strings"
 	"testing"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -255,4 +256,14 @@ func reconcileAndValidateCondition(r GrafanaCommonReconciler, cr v1beta1.CommonR
 	require.NoError(t, err)
 
 	containsEqualCondition(cr.CommonStatus().Conditions, condition)
+
+	err = k8sClient.Delete(testCtx, cr)
+	require.NoError(t, err)
+
+	_, err = r.Reconcile(testCtx, req)
+	if err != nil && strings.Contains(err.Error(), "dummy-deployment") {
+		require.Error(t, err)
+	} else {
+		require.NoError(t, err)
+	}
 }