Merge pull request #25 from williamchanrico/add_golangci_lint

Add golangci-lint and its fixes

Author: williamchanrico

.github/workflows/test.yml

@@ -25,3 +25,20 @@ jobs:
 
       - name: Unit tests
         run: go test -race -v ./...
+
+  golangci-lint:
+    permissions:
+      checks: write
+      contents: read
+      pull-requests: write
+    name: golangci-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: reviewdog/action-golangci-lint@v2
+        with:
+          github_token: ${{ secrets.github_token }}
+          level: 'warning'
+          reporter: github-pr-review
+          go_version: '1.17'

.golangci.yaml

@@ -0,0 +1,91 @@
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  timeout: 30s
+
+  # exit code when at least one issue was found, default is 1
+  issues-exit-code: 1
+
+  # include test files or not, default is true
+  tests: true
+
+  # default is true. Enables skipping of directories:
+  #   vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+  skip-dirs-use-default: true
+
+linters:
+  enable-all: true
+  disable:
+    - gci
+    - wsl
+    - testpackage
+    - gochecknoinits
+    - gochecknoglobals
+    - gomnd
+    - funlen
+    - paralleltest
+    - gofumpt
+    - ireturn
+    - scopelint
+
+# all available settings of specific linters
+linters-settings:
+  enable-all: true
+
+  staticcheck:
+    # Select the Go version to target. The default is '1.13'.
+    go: "1.17"
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all" ]
+
+  stylecheck:
+    # Select the Go version to target. The default is '1.13'.
+    go: "1.17"
+    # https://staticcheck.io/docs/options#checks
+    checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ]
+    # https://staticcheck.io/docs/options#dot_import_whitelist
+    dot-import-whitelist:
+      - fmt
+    # https://staticcheck.io/docs/options#initialisms
+    initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS" ]
+    # https://staticcheck.io/docs/options#http_status_code_whitelist
+    http-status-code-whitelist: [ "200", "400", "404", "500" ]
+
+  tagliatelle:
+    # check the struck tag name case
+    case:
+      # use the struct field name to check the name of the struct tag
+      use-field-name: true
+      rules:
+        # any struct tag type can be used.
+        # support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`
+        json: snake
+        yaml: camel
+        xml: camel
+        bson: camel
+        avro: snake
+        mapstructure: kebab
+
+  lll:
+    # max line length, lines longer will be reported. Default is 120.
+    # '\t' is counted as 1 character by default, and can be changed with the tab-width option
+    line-length: 180
+    # tab width in spaces. Default to 1.
+    tab-width: 1
+
+issues:
+  # Excluding configuration per-path, per-linter, per-text and per-source
+  exclude-rules:
+    # Exclude some staticcheck messages
+    - linters:
+        - godox
+      text: "TODO:"
+
+  # Independently from option `exclude` we use default exclude patterns,
+  # it can be disabled by this option. To list all
+  # excluded by default patterns execute `golangci-lint run --help`.
+  # Default value for this option is true.
+  exclude-use-default: false

Makefile

@@ -68,6 +68,7 @@ go-build-linux: ## Build the app for linux platforms exclude: "arm64" CGO errors
 
 .PHONY: go-test
 go-test: ## Run go test
+	golangci-lint run
 	go test -v ./...
 
 # DOCKER TASKS

cmd/planet-exporter/internal/internal.go

@@ -16,15 +16,15 @@ package internal
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net/http"
+	"net/http/pprof"
 	"os"
 	"os/signal"
 	"syscall"
 	"time"
 
-	"net/http/pprof"
-
 	"planet-exporter/collector"
 	taskdarkstat "planet-exporter/collector/task/darkstat"
 	taskebpf "planet-exporter/collector/task/ebpf"
@@ -38,8 +38,8 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-// Config contains main service config options
-type Config struct {
+// Config contains main service config options.
+type Config struct { // nolint:maligned
 	// Main config
 	ListenAddress       string
 	LogLevel            string
@@ -63,23 +63,23 @@ type Config struct {
 	TaskSocketstatEnabled bool
 }
 
-// Service contains main service dependency
+// Service contains main service dependency.
 type Service struct {
 	Config Config
 
 	// Collector is prometheus collector that is registered
 	Collector *collector.PlanetCollector
 }
 
-// New service
+// New service.
 func New(config Config, collector *collector.PlanetCollector) Service {
 	return Service{
 		Config:    config,
 		Collector: collector,
 	}
 }
 
-// Run main service
+// Run main service.
 func (s Service) Run(ctx context.Context) error {
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
@@ -88,14 +88,14 @@ func (s Service) Run(ctx context.Context) error {
 	log.Infof("Set task ticker duration to %v", s.Config.TaskInterval)
 	interval, err := time.ParseDuration(s.Config.TaskInterval)
 	if err != nil {
-		return err
+		return fmt.Errorf("error parsing interval duration: %w", err)
 	}
 	go s.collect(ctx, interval)
 
-	r := prometheus.NewRegistry()
-	r.MustRegister(version.NewCollector("planet_exporter"))
-	if err := r.Register(s.Collector); err != nil {
-		return fmt.Errorf("Failed to register planet collector: %v", err)
+	promRegistry := prometheus.NewRegistry()
+	promRegistry.MustRegister(version.NewCollector("planet_exporter"))
+	if err := promRegistry.Register(s.Collector); err != nil {
+		return fmt.Errorf("failed to register planet collector: %w", err)
 	}
 
 	handler := http.NewServeMux()
@@ -113,8 +113,8 @@ func (s Service) Run(ctx context.Context) error {
 		}
 	})
 	handler.Handle("/metrics", promhttp.HandlerFor(
-		prometheus.Gatherers{r},
-		promhttp.HandlerOpts{
+		prometheus.Gatherers{promRegistry},
+		promhttp.HandlerOpts{ // nolint:exhaustivestruct
 			ErrorHandling: promhttp.ContinueOnError,
 		},
 	))
@@ -139,18 +139,20 @@ func (s Service) Run(ctx context.Context) error {
 	}()
 
 	log.Infof("Start HTTP server on %v", s.Config.ListenAddress)
-	if err := httpServer.Serve(s.Config.ListenAddress); err != http.ErrServerClosed {
-		return err
+	if err := httpServer.Serve(s.Config.ListenAddress); !errors.Is(err, http.ErrServerClosed) {
+		return fmt.Errorf("error on HTTP server: %w", err)
 	}
 
 	<-stopChan
 
 	return nil
 }
 
-// collect periodically runs all collector tasks that are expensive to compute on-the-fly
+// collect periodically runs all collector tasks that are expensive to compute on-the-fly.
 func (s Service) collect(ctx context.Context, interval time.Duration) {
-	inventoryTicker := time.NewTicker(interval * 25)
+	const inventoryTickerIntervalSeconds = 25
+
+	inventoryTicker := time.NewTicker(interval * inventoryTickerIntervalSeconds)
 	defaultTicker := time.NewTicker(interval)
 	defer inventoryTicker.Stop()
 	defer defaultTicker.Stop()

cmd/planet-exporter/main.go

@@ -26,14 +26,13 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-var (
-	version            string
-	showVersionAndExit bool
-)
+var version string
 
 func main() {
 	var config internal.Config
 
+	var showVersionAndExit bool
+
 	// Main
 	flag.StringVar(&config.ListenAddress, "listen-address", "0.0.0.0:19100", "Address to which exporter will bind its HTTP interface")
 	flag.StringVar(&config.LogLevel, "log-level", "info", "Log level")
@@ -59,11 +58,11 @@ func main() {
 	flag.Parse()
 
 	if showVersionAndExit {
-		fmt.Printf("planet-exporter %v\n", version)
+		fmt.Println("planet-exporter", version) // nolint:forbidigo
 		os.Exit(0)
 	}
 
-	log.SetFormatter(&log.TextFormatter{
+	log.SetFormatter(&log.TextFormatter{ // nolint:exhaustivestruct
 		DisableColors:    config.LogDisableColors,
 		DisableTimestamp: config.LogDisableTimestamp,
 		FullTimestamp:    true,
@@ -88,7 +87,8 @@ func main() {
 	log.Info("Initialize main service")
 	svc := internal.New(config, collector)
 	if err := svc.Run(ctx); err != nil {
-		log.Fatalf("Main service exit with error: %v", err)
+		log.Errorf("Main service exit with error: %v", err)
+		os.Exit(1)
 	}
 
 	log.Info("Main service exit successfully")