*.go: update to golangci-lint, and fix everything

install tools in the workflow actions Also switch away from deprecated ioutil Signed-off-by: Vincent Batts <[email protected]>
vbatts · Oct 24, 2023 · 42b655d · 42b655d
1 parent e7a79ae
commit 42b655d
Show file tree

Hide file tree

Showing 19 changed files with 101 additions and 78 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -22,9 +22,9 @@ jobs:
         go-version: ${{ matrix.go }}
 
     - name: Build
-      run: make
+      run: make build
 
-    - name: Test
+    - name: Validation
       run: make validation
 
     - name: Build.Arches

diff --git a/.github/workflows/validation.yml b/.github/workflows/validation.yml
@@ -0,0 +1,28 @@
+name: lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: ['1.21']
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: ${{ matrix.go }}
+
+    - name: Install tools
+      run: make install.tools
+
+    - name: Test
+      run: make lint
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ GO_VER := go1.14
 default: build validation
 
 .PHONY: validation
-validation: .test .lint .vet .cli.test
+validation: .test .vet .cli.test
 
 .PHONY: validation.tags
 validation.tags: .test.tags .vet.tags .cli.test .staticcheck
@@ -50,11 +50,7 @@ lint: .lint
 CLEAN_FILES += .lint
 
 .lint: $(SOURCE_FILES)
-	@if [ "$(findstring $(GO_VER),$(shell go version))" != "" ] ; then \
-		set -e ; for dir in $(NO_VENDOR_DIR) ; do golint -set_exit_status $$dir ; done && touch $@ \
-	else \
-		touch $@ ; \
-	fi
+	set -e ; golangci-lint run && touch $@
 
 .PHONY: vet
 vet: .vet .vet.tags
@@ -85,12 +81,10 @@ $(BUILD): $(SOURCE_FILES)
 	go build -ldflags="-X 'main.Version=$(shell git describe --always --dirty)'" -mod=vendor -o $(BUILD) $(BUILDPATH)
 
 install.tools:
-	@go install -u github.com/fatih/color@latest ; \
-	go install -u github.com/fzipp/gocyclo/cmd/gocyclo@latest ; \
-	go install -u honnef.co/go/tools/cmd/staticcheck@latest ; \
-	if [ "$(findstring $(GO_VER),$(shell go version))" != "" ] ; then \
-		go get -u golang.org/x/lint/golint ;\
-	fi
+	@go install github.com/fatih/color@latest ; \
+	go install github.com/fzipp/gocyclo/cmd/gocyclo@latest ; \
+	go install honnef.co/go/tools/cmd/staticcheck@latest ; \
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
 
 ./bin:
 	mkdir -p $@

diff --git a/check_test.go b/check_test.go
@@ -2,7 +2,6 @@ package mtree
 
 import (
 	"bytes"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"testing"
@@ -31,14 +30,14 @@ func TestCheck(t *testing.T) {
 // only check again for size and sha1, and ignore time, and ensure it passes
 func TestCheckKeywords(t *testing.T) {
 	content := []byte("I know half of you half as well as I ought to")
-	dir, err := ioutil.TempDir("", "test-check-keywords")
+	dir, err := os.MkdirTemp("", "test-check-keywords")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(dir) // clean up
 
 	tmpfn := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfn, content, 0666); err != nil {
+	if err := os.WriteFile(tmpfn, content, 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -120,7 +119,7 @@ func TestDefaultBrokenLink(t *testing.T) {
 
 // https://github.com/vbatts/go-mtree/issues/8
 func TestTimeComparison(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-time.")
+	dir, err := os.MkdirTemp("", "test-time.")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -165,7 +164,7 @@ func TestTimeComparison(t *testing.T) {
 }
 
 func TestTarTime(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-tar-time.")
+	dir, err := os.MkdirTemp("", "test-tar-time.")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -219,7 +218,7 @@ func TestTarTime(t *testing.T) {
 }
 
 func TestIgnoreComments(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-comments.")
+	dir, err := os.MkdirTemp("", "test-comments.")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -288,7 +287,7 @@ func TestIgnoreComments(t *testing.T) {
 }
 
 func TestCheckNeedsEncoding(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-needs-encoding")
+	dir, err := os.MkdirTemp("", "test-needs-encoding")
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/cmd/gomtree/cmd/validate.go b/cmd/gomtree/cmd/validate.go
@@ -5,7 +5,6 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"strings"
 
@@ -266,7 +265,7 @@ func validateAction(c *cli.Context) error {
 		}
 		ts := mtree.NewTarStreamer(input, excludes, currentKeywords)
 
-		if _, err := io.Copy(ioutil.Discard, ts); err != nil && err != io.EOF {
+		if _, err := io.Copy(io.Discard, ts); err != nil && err != io.EOF {
 			return err
 		}
 		if err := ts.Close(); err != nil {
@@ -344,8 +343,8 @@ func validateAction(c *cli.Context) error {
 		}
 
 		// output stateDh
-		stateDh.WriteTo(fh)
-		return nil
+		_, err = stateDh.WriteTo(fh)
+		return err
 	}
 
 	// no spec manifest has been provided yet, so look for it on stdin
@@ -358,7 +357,8 @@ func validateAction(c *cli.Context) error {
 
 		// We can't check against more fields than in the specKeywords list, so
 		// currentKeywords can only have a subset of specKeywords.
-		specKeywords = specDh.UsedKeywords()
+		// TODO this specKeywords is not even used
+		_ = specDh.UsedKeywords()
 	}
 
 	// This is a validation.

diff --git a/compare_test.go b/compare_test.go
@@ -5,7 +5,6 @@ import (
 	"bytes"
 	"encoding/json"
 	"io"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"testing"
@@ -37,15 +36,15 @@ func TestCompare(t *testing.T) {
 
 //gocyclo:ignore
 func TestCompareModified(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-compare-modified")
+	dir, err := os.MkdirTemp("", "test-compare-modified")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(dir)
 
 	// Create a bunch of objects.
 	tmpfile := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
+	if err := os.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -55,7 +54,7 @@ func TestCompareModified(t *testing.T) {
 	}
 
 	tmpsubfile := filepath.Join(tmpdir, "anotherfile")
-	if err := ioutil.WriteFile(tmpsubfile, []byte("some different content"), 0666); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("some different content"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -66,7 +65,7 @@ func TestCompareModified(t *testing.T) {
 	}
 
 	// Overwrite the content in one of the files.
-	if err := ioutil.WriteFile(tmpsubfile, []byte("modified content"), 0666); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("modified content"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -117,15 +116,15 @@ func TestCompareModified(t *testing.T) {
 
 //gocyclo:ignore
 func TestCompareMissing(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-compare-missing")
+	dir, err := os.MkdirTemp("", "test-compare-missing")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(dir)
 
 	// Create a bunch of objects.
 	tmpfile := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
+	if err := os.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -135,7 +134,7 @@ func TestCompareMissing(t *testing.T) {
 	}
 
 	tmpsubfile := filepath.Join(tmpdir, "anotherfile")
-	if err := ioutil.WriteFile(tmpsubfile, []byte("some different content"), 0666); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("some different content"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -209,7 +208,7 @@ func TestCompareMissing(t *testing.T) {
 
 //gocyclo:ignore
 func TestCompareExtra(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-compare-extra")
+	dir, err := os.MkdirTemp("", "test-compare-extra")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -223,7 +222,7 @@ func TestCompareExtra(t *testing.T) {
 
 	// Create a bunch of objects.
 	tmpfile := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
+	if err := os.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -233,7 +232,7 @@ func TestCompareExtra(t *testing.T) {
 	}
 
 	tmpsubfile := filepath.Join(tmpdir, "anotherfile")
-	if err := ioutil.WriteFile(tmpsubfile, []byte("some different content"), 0666); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("some different content"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -287,15 +286,15 @@ func TestCompareExtra(t *testing.T) {
 }
 
 func TestCompareKeys(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-compare-keys")
+	dir, err := os.MkdirTemp("", "test-compare-keys")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(dir)
 
 	// Create a bunch of objects.
 	tmpfile := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
+	if err := os.WriteFile(tmpfile, []byte("some content here"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -305,7 +304,7 @@ func TestCompareKeys(t *testing.T) {
 	}
 
 	tmpsubfile := filepath.Join(tmpdir, "anotherfile")
-	if err := ioutil.WriteFile(tmpsubfile, []byte("aaa"), 0666); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("aaa"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -316,7 +315,7 @@ func TestCompareKeys(t *testing.T) {
 	}
 
 	// Overwrite the content in one of the files, but without changing the size.
-	if err := ioutil.WriteFile(tmpsubfile, []byte("bbb"), 0666); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("bbb"), 0666); err != nil {
 		t.Fatal(err)
 	}
 
@@ -343,15 +342,15 @@ func TestCompareKeys(t *testing.T) {
 
 //gocyclo:ignore
 func TestTarCompare(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-compare-tar")
+	dir, err := os.MkdirTemp("", "test-compare-tar")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(dir)
 
 	// Create a bunch of objects.
 	tmpfile := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfile, []byte("some content"), 0644); err != nil {
+	if err := os.WriteFile(tmpfile, []byte("some content"), 0644); err != nil {
 		t.Fatal(err)
 	}
 
@@ -361,7 +360,7 @@ func TestTarCompare(t *testing.T) {
 	}
 
 	tmpsubfile := filepath.Join(tmpdir, "anotherfile")
-	if err := ioutil.WriteFile(tmpsubfile, []byte("aaa"), 0644); err != nil {
+	if err := os.WriteFile(tmpsubfile, []byte("aaa"), 0644); err != nil {
 		t.Fatal(err)
 	}
 
@@ -395,7 +394,7 @@ func TestTarCompare(t *testing.T) {
 	}
 
 	str := NewTarStreamer(bytes.NewBuffer(ts), nil, append(DefaultTarKeywords, "sha1"))
-	if _, err = io.Copy(ioutil.Discard, str); err != nil && err != io.EOF {
+	if _, err = io.Copy(io.Discard, str); err != nil && err != io.EOF {
 		t.Fatal(err)
 	}
 	if err = str.Close(); err != nil {

diff --git a/fseval_test.go b/fseval_test.go
@@ -2,7 +2,6 @@ package mtree
 
 import (
 	"encoding/json"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"testing"
@@ -73,15 +72,15 @@ func (fs *MockFsEval) KeywordFunc(fn KeywordFunc) KeywordFunc {
 
 //gocyclo:ignore
 func TestCheckFsEval(t *testing.T) {
-	dir, err := ioutil.TempDir("", "test-check-fs-eval")
+	dir, err := os.MkdirTemp("", "test-check-fs-eval")
 	if err != nil {
 		t.Fatal(err)
 	}
 	defer os.RemoveAll(dir) // clean up
 
 	content := []byte("If you hide your ignorance, no one will hit you and you'll never learn.")
 	tmpfn := filepath.Join(dir, "tmpfile")
-	if err := ioutil.WriteFile(tmpfn, content, 0451); err != nil {
+	if err := os.WriteFile(tmpfn, content, 0451); err != nil {
 		t.Fatal(err)
 	}
 

diff --git a/keywordfunc.go b/keywordfunc.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/vbatts/go-mtree/pkg/govis"
 
-	//lint:ignore SA1019 yes ripemd160 is deprecated, but this is for mtree compatibility
+	//nolint:staticcheck // SA1019 yes ripemd160 is deprecated, but this is for mtree compatibility
 	"golang.org/x/crypto/ripemd160"
 )