dependabot-1 Major linting fixes, code cleanup

Author: bdebyl

.errcheck_excludes

@@ -1 +1,2 @@
-(github.com/go-kit/kit/log.Logger).Log
+(github.com/go-kit/log.Logger).Log
+b.logger.Log

.golangci.yml

@@ -6,11 +6,17 @@ run:
   tests: false
   modules-download-mode: vendor
   timeout: 5m
+  skip-dirs:
+    - test
 
 linters:
   enable-all: true
   disable:
+    - exhaustivestruct
+    - exhaustruct
     - goerr113
+    - ireturn
+    - maintidx
     - varnamelen
 
 linters-settings:
@@ -20,5 +26,4 @@ linters-settings:
     line-length: 120
   funlen:
     lines: 70
-    statements: 40
-
+    statements: 40

Makefile

@@ -132,7 +132,7 @@ test-e2e: $(GOTEST) ; $(info $(M) running test-e2e )
 lint: ## Runs golangci-lint analysis
 lint:
 	# Check .golangci.yml for configuration
-	$(Q) $(GOLANGCI_LINT) run -v --enable-all --skip-dirs tmp -c .golangci.yml
+	$(Q) $(GOLANGCI_LINT) run -v --skip-dirs tmp -c .golangci.yml
 
 .PHONY: fix
 fix: ## Runs golangci-lint fix

archive/archive.go

@@ -4,12 +4,11 @@ import (
 	"compress/flate"
 	"io"
 
+	"github.com/go-kit/log"
+	"github.com/go-kit/log/level"
 	"github.com/meltwater/drone-cache/archive/gzip"
 	"github.com/meltwater/drone-cache/archive/tar"
 	"github.com/meltwater/drone-cache/archive/zstd"
-
-	"github.com/go-kit/kit/log"
-	"github.com/go-kit/kit/log/level"
 )
 
 const (
@@ -51,6 +50,7 @@ func FromFormat(logger log.Logger, root string, format string, opts ...Option) A
 		return zstd.New(logger, root, options.skipSymlinks, options.compressionLevel)
 	default:
 		level.Error(logger).Log("msg", "unknown archive format", "format", format)
+
 		return tar.New(logger, root, options.skipSymlinks) // DefaultArchiveFormat
 	}
 }

archive/gzip/gzip.go

@@ -5,10 +5,9 @@ import (
 	"fmt"
 	"io"
 
+	"github.com/go-kit/log"
 	"github.com/meltwater/drone-cache/archive/tar"
 	"github.com/meltwater/drone-cache/internal"
-
-	"github.com/go-kit/kit/log"
 )
 
 // Archive implements archive for gzip.
@@ -34,17 +33,27 @@ func (a *Archive) Create(srcs []string, w io.Writer) (int64, error) {
 
 	defer internal.CloseWithErrLogf(a.logger, gw, "gzip writer")
 
-	return tar.New(a.logger, a.root, a.skipSymlinks).Create(srcs, gw)
+	wBytes, err := tar.New(a.logger, a.root, a.skipSymlinks).Create(srcs, gw)
+	if err != nil {
+		return 0, fmt.Errorf("writing create archive bytes: %w", err)
+	}
+
+	return wBytes, nil
 }
 
 // Extract reads content from the given archive reader and restores it to the destination, returns written bytes.
 func (a *Archive) Extract(dst string, r io.Reader) (int64, error) {
 	gr, err := gzip.NewReader(r)
 	if err != nil {
-		return 0, err
+		return 0, fmt.Errorf("create archive extractor: %w", err)
 	}
 
 	defer internal.CloseWithErrLogf(a.logger, gr, "gzip reader")
 
-	return tar.New(a.logger, a.root, a.skipSymlinks).Extract(dst, gr)
+	eBytes, err := tar.New(a.logger, a.root, a.skipSymlinks).Extract(dst, gr)
+	if err != nil {
+		return 0, fmt.Errorf("extracting archive bytes: %w", err)
+	}
+
+	return eBytes, nil
 }

archive/gzip/gzip_test.go

@@ -9,7 +9,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/go-kit/kit/log"
+	"github.com/go-kit/log"
 
 	"github.com/meltwater/drone-cache/archive/tar"
 	"github.com/meltwater/drone-cache/test"

archive/tar/tar.go

@@ -10,11 +10,10 @@ import (
 	"strings"
 
 	"github.com/go-kit/log"
-
 	"github.com/meltwater/drone-cache/internal"
 )
 
-const defaultDirPermission = 0755
+const defaultDirPermission = 0o755
 
 var (
 	// ErrSourceNotReachable means that given source is not reachable.
@@ -57,7 +56,7 @@ func (a *Archive) Create(srcs []string, w io.Writer) (int64, error) {
 	return written, nil
 }
 
-// nolint: lll
+// nolint: lll, cyclop
 func writeToArchive(tw *tar.Writer, root string, skipSymlinks bool, written *int64) func(string, os.FileInfo, error) error {
 	return func(path string, fi os.FileInfo, err error) error {
 		if err != nil {
@@ -146,7 +145,7 @@ func createSymlinkHeader(fi os.FileInfo, path string) (*tar.Header, error) {
 	return h, nil
 }
 
-func writeFileToArchive(tw io.Writer, path string) (n int64, err error) {
+func writeFileToArchive(tw io.Writer, path string) (int64, error) {
 	f, err := os.Open(path)
 	if err != nil {
 		return 0, fmt.Errorf("open file <%s>, %w", path, err)
@@ -163,6 +162,7 @@ func writeFileToArchive(tw io.Writer, path string) (n int64, err error) {
 }
 
 // Extract reads content from the given archive reader and restores it to the destination, returns written bytes.
+// nolint: cyclop
 func (a *Archive) Extract(dst string, r io.Reader) (int64, error) {
 	var (
 		written int64
@@ -173,7 +173,7 @@ func (a *Archive) Extract(dst string, r io.Reader) (int64, error) {
 		h, err := tr.Next()
 
 		switch {
-		case err == io.EOF: // if no more files are found return
+		case errors.Is(err, io.EOF): // if no more files are found return
 			return written, nil
 		case err != nil: // return any other error
 			return written, fmt.Errorf("tar reader <%v>, %w", err, ErrArchiveNotReadable)
@@ -241,7 +241,7 @@ func extractDir(h *tar.Header, target string) error {
 	return nil
 }
 
-func extractRegular(h *tar.Header, tr io.Reader, target string) (n int64, err error) {
+func extractRegular(h *tar.Header, tr io.Reader, target string) (int64, error) {
 	f, err := os.OpenFile(target, os.O_CREATE|os.O_RDWR, os.FileMode(h.Mode))
 	if err != nil {
 		return 0, fmt.Errorf("open extracted file for writing <%s>, %w", target, err)
@@ -282,9 +282,8 @@ func extractLink(h *tar.Header, target string) error {
 }
 
 func unlink(path string) error {
-	_, err := os.Lstat(path)
-	if err == nil {
-		return os.Remove(path)
+	if _, err := os.Lstat(path); err == nil {
+		return fmt.Errorf("error with unlinking: %w", os.Remove(path))
 	}
 
 	return nil

archive/tar/tar_test.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/meltwater/drone-cache/test"
 
-	"github.com/go-kit/kit/log"
+	"github.com/go-kit/log"
 )
 
 var (

archive/zstd/zstd.go

@@ -4,12 +4,10 @@ import (
 	"fmt"
 	"io"
 
+	"github.com/go-kit/log"
 	"github.com/klauspost/compress/zstd"
-
 	"github.com/meltwater/drone-cache/archive/tar"
 	"github.com/meltwater/drone-cache/internal"
-
-	"github.com/go-kit/kit/log"
 )
 
 // Archive implements archive for zstd.
@@ -30,22 +28,32 @@ func New(logger log.Logger, root string, skipSymlinks bool, compressionLevel int
 func (a *Archive) Create(srcs []string, w io.Writer) (int64, error) {
 	zw, err := zstd.NewWriter(w, zstd.WithEncoderLevel(zstd.EncoderLevelFromZstd(a.compressionLevel)))
 	if err != nil {
-		return 0, fmt.Errorf("create archive writer, %w", err)
+		return 0, fmt.Errorf("zstd create archive writer, %w", err)
 	}
 
 	defer internal.CloseWithErrLogf(a.logger, zw, "zstd writer")
 
-	return tar.New(a.logger, a.root, a.skipSymlinks).Create(srcs, zw)
+	wBytes, err := tar.New(a.logger, a.root, a.skipSymlinks).Create(srcs, zw)
+	if err != nil {
+		return 0, fmt.Errorf("zstd create archive, %w", err)
+	}
+
+	return wBytes, nil
 }
 
 // Extract reads content from the given archive reader and restores it to the destination, returns written bytes.
 func (a *Archive) Extract(dst string, r io.Reader) (int64, error) {
 	zr, err := zstd.NewReader(r)
 	if err != nil {
-		return 0, err
+		return 0, fmt.Errorf("zstd create extract archive reader, %w", err)
 	}
 
 	defer internal.CloseWithErrLogf(a.logger, zr.IOReadCloser(), "zstd reader")
 
-	return tar.New(a.logger, a.root, a.skipSymlinks).Extract(dst, zr)
+	eBytes, err := tar.New(a.logger, a.root, a.skipSymlinks).Extract(dst, zr)
+	if err != nil {
+		return 0, fmt.Errorf("zstd extract archive, %w", err)
+	}
+
+	return eBytes, nil
 }

archive/zstd/zstd_test.go

@@ -8,7 +8,7 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/go-kit/kit/log"
+	"github.com/go-kit/log"
 
 	"github.com/meltwater/drone-cache/archive/tar"
 	"github.com/meltwater/drone-cache/test"