adding function to override sonarcube

Author: gizas

internal/pkg/composable/providers/kubernetes/pod.go

@@ -9,10 +9,9 @@ import (
 	"sync"
 	"time"
 
-	"github.com/elastic/elastic-agent-autodiscover/utils"
-
 	"github.com/elastic/elastic-agent-autodiscover/kubernetes"
 	"github.com/elastic/elastic-agent-autodiscover/kubernetes/metadata"
+	"github.com/elastic/elastic-agent-autodiscover/utils"
 	c "github.com/elastic/elastic-agent-libs/config"
 	"github.com/elastic/elastic-agent-libs/logp"
 	"github.com/elastic/elastic-agent-libs/mapstr"
@@ -217,11 +216,7 @@ func (p *pod) emitRunning(pod *kubernetes.Pod) {
 		if !p.managed {
 			if ann, ok := data.mapping["annotations"]; ok {
 				annotations, _ := ann.(mapstr.M)
-				hints, incorrecthints := utils.GenerateHints(annotations, "", p.config.Prefix, true, allSupportedHints)
-				for _, value := range incorrecthints { //We check whether the provided annotation follows the supported format and vocabulary. The check happens for annotations that have prefix co.elastic
-					p.logger.Warnf("provided hint: %s/%s is not recognised as supported annotation for pod %s in namespace %s", p.config.Prefix, value, pod.Name, pod.ObjectMeta.Namespace)
-				}
-
+				hints, _ := hintsCheck(annotations, "", p.config.Prefix, true, allSupportedHints, p.logger, pod)
 				if len(hints) > 0 {
 					p.logger.Debugf("Extracted hints are :%v", hints)
 					hintsMapping := GenerateHintsMapping(hints, data.mapping, p.logger, "")
@@ -529,3 +524,12 @@ func updateProcessors(newprocessors []mapstr.M, processors []map[string]interfac
 
 	return processors
 }
+
+// HintsCheck geenrates hints from provided annotations of the pod and logs any possible incorrect annotations that have been provided in the pod
+func hintsCheck(annotations mapstr.M, container string, prefix string, validate bool, allSupportedHints []string, logger *logp.Logger, pod *kubernetes.Pod) (mapstr.M, []string) {
+	hints, incorrecthints := utils.GenerateHints(annotations, container, prefix, validate, allSupportedHints)
+	for _, value := range incorrecthints { //We check whether the provided annotation follows the supported format and vocabulary. The check happens for annotations that have prefix co.elastic
+		logger.Warnf("provided hint: %s/%s is not recognised as supported annotation for pod %s in namespace %s", prefix, value, pod.Name, pod.ObjectMeta.Namespace)
+	}
+	return hints, incorrecthints
+}

internal/pkg/composable/providers/kubernetes/pod_test.go

@@ -22,7 +22,6 @@ import (
 
 	"github.com/elastic/elastic-agent-autodiscover/kubernetes"
 	"github.com/elastic/elastic-agent-autodiscover/kubernetes/metadata"
-	"github.com/elastic/elastic-agent-autodiscover/utils"
 	"github.com/elastic/elastic-agent-libs/mapstr"
 
 	c "github.com/elastic/elastic-agent-libs/config"
@@ -403,26 +402,26 @@ func TestGenerateHints(t *testing.T) {
 		Status: kubernetes.PodStatus{PodIP: "127.0.0.5"},
 	}
 
-	namespaceAnnotations := mapstr.M{
-		"nsa": "nsb",
-	}
-
-	data := generatePodData(pod, &podMeta{}, namespaceAnnotations)
+	data := generatePodData(pod, &podMeta{}, mapstr.M{})
 
 	hints_result := mapstr.M{
 		"hints": mapstr.M{
-			"host":        "${kubernetes.pod.ip}:6379",
-			"package":     "redis",
-			"metricspath": "/metrics", // on purpose we have introduced a typo
-			"period":      "42s",
+			"host":              "${kubernetes.pod.ip}:6379",
+			"package":           "redis",
+			"metricssssssspath": "/metrics", // on purpose we have introduced a typo
+			"period":            "42s",
 		},
 	}
-	incorrecthints_results := []string{"hints/metricspath"}
+	incorrecthints_results := []string{"hints/metricssssssspath"}
 
 	ann := data.mapping["annotations"]
 	annotations, _ := ann.(mapstr.M)
 	prefix := "co.elastic"
-	hints, incorrecthints := utils.GenerateHints(annotations, "", prefix, true, allSupportedHints)
+
+	log, err := logger.New("hint-test", true)
+	assert.NoError(t, err)
+
+	hints, incorrecthints := hintsCheck(annotations, "", prefix, true, allSupportedHints, log, pod)
 
 	assert.Equal(t, string(pod.GetUID()), data.uid)
 	assert.Equal(t, hints, hints_result)