Add observability controller unit tests

Signed-off-by: João Vilaça <[email protected]>

Author: machadovilaca

controllers/alerts/metrics_test.go

@@ -14,7 +14,6 @@ import (
 	. "github.com/onsi/gomega"
 	"github.com/onsi/gomega/gstruct"
 
-	"github.com/machadovilaca/operator-observability/pkg/operatorrules"
 	monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
@@ -53,8 +52,7 @@ var _ = Describe("alert tests", func() {
 
 		req = commontestutils.NewReq(nil)
 
-		err := operatorrules.CleanRegistry()
-		Expect(err).ToNot(HaveOccurred())
+		rules.ResetRules()
 	})
 
 	Context("test reconciler", func() {
@@ -349,13 +347,12 @@ var _ = Describe("alert tests", func() {
 		})
 
 		It("should use the desired runbook URL template when its ENV Variable is set", func() {
-			err := operatorrules.CleanRegistry()
-			Expect(err).ToNot(HaveOccurred())
+			rules.ResetRules()
 
 			desiredRunbookURLTemplate := "desired/runbookURL/template/%s"
 			os.Setenv(runbookURLTemplateEnv, desiredRunbookURLTemplate)
 
-			err = rules.SetupRules()
+			err := rules.SetupRules()
 			Expect(err).ToNot(HaveOccurred())
 
 			owner := getDeploymentReference(ci.GetDeployment())

controllers/observability/observability_controller_test.go

@@ -0,0 +1,67 @@
+package observability
+
+import (
+	"os"
+	"time"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	appsv1 "k8s.io/api/apps/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/rest"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/manager"
+
+	"github.com/kubevirt/hyperconverged-cluster-operator/controllers/commontestutils"
+	"github.com/kubevirt/hyperconverged-cluster-operator/pkg/monitoring/observability/rules"
+)
+
+const testNamespace = "observability_test"
+
+var logger = logf.Log.WithName("observability-controller")
+
+var _ = Describe("Observability Controller", func() {
+	var mgr manager.Manager
+
+	BeforeEach(func() {
+		err := os.Setenv("OPERATOR_NAMESPACE", testNamespace)
+		Expect(err).ToNot(HaveOccurred())
+
+		cl := commontestutils.InitClient([]client.Object{})
+
+		mgr, err = commontestutils.NewManagerMock(&rest.Config{}, manager.Options{}, cl, logger)
+		Expect(err).ToNot(HaveOccurred())
+	})
+
+	It("Should successfully setup the controller", func() {
+		err := SetupWithManager(mgr, &appsv1.Deployment{})
+		Expect(err).ToNot(HaveOccurred())
+		Expect(rules.ListAlerts()).To(Not(BeEmpty()))
+	})
+
+	It("Should successfully reconcile observability", func() {
+		ownerDeployment := &appsv1.Deployment{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: "test-deployment",
+			},
+		}
+
+		reconciler := NewReconciler(mgr, testNamespace, ownerDeployment)
+		Expect(reconciler.owner.Name).To(Equal(ownerDeployment.Name))
+		Expect(reconciler.namespace).To(Equal(testNamespace))
+		Expect(reconciler.config).To(Equal(mgr.GetConfig()))
+		Expect(reconciler.Client).To(Equal(mgr.GetClient()))
+	})
+
+	It("Should receive periodic events in reconciler events channel", func() {
+		reconciler := NewReconciler(mgr, testNamespace, &appsv1.Deployment{})
+		reconciler.startEventLoop()
+
+		Eventually(reconciler.events).
+			WithTimeout(5 * time.Second).
+			WithPolling(100 * time.Millisecond).
+			Should(Receive())
+	})
+})

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/kubevirt/cluster-network-addons-operator v0.95.1
 	github.com/kubevirt/monitoring/pkg/metrics/parser v0.0.0-20240505100225-e29dee0bb12b
-	github.com/machadovilaca/operator-observability v0.0.21
+	github.com/machadovilaca/operator-observability v0.0.26
 	github.com/onsi/ginkgo/v2 v2.20.2
 	github.com/onsi/gomega v1.34.2
 	github.com/openshift/api v3.9.1-0.20190517100836-d5b34b957e91+incompatible

go.sum

@@ -151,8 +151,8 @@ github.com/kubevirt/monitoring/pkg/metrics/parser v0.0.0-20240505100225-e29dee0b
 github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/ledongthuc/pdf v0.0.0-20220302134840-0c2507a12d80/go.mod h1:imJHygn/1yfhB7XSJJKlFZKl/J+dCPAknuiaGOshXAs=
-github.com/machadovilaca/operator-observability v0.0.21 h1:H0nH+45wtqsxCrJOm8wmcrJLuRZ5QY6iTlHKMlMEZss=
-github.com/machadovilaca/operator-observability v0.0.21/go.mod h1:trC+BjI6zhvZMBcX0q7vHrKKRX3lWZdwJxgVUmRJCfw=
+github.com/machadovilaca/operator-observability v0.0.26 h1:bSwjBQ5Ua4Y9jukLn4HY2ajUfkWraPRAUcn7eRq079g=
+github.com/machadovilaca/operator-observability v0.0.26/go.mod h1:trC+BjI6zhvZMBcX0q7vHrKKRX3lWZdwJxgVUmRJCfw=
 github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
 github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
 github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=

pkg/monitoring/hyperconverged/rules/alerts/prometheus.go

@@ -20,7 +20,7 @@ const (
 	runbookURLTemplateEnv          = "RUNBOOK_URL_TEMPLATE"
 )
 
-func Register() error {
+func Register(operatorRegistry *operatorrules.Registry) error {
 	alerts := [][]promv1.Rule{
 		operatorAlerts(),
 	}
@@ -35,7 +35,7 @@ func Register() error {
 
 	}
 
-	return operatorrules.RegisterAlerts(alerts...)
+	return operatorRegistry.RegisterAlerts(alerts...)
 }
 
 func getRunbookURLTemplate() string {

pkg/monitoring/hyperconverged/rules/recordingrules/recordingrules.go

@@ -2,8 +2,6 @@ package recordingrules
 
 import "github.com/machadovilaca/operator-observability/pkg/operatorrules"
 
-func Register() error {
-	return operatorrules.RegisterRecordingRules(
-		operatorRecordingRules,
-	)
+func Register(operatorRegistry *operatorrules.Registry) error {
+	return operatorRegistry.RegisterRecordingRules(operatorRecordingRules)
 }

pkg/monitoring/hyperconverged/rules/rules.go

@@ -15,22 +15,28 @@ const (
 	ruleName = hcoutil.HyperConvergedName + "-prometheus-rule"
 )
 
+var operatorRegistry = operatorrules.NewRegistry()
+
 func SetupRules() error {
-	err := recordingrules.Register()
+	err := recordingrules.Register(operatorRegistry)
 	if err != nil {
 		return err
 	}
 
-	err = alerts.Register()
+	err = alerts.Register(operatorRegistry)
 	if err != nil {
 		return err
 	}
 
 	return nil
 }
 
+func ResetRules() {
+	operatorRegistry = operatorrules.NewRegistry()
+}
+
 func BuildPrometheusRule(namespace string, owner metav1.OwnerReference) (*promv1.PrometheusRule, error) {
-	rules, err := operatorrules.BuildPrometheusRule(
+	rules, err := operatorRegistry.BuildPrometheusRule(
 		ruleName,
 		namespace,
 		hcoutil.GetLabels(hcoutil.HyperConvergedName, hcoutil.AppComponentMonitoring),
@@ -45,9 +51,9 @@ func BuildPrometheusRule(namespace string, owner metav1.OwnerReference) (*promv1
 }
 
 func ListRecordingRules() []operatorrules.RecordingRule {
-	return operatorrules.ListRecordingRules()
+	return operatorRegistry.ListRecordingRules()
 }
 
 func ListAlerts() []promv1.Rule {
-	return operatorrules.ListAlerts()
+	return operatorRegistry.ListAlerts()
 }