Add go workflow to lint src/bpm/ (#164)

* Add go workflow to lint src/bpm/ * Fix lint errors or add nolint comments
cloudfoundry · Feb 29, 2024 · b5ea657 · b5ea657
1 parent d384f52
commit b5ea657
Show file tree

Hide file tree

Showing 37 changed files with 112 additions and 112 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -0,0 +1,15 @@
+name: go
+on:
+  push:
+  pull_request:
+jobs:
+  lint:
+    runs-on: [ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-go@v4
+      with:
+        go-version-file: src/bpm/go.mod
+    - uses: golangci/golangci-lint-action@v3
+      with:
+        working-directory: src/bpm/
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,7 @@
+# https://golangci-lint.run/usage/configuration/
+run:
+  timeout: 5m # 1m default times out on github-action runners
+
+output:
+  # Sort results by: filepath, line and column.
+  sort-results: true
diff --git a/src/bpm/acceptance/bpm_acceptance_test.go b/src/bpm/acceptance/bpm_acceptance_test.go
@@ -18,7 +18,7 @@ package bpm_acceptance_test
 import (
 	"bufio"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"sort"
 	"strings"
@@ -41,7 +41,7 @@ var _ = Describe("BpmAcceptance", func() {
 
 		Expect(resp.StatusCode).To(Equal(http.StatusOK))
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(string(body)).To(Equal("BPM is SWEET!\n"))
 	})
@@ -51,7 +51,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(string(body)).To(Equal("vcap\n"))
 	})
@@ -61,7 +61,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 
 		mounts := parseMounts(string(body))
@@ -108,7 +108,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 
 		mounts := parseMounts(string(body))
@@ -130,7 +130,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 
 		Expect(string(body)).To(Equal(""))
@@ -141,7 +141,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		directories := strings.Split(strings.Trim(string(body), "\n"), "\n")
 		Expect(directories).To(ConsistOf("store", "data", "jobs", "packages", "sys"))
@@ -152,7 +152,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		directories := strings.Split(strings.Trim(string(body), "\n"), "\n")
 		Expect(directories).To(ConsistOf("test-server", "packages", "shared"))
@@ -163,7 +163,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		directories := strings.Split(strings.Trim(string(body), "\n"), "\n")
 		Expect(directories).To(ConsistOf("test-server"))
@@ -174,7 +174,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		processes := strings.Split(strings.Trim(string(body), "\n"), "\n")
 
@@ -191,7 +191,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(string(body)).To(ContainSubstring("/var/vcap/jobs/test-server/bin:/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin:."))
 	})
@@ -204,7 +204,7 @@ var _ = Describe("BpmAcceptance", func() {
 		Expect(err).NotTo(HaveOccurred())
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		Expect(err).NotTo(HaveOccurred())
 		Expect(string(body)).To(ContainSubstring("/var/vcap/data/"))
 	})
@@ -217,7 +217,7 @@ var _ = Describe("BpmAcceptance", func() {
 
 			Expect(resp.StatusCode).To(Equal(http.StatusOK))
 
-			body, err := ioutil.ReadAll(resp.Body)
+			body, err := io.ReadAll(resp.Body)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(string(body)).To(ContainSubstring("Expected success occurred"))
 		})
@@ -229,7 +229,7 @@ var _ = Describe("BpmAcceptance", func() {
 
 			Expect(resp.StatusCode).To(Equal(http.StatusOK))
 
-			body, err := ioutil.ReadAll(resp.Body)
+			body, err := io.ReadAll(resp.Body)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(string(body)).To(ContainSubstring("Expected error occurred"))
 		})

diff --git a/src/bpm/acceptance/fixtures/test-server/handlers/curl.go b/src/bpm/acceptance/fixtures/test-server/handlers/curl.go
@@ -17,12 +17,11 @@ package handlers
 
 import (
 	"io"
-	"io/ioutil"
 	"net/http"
 )
 
 func Curl(w http.ResponseWriter, r *http.Request) {
-	address, err := ioutil.ReadAll(r.Body)
+	address, err := io.ReadAll(r.Body)
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		return

diff --git a/src/bpm/acceptance/fixtures/test-server/handlers/env.go b/src/bpm/acceptance/fixtures/test-server/handlers/env.go
@@ -17,13 +17,13 @@ package handlers
 
 import (
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"os"
 )
 
 func Env(w http.ResponseWriter, r *http.Request) {
-	envKey, err := ioutil.ReadAll(r.Body)
+	envKey, err := io.ReadAll(r.Body)
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		return

diff --git a/src/bpm/acceptance/fixtures/test-server/handlers/masked_paths.go b/src/bpm/acceptance/fixtures/test-server/handlers/masked_paths.go
@@ -51,7 +51,8 @@ func MaskedPaths(w http.ResponseWriter, r *http.Request) {
 		} else {
 			cmd := exec.Command("/bin/dd", fmt.Sprintf("if=%s", path))
 			output, err := cmd.CombinedOutput()
-			defer cmd.Process.Kill() // as dd could run indefinitely and cause issues with other tests...
+			// as dd could run indefinitely and cause issues with other tests...
+			defer cmd.Process.Kill() //nolint:errcheck
 
 			if err != nil {
 				readablePaths += fmt.Sprintf("Error reading path: %s\n", path)

diff --git a/src/bpm/acceptance/fixtures/test-server/handlers/mounts.go b/src/bpm/acceptance/fixtures/test-server/handlers/mounts.go
@@ -17,12 +17,12 @@ package handlers
 
 import (
 	"fmt"
-	"io/ioutil"
 	"net/http"
+	"os"
 )
 
 func Mounts(w http.ResponseWriter, r *http.Request) {
-	data, err := ioutil.ReadFile("/proc/mounts")
+	data, err := os.ReadFile("/proc/mounts")
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		return

diff --git a/src/bpm/acceptance/fixtures/test-server/handlers/processes.go b/src/bpm/acceptance/fixtures/test-server/handlers/processes.go
@@ -17,8 +17,8 @@ package handlers
 
 import (
 	"fmt"
-	"io/ioutil"
 	"net/http"
+	"os"
 	"path/filepath"
 )
 
@@ -30,12 +30,12 @@ func Processes(w http.ResponseWriter, r *http.Request) {
 	}
 
 	for _, item := range items {
-		body, err := ioutil.ReadFile(filepath.Join(item, "cmdline"))
+		body, err := os.ReadFile(filepath.Join(item, "cmdline"))
 		if err != nil {
 			w.WriteHeader(http.StatusInternalServerError)
 			return
 		}
 
-		fmt.Fprintln(w, fmt.Sprintf("%s %s", filepath.Base(item), string(body)))
+		fmt.Fprintf(w, "%s %s\n", filepath.Base(item), string(body))
 	}
 }
diff --git a/src/bpm/acceptance/fixtures/test-server/handlers/varvcap.go b/src/bpm/acceptance/fixtures/test-server/handlers/varvcap.go
@@ -17,12 +17,12 @@ package handlers
 
 import (
 	"fmt"
-	"io/ioutil"
 	"net/http"
+	"os"
 )
 
 func VarVcap(w http.ResponseWriter, r *http.Request) {
-	items, err := ioutil.ReadDir("/var/vcap")
+	items, err := os.ReadDir("/var/vcap")
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		return
@@ -34,7 +34,7 @@ func VarVcap(w http.ResponseWriter, r *http.Request) {
 }
 
 func VarVcapJobs(w http.ResponseWriter, r *http.Request) {
-	items, err := ioutil.ReadDir("/var/vcap/jobs")
+	items, err := os.ReadDir("/var/vcap/jobs")
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		return
@@ -46,7 +46,7 @@ func VarVcapJobs(w http.ResponseWriter, r *http.Request) {
 }
 
 func VarVcapData(w http.ResponseWriter, r *http.Request) {
-	items, err := ioutil.ReadDir("/var/vcap/data")
+	items, err := os.ReadDir("/var/vcap/data")
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		return

diff --git a/src/bpm/bosh/env.go b/src/bpm/bosh/env.go
@@ -16,7 +16,7 @@
 package bosh
 
 import (
-	"io/ioutil"
+	"os"
 	"path/filepath"
 )
 
@@ -43,7 +43,7 @@ func NewEnv(root string) *Env {
 func (e *Env) JobNames() []string {
 	var jobs []string
 
-	fileInfos, err := ioutil.ReadDir(filepath.Join(e.root, "jobs"))
+	fileInfos, err := os.ReadDir(filepath.Join(e.root, "jobs"))
 	if err != nil {
 		return jobs
 	}

diff --git a/src/bpm/bosh/env_test.go b/src/bpm/bosh/env_test.go
@@ -16,7 +16,6 @@
 package bosh_test
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -31,7 +30,7 @@ var _ = Describe("Bosh Environment", func() {
 
 	BeforeEach(func() {
 		var err error
-		root, err = ioutil.TempDir("", "bosh_test")
+		root, err = os.MkdirTemp("", "bosh_test")
 		Expect(err).NotTo(HaveOccurred())
 	})
 

diff --git a/src/bpm/commands/logs.go b/src/bpm/commands/logs.go
@@ -106,7 +106,7 @@ func logsForJob(cmd *cobra.Command, _ []string) error {
 	for {
 		select {
 		case sig := <-signals: // Forward signal received by parent to child
-			tailCmd.Process.Signal(sig)
+			tailCmd.Process.Signal(sig) //nolint:errcheck
 		case err := <-errCh: // Signal parent when child dies
 			if err != nil && err.Error() != "signal: interrupt" {
 				return err

diff --git a/src/bpm/commands/trace.go b/src/bpm/commands/trace.go
@@ -94,7 +94,7 @@ func trace(cmd *cobra.Command, _ []string) error {
 	for {
 		select {
 		case sig := <-signals:
-			straceCmd.Process.Signal(sig)
+			straceCmd.Process.Signal(sig) //nolint:errcheck
 		case err := <-errCh:
 			if eerr, ok := err.(*exec.ExitError); ok {
 				// was the process killed by a signal?

diff --git a/src/bpm/commands/version.go b/src/bpm/commands/version.go
@@ -36,7 +36,7 @@ var versionCommand = &cobra.Command{
 
 func version(cmd *cobra.Command, args []string) {
 	if len(args) != 0 {
-		cmd.Usage()
+		cmd.Usage() //nolint:errcheck
 		os.Exit(1)
 	}
 

diff --git a/src/bpm/config/job_config.go b/src/bpm/config/job_config.go
@@ -18,7 +18,7 @@ package config
 import (
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"os"
 	"path/filepath"
 	"strings"
 
@@ -73,7 +73,7 @@ type Unsafe struct {
 }
 
 func ParseJobConfig(configPath string) (*JobConfig, error) {
-	data, err := ioutil.ReadFile(configPath)
+	data, err := os.ReadFile(configPath)
 	if err != nil {
 		return nil, err
 	}

diff --git a/src/bpm/flock/flock_test.go b/src/bpm/flock/flock_test.go
@@ -16,7 +16,6 @@
 package flock_test
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -31,7 +30,7 @@ var _ = Describe("Flock", func() {
 
 	BeforeEach(func() {
 		var err error
-		tmpdir, err = ioutil.TempDir("", "flocktest")
+		tmpdir, err = os.MkdirTemp("", "flocktest")
 		Expect(err).NotTo(HaveOccurred())
 	})
 
@@ -56,7 +55,7 @@ var _ = Describe("Flock", func() {
 
 		It("cannot be unlocked again", func() {
 			Expect(func() {
-				lock.Unlock()
+				lock.Unlock() //nolint:errcheck
 			}).Should(Panic())
 		})
 
@@ -76,7 +75,7 @@ var _ = Describe("Flock", func() {
 			Expect(err).NotTo(HaveOccurred())
 
 			Expect(func() {
-				lock.Unlock()
+				lock.Unlock() //nolint:errcheck
 			}).Should(Panic())
 		})
 

diff --git a/src/bpm/hostlock/hostlock_test.go b/src/bpm/hostlock/hostlock_test.go
@@ -16,7 +16,6 @@
 package hostlock_test
 
 import (
-	"io/ioutil"
 	"os"
 
 	. "github.com/onsi/ginkgo"
@@ -30,7 +29,7 @@ var _ = Describe("Hostlock", func() {
 
 	BeforeEach(func() {
 		var err error
-		tmpdir, err = ioutil.TempDir("", "hostlock_test")
+		tmpdir, err = os.MkdirTemp("", "hostlock_test")
 		Expect(err).NotTo(HaveOccurred())
 	})