Chore(Internal): Refactor pointer bools (#1776)

* refactor: Change AllowCrossNamespaceImport from *bool to bool * test: Add notification policy and contactpoint * chore: Delete duplicate annotation * chore: Generate crds/docs --------- Co-authored-by: Igor Beliakov <[email protected]>
grafana · Dec 18, 2024 · 80f4b26 · 80f4b26
1 parent 34511cd
commit 80f4b26
Show file tree

Hide file tree

Showing 23 changed files with 71 additions and 25 deletions.
diff --git a/api/v1beta1/common.go b/api/v1beta1/common.go
@@ -37,7 +37,8 @@ type GrafanaCommonSpec struct {
 
 	// Allow the Operator to match this resource with Grafanas outside the current namespace
 	// +optional
-	AllowCrossNamespaceImport *bool `json:"allowCrossNamespaceImport,omitempty"`
+	// +kubebuilder:default=false
+	AllowCrossNamespaceImport bool `json:"allowCrossNamespaceImport,omitempty"`
 }
 
 // Common Functions that all CRs should implement, excluding Grafana

diff --git a/api/v1beta1/grafanadashboard_types.go b/api/v1beta1/grafanadashboard_types.go
@@ -308,10 +308,7 @@ func (in *GrafanaDashboardStatus) getContentCache(url string, cacheDuration time
 }
 
 func (in *GrafanaDashboard) IsAllowCrossNamespaceImport() bool {
-	if in.Spec.AllowCrossNamespaceImport != nil {
-		return *in.Spec.AllowCrossNamespaceImport
-	}
-	return false
+	return in.Spec.AllowCrossNamespaceImport
 }
 
 func (in *GrafanaDashboard) IsUpdatedUID(uid string) bool {

diff --git a/api/v1beta1/grafanadatasource_types.go b/api/v1beta1/grafanadatasource_types.go
@@ -147,10 +147,7 @@ func (in *GrafanaDatasource) CustomUIDOrUID() string {
 }
 
 func (in *GrafanaDatasource) IsAllowCrossNamespaceImport() bool {
-	if in.Spec.AllowCrossNamespaceImport != nil {
-		return *in.Spec.AllowCrossNamespaceImport
-	}
-	return false
+	return in.Spec.AllowCrossNamespaceImport
 }
 
 func (in *GrafanaDatasourceList) Find(namespace string, name string) *GrafanaDatasource {

diff --git a/api/v1beta1/grafanafolder_types.go b/api/v1beta1/grafanafolder_types.go
@@ -173,8 +173,5 @@ func (in *GrafanaFolder) MatchNamespace() string {
 }
 
 func (in *GrafanaFolder) AllowCrossNamespace() bool {
-	if in.Spec.AllowCrossNamespaceImport != nil {
-		return *in.Spec.AllowCrossNamespaceImport
-	}
-	return false
+	return in.Spec.AllowCrossNamespaceImport
 }
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/grafana.integreatly.org_grafanaalertrulegroups.yaml b/config/crd/bases/grafana.integreatly.org_grafanaalertrulegroups.yaml
@@ -43,6 +43,7 @@ spec:
             description: GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml b/config/crd/bases/grafana.integreatly.org_grafanacontactpoints.yaml
@@ -43,6 +43,7 @@ spec:
             description: GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/config/crd/bases/grafana.integreatly.org_grafanadashboards.yaml b/config/crd/bases/grafana.integreatly.org_grafanadashboards.yaml
@@ -53,6 +53,7 @@ spec:
             description: GrafanaDashboardSpec defines the desired state of GrafanaDashboard
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/config/crd/bases/grafana.integreatly.org_grafanadatasources.yaml b/config/crd/bases/grafana.integreatly.org_grafanadatasources.yaml
@@ -53,6 +53,7 @@ spec:
             description: GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/config/crd/bases/grafana.integreatly.org_grafanafolders.yaml b/config/crd/bases/grafana.integreatly.org_grafanafolders.yaml
@@ -49,6 +49,7 @@ spec:
             description: GrafanaFolderSpec defines the desired state of GrafanaFolder
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml b/config/crd/bases/grafana.integreatly.org_grafananotificationpolicies.yaml
@@ -44,6 +44,7 @@ spec:
               GrafanaNotificationPolicy
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/controllers/controller_shared_test.go b/controllers/controller_shared_test.go
@@ -235,8 +235,6 @@ func TestLabelsSatisfyMatchExpressions(t *testing.T) {
 }
 
 var _ = Describe("GetMatchingInstances functions", Ordered, func() {
-	refTrue := true
-	refFalse := false
 	namespace := corev1.Namespace{
 		ObjectMeta: metav1.ObjectMeta{
 			Name: "get-matching-test",
@@ -253,7 +251,7 @@ var _ = Describe("GetMatchingInstances functions", Ordered, func() {
 		},
 		Spec: v1beta1.GrafanaFolderSpec{
 			GrafanaCommonSpec: v1beta1.GrafanaCommonSpec{
-				AllowCrossNamespaceImport: &refTrue,
+				AllowCrossNamespaceImport: true,
 				InstanceSelector: &v1.LabelSelector{
 					MatchLabels: map[string]string{
 						"test": "folder",
@@ -265,7 +263,7 @@ var _ = Describe("GetMatchingInstances functions", Ordered, func() {
 	// Create duplicate resources, changing key fields
 	denyFolder := allowFolder.DeepCopy()
 	denyFolder.Name = "deny-cross-namespace"
-	denyFolder.Spec.AllowCrossNamespaceImport = &refFalse
+	denyFolder.Spec.AllowCrossNamespaceImport = false
 
 	matchAllFolder := allowFolder.DeepCopy()
 	matchAllFolder.Name = "invalid-match-labels"

diff --git a/controllers/grafanaalertrulegroup_controller.go b/controllers/grafanaalertrulegroup_controller.go
@@ -57,7 +57,6 @@ type GrafanaAlertRuleGroupReconciler struct {
 
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.
-//+kubebuilder:rbac:groups=grafana.integreatly.org,resources=grafanaalertrulegroups/finalizers,verbs=update
 
 func (r *GrafanaAlertRuleGroupReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
 	controllerLog := log.FromContext(ctx).WithName("GrafanaAlertRuleGroupReconciler")
@@ -336,7 +335,7 @@ func (r *GrafanaAlertRuleGroupReconciler) GetMatchingInstances(ctx context.Conte
 	if err != nil || len(instances.Items) == 0 {
 		return nil, err
 	}
-	if group.Spec.AllowCrossNamespaceImport != nil && *group.Spec.AllowCrossNamespaceImport {
+	if group.Spec.AllowCrossNamespaceImport {
 		return instances.Items, nil
 	}
 	items := []grafanav1beta1.Grafana{}

diff --git a/controllers/grafanacontactpoint_controller.go b/controllers/grafanacontactpoint_controller.go
@@ -292,7 +292,7 @@ func (r *GrafanaContactPointReconciler) GetMatchingInstances(ctx context.Context
 	if err != nil || len(instances.Items) == 0 {
 		return nil, err
 	}
-	if contactPoint.Spec.AllowCrossNamespaceImport != nil && *contactPoint.Spec.AllowCrossNamespaceImport {
+	if contactPoint.Spec.AllowCrossNamespaceImport {
 		return instances.Items, nil
 	}
 	items := []grafanav1beta1.Grafana{}

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanaalertrulegroups.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanaalertrulegroups.yaml
@@ -43,6 +43,7 @@ spec:
             description: GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanacontactpoints.yaml
@@ -43,6 +43,7 @@ spec:
             description: GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadashboards.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadashboards.yaml
@@ -53,6 +53,7 @@ spec:
             description: GrafanaDashboardSpec defines the desired state of GrafanaDashboard
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadatasources.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanadatasources.yaml
@@ -53,6 +53,7 @@ spec:
             description: GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafanafolders.yaml
@@ -49,6 +49,7 @@ spec:
             description: GrafanaFolderSpec defines the desired state of GrafanaFolder
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml b/deploy/helm/grafana-operator/crds/grafana.integreatly.org_grafananotificationpolicies.yaml
@@ -44,6 +44,7 @@ spec:
               GrafanaNotificationPolicy
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml
@@ -42,6 +42,7 @@ spec:
             description: GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean
@@ -358,6 +359,7 @@ spec:
             description: GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean
@@ -654,6 +656,7 @@ spec:
             description: GrafanaDashboardSpec defines the desired state of GrafanaDashboard
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean
@@ -1149,6 +1152,7 @@ spec:
             description: GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean
@@ -1414,6 +1418,7 @@ spec:
             description: GrafanaFolderSpec defines the desired state of GrafanaFolder
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean
@@ -1629,6 +1634,7 @@ spec:
               GrafanaNotificationPolicy
             properties:
               allowCrossNamespaceImport:
+                default: false
                 description: Allow the Operator to match this resource with Grafanas
                   outside the current namespace
                 type: boolean

diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -130,6 +130,8 @@ GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
         <td>boolean</td>
         <td>
           Allow the Operator to match this resource with Grafanas outside the current namespace<br/>
+          <br/>
+            <i>Default</i>: false<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -721,6 +723,8 @@ GrafanaContactPointSpec defines the desired state of GrafanaContactPoint
         <td>boolean</td>
         <td>
           Allow the Operator to match this resource with Grafanas outside the current namespace<br/>
+          <br/>
+            <i>Default</i>: false<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -1205,6 +1209,8 @@ GrafanaDashboardSpec defines the desired state of GrafanaDashboard
         <td>boolean</td>
         <td>
           Allow the Operator to match this resource with Grafanas outside the current namespace<br/>
+          <br/>
+            <i>Default</i>: false<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -2321,6 +2327,8 @@ GrafanaDatasourceSpec defines the desired state of GrafanaDatasource
         <td>boolean</td>
         <td>
           Allow the Operator to match this resource with Grafanas outside the current namespace<br/>
+          <br/>
+            <i>Default</i>: false<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -2902,6 +2910,8 @@ GrafanaFolderSpec defines the desired state of GrafanaFolder
         <td>boolean</td>
         <td>
           Allow the Operator to match this resource with Grafanas outside the current namespace<br/>
+          <br/>
+            <i>Default</i>: false<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -3257,6 +3267,8 @@ GrafanaNotificationPolicySpec defines the desired state of GrafanaNotificationPo
         <td>boolean</td>
         <td>
           Allow the Operator to match this resource with Grafanas outside the current namespace<br/>
+          <br/>
+            <i>Default</i>: false<br/>
         </td>
         <td>false</td>
       </tr><tr>

diff --git a/tests/example-resources.yaml b/tests/example-resources.yaml
@@ -15,6 +15,38 @@ spec:
       admin_password: secret
 ---
 apiVersion: grafana.integreatly.org/v1beta1
+kind: GrafanaContactPoint
+metadata:
+  name: testdata
+  labels:
+    test: "testdata"
+spec:
+  name: testdata
+  type: email
+  instanceSelector:
+    matchLabels:
+      test: "testdata"
+  settings:
+    addresses: "[email protected]"
+    subject: 'Grafana Alert'
+---
+apiVersion: grafana.integreatly.org/v1beta1
+kind: GrafanaNotificationPolicy
+metadata:
+  name: testdata
+  labels:
+    test: "testdata"
+spec:
+  instanceSelector:
+    matchLabels:
+      test: "testdata"
+  route:
+    receiver: testdata
+    group_by:
+      - grafana_folder
+      - alertname
+---
+apiVersion: grafana.integreatly.org/v1beta1
 kind: GrafanaFolder
 metadata:
   name: testdata