Merge branch 'master' into feat/notificationtemplate

.github/workflows/e2e.yaml

@@ -25,7 +25,7 @@ jobs:
 
       - id: changed-files
         name: Get changed files
-        uses: tj-actions/changed-files@bab30c2299617f6615ec02a68b9a40d10bd21366 #v45.0.5
+        uses: tj-actions/changed-files@d6e91a2266cdb9d62096cebf1e8546899c6aa18f #v45.0.6
         with:
           files_ignore: |
             **/*.md

controllers/controller_shared.go

@@ -89,10 +89,14 @@ func GetScopedMatchingInstances(log logr.Logger, ctx context.Context, k8sClient
 
 	var list v1beta1.GrafanaList
 	err := k8sClient.List(ctx, &list, opts...)
-	if err != nil || len(list.Items) == 0 {
+	if err != nil {
 		return []v1beta1.Grafana{}, err
 	}
 
+	if len(list.Items) == 0 {
+		return []v1beta1.Grafana{}, nil
+	}
+
 	selectedList := []v1beta1.Grafana{}
 	var unready_instances []string
 	for _, instance := range list.Items {
@@ -129,10 +133,14 @@ func GetAllMatchingInstances(ctx context.Context, k8sClient client.Client, cr v1
 
 	var list v1beta1.GrafanaList
 	err := k8sClient.List(ctx, &list, client.MatchingLabels(instanceSelector.MatchLabels))
-	if err != nil || len(list.Items) == 0 {
+	if err != nil {
 		return []v1beta1.Grafana{}, err
 	}
 
+	if len(list.Items) == 0 {
+		return []v1beta1.Grafana{}, nil
+	}
+
 	selectedList := []v1beta1.Grafana{}
 	for _, instance := range list.Items {
 		// Matches all instances when MatchExpressions is undefined

controllers/grafanafolder_controller.go

@@ -37,6 +37,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 
 	grafanav1beta1 "github.com/grafana/grafana-operator/v5/api/v1beta1"
@@ -58,17 +59,14 @@ type GrafanaFolderReconciler struct {
 //+kubebuilder:rbac:groups=grafana.integreatly.org,resources=grafanafolders/finalizers,verbs=update
 
 func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result, error) {
-	syncLog := log.FromContext(ctx).WithName("GrafanaFolderReconciler")
 	foldersSynced := 0
 
 	// get all grafana instances
 	grafanas := &grafanav1beta1.GrafanaList{}
 	var opts []client.ListOption
 	err := r.Client.List(ctx, grafanas, opts...)
 	if err != nil {
-		return ctrl.Result{
-			Requeue: true,
-		}, err
+		return ctrl.Result{}, err
 	}
 
 	// no instances, no need to sync
@@ -80,9 +78,7 @@ func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result,
 	allFolders := &grafanav1beta1.GrafanaFolderList{}
 	err = r.Client.List(ctx, allFolders, opts...)
 	if err != nil {
-		return ctrl.Result{
-			Requeue: true,
-		}, err
+		return ctrl.Result{}, err
 	}
 
 	// sync folders, delete folders from grafana that do no longer have a cr
@@ -100,7 +96,7 @@ func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result,
 	for grafana, existingFolders := range foldersToDelete {
 		grafanaClient, err := client2.NewGeneratedGrafanaClient(ctx, r.Client, grafana)
 		if err != nil {
-			return ctrl.Result{Requeue: true}, err
+			return ctrl.Result{}, err
 		}
 
 		for _, folder := range existingFolders {
@@ -119,9 +115,9 @@ func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result,
 			if err != nil {
 				var notFound *folders.DeleteFolderNotFound
 				if errors.As(err, &notFound) {
-					syncLog.Info("folder no longer exists", "namespace", namespace, "name", name)
+					r.Log.Info("folder no longer exists", "namespace", namespace, "name", name)
 				} else {
-					return ctrl.Result{Requeue: false}, err
+					return ctrl.Result{}, err
 				}
 			}
 
@@ -133,12 +129,12 @@ func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result,
 		// so we should minimize those updates
 		err = r.Client.Status().Update(ctx, grafana)
 		if err != nil {
-			return ctrl.Result{Requeue: false}, err
+			return ctrl.Result{}, err
 		}
 	}
 
 	if foldersSynced > 0 {
-		syncLog.Info("successfully synced folders", "folders", foldersSynced)
+		r.Log.Info("successfully synced folders", "folders", foldersSynced)
 	}
 	return ctrl.Result{Requeue: false}, nil
 }
@@ -153,8 +149,7 @@ func (r *GrafanaFolderReconciler) syncFolders(ctx context.Context) (ctrl.Result,
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.9.2/pkg/reconcile
 func (r *GrafanaFolderReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	controllerLog := log.FromContext(ctx).WithName("GrafanaFolderReconciler")
-	r.Log = controllerLog
+	r.Log = log.FromContext(ctx).WithName("GrafanaFolderReconciler")
 
 	// periodic sync reconcile
 	if req.Namespace == "" && req.Name == "" {
@@ -166,26 +161,45 @@ func (r *GrafanaFolderReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 	}
 
 	folder := &grafanav1beta1.GrafanaFolder{}
-
 	err := r.Client.Get(ctx, client.ObjectKey{
 		Namespace: req.Namespace,
 		Name:      req.Name,
 	}, folder)
 	if err != nil {
 		if kuberr.IsNotFound(err) {
-			if err := r.onFolderDeleted(ctx, req.Namespace, req.Name); err != nil {
-				return ctrl.Result{RequeueAfter: RequeueDelay}, err
-			}
 			return ctrl.Result{}, nil
 		}
 		return ctrl.Result{}, fmt.Errorf("error getting grafana folder cr: %w", err)
 	}
+
+	if folder.GetDeletionTimestamp() != nil {
+		// Check if resource needs clean up
+		if controllerutil.ContainsFinalizer(folder, grafanaFinalizer) {
+			if err := r.finalize(ctx, folder); err != nil {
+				return ctrl.Result{}, fmt.Errorf("failed to finalize GrafanaFolder: %w", err)
+			}
+			if err := removeFinalizer(ctx, r.Client, folder); err != nil {
+				return ctrl.Result{}, fmt.Errorf("failed to remove finalizer: %w", err)
+			}
+		}
+		return ctrl.Result{}, nil
+	}
+
 	defer func() {
 		folder.Status.Hash = folder.Hash()
 		folder.Status.LastResync = metav1.Time{Time: time.Now()}
 		if err := r.Status().Update(ctx, folder); err != nil {
 			r.Log.Error(err, "updating status")
 		}
+		if meta.IsStatusConditionTrue(folder.Status.Conditions, conditionNoMatchingInstance) {
+			if err := removeFinalizer(ctx, r.Client, folder); err != nil {
+				r.Log.Error(err, "failed to remove finalizer")
+			}
+		} else {
+			if err := addFinalizer(ctx, r.Client, folder); err != nil {
+				r.Log.Error(err, "failed to set finalizer")
+			}
+		}
 	}()
 
 	if folder.Spec.ParentFolderUID == folder.CustomUIDOrUID() {
@@ -195,18 +209,24 @@ func (r *GrafanaFolderReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 	}
 	removeInvalidSpec(&folder.Status.Conditions)
 
-	instances, err := GetScopedMatchingInstances(controllerLog, ctx, r.Client, folder)
-	if err != nil || len(instances) == 0 {
+	instances, err := GetScopedMatchingInstances(r.Log, ctx, r.Client, folder)
+	if err != nil {
 		setNoMatchingInstancesCondition(&folder.Status.Conditions, folder.Generation, err)
+		meta.RemoveStatusCondition(&folder.Status.Conditions, conditionFolderSynchronized)
 		folder.Status.NoMatchingInstances = true
+		return ctrl.Result{}, fmt.Errorf("failed fetching instances: %w", err)
+	}
+
+	if len(instances) == 0 {
+		setNoMatchingInstancesCondition(&folder.Status.Conditions, folder.Generation, err)
 		meta.RemoveStatusCondition(&folder.Status.Conditions, conditionFolderSynchronized)
-		controllerLog.Error(err, "could not find matching instances", "name", folder.Name, "namespace", folder.Namespace)
+		folder.Status.NoMatchingInstances = true
 		return ctrl.Result{RequeueAfter: RequeueDelay}, nil
 	}
 
 	removeNoMatchingInstance(&folder.Status.Conditions)
 	folder.Status.NoMatchingInstances = false
-	controllerLog.Info("found matching Grafana instances for folder", "count", len(instances))
+	r.Log.Info("found matching Grafana instances for folder", "count", len(instances))
 
 	applyErrors := make(map[string]string)
 	for _, grafana := range instances {
@@ -266,7 +286,7 @@ func (r *GrafanaFolderReconciler) SetupWithManager(mgr ctrl.Manager, ctx context
 	return err
 }
 
-func (r *GrafanaFolderReconciler) onFolderDeleted(ctx context.Context, namespace string, name string) error {
+func (r *GrafanaFolderReconciler) finalize(ctx context.Context, folder *grafanav1beta1.GrafanaFolder) error {
 	list := grafanav1beta1.GrafanaList{}
 	var opts []client.ListOption
 	err := r.Client.List(ctx, &list, opts...)
@@ -276,7 +296,7 @@ func (r *GrafanaFolderReconciler) onFolderDeleted(ctx context.Context, namespace
 
 	for _, grafana := range list.Items {
 		grafana := grafana
-		if found, uid := grafana.Status.Folders.Find(namespace, name); found {
+		if found, uid := grafana.Status.Folders.Find(folder.Namespace, folder.Name); found {
 			grafanaClient, err := client2.NewGeneratedGrafanaClient(ctx, r.Client, &grafana)
 			if err != nil {
 				return err
@@ -291,7 +311,7 @@ func (r *GrafanaFolderReconciler) onFolderDeleted(ctx context.Context, namespace
 				}
 			}
 
-			grafana.Status.Folders = grafana.Status.Folders.Remove(namespace, name)
+			grafana.Status.Folders = grafana.Status.Folders.Remove(folder.Namespace, folder.Name)
 			err = r.Client.Status().Update(ctx, &grafana)
 			if err != nil {
 				return err

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/go-openapi/strfmt v0.23.0
 	github.com/google/go-jsonnet v0.20.0
 	github.com/grafana/grafana-openapi-client-go v0.0.0-20240430202104-3ad0f7e4ee52
-	github.com/onsi/ginkgo/v2 v2.22.1
+	github.com/onsi/ginkgo/v2 v2.22.2
 	github.com/onsi/gomega v1.36.2
 	github.com/openshift/api v3.9.0+incompatible
 	github.com/pkg/errors v0.9.1

go.sum

@@ -96,8 +96,8 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
-github.com/onsi/ginkgo/v2 v2.22.1 h1:QW7tbJAUDyVDVOM5dFa7qaybo+CRfR7bemlQUN6Z8aM=
-github.com/onsi/ginkgo/v2 v2.22.1/go.mod h1:S6aTpoRsSq2cZOd+pssHAlKW/Q/jZt6cPrPlnj4a1xM=
+github.com/onsi/ginkgo/v2 v2.22.2 h1:/3X8Panh8/WwhU/3Ssa6rCKqPLuAkVY2I0RoyDLySlU=
+github.com/onsi/ginkgo/v2 v2.22.2/go.mod h1:oeMosUL+8LtarXBHu/c0bx2D/K9zyQ6uX3cTyztHwsk=
 github.com/onsi/gomega v1.36.2 h1:koNYke6TVk6ZmnyHrCXba/T/MoLBXFjeC1PtvYgw0A8=
 github.com/onsi/gomega v1.36.2/go.mod h1:DdwyADRjrc825LhMEkD76cHR5+pUnjhUN8GlHlRPHzY=
 github.com/openshift/api v0.0.0-20190924102528-32369d4db2ad h1:MiZEukiPd7ll8BQDwBfc3LKBxbqyeXIx+wl4CzVj5EQ=