[chore]: enable comment-spacings rule from revive (#4792)

Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>

Author: mmorel-35

.golangci.yaml

@@ -71,7 +71,8 @@ linters:
         - name: confusing-results
           disabled: true # FIXME
         - name: comment-spacings
-          disabled: true # FIXME
+          arguments:
+            - +kubebuilder
         - name: deep-exit
           disabled: true # FIXME
         - name: defer

cmd/operator-opamp-bridge/internal/metrics/reporter.go

@@ -96,7 +96,7 @@ func NewMetricReporter(logger logr.Logger, dest *protobufs.TelemetryConnectionSe
 
 	reporter.meter = provider.Meter("opamp")
 
-	reporter.process, err = process.NewProcess(int32(os.Getpid())) //nolint: gosec // this is guaranteed to not overflow
+	reporter.process, err = process.NewProcess(int32(os.Getpid())) //nolint:gosec // this is guaranteed to not overflow
 	if err != nil {
 		return nil, fmt.Errorf("cannot query own process: %w", err)
 	}

cmd/otel-allocator/internal/server/server.go

@@ -602,7 +602,7 @@ func (s *Server) ScrapeConfigsHTMLHandler(c *gin.Context) {
 	WriteHTMLPageHeader(c.Writer, HeaderData{
 		Title: "OpenTelemetry Target Allocator - Scrape Configs",
 	})
-	//s.scrapeConfigResponse
+	// s.scrapeConfigResponse
 	// Marshal the scrape config to JSON
 	scrapeConfigs := make(map[string]any)
 	err := json.Unmarshal(s.scrapeConfigResponse, &scrapeConfigs)

cmd/otel-allocator/internal/watcher/promOperator.go

@@ -66,7 +66,7 @@ func NewPrometheusCRWatcher(
 	// we want to use endpointslices by default
 	serviceDiscoveryRole := monitoringv1.ServiceDiscoveryRole("EndpointSlice")
 
-	//no need to hardcode durations, use default if not set
+	// no need to hardcode durations, use default if not set
 	prom := &monitoringv1.Prometheus{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: cfg.CollectorNamespace,

internal/manifests/collector/container_test.go

@@ -666,7 +666,7 @@ func TestContainerImagePullPolicy(t *testing.T) {
 }
 
 func TestContainerEnvFrom(t *testing.T) {
-	//prepare
+	// prepare
 	envFrom1 := corev1.EnvFromSource{
 		SecretRef: &corev1.SecretEnvSource{
 			LocalObjectReference: corev1.LocalObjectReference{

internal/manifests/manifestutils/annotations_test.go

@@ -33,7 +33,7 @@ func TestDefaultAnnotations(t *testing.T) {
 	podAnnotations, err := PodAnnotations(otelcol, []string{})
 	require.NoError(t, err)
 
-	//verify propagation from metadata.annotations to spec.template.spec.metadata.annotations
+	// verify propagation from metadata.annotations to spec.template.spec.metadata.annotations
 	assert.Equal(t, "true", podAnnotations["prometheus.io/scrape"])
 	assert.Equal(t, "8888", podAnnotations["prometheus.io/port"])
 	assert.Equal(t, "/metrics", podAnnotations["prometheus.io/path"])
@@ -62,11 +62,11 @@ func TestNonDefaultPodAnnotation(t *testing.T) {
 	podAnnotations, err := PodAnnotations(otelcol, []string{})
 	require.NoError(t, err)
 
-	//verify
+	// verify
 	assert.NotContains(t, annotations, "prometheus.io/scrape", "Prometheus scrape annotation should not exist")
 	assert.NotContains(t, annotations, "prometheus.io/port", "Prometheus port annotation should not exist")
 	assert.NotContains(t, annotations, "prometheus.io/path", "Prometheus path annotation should not exist")
-	//verify propagation from metadata.annotations to spec.template.spec.metadata.annotations
+	// verify propagation from metadata.annotations to spec.template.spec.metadata.annotations
 	assert.NotContains(t, podAnnotations, "prometheus.io/scrape", "Prometheus scrape annotation should not exist in pod annotations")
 	assert.NotContains(t, podAnnotations, "prometheus.io/port", "Prometheus port annotation should not exist in pod annotations")
 	assert.NotContains(t, podAnnotations, "prometheus.io/path", "Prometheus path annotation should not exist in pod annotations")
@@ -99,7 +99,7 @@ func TestUserAnnotations(t *testing.T) {
 	podAnnotations, err := PodAnnotations(otelcol, []string{})
 	require.NoError(t, err)
 
-	//verify
+	// verify
 	assert.Equal(t, "false", annotations["prometheus.io/scrape"])
 	assert.Equal(t, "1234", annotations["prometheus.io/port"])
 	assert.Equal(t, "/test", annotations["prometheus.io/path"])

internal/manifests/targetallocator/container_test.go

@@ -606,7 +606,7 @@ func TestContainerLifecycle(t *testing.T) {
 }
 
 func TestContainerEnvFrom(t *testing.T) {
-	//prepare
+	// prepare
 	envFrom1 := corev1.EnvFromSource{
 		SecretRef: &corev1.SecretEnvSource{
 			LocalObjectReference: corev1.LocalObjectReference{

pkg/collector/upgrade/upgrade.go

@@ -141,7 +141,7 @@ func (u VersionUpgrade) ManagedInstance(_ context.Context, otelcol v1beta1.OpenT
 				}
 				u.Log.V(1).Info("step upgrade", "name", updated.Name, "namespace", updated.Namespace, "version", available.String())
 			} else {
-				upgraded, err := available.upgradeV1beta1(u, &updated) //available.upgrade(params., &updated)
+				upgraded, err := available.upgradeV1beta1(u, &updated) // available.upgrade(params., &updated)
 				if err != nil {
 					u.Log.Error(err, "failed to upgrade managed otelcol instance", "name", updated.Name, "namespace", updated.Namespace)
 					return updated, err

pkg/collector/upgrade/v0_43_0.go

@@ -20,9 +20,9 @@ func upgrade0_43_0(u VersionUpgrade, otelcol *v1alpha1.OpenTelemetryCollector) (
 		return otelcol, nil
 	}
 
-	//Removing deprecated Spec.Args (--metrics-addr and --metrics-level) based on
+	// Removing deprecated Spec.Args (--metrics-addr and --metrics-level) based on
 	// https://github.com/open-telemetry/opentelemetry-collector/pull/4695
-	//Both args can be used now on the Spec.Config
+	// Both args can be used now on the Spec.Config
 	foundMetricsArgs := make(map[string]string)
 	for argKey, argValue := range otelcol.Spec.Args {
 		if argKey == "--metrics-addr" || argKey == "--metrics-level" {

pkg/collector/upgrade/v0_57_2.go

@@ -23,7 +23,7 @@ func upgrade0_57_2(u VersionUpgrade, otelcol *v1alpha1.OpenTelemetryCollector) (
 		return otelcol, fmt.Errorf("couldn't upgrade to v0.57.2, failed to parse configuration: %w", err)
 	}
 
-	//Remove deprecated port field from config. (https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/10853)
+	// Remove deprecated port field from config. (https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/10853)
 	extensionsConfig, ok := otelCfg["extensions"].(map[any]any)
 	if !ok {
 		// In case there is no extensions config.