Merge pull request #15 from NETWAYS/chore/update-deps

Update Dependencies and move to slog

Author: RincewindsHat

.github/dependabot.yml

@@ -6,3 +6,8 @@ updates:
     interval: weekly
     time: '10:00'
   open-pull-requests-limit: 10
+
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: monthly

.github/workflows/go.yml

@@ -17,9 +17,9 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
-          go-version: 1.18
+          go-version: 1.21
 
       - name: Test
         run: go test -v ./...
@@ -29,7 +29,7 @@ jobs:
 
       - name: Run goreleaser in release mode
         if: success() && startsWith(github.ref, 'refs/tags/v')
-        uses: goreleaser/goreleaser-action@v3
+        uses: goreleaser/goreleaser-action@v4
         with:
           version: latest
           args: release --rm-dist

.github/workflows/golangci-lint.yml

@@ -11,13 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v4
         with:
-          go-version: 1.18
+          go-version: 1.21
 
       - uses: actions/checkout@v3
-
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
-        with:
-          version: v1.51

.golangci.yml

@@ -1,13 +1,36 @@
 run:
   timeout: 5m
-  skip-files:
-    - '(.+)_test\.go'
-
+  tests: false
 linters:
-  disable-all: false
-  disable:
-    - musttag
-  presets:
-    - bugs
-    - unused
-  fast: false
+   enable-all: true
+   disable:
+     - cyclop
+     - depguard
+     - exhaustivestruct
+     - exhaustruct
+     - forbidigo
+     - forcetypeassert
+     - gci
+     - gochecknoglobals
+     - gochecknoinits
+     - godox
+     - goerr113
+     - gofumpt
+     - gomnd
+     - ifshort
+     - lll
+     - musttag
+     - nakedret
+     - nlreturn
+     - nolintlint
+     - nonamedreturns
+     - tagliatelle
+     - varnamelen
+     - wrapcheck
+linters-settings:
+   estif:
+     min-complexity: 4
+   maligned:
+     suggest-new: true
+   funlen:
+     lines: 80

api.go

@@ -7,16 +7,16 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"log/slog"
 	"net/http"
 	"net/url"
 	"time"
-
-	log "github.com/sirupsen/logrus"
 )
 
 type RestAPI struct {
 	URL    string
 	Client *http.Client
+	Logger *slog.Logger
 }
 
 func (a RestAPI) ExecuteCheck(command string, arguments map[string]interface{}, timeout uint32) (*APICheckResult, error) { //nolint:lll
@@ -31,14 +31,11 @@ func (a RestAPI) ExecuteCheck(command string, arguments map[string]interface{},
 	defer cancel()
 
 	// Build request
-	requestUrl := a.URL + "/v1/checker?command=" + url.QueryEscape(command)
+	requestURL := a.URL + "/v1/checker?command=" + url.QueryEscape(command)
 
-	log.WithFields(log.Fields{
-		"body": string(body),
-		"url":  requestUrl,
-	}).Debug("sending request")
+	a.Logger.Debug("sending request", "body", string(body), "url", requestURL)
 
-	req, err := http.NewRequestWithContext(ctx, "POST", requestUrl, bytes.NewReader(body))
+	req, err := http.NewRequestWithContext(ctx, http.MethodPost, requestURL, bytes.NewReader(body))
 	if err != nil {
 		return nil, fmt.Errorf("could not build request: %w", err)
 	}
@@ -53,6 +50,7 @@ func (a RestAPI) ExecuteCheck(command string, arguments map[string]interface{},
 		if errors.Is(err, context.DeadlineExceeded) {
 			return nil, fmt.Errorf("timeout during HTTP request: %w", err)
 		}
+
 		return nil, fmt.Errorf("executing API request failed: %w", err)
 	}
 
@@ -64,9 +62,9 @@ func (a RestAPI) ExecuteCheck(command string, arguments map[string]interface{},
 		return nil, fmt.Errorf("could not read result: %w", err)
 	}
 
-	log.WithField("body", string(resultBody)).Debug("received response")
+	a.Logger.Debug("received response", "body", string(resultBody))
 
-	if resp.StatusCode != 200 {
+	if resp.StatusCode != http.StatusOK {
 		return nil, fmt.Errorf("API request not successful code=%d: %s", resp.StatusCode, string(resultBody))
 	}
 

api_test.go

@@ -1,8 +1,10 @@
 package main
 
 import (
+	"log/slog"
 	"net/http"
 	"net/http/httptest"
+	"os"
 	"strings"
 	"testing"
 	"time"
@@ -23,7 +25,7 @@ func TestApiCmd(t *testing.T) {
 				w.WriteHeader(http.StatusOK)
 				w.Write([]byte(`{"Invoke-IcingaCheckFoo": {"exitcode": 0, "checkresult": "[OK] \"foo\"", "perfdata": ["'foo'=1.00%;;;0;100 "]}}`))
 			})),
-			api: RestAPI{},
+			api: RestAPI{Logger: slog.New(slog.NewTextHandler(os.Stdout, nil))},
 			expected: APICheckResult{
 				ExitCode:    0,
 				CheckResult: "[OK] \"foo\"",
@@ -58,7 +60,13 @@ func TestApiCmd(t *testing.T) {
 }
 
 func TestApiTimeout(t *testing.T) {
-	api := RestAPI{}
+	opts := &slog.HandlerOptions{
+		Level: slog.LevelDebug,
+	}
+
+	logger := slog.New(slog.NewTextHandler(os.Stdout, opts))
+
+	api := RestAPI{Logger: logger}
 
 	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// Wait for the context timeout to kick in

api_types.go

@@ -41,7 +41,7 @@ func (p *APIPerfdataList) UnmarshalJSON(data []byte) error {
 	var value []string
 
 	// catch empty object and return empty []string
-	if bytes.Compare(data, []byte("{}")) == 0 {
+	if bytes.Equal(data, []byte("{}")) {
 		value = []string{}
 	} else {
 		err := json.Unmarshal(data, &value)

api_types_test.go

@@ -2,8 +2,9 @@ package main
 
 import (
 	"encoding/json"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestAPIPerfdataList_UnmarshalJSON(t *testing.T) {

config.go

@@ -16,19 +16,19 @@ const (
 )
 
 type Config struct {
-	Timeout      uint32
 	API          string
 	Command      string
-	Arguments    map[string]interface{}
 	CertName     string
 	CAFile       string
+	Arguments    map[string]interface{}
+	Timeout      uint32
 	Insecure     bool
 	Debug        bool
 	PrintVersion bool
 }
 
 var (
-	// ErrVersionRequested returned when --version flag is set
+	// ErrVersionRequested returned when --version flag is set.
 	ErrVersionRequested = errors.New("version was requested by a flag")
 
 	// ErrNoCommand is returned when no PowerShell command could be parsed from flags.

config_test.go

@@ -1,10 +1,11 @@
 package main
 
 import (
-	flag "github.com/spf13/pflag"
-	"github.com/stretchr/testify/assert"
 	"os"
 	"testing"
+
+	flag "github.com/spf13/pflag"
+	"github.com/stretchr/testify/assert"
 )
 
 func quietTest() func() {