enable and fix lint settings in golangci.yaml (#49)

Author: Maanas-23

go.work

@@ -1,7 +1,7 @@
 go 1.22.3
 
 use (
-	./operator/
-	./pkg/
-	./resolver/
+	./operator
+	./pkg
+	./resolver
 )

golangci.yaml

@@ -13,23 +13,23 @@ linters:
     - dogsled
     - dupl
     - durationcheck
-    # - errcheck
+    - errcheck
     - errchkjson
     - errname
-    # - errorlint
+    - errorlint
     - exhaustive
     # - forcetypeassert
     - gocognit
-    # - goconst
-    # - gocritic
+    - goconst
+    - gocritic
     - gocyclo
     - gofmt
     - goheader
     - goimports
     # - gomoddirectives
     - gomodguard
     - goprintffuncname
-    # - gosec
+    - gosec
     - gosimple
     - govet
     - grouper
@@ -46,17 +46,17 @@ linters:
     - nolintlint
     # - nonamedreturns
     - nosprintfhostport
-    # - predeclared
+    - predeclared
     # - promlinter
-    # - revive
+    - revive
     - staticcheck
-    # - stylecheck
+    - stylecheck
     - tenv
     - thelper
     - tparallel
     - typecheck
     - unconvert
-    # - unparam
+    - unparam
     - unused
     - whitespace
-    # - wrapcheck
+    - wrapcheck

operator/cmd/main.go

@@ -19,14 +19,15 @@ package main
 import (
 	"crypto/tls"
 	"flag"
+	"fmt"
 	"os"
 	"time"
 
 	"github.com/getsentry/sentry-go"
 
-	"truefoundry/elasti/operator/internal/elastiServer"
+	"truefoundry/elasti/operator/internal/elastiserver"
 
-	"truefoundry/elasti/operator/internal/crdDirectory"
+	"truefoundry/elasti/operator/internal/crddirectory"
 	"truefoundry/elasti/operator/internal/informer"
 
 	tfLogger "github.com/truefoundry/elasti/pkg/logger"
@@ -66,6 +67,13 @@ const (
 )
 
 func main() {
+	err := mainWithError()
+	if err != nil {
+		os.Exit(1)
+	}
+}
+
+func mainWithError() error {
 	zapLogger, err := tfLogger.NewLogger("dev")
 	if err != nil {
 		setupLog.Error(err, "unable to create logger")
@@ -154,43 +162,49 @@ func main() {
 	})
 	if err != nil {
 		setupLog.Error(err, "unable to start manager")
-		os.Exit(1)
+		sentry.CaptureException(err)
+		return fmt.Errorf("main: %w", err)
 	}
 
 	// Start the shared CRD Directory
-	crdDirectory.INITDirectory(zapLogger)
+	crddirectory.INITDirectory(zapLogger)
 	// Initiate and start the shared Informer manager
 	Informer := informer.NewInformerManager(zapLogger, mgr.GetConfig())
 	Informer.Start()
 
 	// Set up the ElastiService controller
 	if err = (&controller.ElastiServiceReconciler{
-		Client:   mgr.GetClient(),
-		Scheme:   mgr.GetScheme(),
-		Logger:   zapLogger,
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(), Logger: zapLogger,
 		Informer: Informer,
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "ElastiService")
-		os.Exit(1)
+		sentry.CaptureException(err)
+		return fmt.Errorf("main: %w", err)
 	}
 
 	// Start the elasti server
-	eServer := elastiServer.NewServer(zapLogger, mgr.GetConfig(), 30*time.Second)
+	eServer := elastiserver.NewServer(zapLogger, mgr.GetConfig(), 30*time.Second)
 	go eServer.Start(elastiServerPort)
 
 	//+kubebuilder:scaffold:builder
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
 		setupLog.Error(err, "unable to set up health check")
-		os.Exit(1)
+		sentry.CaptureException(err)
+		return fmt.Errorf("main: %w", err)
 	}
 	if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
 		setupLog.Error(err, "unable to set up ready check")
-		os.Exit(1)
+		sentry.CaptureException(err)
+		return fmt.Errorf("main: %w", err)
 	}
 
 	setupLog.Info("starting manager")
 	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
 		setupLog.Error(err, "problem running manager")
-		os.Exit(1)
+		sentry.CaptureException(err)
+		return fmt.Errorf("main: %w", err)
 	}
+
+	return nil
 }

operator/internal/controller/elastiservice_controller.go

@@ -2,12 +2,13 @@ package controller
 
 import (
 	"context"
+	"fmt"
 	"sync"
 	"time"
 
 	"github.com/getsentry/sentry-go"
 
-	"truefoundry/elasti/operator/internal/crdDirectory"
+	"truefoundry/elasti/operator/internal/crddirectory"
 	"truefoundry/elasti/operator/internal/informer"
 	"truefoundry/elasti/operator/internal/prom"
 
@@ -114,7 +115,7 @@ func (r *ElastiServiceReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 
 	// We add the CRD details to service directory, so when elasti server received a request,
 	// we can find the right resource to scale up
-	crdDirectory.CRDDirectory.AddCRD(es.Spec.Service, &crdDirectory.CRDDetails{
+	crddirectory.CRDDirectory.AddCRD(es.Spec.Service, &crddirectory.CRDDetails{
 		CRDName: es.Name,
 		Spec:    es.Spec,
 	})
@@ -123,9 +124,10 @@ func (r *ElastiServiceReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 }
 
 func (r *ElastiServiceReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewControllerManagedBy(mgr).
+	err := ctrl.NewControllerManagedBy(mgr).
 		For(&v1alpha1.ElastiService{}).
 		Complete(r)
+	return fmt.Errorf("SetupWithManager: %w", err)
 }
 
 func (r *ElastiServiceReconciler) getMutexForReconcile(key string) *sync.Mutex {

operator/internal/controller/opsCRD.go

@@ -7,7 +7,7 @@ import (
 	"sync"
 
 	"truefoundry/elasti/operator/api/v1alpha1"
-	"truefoundry/elasti/operator/internal/crdDirectory"
+	"truefoundry/elasti/operator/internal/crddirectory"
 	"truefoundry/elasti/operator/internal/informer"
 	"truefoundry/elasti/operator/internal/prom"
 
@@ -109,7 +109,7 @@ func (r *ElastiServiceReconciler) finalizeCRD(ctx context.Context, es *v1alpha1.
 	}()
 	wg.Wait()
 	// Remove CRD details from service directory
-	crdDirectory.CRDDirectory.RemoveCRD(es.Spec.Service)
+	crddirectory.CRDDirectory.RemoveCRD(es.Spec.Service)
 	r.Logger.Info("[Done] CRD removed from service directory", zap.String("es", req.String()))
 
 	if err1 != nil || err2 != nil {
@@ -128,7 +128,7 @@ func (r *ElastiServiceReconciler) watchScaleTargetRef(ctx context.Context, es *v
 		return fmt.Errorf("scaleTargetRef is incomplete: %w", k8shelper.ErrNoScaleTargetFound)
 	}
 
-	crd, found := crdDirectory.CRDDirectory.GetCRD(es.Spec.Service)
+	crd, found := crddirectory.CRDDirectory.GetCRD(es.Spec.Service)
 	if found {
 		if es.Spec.ScaleTargetRef.Name != crd.Spec.ScaleTargetRef.Name ||
 			es.Spec.ScaleTargetRef.Kind != crd.Spec.ScaleTargetRef.Kind ||
@@ -201,7 +201,7 @@ func (r *ElastiServiceReconciler) watchPublicService(ctx context.Context, es *v1
 	return nil
 }
 
-func (r *ElastiServiceReconciler) finalizeCRDIfDeleted(ctx context.Context, es *v1alpha1.ElastiService, req ctrl.Request) (delete bool, err error) {
+func (r *ElastiServiceReconciler) finalizeCRDIfDeleted(ctx context.Context, es *v1alpha1.ElastiService, req ctrl.Request) (isDeleted bool, err error) {
 	// If the ElastiService is being deleted, we need to clean up the resources
 	if !es.ObjectMeta.DeletionTimestamp.IsZero() {
 		defer func() {

operator/internal/controller/opsEndpointslices.go

@@ -21,7 +21,7 @@ func (r *ElastiServiceReconciler) getIPsForResolver(ctx context.Context) ([]stri
 		"kubernetes.io/service-name": resolverServiceName,
 	}); err != nil {
 		r.Logger.Error("Failed to get Resolver endpoint slices", zap.Error(err))
-		return nil, err
+		return nil, fmt.Errorf("getIPsForResolver: %w", err)
 	}
 	var resolverPodIPs []string
 	for _, endpointSlice := range resolverSlices.Items {
@@ -70,7 +70,7 @@ func (r *ElastiServiceReconciler) createOrUpdateEndpointsliceToResolver(ctx cont
 	sliceToResolver := &networkingv1.EndpointSlice{}
 	if err := r.Get(ctx, EndpointsliceNamespacedName, sliceToResolver); err != nil && !errors.IsNotFound(err) {
 		r.Logger.Debug("Error getting a endpoint slice to Resolver", zap.String("endpointslice", EndpointsliceNamespacedName.String()), zap.Error(err))
-		return err
+		return fmt.Errorf("createOrUpdateEndpointsliceToResolver: %w", err)
 	} else if errors.IsNotFound(err) {
 		// TODO: This can be handled better
 		// This is a similar case as seen in resolver informer
@@ -101,7 +101,7 @@ func (r *ElastiServiceReconciler) createOrUpdateEndpointsliceToResolver(ctx cont
 		},
 	}
 
-	//sliceToResolver.DeepCopy()
+	// sliceToResolver.DeepCopy()
 
 	for _, ip := range resolverPodIPs {
 		newEndpointSlice.Endpoints = append(newEndpointSlice.Endpoints, networkingv1.Endpoint{
@@ -112,14 +112,14 @@ func (r *ElastiServiceReconciler) createOrUpdateEndpointsliceToResolver(ctx cont
 	if isResolverSliceFound {
 		if err := r.Update(ctx, newEndpointSlice); err != nil {
 			r.Logger.Error("failed to update sliceToResolver", zap.String("endpointslice", EndpointsliceNamespacedName.String()), zap.Error(err))
-			return err
+			return fmt.Errorf("createOrUpdateEndpointsliceToResolver: %w", err)
 		}
 		r.Logger.Info("EndpointSlice updated successfully", zap.String("endpointslice", EndpointsliceNamespacedName.String()))
 	} else {
 		// TODOS: Make sure the private service is owned by the ElastiService
 		if err := r.Create(ctx, newEndpointSlice); err != nil {
 			r.Logger.Error("failed to create sliceToResolver", zap.String("endpointslice", EndpointsliceNamespacedName.String()), zap.Error(err))
-			return err
+			return fmt.Errorf("createOrUpdateEndpointsliceToResolver: %w", err)
 		}
 		r.Logger.Info("EndpointSlice created successfully", zap.String("endpointslice", EndpointsliceNamespacedName.String()))
 	}

operator/internal/controller/opsInformer.go

@@ -58,9 +58,9 @@ func (r *ElastiServiceReconciler) getResolverChangeHandler(ctx context.Context,
 			}
 			prom.InformerHandlerCounter.WithLabelValues(req.String(), key, errStr).Inc()
 		},
-		UpdateFunc: func(old, new interface{}) {
+		UpdateFunc: func(_, newObj interface{}) {
 			errStr := values.Success
-			err := r.handleResolverChanges(ctx, new, es.Spec.Service, req.Namespace)
+			err := r.handleResolverChanges(ctx, newObj, es.Spec.Service, req.Namespace)
 			if err != nil {
 				errStr = err.Error()
 				r.Logger.Error("Failed to handle resolver changes", zap.Error(err))
@@ -69,7 +69,7 @@ func (r *ElastiServiceReconciler) getResolverChangeHandler(ctx context.Context,
 			}
 			prom.InformerHandlerCounter.WithLabelValues(req.String(), key, errStr).Inc()
 		},
-		DeleteFunc: func(obj interface{}) {
+		DeleteFunc: func(_ interface{}) {
 			// TODO: Handle deletion of resolver deployment
 			// We can do two things here
 			// 1. We can move to the serve mode
@@ -103,9 +103,9 @@ func (r *ElastiServiceReconciler) getPublicServiceChangeHandler(ctx context.Cont
 			}
 			prom.InformerHandlerCounter.WithLabelValues(req.String(), key, errStr).Inc()
 		},
-		UpdateFunc: func(old, new interface{}) {
+		UpdateFunc: func(_, newObj interface{}) {
 			errStr := values.Success
-			err := r.handlePublicServiceChanges(ctx, new, es.Spec.Service, req.Namespace)
+			err := r.handlePublicServiceChanges(ctx, newObj, es.Spec.Service, req.Namespace)
 			if err != nil {
 				errStr = err.Error()
 				r.Logger.Error("Failed to handle public service changes", zap.Error(err))
@@ -114,7 +114,7 @@ func (r *ElastiServiceReconciler) getPublicServiceChangeHandler(ctx context.Cont
 			}
 			prom.InformerHandlerCounter.WithLabelValues(req.String(), key, errStr).Inc()
 		},
-		DeleteFunc: func(obj interface{}) {
+		DeleteFunc: func(_ interface{}) {
 			r.Logger.Debug("public deployment deleted",
 				zap.String("es", req.String()),
 				zap.String("service", es.Spec.Service))
@@ -130,9 +130,9 @@ func (r *ElastiServiceReconciler) getScaleTargetRefChangeHandler(ctx context.Con
 		Resource:     es.Spec.ScaleTargetRef.Name,
 	})
 	return cache.ResourceEventHandlerFuncs{
-		UpdateFunc: func(old, new interface{}) {
+		UpdateFunc: func(_, newObj interface{}) {
 			errStr := values.Success
-			err := r.handleScaleTargetRefChanges(ctx, new, es, req)
+			err := r.handleScaleTargetRefChanges(ctx, newObj, es, req)
 			if err != nil {
 				errStr = err.Error()
 				r.Logger.Error("Failed to handle ScaleTargetRef changes", zap.Error(err))

operator/internal/controller/opsServices.go

@@ -17,7 +17,7 @@ import (
 
 func (r *ElastiServiceReconciler) deletePrivateService(ctx context.Context, publichServiceNamespacedName types.NamespacedName) (err error) {
 	privateServiceNamespacedName := publichServiceNamespacedName
-	privateServiceNamespacedName.Name = utils.GetPrivateSerivceName(publichServiceNamespacedName.Name)
+	privateServiceNamespacedName.Name = utils.GetPrivateServiceName(publichServiceNamespacedName.Name)
 	privateSVC := &v1.Service{}
 	if err := r.Get(ctx, privateServiceNamespacedName, privateSVC); err != nil && !errors.IsNotFound(err) {
 		return fmt.Errorf("failed to get private service: %w", err)
@@ -31,9 +31,9 @@ func (r *ElastiServiceReconciler) deletePrivateService(ctx context.Context, publ
 	return nil
 }
 
-func (r *ElastiServiceReconciler) checkAndCreatePrivateService(ctx context.Context, publicSVC *v1.Service, es *v1alpha1.ElastiService) (PVTName string, err error) {
-	PVTName = utils.GetPrivateSerivceName(publicSVC.Name)
-	privateServiceNamespacedName := types.NamespacedName{Name: PVTName, Namespace: publicSVC.Namespace}
+func (r *ElastiServiceReconciler) checkAndCreatePrivateService(ctx context.Context, publicSVC *v1.Service, es *v1alpha1.ElastiService) (privateServiceName string, err error) {
+	privateServiceName = utils.GetPrivateServiceName(publicSVC.Name)
+	privateServiceNamespacedName := types.NamespacedName{Name: privateServiceName, Namespace: publicSVC.Namespace}
 	// See if private service already exist
 	privateSVC := &v1.Service{}
 	if err := r.Get(ctx, privateServiceNamespacedName, privateSVC); err != nil && !errors.IsNotFound(err) {
@@ -42,11 +42,11 @@ func (r *ElastiServiceReconciler) checkAndCreatePrivateService(ctx context.Conte
 		r.Logger.Info("Private service not found, creating one", zap.String("private-service", privateServiceNamespacedName.String()))
 	} else {
 		r.Logger.Info("Private service already exists", zap.String("private-service", privateServiceNamespacedName.String()))
-		return PVTName, nil
+		return privateServiceName, nil
 	}
 
 	privateSVC = publicSVC.DeepCopy()
-	privateSVC.SetName(PVTName)
+	privateSVC.SetName(privateServiceName)
 	// We must remove the cluster IP and node port, as it already exists for the public service
 	privateSVC.Spec.ClusterIP = ""
 	privateSVC.Spec.ClusterIPs = nil
@@ -58,14 +58,14 @@ func (r *ElastiServiceReconciler) checkAndCreatePrivateService(ctx context.Conte
 
 	// Make sure the private service is owned by the ElastiService
 	if err := controllerutil.SetControllerReference(es, privateSVC, r.Scheme); err != nil {
-		return PVTName, err
+		return privateServiceName, fmt.Errorf("checkAndCreatePrivateService: %w", err)
 	}
 	err = r.Create(ctx, privateSVC)
 	if err != nil {
 		r.Logger.Error("Failed to create private service", zap.String("private-service", privateServiceNamespacedName.String()), zap.Error(err))
-		return PVTName, err
+		return privateServiceName, fmt.Errorf("checkAndCreatePrivateService: %w", err)
 	}
-	return PVTName, nil
+	return privateServiceName, nil
 }
 
 // handlePublicServiceChanges handles the changes in the public service, and sync those changes in the private service
@@ -81,7 +81,7 @@ func (r *ElastiServiceReconciler) handlePublicServiceChanges(ctx context.Context
 		return fmt.Errorf("public service is not same as mentioned in CRD; informer misconfigured")
 	}
 	// Get Private Service
-	PVTName := utils.GetPrivateSerivceName(publicSVC.Name)
+	PVTName := utils.GetPrivateServiceName(publicSVC.Name)
 	privateServiceNamespacedName := types.NamespacedName{Name: PVTName, Namespace: publicSVC.Namespace}
 	privateSVC := &v1.Service{}
 	if err := r.Get(ctx, privateServiceNamespacedName, privateSVC); err != nil && !errors.IsNotFound(err) {

operator/internal/crdDirectory/directory.go operator/internal/crddirectory/directory.go

@@ -1,4 +1,4 @@
-package crdDirectory
+package crddirectory
 
 import (
 	"sync"