chore: docs & error formatting

Signed-off-by: Bruno Bressi <[email protected]>

cmd/run.go

@@ -82,8 +82,6 @@ func run() func(cmd *cobra.Command, args []string) error {
 		log.Info("Running sparrow")
 		if err = s.Run(ctx); err != nil {
 			err = fmt.Errorf("error while running sparrow: %w", err)
-			// by this time all shutdown routines should have been called
-			// so we can exit here
 			return err
 		}
 

internal/helper/retry_test.go

@@ -65,7 +65,7 @@ func TestRetry(t *testing.T) {
 					if effectorFuncCallCounter > 1 {
 						return nil
 					}
-					return fmt.Errorf("Ups sth wrong")
+					return fmt.Errorf("ups sth wrong")
 				},
 				rc: RetryConfig{
 					Count: 2,
@@ -81,7 +81,7 @@ func TestRetry(t *testing.T) {
 			args: args{
 				effector: func(ctx context.Context) error {
 					effectorFuncCallCounter++
-					return fmt.Errorf("Ups sth wrong")
+					return fmt.Errorf("ups sth wrong")
 				},
 				rc: RetryConfig{
 					Count: 2,
@@ -98,7 +98,7 @@ func TestRetry(t *testing.T) {
 				effector: func(ctx context.Context) error {
 					effectorFuncCallCounter++
 					cancel()
-					return errors.New("Ups")
+					return errors.New("ups")
 				},
 				rc: RetryConfig{
 					Count: 2,

pkg/api/routingtree.go

@@ -23,7 +23,7 @@ import (
 	"sync"
 )
 
-// creates a simple routing tree, so checks can easily create and remove handlers
+// RoutingTree creates a simple routing tree, so checks can easily create and remove handlers
 // Maps the method to the path and the handler
 type RoutingTree struct {
 	tree map[string]map[string]http.HandlerFunc

pkg/checks/health.go

@@ -21,6 +21,7 @@ package checks
 import (
 	"context"
 	"fmt"
+	"io"
 	"net/http"
 	"sync"
 	"time"
@@ -243,12 +244,17 @@ func getHealth(ctx context.Context, url string) error {
 		return err
 	}
 
-	res, err := client.Do(req)
+	res, err := client.Do(req) //nolint:bodyclose
 	if err != nil {
 		log.Error("Http get request failed", "error", err.Error())
 		return err
 	}
-	defer res.Body.Close()
+	defer func(Body io.ReadCloser) {
+		err := Body.Close()
+		if err != nil {
+			log.Error("Failed to close response body", "error", err.Error())
+		}
+	}(res.Body)
 
 	if res.StatusCode != http.StatusOK {
 		log.Error("Http get request failed", "status", res.Status)

pkg/checks/oapi.go

@@ -23,7 +23,7 @@ import (
 	"github.com/getkin/kin-openapi/openapi3gen"
 )
 
-// Takes in check perfdata and returns an openapi3.SchemaRef of a result wrapping the perfData
+// OpenapiFromPerfData takes in check perfdata and returns an openapi3.SchemaRef of a result wrapping the perfData
 // this is a workaround, since the openapi3gen.NewSchemaRefForValue function does not work with any types
 func OpenapiFromPerfData[T any](data T) (*openapi3.SchemaRef, error) {
 	checkSchema, err := openapi3gen.NewSchemaRefForValue(Result{}, openapi3.Schemas{})

pkg/config/http.go

@@ -79,19 +79,19 @@ func (hl *HttpLoader) Run(ctx context.Context) error {
 }
 
 // GetRuntimeConfig gets the remote runtime configuration
-func (gl *HttpLoader) GetRuntimeConfig(ctx context.Context) (*RuntimeConfig, error) {
-	log := logger.FromContext(ctx).With("url", gl.cfg.Loader.Http.Url)
+func (hl *HttpLoader) GetRuntimeConfig(ctx context.Context) (*RuntimeConfig, error) {
+	log := logger.FromContext(ctx).With("url", hl.cfg.Loader.Http.Url)
 
-	req, err := http.NewRequestWithContext(ctx, http.MethodGet, gl.cfg.Loader.Http.Url, http.NoBody)
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, hl.cfg.Loader.Http.Url, http.NoBody)
 	if err != nil {
 		log.Error("Could not create http GET request", "error", err.Error())
 		return nil, err
 	}
-	if gl.cfg.Loader.Http.Token != "" {
-		req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", gl.cfg.Loader.Http.Token))
+	if hl.cfg.Loader.Http.Token != "" {
+		req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", hl.cfg.Loader.Http.Token))
 	}
 
-	res, err := gl.client.Do(req) //nolint:bodyclose
+	res, err := hl.client.Do(req) //nolint:bodyclose
 	if err != nil {
 		log.Error("Http get request failed", "error", err.Error())
 		return nil, err

pkg/db/db.go

@@ -62,7 +62,7 @@ func (i *InMemory) Get(check string) (checks.Result, bool) {
 	return *result, true
 }
 
-// Returns a copy of the map
+// List returns a copy of the map
 func (i *InMemory) List() map[string]checks.Result {
 	results := make(map[string]checks.Result)
 	i.data.Range(func(key, value any) bool {

pkg/sparrow/api.go

@@ -42,10 +42,7 @@ const (
 	readHeaderTimeout = time.Second * 5
 )
 
-var (
-	ErrServeApi            = errors.New("failed to serve api")
-	ErrCreateOpenapiSchema = errors.New("failed to get schema for check")
-)
+var ErrCreateOpenapiSchema = errors.New("failed to get schema for check")
 
 func (s *Sparrow) register(ctx context.Context) {
 	s.router.Use(logger.Middleware(ctx))
@@ -101,7 +98,7 @@ func (s *Sparrow) api(ctx context.Context) error {
 	}
 }
 
-// Shutdown gracefully shuts down the api server
+// shutdownAPI gracefully shuts down the api server
 // Returns an error if an error is present in the context
 // or if the server cannot be shut down
 func (s *Sparrow) shutdownAPI(ctx context.Context) error {

pkg/sparrow/metrics.go

@@ -34,7 +34,7 @@ type PrometheusMetrics struct {
 	registry *prometheus.Registry
 }
 
-// InitMetrics initializes the metrics and returns the PrometheusMetrics
+// NewMetrics initializes the metrics and returns the PrometheusMetrics
 func NewMetrics() Metrics {
 	registry := prometheus.NewRegistry()
 

pkg/sparrow/run_test.go

@@ -206,7 +206,7 @@ func TestSparrow_Run(t *testing.T) {
 		},
 	}
 
-	c.Loader.File.Path = ("../config/testdata/config.yaml")
+	c.Loader.File.Path = "../config/testdata/config.yaml"
 
 	// start sparrow
 	s := New(c)

scripts/gen-docs/gen-docs.go

@@ -41,7 +41,7 @@ func execute() {
 	rootCmd.AddCommand(NewCmdGenDocs())
 
 	if err := rootCmd.Execute(); err != nil {
-		fmt.Fprintln(os.Stderr, err)
+		_, _ = fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
 }
@@ -68,7 +68,7 @@ func runGenDocs(path *string) func(cmd *cobra.Command, args []string) error {
 	c.DisableAutoGenTag = true
 	return func(cmd *cobra.Command, args []string) error {
 		if err := doc.GenMarkdownTree(c, *path); err != nil {
-			return fmt.Errorf("Failed to generate docs: %w", err)
+			return fmt.Errorf("failed to generate docs: %w", err)
 		}
 		return nil
 	}