Dynamic Notification Policy Routes

PROJECT

@@ -8,7 +8,7 @@ layout:
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
 projectName: grafana-operator
-repo: github.com/grafana/grafana-operator
+repo: github.com/grafana/grafana-operator/v5
 resources:
 - api:
     crdVersion: v1
@@ -64,4 +64,13 @@ resources:
   kind: GrafanaContactPoint
   path: github.com/grafana/grafana-operator/api/v1beta1
   version: v1beta1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: integreatly.org
+  group: grafana
+  kind: GrafanaNotificationPolicyRoute
+  path: github.com/grafana/grafana-operator/v5/api/v1beta1
+  version: v1beta1
 version: "3"

api/v1beta1/grafananotificationpolicy_types.go

@@ -71,6 +71,9 @@ type Route struct {
 	// repeat interval
 	RepeatInterval string `json:"repeat_interval,omitempty"`
 
+	// Selects GrafanaNotificationPolicyRoutes to merge in when specified
+	RouteSelector *metav1.LabelSelector `json:"routeSelector,omitempty"`
+
 	// routes
 	// +kubebuilder:pruning:PreserveUnknownFields
 	// +kubebuilder:validation:Schemaless
@@ -126,6 +129,34 @@ func (r *Route) ToModelRoute() *models.Route {
 	return out
 }
 
+// isMutuallyExclusive checks if a single route satisfies the mutual exclusivity constraint
+func isMutuallyExclusive(r *Route) bool {
+	return !(r.RouteSelector != nil && len(r.Routes) > 0)
+}
+
+// IsRouteSelectorMutuallyExclusive returns true when the route and all its sub-routes
+// satisfy the constraint of routes and routeSelector being mutually exclusive
+func (r *Route) IsRouteSelectorMutuallyExclusive() bool {
+	if !isMutuallyExclusive(r) {
+		return false
+	}
+
+	// Recursively check all child routes
+	for _, childRoute := range r.Routes {
+		if !childRoute.IsRouteSelectorMutuallyExclusive() {
+			return false
+		}
+	}
+	return true
+}
+
+// GrafanaNotificationPolicyStatus defines the observed state of GrafanaNotificationPolicy
+type GrafanaNotificationPolicyStatus struct {
+	GrafanaCommonStatus `json:",inline"`
+
+	DiscoveredRoutes *[]string `json:"discoveredRoutes,omitempty"`
+}
+
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 
@@ -137,14 +168,19 @@ type GrafanaNotificationPolicy struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   GrafanaNotificationPolicySpec `json:"spec,omitempty"`
-	Status GrafanaCommonStatus           `json:"status,omitempty"`
+	Spec   GrafanaNotificationPolicySpec   `json:"spec,omitempty"`
+	Status GrafanaNotificationPolicyStatus `json:"status,omitempty"`
 }
 
 func (np *GrafanaNotificationPolicy) NamespacedResource() string {
 	return fmt.Sprintf("%v/%v/%v", np.ObjectMeta.Namespace, np.ObjectMeta.Name, np.ObjectMeta.UID)
 }
 
+// IsCrossNamespaceImportAllowed returns true when cross namespace imports are allowed
+func (np *GrafanaNotificationPolicy) IsCrossNamespaceImportAllowed() bool {
+	return np.Spec.AllowCrossNamespaceImport
+}
+
 //+kubebuilder:object:root=true
 
 // GrafanaNotificationPolicyList contains a list of GrafanaNotificationPolicy

api/v1beta1/grafananotificationpolicy_types_test.go

@@ -2,9 +2,11 @@ package v1beta1
 
 import (
 	"context"
+	"testing"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -74,3 +76,83 @@ var _ = Describe("NotificationPolicy type", func() {
 		})
 	})
 })
+
+func TestIsRouteSelectorMutuallyExclusive(t *testing.T) {
+	tests := []struct {
+		name     string
+		route    *Route
+		expected bool
+	}{
+		{
+			name:     "Empty route",
+			route:    &Route{},
+			expected: true,
+		},
+		{
+			name: "Route with only RouteSelector",
+			route: &Route{
+				RouteSelector: &metav1.LabelSelector{},
+			},
+			expected: true,
+		},
+		{
+			name: "Route with only sub-routes",
+			route: &Route{
+				Routes: []*Route{
+					{},
+					{},
+				},
+			},
+			expected: true,
+		},
+		{
+			name: "Route with both RouteSelector and sub-routes",
+			route: &Route{
+				RouteSelector: &metav1.LabelSelector{},
+				Routes: []*Route{
+					{},
+				},
+			},
+			expected: false,
+		},
+		{
+			name: "Nested routes with mutual exclusivity",
+			route: &Route{
+				Routes: []*Route{
+					{
+						RouteSelector: &metav1.LabelSelector{},
+					},
+					{
+						Routes: []*Route{
+							{},
+						},
+					},
+				},
+			},
+			expected: true,
+		},
+		{
+			name: "Nested routes without mutual exclusivity",
+			route: &Route{
+				Routes: []*Route{
+					{
+						RouteSelector: &metav1.LabelSelector{},
+						Routes: []*Route{
+							{},
+						},
+					},
+				},
+			},
+			expected: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := tt.route.IsRouteSelectorMutuallyExclusive()
+			if result != tt.expected {
+				t.Errorf("IsRouteSelectorMutuallyExclusive() = %v, want %v", result, tt.expected)
+			}
+		})
+	}
+}

api/v1beta1/grafananotificationpolicyroute_types.go

@@ -0,0 +1,58 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// GrafanaNotificationPolicyRouteSpec defines the desired state of GrafanaNotificationPolicyRoute
+type GrafanaNotificationPolicyRouteSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// Route for alerts to match against
+	Route *Route `json:"route"`
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// GrafanaNotificationPolicyRoute is the Schema for the grafananotificationpolicyroutes API
+type GrafanaNotificationPolicyRoute struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   GrafanaNotificationPolicyRouteSpec `json:"spec,omitempty"`
+	Status GrafanaCommonStatus                `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// GrafanaNotificationPolicyRouteList contains a list of GrafanaNotificationPolicyRoute
+type GrafanaNotificationPolicyRouteList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []GrafanaNotificationPolicyRoute `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&GrafanaNotificationPolicyRoute{}, &GrafanaNotificationPolicyRouteList{})
+}