chore(lint): add GolangCI-Lint integration and Makefile targets

.golangci.yaml

@@ -0,0 +1,24 @@
+version: "2"
+
+issues:
+  max-same-issues: 50
+
+formatters:
+  enable:
+    - goimports # checks if the code and import statements are formatted according to the 'goimports' command
+    - gofumpt # Or "gofmt", # Enforce standard formatting
+
+linters:
+  enable:
+    - errcheck #Errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases.
+    - govet # Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [auto-fix]
+    - ineffassign # Detects when assignments to existing variables are not used. [fast]
+    - staticcheck # It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [auto-fix]
+    - unused # Checks Go code for unused constants, variables, functions and types.
+    # Subective additional linters
+    - gocyclo # or "cyclop", # Detect cyclomatic complexity
+    - goconst # Detect repeated values that can be made constants
+    - misspell # Fix spelling errors
+    - unconvert # Detect unnecessary type conversions
+    - unparam # Detect unused function parameters
+    - dupword # Detect duplicate words in comments and string literals (e.g. “the the”, “is is”)

Makefile

@@ -70,7 +70,7 @@ endef
 
 all: info
 
-.PHONY: build local_build logs major minor patch push run stop test version
+.PHONY: build local_build logs major minor patch push run stop test version lint lint-fix format
 info: 
 	@echo -e "\n${GREEN} ${PROJECT_NAME} / Makefile ${RESET}\n"
 
@@ -115,6 +115,25 @@ push:
 	@git tag -fa 'v${APP_VERSION}' -m 'v${APP_VERSION}'
 	@git push --follow-tags --set-upstream origin master
 
+format:
+	@echo "\n>>> Formating code with golangci-lint…"
+	@golangci-lint fmt \
+		--config .golangci.yaml \
+		./...
+
+lint:
+	@echo "\n>>> Running golangci-lint…"
+	@golangci-lint run \
+		--config .golangci.yaml \
+		--timeout 2m \
+		./...
+
+lint-fix:
+	@echo "\n>>> Auto-fixing with golangci-lint…"
+	@golangci-lint run --fix \
+		--config .golangci.yaml \
+		--timeout 2m \
+		./...
 
 MAJOR := $(shell echo ${APP_VERSION} | cut -d. -f1)
 MINOR := $(shell echo ${APP_VERSION} | cut -d. -f2)

cmd/dish/cli_test.go

@@ -10,16 +10,23 @@ import (
 
 func TestPrintHelp(t *testing.T) {
 	oldStdout := os.Stdout
-	r, w, _ := os.Pipe()
+	r, w, err := os.Pipe()
+	if err != nil {
+		t.Errorf("failed to process pipe: %v", err)
+	}
+
 	os.Stdout = w
 
 	printHelp()
 
-	w.Close()
+	if err := w.Close(); err != nil {
+		t.Errorf("pipe close: %v", err)
+	}
+
 	os.Stdout = oldStdout
 
 	var buf bytes.Buffer
-	_, err := io.Copy(&buf, r)
+	_, err = io.Copy(&buf, r)
 	if err != nil {
 		t.Fatalf("failed to read from pipe: %v", err)
 	}

cmd/dish/main.go

@@ -23,7 +23,7 @@ func run(fs *flag.FlagSet, args []string, _, stderr io.Writer) int {
 			return 1
 		}
 		// Otherwise, print the error
-		fmt.Fprintln(stderr, "error loading config:", err)
+		fmt.Fprintln(stderr, "error loading config:", err) //nolint:errcheck
 		return 2
 	}
 

cmd/dish/runner_test.go

@@ -28,7 +28,6 @@ func compareResults(expected, actual []socket.Result) bool {
 }
 
 func TestFanInChannels(t *testing.T) {
-
 	testChannels := []chan socket.Result{}
 
 	for range 3 {

pkg/alert/alerter_test.go

@@ -7,9 +7,7 @@ import (
 )
 
 func TestNewAlerter(t *testing.T) {
-	var (
-		mockLogger = MockLogger{}
-	)
+	mockLogger := MockLogger{}
 
 	if alerterNil := NewAlerter(nil); alerterNil != nil {
 		t.Error("expected nil, got alerter")

pkg/alert/api_test.go

@@ -10,15 +10,14 @@ import (
 func TestNewAPISender(t *testing.T) {
 	mockHTTPClient := &SuccessStatusHTTPClient{}
 
-	url := "https://abc123.xyz.com"
 	headerName := "X-Api-Key"
 	headerValue := "abc123"
 	notifySuccess := false
 	verbose := false
 
 	expected := &apiSender{
 		httpClient:    mockHTTPClient,
-		url:           url,
+		url:           pushgatewayURL,
 		headerName:    headerName,
 		headerValue:   headerValue,
 		notifySuccess: notifySuccess,
@@ -27,7 +26,7 @@ func TestNewAPISender(t *testing.T) {
 	}
 
 	cfg := &config.Config{
-		ApiURL:               url,
+		ApiURL:               pushgatewayURL,
 		ApiHeaderName:        headerName,
 		ApiHeaderValue:       headerValue,
 		MachineNotifySuccess: notifySuccess,
@@ -42,7 +41,6 @@ func TestNewAPISender(t *testing.T) {
 }
 
 func TestSend_API(t *testing.T) {
-	url := "https://abc123.xyz.com"
 	headerName := "X-Api-Key"
 	headerValue := "abc123"
 
@@ -65,7 +63,7 @@ func TestSend_API(t *testing.T) {
 
 	newConfig := func(headerName, headerValue string, notifySuccess, verbose bool) *config.Config {
 		return &config.Config{
-			ApiURL:               url,
+			ApiURL:               pushgatewayURL,
 			MachineNotifySuccess: notifySuccess,
 			Verbose:              verbose,
 			ApiHeaderName:        headerName,

pkg/alert/discord.go

@@ -46,7 +46,6 @@ func NewDiscordSender(httpClient HTTPClient, config *config.Config, logger logge
 		notifySuccess: config.TextNotifySuccess,
 		url:           parsedURL.String(),
 	}, nil
-
 }
 
 func (s *discordSender) send(message string, failedCount int) error {
@@ -69,7 +68,6 @@ func (s *discordSender) send(message string, failedCount int) error {
 	resp, err := handleSubmit(s.httpClient, http.MethodPost, s.url, bytes.NewBuffer(body), func(o *submitOptions) {
 		o.headers["Authorization"] = "Bot " + strings.TrimSpace(s.botToken)
 	})
-
 	if err != nil {
 		return fmt.Errorf("error submitting discord alert: %w", err)
 	}

pkg/alert/formatter.go

@@ -7,7 +7,6 @@ import (
 )
 
 func FormatMessengerText(result socket.Result) string {
-
 	status := "failed"
 	if result.Passed {
 		status = "success"

pkg/alert/pushgateway_test.go

@@ -7,18 +7,19 @@ import (
 	"go.vxn.dev/dish/pkg/config"
 )
 
+const pushgatewayURL = "https://abc123.xyz.com"
+
 func TestNewPushgatewaySender(t *testing.T) {
 	mockHTTPClient := &SuccessStatusHTTPClient{}
 	mockLogger := &MockLogger{}
 
-	url := "https://abc123.xyz.com"
 	instanceName := "test-instance"
 	verbose := false
 	notifySuccess := false
 
 	expected := &pushgatewaySender{
 		httpClient:    mockHTTPClient,
-		url:           url,
+		url:           pushgatewayURL,
 		instanceName:  "test-instance",
 		notifySuccess: notifySuccess,
 		verbose:       verbose,
@@ -27,7 +28,7 @@ func TestNewPushgatewaySender(t *testing.T) {
 	}
 
 	cfg := &config.Config{
-		PushgatewayURL:       url,
+		PushgatewayURL:       pushgatewayURL,
 		InstanceName:         instanceName,
 		Verbose:              verbose,
 		MachineNotifySuccess: notifySuccess,
@@ -60,7 +61,6 @@ func TestNewPushgatewaySender(t *testing.T) {
 }
 
 func TestSend_Pushgateway(t *testing.T) {
-	url := "https://abc123.xyz.com"
 	instanceName := "test-instance"
 
 	successResults := Results{
@@ -213,7 +213,7 @@ func TestSend_Pushgateway(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			cfg := newConfig(url, tt.instanceName, tt.notifySuccess, tt.verbose)
+			cfg := newConfig(pushgatewayURL, tt.instanceName, tt.notifySuccess, tt.verbose)
 			sender, err := NewPushgatewaySender(tt.client, cfg, &MockLogger{})
 			if err != nil {
 				t.Fatalf("failed to create Pushgateway sender instance: %v", err)
@@ -229,7 +229,7 @@ func TestSend_Pushgateway(t *testing.T) {
 
 func TestCreateMessage(t *testing.T) {
 	cfg := &config.Config{
-		PushgatewayURL:       "https://abc123.xyz.com",
+		PushgatewayURL:       pushgatewayURL,
 		InstanceName:         "test-instance",
 		MachineNotifySuccess: false,
 		Verbose:              false,

pkg/alert/telegram_test.go

@@ -11,8 +11,8 @@ func TestNewTelegramSender(t *testing.T) {
 	mockHTTPClient := &SuccessStatusHTTPClient{}
 	mockLogger := &MockLogger{}
 
-	chatID := "-123"
 	token := "abc123"
+	chatID := "-123"
 	verbose := false
 	notifySuccess := false
 

pkg/alert/transport.go

@@ -74,7 +74,11 @@ func handleSubmit(client HTTPClient, method string, url string, body io.Reader,
 
 // handleRead reads an HTTP response, ensures the status code is within the expected <200, 299> range and if not, logs the response body.
 func handleRead(res *http.Response, logger logger.Logger) error {
-	defer res.Body.Close()
+	defer func() {
+		if err := res.Body.Close(); err != nil {
+			logger.Errorf("failed to close response body: %v", err)
+		}
+	}()
 
 	if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusMultipleChoices {
 		body, err := io.ReadAll(res.Body)

pkg/config/config.go

@@ -96,7 +96,7 @@ func defineFlags(fs *flag.FlagSet, cfg *Config) {
 // If a flag is used for a supported config parameter, the config parameter's value is set according to the provided flag. Otherwise, a default value is used for the given parameter.
 func NewConfig(fs *flag.FlagSet, args []string) (*Config, error) {
 	if fs == nil {
-		//fs = flag.CommandLine
+		// fs = flag.CommandLine
 		return nil, fmt.Errorf("flagset argument cannot be nil")
 	}
 

pkg/logger/console_logger.go

@@ -27,7 +27,7 @@ func NewConsoleLogger(verbose bool, out io.Writer) *consoleLogger {
 
 	l := &consoleLogger{
 		stdLogger:  log.New(out, "", log.LstdFlags),
-		withColors: !(os.Getenv("NO_COLOR") == "true") && verbose,
+		withColors: os.Getenv("NO_COLOR") != "true" && verbose,
 	}
 
 	l.logLevel = INFO

pkg/logger/console_logger_test.go

@@ -35,7 +35,10 @@ func TestNewConsoleLogger(t *testing.T) {
 		}
 		logger.Info("hello stderr")
 
-		w.Close()
+		if err := w.Close(); err != nil {
+			t.Errorf("failed to close capture pipe writer: %v", err)
+		}
+
 		var buf bytes.Buffer
 		_, err := buf.ReadFrom(r)
 		if err != nil {
@@ -65,7 +68,6 @@ func TestNewConsoleLogger(t *testing.T) {
 		if actual != expected {
 			t.Fatalf("expected %s, got %s", expected, actual)
 		}
-
 	})
 
 	t.Run("with colors when verbose and no env set", func(t *testing.T) {

pkg/netrunner/runner.go

@@ -92,7 +92,15 @@ func (runner *tcpRunner) RunTest(ctx context.Context, sock socket.Socket) socket
 	if err != nil {
 		return socket.Result{Socket: sock, Error: err, Passed: false}
 	}
-	defer conn.Close()
+
+	defer func() {
+		if err := conn.Close(); err != nil {
+			runner.logger.Errorf(
+				"failed to close TCP connection to %s: %v",
+				endpoint, err,
+			)
+		}
+	}()
 
 	return socket.Result{Socket: sock, Passed: true}
 }
@@ -120,7 +128,12 @@ func (runner *httpRunner) RunTest(ctx context.Context, sock socket.Socket) socke
 	if err != nil {
 		return socket.Result{Socket: sock, Passed: false, Error: err}
 	}
-	defer resp.Body.Close()
+
+	defer func() {
+		if cerr := resp.Body.Close(); cerr != nil {
+			runner.logger.Errorf("failed to close body for %v", cerr)
+		}
+	}()
 
 	if !slices.Contains(sock.ExpectedHTTPCodes, resp.StatusCode) {
 		err = fmt.Errorf("expected codes: %v, got %d", sock.ExpectedHTTPCodes, resp.StatusCode)

pkg/netrunner/runner_posix.go

@@ -24,9 +24,11 @@ const (
 	echoRequest ICMPType = 8
 )
 
-const ipStripHdr = 23
-const testID = 0x1234
-const testSeq = 0x0001
+const (
+	ipStripHdr = 23
+	testID     = 0x1234
+	testSeq    = 0x0001
+)
 
 type icmpRunner struct {
 	logger logger.Logger
@@ -64,7 +66,15 @@ func (runner *icmpRunner) RunTest(ctx context.Context, sock socket.Socket) socke
 	if err != nil {
 		return socket.Result{Socket: sock, Error: fmt.Errorf("failed to create a non-privileged icmp socket: %w", err)}
 	}
-	defer syscall.Close(sysSocket)
+
+	defer func() {
+		if cerr := syscall.Close(sysSocket); cerr != nil {
+			runner.logger.Errorf(
+				"error closing ICMP socket (fd %d) for %s:%d: %v",
+				sysSocket, sock.Host, sock.Port, cerr,
+			)
+		}
+	}()
 
 	if runtime.GOOS == "darwin" {
 		if err := syscall.SetsockoptInt(sysSocket, syscall.IPPROTO_IP, ipStripHdr, 1); err != nil {