BUILD/MEDIUM: update linters, use local version

oktalz · oktalz · commit cbfd37df7889 · 2023-01-18T09:12:49.000+01:00
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
@@ -58,6 +58,10 @@ jobs:
     steps:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v2
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.19
       - uses: actions/cache@v2
         with:
           path: |
@@ -66,10 +70,9 @@ jobs:
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
           restore-keys: |
             ${{ runner.os }}-go-
-      - name: golangci-lint
-        uses: docker://ghcr.io/haproxytech/go-linter:1.33
-        with:
-          args: --timeout 5m
+      - name: Lint
+        run: |
+          make lint
   build:
     name: build
     runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 kubernetes-ingress
 dist/
 .code-generator/
+bin/golangci-lint
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -42,12 +42,12 @@ golangci_lint:
   stage: lint
   needs: []
   image:
-    name: $CI_REGISTRY_GO/lint:1.33
+    name: $CI_REGISTRY_GO/golang:1.19
     entrypoint: [""]
   tags:
     - go
   script:
-    - golangci-lint run --enable-all --timeout=10m
+    - make lint
   only:
     - merge_requests
     - branches
diff --git a/.golangci.yml b/.golangci.yml
@@ -7,6 +7,14 @@ linters-settings:
     suggest-new: true
   dupl:
     threshold: 200
+  revive:
+    rules:
+      - name: var-naming
+        severity: warning
+        disabled: true
+        arguments:
+          - [] # AllowList
+          - [] # DenyList
 
 linters:
   enable-all: true
@@ -32,3 +40,15 @@ linters:
     - nakedret
     - paralleltest
     - testpackage
+    - varnamelen
+    - tagliatelle
+    - nonamedreturns
+    - forcetypeassert
+    - exhaustruct
+    - ireturn
+    - cyclop
+    - stylecheck
+    - errchkjson
+    - forbidigo
+    - nosnakecase
+    - interfacebloat
diff --git a/Makefile b/Makefile
@@ -1,5 +1,6 @@
 PROJECT_PATH=${PWD}
 TARGETPLATFORM?=linux/amd64
+GOLANGCI_LINT_VERSION=1.50.1
 
 .PHONY: test
 test:
@@ -21,8 +22,12 @@ doc:
 
 .PHONY: lint
 lint:
+	cd bin;GOLANGCI_LINT_VERSION=${GOLANGCI_LINT_VERSION} sh lint-check.sh
+	bin/golangci-lint run --timeout 5m --color always --max-issues-per-linter 0 --max-same-issues 0
+
+.PHONY: yaml-lint
+yaml-lint:
 	docker run --rm -v $(pwd):/data cytopia/yamllint .
-	golangci-lint run --color always --timeout 240s
 
 .PHONY: example
 example:
diff --git a/bin/lint-check.sh b/bin/lint-check.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+V=$(./golangci-lint --version)
+
+case "$V" in
+  *$GOLANGCI_LINT_VERSION*) echo "$V" ;;
+  *)          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(pwd) "v$GOLANGCI_LINT_VERSION" ;;
+esac
diff --git a/deploy/tests/e2e/client.go b/deploy/tests/e2e/client.go
@@ -20,7 +20,7 @@ import (
 	"context"
 	"crypto/tls"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net"
 	"net/http"
 	"os"
@@ -67,7 +67,7 @@ func newClient(host string, port int, tls bool) (*Client, error) {
 	if port != 0 {
 		dstPort = port
 	}
-	req, err := http.NewRequest("GET", fmt.Sprintf("%s://%s", scheme, host), nil)
+	req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s://%s", scheme, host), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -112,7 +112,7 @@ func NewHTTPSClient(host string, port ...int) (*Client, error) {
 	return client, nil
 }
 
-func (c *Client) Do() (res *http.Response, close func() error, err error) {
+func (c *Client) Do() (res *http.Response, closeFunc func() error, err error) {
 	client := &http.Client{}
 	if c.Transport != nil {
 		client.Transport = c.Transport
@@ -130,7 +130,7 @@ func (c *Client) Do() (res *http.Response, close func() error, err error) {
 	if err != nil {
 		return
 	}
-	close = res.Body.Close
+	closeFunc = res.Body.Close
 	return
 }
 
@@ -177,7 +177,7 @@ func ProxyProtoConn() (result []byte, err error) {
 		return
 	}
 
-	return ioutil.ReadAll(conn)
+	return io.ReadAll(conn)
 }
 
 func runtimeCommand(command string) (result []byte, err error) {
diff --git a/deploy/tests/e2e/utils.go b/deploy/tests/e2e/utils.go
@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"flag"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -17,11 +16,15 @@ import (
 	"k8s.io/client-go/tools/clientcmd"
 )
 
-var WaitDuration = 60 * time.Second
-var TickDuration = 2 * time.Second
+var (
+	WaitDuration = 60 * time.Second
+	TickDuration = 2 * time.Second
+)
 
-var devModeFlag = flag.Bool("dev", false, "keep test environment after finishing")
-var devMode bool
+var (
+	devModeFlag = flag.Bool("dev", false, "keep test environment after finishing")
+	devMode     bool
+)
 
 type Test struct {
 	namespace     string
@@ -50,7 +53,7 @@ func NewTest() (test Test, err error) {
 		return nil
 	}}
 	// TemplateDir
-	test.templateDir, err = ioutil.TempDir("/tmp/", "haproxy-ic-test-tmpl")
+	test.templateDir, err = os.MkdirTemp("/tmp/", "haproxy-ic-test-tmpl")
 	if err != nil {
 		return test, fmt.Errorf("error creating template dir: %w ", err)
 	}
@@ -69,7 +72,7 @@ func (t *Test) Apply(path string, namespace string, tmplData interface{}) error
 			return err
 		}
 	}
-	if file, err = ioutil.ReadFile(path); err != nil {
+	if file, err = os.ReadFile(path); err != nil {
 		return fmt.Errorf("error reading yaml file: %w", err)
 	}
 	// kubectl -n $NS apply -f -
@@ -80,7 +83,7 @@ func (t *Test) Apply(path string, namespace string, tmplData interface{}) error
 }
 
 func (t *Test) processTemplate(path string, tmplData interface{}) (string, error) {
-	file, err := ioutil.ReadFile(path)
+	file, err := os.ReadFile(path)
 	if err != nil {
 		return "", fmt.Errorf("error reading yaml template: %w", err)
 	}
@@ -91,13 +94,13 @@ func (t *Test) processTemplate(path string, tmplData interface{}) (string, error
 		return "", fmt.Errorf("error parsing yaml template: %w", err)
 	}
 	yaml := filepath.Join(t.templateDir, t.namespace+time.Now().Format("2006-01-02-1504051111")+".yaml")
-	return yaml, ioutil.WriteFile(yaml, result.Bytes(), 0600)
+	return yaml, os.WriteFile(yaml, result.Bytes(), 0o600)
 }
 
 func (t *Test) Delete(path string) error {
 	var err error
 	var file []byte
-	if file, err = ioutil.ReadFile(path); err != nil {
+	if file, err = os.ReadFile(path); err != nil {
 		return fmt.Errorf("error reading yaml file: %w", err)
 	}
 	if out, errApply := t.execute(string(file), "kubectl", "delete", "-f", "-"); errApply != nil {
diff --git a/deploy/tests/integration/customresources/suite_test.go b/deploy/tests/integration/customresources/suite_test.go
@@ -15,7 +15,7 @@
 package customresources
 
 import (
-	"io/ioutil"
+	"os"
 	"path/filepath"
 	"testing"
 
@@ -47,7 +47,7 @@ type Test struct {
 }
 
 func (suite *CustomResourceSuite) BeforeTest(suiteName, testName string) {
-	tempDir, err := ioutil.TempDir("", "ut-"+testName+"-*")
+	tempDir, err := os.MkdirTemp("", "ut-"+testName+"-*")
 	if err != nil {
 		suite.T().Fatalf("Suite '%s': Test '%s' : error : %s", suiteName, testName, err)
 	}
diff --git a/pkg/annotations/cfgSnippet.go b/pkg/annotations/cfgSnippet.go
@@ -35,7 +35,7 @@ var cfgSnippet struct {
 	backends  map[string]*cfgData
 }
 
-//nolint: gochecknoinits
+//nolint:gochecknoinits
 func init() {
 	cfgSnippet.global = &cfgData{}
 	cfgSnippet.frontends = make(map[string]*cfgData)
diff --git a/pkg/annotations/global/syslogServer.go b/pkg/annotations/global/syslogServer.go
@@ -29,9 +29,10 @@ func (a *SyslogServers) GetName() string {
 // Input is multiple syslog lines
 // Each syslog line is a list of params
 // Example:
-//  syslog-server: |
-//    address:127.0.0.1, port:514, facility:local0
-//    address:192.168.1.1, port:514, facility:local1
+//
+//	syslog-server: |
+//	  address:127.0.0.1, port:514, facility:local0
+//	  address:192.168.1.1, port:514, facility:local1
 func (a *SyslogServers) Process(k store.K8s, annotations ...map[string]string) error {
 	input := common.GetValue(a.GetName(), annotations...)
 	a.stdout = false
diff --git a/pkg/annotations/models.go b/pkg/annotations/models.go
@@ -104,5 +104,5 @@ func model(name, defaultNS string, crType int, k store.K8s, annotations ...map[s
 		}
 		return backend, nil
 	}
-	return nil, nil
+	return nil, nil //nolint:nilnil
 }
diff --git a/pkg/controller/monitor.go b/pkg/controller/monitor.go
@@ -83,7 +83,7 @@ func (c *HAProxyController) auxCfgManager() (restart, reload bool) {
 	info, errStat := os.Stat(c.haproxy.AuxCFGFile)
 	var (
 		modifTime  int64
-		auxCfgFile string = c.haproxy.AuxCFGFile
+		auxCfgFile = c.haproxy.AuxCFGFile
 		useAuxFile bool
 	)
 
diff --git a/pkg/haproxy/certs/main.go b/pkg/haproxy/certs/main.go
@@ -3,7 +3,6 @@ package certs
 import (
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path"
 	"strings"
@@ -183,7 +182,7 @@ func (c *certs) CertsUpdated() (reload bool) {
 }
 
 func refreshCerts(certs map[string]*cert, certDir string) (removed bool) {
-	files, err := ioutil.ReadDir(certDir)
+	files, err := os.ReadDir(certDir)
 	if err != nil {
 		logger.Error(err)
 		return false
diff --git a/pkg/haproxy/main.go b/pkg/haproxy/main.go
@@ -89,7 +89,7 @@ func (h HAProxy) Clean() {
 }
 
 func logVersion(program string) {
-	//nolint:gosec //checks of HAProxyBinary should be done in Env.Init() .
+	// checks of HAProxyBinary should be done in Env.Init() .
 	cmd := exec.Command(program, "-v")
 	res, errExec := cmd.Output()
 	if errExec != nil {
diff --git a/pkg/haproxy/process/s6-overlay.go b/pkg/haproxy/process/s6-overlay.go
@@ -23,7 +23,7 @@ func (d *s6Control) Service(action string) (err error) {
 	}
 	var cmd *exec.Cmd
 
-	//nolint:gosec //checks on HAProxyBinary should be done in configuration module.
+	// checks on HAProxyBinary should be done in configuration module.
 	switch action {
 	case "start":
 		// no need to start it is up already (s6)
diff --git a/pkg/haproxy/rules/main.go b/pkg/haproxy/rules/main.go
@@ -55,7 +55,7 @@ type ruleInfo struct {
 // ruleState describes Rule creation
 type ruleState int
 
-//nolint: golint,stylecheck
+//nolint:golint,stylecheck
 const (
 	CREATED   ruleState = 0
 	TO_CREATE ruleState = 1
diff --git a/pkg/haproxy/rules/types.go b/pkg/haproxy/rules/types.go
@@ -4,7 +4,7 @@ package rules
 // Rules will be evaluated by HAProxy in the defined order.
 type Type int
 
-//nolint: golint,stylecheck
+//nolint:golint,stylecheck
 const (
 	REQ_ACCEPT_CONTENT Type = iota
 	REQ_INSPECT_DELAY
diff --git a/pkg/ingress/types.go b/pkg/ingress/types.go
@@ -6,7 +6,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 )
 
-//nolint:golint,stylecheck
 const CONTROLLER = "haproxy.org/ingress-controller"
 
 var logger = utils.GetLogger()
diff --git a/pkg/k8s/main.go b/pkg/k8s/main.go
@@ -36,7 +36,8 @@ import (
 var logger = utils.GetK8sAPILogger()
 
 // TRACE_API outputs all k8s events received from k8s API
-//nolint golint
+//
+//nolint:golint
 const (
 	TRACE_API        = false
 	CoreGroupVersion = "core.haproxy.org/v1alpha1"
diff --git a/pkg/utils/logging.go b/pkg/utils/logging.go
@@ -44,10 +44,13 @@ const (
 //
 // if nil is sent, it won't be printed. This is useful for printing errors only
 // if they exist.
+//
 // ```
-// if err != nil {
-//   logger.Error(err)
-// }
+//
+//	if err != nil {
+//	  logger.Error(err)
+//	}
+//
 // ```
 // can be shortened to
 // ```
@@ -80,11 +83,15 @@ type logger struct {
 	FileName bool
 }
 
-var logSingelton *logger
-var doOnce sync.Once
+var (
+	logSingelton *logger
+	doOnce       sync.Once
+)
 
-var k8sAPILogSingelton *logger
-var dok8sAPIOnce sync.Once
+var (
+	k8sAPILogSingelton *logger
+	dok8sAPIOnce       sync.Once
+)
 
 //nolint:golint // 'exported func GetLogger returns unexported type , which can be annoying to use' - this is deliberate here
 func GetLogger() *logger {

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import (`
`20`	`20`	`"context"`
`21`	`21`	`"crypto/tls"`
`22`	`22`	`"fmt"`
`23`		`- "io/ioutil"`
	`23`	`+ "io"`
`24`	`24`	`"net"`
`25`	`25`	`"net/http"`
`26`	`26`	`"os"`
`@@ -67,7 +67,7 @@ func newClient(host string, port int, tls bool) (*Client, error) {`
`67`	`67`	`if port != 0 {`
`68`	`68`	`dstPort = port`
`69`	`69`	`}`
`70`		`- req, err := http.NewRequest("GET", fmt.Sprintf("%s://%s", scheme, host), nil)`
	`70`	`+ req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s://%s", scheme, host), nil)`
`71`	`71`	`if err != nil {`
`72`	`72`	`return nil, err`
`73`	`73`	`}`
`@@ -112,7 +112,7 @@ func NewHTTPSClient(host string, port ...int) (*Client, error) {`
`112`	`112`	`return client, nil`
`113`	`113`	`}`
`114`	`114`
`115`		`-func (c Client) Do() (res http.Response, close func() error, err error) {`
	`115`	`+func (c Client) Do() (res http.Response, closeFunc func() error, err error) {`
`116`	`116`	`client := &http.Client{}`
`117`	`117`	`if c.Transport != nil {`
`118`	`118`	`client.Transport = c.Transport`
`@@ -130,7 +130,7 @@ func (c Client) Do() (res http.Response, close func() error, err error) {`
`130`	`130`	`if err != nil {`
`131`	`131`	`return`
`132`	`132`	`}`
`133`		`- close = res.Body.Close`
	`133`	`+ closeFunc = res.Body.Close`
`134`	`134`	`return`
`135`	`135`	`}`
`136`	`136`
`@@ -177,7 +177,7 @@ func ProxyProtoConn() (result []byte, err error) {`
`177`	`177`	`return`
`178`	`178`	`}`
`179`	`179`
`180`		`- return ioutil.ReadAll(conn)`
	`180`	`+ return io.ReadAll(conn)`
`181`	`181`	`}`
`182`	`182`
`183`	`183`	`func runtimeCommand(command string) (result []byte, err error) {`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`package customresources`
`16`	`16`
`17`	`17`	`import (`
`18`		`- "io/ioutil"`
	`18`	`+ "os"`
`19`	`19`	`"path/filepath"`
`20`	`20`	`"testing"`
`21`	`21`
`@@ -47,7 +47,7 @@ type Test struct {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`func (suite *CustomResourceSuite) BeforeTest(suiteName, testName string) {`
`50`		`- tempDir, err := ioutil.TempDir("", "ut-"+testName+"-*")`
	`50`	`+ tempDir, err := os.MkdirTemp("", "ut-"+testName+"-*")`
`51`	`51`	`if err != nil {`
`52`	`52`	`suite.T().Fatalf("Suite '%s': Test '%s' : error : %s", suiteName, testName, err)`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ var cfgSnippet struct {`
`35`	`35`	`backends map[string]*cfgData`
`36`	`36`	`}`
`37`	`37`
`38`		`-//nolint: gochecknoinits`
	`38`	`+//nolint:gochecknoinits`
`39`	`39`	`func init() {`
`40`	`40`	`cfgSnippet.global = &cfgData{}`
`41`	`41`	`cfgSnippet.frontends = make(map[string]*cfgData)`