Fix linting issues

- Add new action that will be responsible for running the linter - Fix all the linter issues - Remove deprecated linters Signed-off-by: João Pereira <joaod@vmware.com>
cloudfoundry · May 21, 2024 · 26cfa3a · 26cfa3a
1 parent d76a6c6
commit 26cfa3a
Show file tree

Hide file tree

Showing 213 changed files with 950 additions and 976 deletions.
diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml
@@ -0,0 +1,56 @@
+name: golangci-lint
+
+on:
+  push:
+    tags:
+      - "v9.*"
+      - "v8.*"
+      - "v7.*"
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+    branches:
+      - main
+      - v9
+      - v8
+      - v7
+    paths-ignore:
+      - "doc/**"
+      - ".gitpod.yml"
+      - "README.md"
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+          check-latest: true
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.54
+          args: -v --exclude-dirs cf --exclude-dirs fixtures --exclude-dirs plugin --exclude-dirs command/plugin
+  format:
+    name: Run go fmt
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: '0'
+    - name: Set Up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: go.mod
+        check-latest: true
+    - name: Run go fmt
+      run: go fmt && git diff --exit-code
diff --git a/.github/workflows/tests-unit.yml b/.github/workflows/tests-unit.yml
@@ -26,23 +26,6 @@ defaults:
     shell: bash
 
 jobs:
-  lint:
-    name: Lint code
-    runs-on: ubuntu-latest
-    steps:
-
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - name: Set Up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version-file: go.mod
-        check-latest: true
-
-    - name: Run go fmt
-      run: go fmt && git diff --exit-code
-
   units:
     name: Units
     strategy:

diff --git a/.golangci.json b/.golangci.json
@@ -1,10 +1,7 @@
 {
   "run": {
     "concurrency": 4,
-    "timeout": "20m",
-    "skip-files": [
-      "integration/helpers/fake_server.go"
-    ]
+    "timeout": "20m"
   },
   "linters": {
     "disable-all": true,
@@ -14,15 +11,16 @@
       "errcheck",
       "staticcheck",
       "unused",
-      "structcheck",
-      "varcheck",
-      "ineffassign",
-      "deadcode"
+      "ineffassign"
     ]
   },
   "linters-settings": {},
   "issues": {
     "max-same-issue": 0,
+    "exclude-files":  [
+      "integration/helpers/fake_server.go",
+      "command/plugin/*.go$"
+    ],
     "exclude": [
       "Error return value of `client.GetApplicationTasks` is not checked",
       "Error return value of `logger.output.Stop` is not checked",

diff --git a/Makefile b/Makefile
@@ -141,11 +141,9 @@ integration-tests-full-ci: install-test-deps integration-cleanup
 		integration/shared/isolated integration/v7/isolated integration/shared/plugin integration/shared/experimental integration/v7/experimental integration/v7/push
 	$(ginkgo_int) -flake-attempts $(FLAKE_ATTEMPTS) integration/shared/global integration/v7/global
 
-lint: ## Runs all linters and formatters
+lint: format ## Runs all linters and formatters
 	@echo "Running linters..."
-	go list -f "{{.Dir}}" ./... \
-		| grep -v -e "/cf/" -e "/fixtures/" -e "/assets/" -e "/plugin/" -e "/command/plugin" -e "fakes" \
-		| xargs golangci-lint run
+	golangci-lint run --exclude-dirs cf --exclude-dirs fixtures --exclude-dirs plugin --exclude-dirs command/plugin
 	@echo "No lint errors!"
 
 # TODO: version specific tagging for all these builds

diff --git a/actor/pluginaction/checksum_test.go b/actor/pluginaction/checksum_test.go
@@ -1,7 +1,6 @@
 package pluginaction_test
 
 import (
-	"io/ioutil"
 	"os"
 
 	. "code.cloudfoundry.org/cli/actor/pluginaction"
@@ -25,11 +24,11 @@ var _ = Describe("Checksums", func() {
 		var file *os.File
 		BeforeEach(func() {
 			var err error
-			file, err = ioutil.TempFile("", "")
+			file, err = os.CreateTemp("", "")
 			Expect(err).NotTo(HaveOccurred())
 			defer file.Close()
 
-			err = ioutil.WriteFile(file.Name(), []byte("foo"), 0600)
+			err = os.WriteFile(file.Name(), []byte("foo"), 0600)
 			Expect(err).NotTo(HaveOccurred())
 		})
 

diff --git a/actor/pluginaction/install.go b/actor/pluginaction/install.go
@@ -1,7 +1,6 @@
 package pluginaction
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"sort"
@@ -189,7 +188,7 @@ func (actor Actor) InstallPluginFromPath(path string, plugin configv3.Plugin) er
 }
 
 func makeTempFile(tempDir string) (*os.File, error) {
-	tempFile, err := ioutil.TempFile(tempDir, "")
+	tempFile, err := os.CreateTemp(tempDir, "")
 	if err != nil {
 		return nil, err
 	}

diff --git a/actor/pluginaction/install_test.go b/actor/pluginaction/install_test.go
@@ -2,7 +2,6 @@ package pluginaction_test
 
 import (
 	"errors"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -32,7 +31,7 @@ var _ = Describe("install actions", func() {
 		actor = NewActor(fakeConfig, fakeClient)
 
 		var err error
-		tempPluginDir, err = ioutil.TempDir("", "")
+		tempPluginDir, err = os.MkdirTemp("", "")
 		Expect(err).ToNot(HaveOccurred())
 	})
 
@@ -46,7 +45,7 @@ var _ = Describe("install actions", func() {
 			var pluginPath string
 
 			BeforeEach(func() {
-				tempFile, err := ioutil.TempFile("", "")
+				tempFile, err := os.CreateTemp("", "")
 				Expect(err).ToNot(HaveOccurred())
 
 				_, err = tempFile.WriteString("cthulhu")
@@ -66,7 +65,7 @@ var _ = Describe("install actions", func() {
 				copyPath, err := actor.CreateExecutableCopy(pluginPath, tempPluginDir)
 				Expect(err).ToNot(HaveOccurred())
 
-				contents, err := ioutil.ReadFile(copyPath)
+				contents, err := os.ReadFile(copyPath)
 				Expect(err).ToNot(HaveOccurred())
 				Expect(contents).To(BeEquivalentTo("cthulhu"))
 			})
@@ -101,14 +100,14 @@ var _ = Describe("install actions", func() {
 			BeforeEach(func() {
 				data = []byte("some test data")
 				fakeClient.DownloadPluginStub = func(_ string, path string, _ plugin.ProxyReader) error {
-					err := ioutil.WriteFile(path, data, 0700)
+					err := os.WriteFile(path, data, 0700)
 					Expect(err).ToNot(HaveOccurred())
 					return nil
 				}
 			})
 			It("returns the path to the file and the size", func() {
 				Expect(downloadErr).ToNot(HaveOccurred())
-				fileData, err := ioutil.ReadFile(path)
+				fileData, err := os.ReadFile(path)
 				Expect(err).ToNot(HaveOccurred())
 				Expect(fileData).To(Equal(data))
 
@@ -139,7 +138,7 @@ var _ = Describe("install actions", func() {
 
 		When("the file exists", func() {
 			BeforeEach(func() {
-				pluginFile, err := ioutil.TempFile("", "")
+				pluginFile, err := os.CreateTemp("", "")
 				Expect(err).NotTo(HaveOccurred())
 				err = pluginFile.Close()
 				Expect(err).NotTo(HaveOccurred())
@@ -661,14 +660,14 @@ var _ = Describe("install actions", func() {
 				},
 			}
 
-			pluginFile, err := ioutil.TempFile("", "")
+			pluginFile, err := os.CreateTemp("", "")
 			Expect(err).NotTo(HaveOccurred())
 			err = pluginFile.Close()
 			Expect(err).NotTo(HaveOccurred())
 
 			pluginPath = pluginFile.Name()
 
-			tempDir, err = ioutil.TempDir("", "")
+			tempDir, err = os.MkdirTemp("", "")
 			Expect(err).ToNot(HaveOccurred())
 
 			pluginHomeDir = filepath.Join(tempDir, ".cf", "plugin")

diff --git a/actor/pluginaction/install_unix_test.go b/actor/pluginaction/install_unix_test.go
@@ -4,7 +4,6 @@
 package pluginaction_test
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -26,7 +25,7 @@ var _ = Describe("install actions", func() {
 	BeforeEach(func() {
 		fakeConfig = new(pluginactionfakes.FakeConfig)
 		var err error
-		tempPluginDir, err = ioutil.TempDir("", "")
+		tempPluginDir, err = os.MkdirTemp("", "")
 		Expect(err).ToNot(HaveOccurred())
 		actor = NewActor(fakeConfig, nil)
 	})
@@ -41,7 +40,7 @@ var _ = Describe("install actions", func() {
 			var pluginPath string
 
 			BeforeEach(func() {
-				tempFile, err := ioutil.TempFile("", "")
+				tempFile, err := os.CreateTemp("", "")
 				Expect(err).ToNot(HaveOccurred())
 
 				_, err = tempFile.WriteString("cthulhu")
@@ -86,14 +85,14 @@ var _ = Describe("install actions", func() {
 				},
 			}
 
-			pluginFile, err := ioutil.TempFile("", "")
+			pluginFile, err := os.CreateTemp("", "")
 			Expect(err).NotTo(HaveOccurred())
 			err = pluginFile.Close()
 			Expect(err).NotTo(HaveOccurred())
 
 			pluginPath = pluginFile.Name()
 
-			tempDir, err = ioutil.TempDir("", "")
+			tempDir, err = os.MkdirTemp("", "")
 			Expect(err).ToNot(HaveOccurred())
 
 			pluginHomeDir = filepath.Join(tempDir, ".cf", "plugin")

diff --git a/actor/pluginaction/install_windows_test.go b/actor/pluginaction/install_windows_test.go
@@ -4,7 +4,6 @@
 package pluginaction_test
 
 import (
-	"io/ioutil"
 	"os"
 
 	. "code.cloudfoundry.org/cli/actor/pluginaction"
@@ -23,7 +22,7 @@ var _ = Describe("install actions", func() {
 	BeforeEach(func() {
 		fakeConfig = new(pluginactionfakes.FakeConfig)
 		var err error
-		tempPluginDir, err = ioutil.TempDir("", "")
+		tempPluginDir, err = os.MkdirTemp("", "")
 		Expect(err).ToNot(HaveOccurred())
 		actor = NewActor(fakeConfig, nil)
 	})
@@ -38,7 +37,7 @@ var _ = Describe("install actions", func() {
 			var pluginPath string
 
 			BeforeEach(func() {
-				tempFile, err := ioutil.TempFile("", "")
+				tempFile, err := os.CreateTemp("", "")
 				Expect(err).ToNot(HaveOccurred())
 
 				_, err = tempFile.WriteString("cthulhu")

diff --git a/actor/pluginaction/uninstall_test.go b/actor/pluginaction/uninstall_test.go
@@ -2,7 +2,6 @@ package pluginaction_test
 
 import (
 	"errors"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -35,11 +34,11 @@ var _ = Describe("Plugin actor", func() {
 
 		BeforeEach(func() {
 			var err error
-			pluginHome, err = ioutil.TempDir("", "")
+			pluginHome, err = os.MkdirTemp("", "")
 			Expect(err).ToNot(HaveOccurred())
 
 			binaryPath = filepath.Join(pluginHome, "banana-faceman")
-			err = ioutil.WriteFile(binaryPath, nil, 0600)
+			err = os.WriteFile(binaryPath, nil, 0600)
 			Expect(err).ToNot(HaveOccurred())
 
 			fakePluginUninstaller = new(pluginactionfakes.FakePluginUninstaller)
@@ -188,7 +187,7 @@ var _ = Describe("Plugin actor", func() {
 					Expect(err).ToNot(HaveOccurred())
 					err = os.Mkdir(binaryPath, 0700)
 					Expect(err).ToNot(HaveOccurred())
-					err = ioutil.WriteFile(filepath.Join(binaryPath, "foooooo"), nil, 0500)
+					err = os.WriteFile(filepath.Join(binaryPath, "foooooo"), nil, 0500)
 					Expect(err).ToNot(HaveOccurred())
 				})
 

diff --git a/actor/sharedaction/resource.go b/actor/sharedaction/resource.go
@@ -5,7 +5,6 @@ import (
 	"crypto/sha1"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -214,7 +213,7 @@ func (actor Actor) GatherDirectoryResources(sourceDir string) ([]Resource, error
 // filemode for user is forced to be readable and executable.
 func (actor Actor) ZipArchiveResources(sourceArchivePath string, filesToInclude []Resource) (string, error) {
 	log.WithField("sourceArchive", sourceArchivePath).Info("zipping source files from archive")
-	zipFile, err := ioutil.TempFile("", "cf-cli-")
+	zipFile, err := os.CreateTemp("", "cf-cli-")
 	if err != nil {
 		return "", err
 	}
@@ -274,7 +273,7 @@ func (actor Actor) ZipArchiveResources(sourceArchivePath string, filesToInclude
 // filemode for user is forced to be readable and executable.
 func (actor Actor) ZipDirectoryResources(sourceDir string, filesToInclude []Resource) (string, error) {
 	log.WithField("sourceDir", sourceDir).Info("zipping source files from directory")
-	zipFile, err := ioutil.TempFile("", "cf-cli-")
+	zipFile, err := os.CreateTemp("", "cf-cli-")
 	if err != nil {
 		return "", err
 	}
@@ -434,7 +433,7 @@ func (Actor) generateArchiveCFIgnoreMatcher(files []*zip.File) (*ignore.GitIgnor
 			}
 			defer fileReader.Close()
 
-			raw, err := ioutil.ReadAll(fileReader)
+			raw, err := io.ReadAll(fileReader)
 			if err != nil {
 				return nil, err
 			}