Merge pull request #28 from quero-edu/add_logger_to_logql_validation

Add logs when logql is rejected

.golangci.yml

@@ -137,3 +137,9 @@ linters-settings:
       - name: unused-parameter
         severity: warning
         disabled: false
+
+issues:
+  exclude-rules:
+    - path: '(.+)_test\.go'
+      text: "dot-imports: should not use dot imports"
+

internal/logger/logger.go

@@ -78,7 +78,7 @@ func NewLogger(level string, onError func(err error, args ...interface{})) Logge
 }
 
 func NewNopLogger() Logger {
-	noopErrorCallback := func(err error, args ...interface{}) {}
+	noopErrorCallback := func(_ error, _ ...interface{}) {}
 
 	return &loggerImpl{logger: gokitlog.NewNopLogger(), errorCallback: noopErrorCallback}
 }

pkg/controllers/logql_validator_test.go

@@ -66,7 +66,7 @@ func TestValidateLogQLOnServerWithHeadersFunc(t *testing.T) {
 }
 
 func TestValidateLogQLOnServerFuncHTTP500IsAnInvalidResponse(t *testing.T) {
-	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
 		w.WriteHeader(http.StatusInternalServerError)
 	}))
 
@@ -84,7 +84,7 @@ func TestValidateLogQLOnServerFuncHTTP500IsAnInvalidResponse(t *testing.T) {
 }
 
 func TestValidateLogQLOnServerFuncInvalidRequest(t *testing.T) {
-	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
 		w.WriteHeader(500)
 	}))
 	isValid, err := ValidateLogQLOnServerFunc(http.DefaultClient, ts.URL, "{job=\"loki-test\"}")

pkg/controllers/lokirule_controller.go

@@ -111,20 +111,20 @@ func getLokiStatefulSet(
 	return statefulSet, nil
 }
 
-var handleValidateLogQLResult = func(client *http.Client, lokiURL string, queryStringArray []string) bool {
-
+func (r *LokiRuleReconciler) handleValidateLogQLResult(queryStringArray []string) bool {
 	for _, queryString := range queryStringArray {
-		valid, err := ValidateLogQLOnServerFunc(client, lokiURL, queryString)
+		valid, err := ValidateLogQLOnServerFunc(r.LokiClient, r.LokiURL, queryString)
 
 		if err != nil {
+			r.Logger.Error(err, "Failed to send request to Loki server")
 			return false
 		}
 
 		if !valid {
+			r.Logger.Warn("The query string:", queryString, "is not a valid LogQL query")
 			return false
 		}
 	}
-
 	return true
 }
 
@@ -145,11 +145,11 @@ func handleByEventType(r *LokiRuleReconciler) predicate.Predicate {
 	return predicate.Funcs{
 		CreateFunc: func(e event.CreateEvent) bool {
 			queryStringArray := getStringQueryFromLokiRule(e.Object.(*querocomv1alpha1.LokiRule))
-			return handleValidateLogQLResult(r.LokiClient, r.LokiURL, queryStringArray)
+			return r.handleValidateLogQLResult(queryStringArray)
 		},
 		UpdateFunc: func(e event.UpdateEvent) bool {
 			queryStringArray := getStringQueryFromLokiRule(e.ObjectNew.(*querocomv1alpha1.LokiRule))
-			return handleValidateLogQLResult(r.LokiClient, r.LokiURL, queryStringArray)
+			return r.handleValidateLogQLResult(queryStringArray)
 		},
 		DeleteFunc: func(e event.DeleteEvent) bool {
 			options := k8sutils.Options{Ctx: context.TODO(), Logger: r.Logger}

pkg/controllers/lokirule_controller_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"net/http/httptest"
 	"path/filepath"
 	"reflect"
 	"time"
@@ -43,6 +44,8 @@ const lokiRuleConfigMapName = "loki-rule-cfg"
 var k8sClient client.Client
 var testEnv *envtest.Environment
 
+var httpServer *httptest.Server
+
 var lokiStatefulSet *appsv1.StatefulSet
 var lokiRuleReconcilerInstance *LokiRuleReconciler
 
@@ -76,6 +79,10 @@ var _ = BeforeSuite(func() {
 	})
 	Expect(err).ToNot(HaveOccurred())
 
+	httpServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+		w.WriteHeader(http.StatusOK)
+	}))
+
 	selector := &metav1.LabelSelector{
 		MatchLabels: labels,
 	}
@@ -88,6 +95,8 @@ var _ = BeforeSuite(func() {
 		LokiLabelSelector:     selector,
 		LokiNamespace:         lokiSTSNamespaceName,
 		LokiRuleConfigMapName: lokiRuleConfigMapName,
+		LokiURL:               httpServer.URL,
+		LokiClient:            &http.Client{},
 	}
 
 	err = (lokiRuleReconcilerInstance).SetupWithManager(mgr)
@@ -104,16 +113,17 @@ var _ = BeforeSuite(func() {
 	}()
 })
 
+var _ = AfterSuite(func() {
+	defer httpServer.Close()
+})
+
 var _ = Describe("LokiRuleController", func() {
 	Describe("Reconcile", func() {
 		Context("When a LokiRule is created", func() {
 			var lokiRule *querocomv1alpha1.LokiRule
 			configMapName := "loki-rule-cfg"
 
 			BeforeEach(func() {
-				handleValidateLogQLResult = func(client *http.Client, lokiURL string, queryStringArray []string) bool {
-					return true
-				}
 				lokiRule = &querocomv1alpha1.LokiRule{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "test-lokirule",