Add golangci-lint configuration + fix lint errors

olivierlemasle · olivierlemasle · commit 8e61d13e51f4 · 2021-07-16T09:50:47.000+02:00
- Add a configuration file for golangci-lint
- Update golangci-lint in CI
- Fix errors (spelling, order of imports, error messages)
diff --git a/.github/workflows/pr-check.yaml b/.github/workflows/pr-check.yaml
@@ -12,7 +12,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.34
+          version: v1.41.1
 
   build:
     name: Test & Build
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,37 @@
+issues:
+  exclude-use-default: true
+  max-issues-per-linter: 50
+  max-same-issues: 0 # disable
+
+linters-settings:
+
+  staticcheck:
+    go: "1.15"
+    checks: [ "all" ]
+
+  stylecheck:
+    go: "1.15"
+    checks: [ "all" ]
+
+  goimports:
+    local-prefixes: github.com/apalia/cloudstack-csi-driver
+
+  misspell:
+    locale: US
+
+linters:
+  disable-all: true
+  enable:
+    - deadcode
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - stylecheck
+    - goimports
+    - structcheck
+    - typecheck
+    - unused
+    - varcheck
+    - misspell
diff --git a/cmd/cloudstack-csi-driver/main.go b/cmd/cloudstack-csi-driver/main.go
@@ -12,10 +12,11 @@ import (
 	"os"
 	"path"
 
-	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
-	"github.com/apalia/cloudstack-csi-driver/pkg/driver"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
+
+	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
+	"github.com/apalia/cloudstack-csi-driver/pkg/driver"
 )
 
 var (
diff --git a/pkg/cloud/cloud.go b/pkg/cloud/cloud.go
@@ -47,8 +47,8 @@ type VM struct {
 
 // Specific errors
 var (
-	ErrNotFound       = errors.New("Not found")
-	ErrTooManyResults = errors.New("Too many results")
+	ErrNotFound       = errors.New("not found")
+	ErrTooManyResults = errors.New("too many results")
 )
 
 // client is the implementation of Interface.
diff --git a/pkg/cloud/config.go b/pkg/cloud/config.go
@@ -34,7 +34,7 @@ type csConfig struct {
 func ReadConfig(configFilePath string) (*Config, error) {
 	cfg := &csConfig{}
 	if err := gcfg.ReadFileInto(cfg, configFilePath); err != nil {
-		return nil, fmt.Errorf("Could not parse CloudStack config: %w", err)
+		return nil, fmt.Errorf("could not parse CloudStack config: %w", err)
 	}
 
 	return &Config{
diff --git a/pkg/cloud/fake/fake.go b/pkg/cloud/fake/fake.go
@@ -5,9 +5,10 @@ package fake
 import (
 	"context"
 
+	"github.com/hashicorp/go-uuid"
+
 	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
 	"github.com/apalia/cloudstack-csi-driver/pkg/util"
-	"github.com/hashicorp/go-uuid"
 )
 
 const zoneID = "a1887604-237c-4212-a9cd-94620b7880fa"
diff --git a/pkg/driver/controller.go b/pkg/driver/controller.go
@@ -5,11 +5,12 @@ import (
 	"fmt"
 	"math/rand"
 
-	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
-	"github.com/apalia/cloudstack-csi-driver/pkg/util"
 	"github.com/container-storage-interface/spec/lib/go/csi"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
+
+	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
+	"github.com/apalia/cloudstack-csi-driver/pkg/util"
 )
 
 // onlyVolumeCapAccessMode is the only volume capability access
@@ -177,7 +178,7 @@ func determineSize(req *csi.CreateVolumeRequest) (int64, error) {
 
 		if limit := capRange.GetLimitBytes(); limit > 0 {
 			if util.GigaBytesToBytes(sizeInGB) > limit {
-				return 0, fmt.Errorf("After round-up, volume size %v GB exceeds the limit specified of %v bytes", sizeInGB, limit)
+				return 0, fmt.Errorf("after round-up, volume size %v GB exceeds the limit specified of %v bytes", sizeInGB, limit)
 			}
 		}
 	}
diff --git a/pkg/driver/driver.go b/pkg/driver/driver.go
@@ -4,9 +4,10 @@
 package driver
 
 import (
+	"go.uber.org/zap"
+
 	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
 	"github.com/apalia/cloudstack-csi-driver/pkg/mount"
-	"go.uber.org/zap"
 )
 
 // Interface is the CloudStack CSI driver interface.
diff --git a/pkg/driver/node.go b/pkg/driver/node.go
@@ -6,12 +6,13 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
-	"github.com/apalia/cloudstack-csi-driver/pkg/mount"
 	"github.com/container-storage-interface/spec/lib/go/csi"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
+
+	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
+	"github.com/apalia/cloudstack-csi-driver/pkg/mount"
 )
 
 const (
diff --git a/pkg/driver/server.go b/pkg/driver/server.go
@@ -24,13 +24,13 @@ func (cs *cloudstackDriver) serve(ids csi.IdentityServer, ctrls csi.ControllerSe
 			addr = "/" + addr
 		}
 		if err := os.Remove(addr); err != nil && !os.IsNotExist(err) {
-			return fmt.Errorf("Failed to remove %s, error: %s", addr, err.Error())
+			return fmt.Errorf("failed to remove %s, error: %s", addr, err.Error())
 		}
 	}
 
 	listener, err := net.Listen(proto, addr)
 	if err != nil {
-		return fmt.Errorf("Failed to listen: %w", err)
+		return fmt.Errorf("failed to listen: %w", err)
 	}
 
 	// Log every request and payloads (request + response)
@@ -66,5 +66,5 @@ func parseEndpoint(ep string) (string, string, error) {
 			return s[0], s[1], nil
 		}
 	}
-	return "", "", fmt.Errorf("Invalid endpoint: %v", ep)
+	return "", "", fmt.Errorf("invalid endpoint: %v", ep)
 }
diff --git a/pkg/driver/topology.go b/pkg/driver/topology.go
@@ -16,12 +16,12 @@ type Topology struct {
 func NewTopology(t *csi.Topology) (Topology, error) {
 	segments := t.GetSegments()
 	if segments == nil {
-		return Topology{}, errors.New("Nil segment in topology")
+		return Topology{}, errors.New("nil segment in topology")
 	}
 
 	zoneID, ok := segments[ZoneKey]
 	if !ok {
-		return Topology{}, errors.New("No zone in topology")
+		return Topology{}, errors.New("no zone in topology")
 	}
 	hostID := segments[HostKey]
 	return Topology{zoneID, hostID}, nil
diff --git a/pkg/mount/mount.go b/pkg/mount/mount.go
@@ -74,9 +74,9 @@ func (m *mounter) GetDevicePath(ctx context.Context, volumeID string) (string, e
 	})
 
 	if err == wait.ErrWaitTimeout {
-		return "", fmt.Errorf("Failed to find device for the volumeID: %q within the alloted time", volumeID)
+		return "", fmt.Errorf("failed to find device for the volumeID: %q within the alloted time", volumeID)
 	} else if devicePath == "" {
-		return "", fmt.Errorf("Device path was empty for volumeID: %q", volumeID)
+		return "", fmt.Errorf("device path was empty for volumeID: %q", volumeID)
 	}
 	return devicePath, nil
 }
diff --git a/pkg/syncer/run.go b/pkg/syncer/run.go
@@ -6,13 +6,14 @@ import (
 	"fmt"
 	"log"
 
-	"github.com/apalia/cloudstack-csi-driver/pkg/driver"
 	"github.com/xanzy/go-cloudstack/v2/cloudstack"
 	corev1 "k8s.io/api/core/v1"
 	storagev1 "k8s.io/api/storage/v1"
 	k8serrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
+
+	"github.com/apalia/cloudstack-csi-driver/pkg/driver"
 )
 
 var (
@@ -34,7 +35,7 @@ func (s syncer) Run(ctx context.Context) error {
 		LabelSelector: labelSelector,
 	})
 	if err != nil {
-		return fmt.Errorf("Cannot list existing storage classes: %w", err)
+		return fmt.Errorf("cannot list existing storage classes: %w", err)
 	}
 	for _, sc := range scList.Items {
 		oldSc = append(oldSc, sc.Name)
@@ -47,7 +48,7 @@ func (s syncer) Run(ctx context.Context) error {
 	p := s.csClient.DiskOffering.NewListDiskOfferingsParams()
 	diskOfferings, err := s.csClient.DiskOffering.ListDiskOfferings(p)
 	if err != nil {
-		return fmt.Errorf("Cannot list CloudStack disk offerings: %w", err)
+		return fmt.Errorf("cannot list CloudStack disk offerings: %w", err)
 	}
 
 	// Iterate over CloudStack disk offerings to synchronize them
@@ -65,7 +66,7 @@ func (s syncer) Run(ctx context.Context) error {
 	}
 	log.Println("No more CloudStack disk offerings")
 
-	// If enabled, delete unused labelled storage classes
+	// If enabled, delete unused labeled storage classes
 
 	if s.delete {
 		del := toDelete(oldSc, newSc)
@@ -76,7 +77,7 @@ func (s syncer) Run(ctx context.Context) error {
 				log.Printf("Deleting storage class %s", sc)
 				err = s.k8sClient.StorageV1().StorageClasses().Delete(ctx, sc, metav1.DeleteOptions{})
 				if err != nil {
-					err = fmt.Errorf("Error deleting storage class %s: %w", sc, err)
+					err = fmt.Errorf("error deleting storage class %s: %w", sc, err)
 					log.Println(err.Error())
 					errs = append(errs, err)
 				}
@@ -162,19 +163,19 @@ func checkStorageClass(sc *storagev1.StorageClass, expectedOfferingID string) er
 	errs := make([]error, 0)
 	diskOfferingID, ok := sc.Parameters[driver.DiskOfferingKey]
 	if !ok {
-		errs = append(errs, fmt.Errorf("Missing parameter %s", driver.DiskOfferingKey))
+		errs = append(errs, fmt.Errorf("missing parameter %s", driver.DiskOfferingKey))
 	} else if diskOfferingID != expectedOfferingID {
-		errs = append(errs, fmt.Errorf("Storage class %s has parameter %s=%s, should be %s", sc.Name, driver.DiskOfferingKey, diskOfferingID, expectedOfferingID))
+		errs = append(errs, fmt.Errorf("storage class %s has parameter %s=%s, should be %s", sc.Name, driver.DiskOfferingKey, diskOfferingID, expectedOfferingID))
 	}
 
 	if sc.ReclaimPolicy == nil || *sc.ReclaimPolicy != reclaimPolicy {
-		errs = append(errs, errors.New("Wrong ReclaimPolicy"))
+		errs = append(errs, errors.New("wrong ReclaimPolicy"))
 	}
 	if sc.VolumeBindingMode == nil || *sc.VolumeBindingMode != volBindingMode {
-		errs = append(errs, errors.New("Wrong VolumeBindingMode"))
+		errs = append(errs, errors.New("wrong VolumeBindingMode"))
 	}
 	if sc.AllowVolumeExpansion == nil || *sc.AllowVolumeExpansion != allowVolumeExpansion {
-		errs = append(errs, errors.New("Wrong AllowVolumeExpansion"))
+		errs = append(errs, errors.New("wrong AllowVolumeExpansion"))
 	}
 
 	if len(errs) > 0 {
diff --git a/pkg/syncer/syncer.go b/pkg/syncer/syncer.go
@@ -9,12 +9,13 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
 	"github.com/xanzy/go-cloudstack/v2/cloudstack"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
+
+	"github.com/apalia/cloudstack-csi-driver/pkg/cloud"
 )
 
 // Config holds the syncer tool configuration.
@@ -27,7 +28,7 @@ type Config struct {
 	Delete           bool
 }
 
-// Syncer has a function Run which synchronises CloudStack
+// Syncer has a function Run which synchronizes CloudStack
 // disk offerings to Kubernetes Storage classes.
 type Syncer interface {
 	Run(context.Context) error
@@ -87,11 +88,11 @@ func createLabelsSet(label string) labels.Set {
 func New(config Config) (Syncer, error) {
 	k8sClient, err := createK8sClient(config.KubeConfig, config.Agent)
 	if err != nil {
-		return nil, fmt.Errorf("Cannot create Kubernetes client: %w", err)
+		return nil, fmt.Errorf("cannot create Kubernetes client: %w", err)
 	}
 	csClient, err := createCloudStackClient(config.CloudStackConfig)
 	if err != nil {
-		return nil, fmt.Errorf("Cannot create CloudStack client: %w", err)
+		return nil, fmt.Errorf("cannot create CloudStack client: %w", err)
 	}
 
 	return syncer{
diff --git a/test/sanity/sanity_test.go b/test/sanity/sanity_test.go
@@ -8,11 +8,12 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/kubernetes-csi/csi-test/v4/pkg/sanity"
+	"go.uber.org/zap"
+
 	"github.com/apalia/cloudstack-csi-driver/pkg/cloud/fake"
 	"github.com/apalia/cloudstack-csi-driver/pkg/driver"
 	"github.com/apalia/cloudstack-csi-driver/pkg/mount"
-	"github.com/kubernetes-csi/csi-test/v4/pkg/sanity"
-	"go.uber.org/zap"
 )
 
 func TestSanity(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,8 @@ type VM struct {`
`47`	`47`
`48`	`48`	`// Specific errors`
`49`	`49`	`var (`
`50`		`- ErrNotFound = errors.New("Not found")`
`51`		`- ErrTooManyResults = errors.New("Too many results")`
	`50`	`+ ErrNotFound = errors.New("not found")`
	`51`	`+ ErrTooManyResults = errors.New("too many results")`
`52`	`52`	`)`
`53`	`53`
`54`	`54`	`// client is the implementation of Interface.`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ type csConfig struct {`
`34`	`34`	`func ReadConfig(configFilePath string) (*Config, error) {`
`35`	`35`	`cfg := &csConfig{}`
`36`	`36`	`if err := gcfg.ReadFileInto(cfg, configFilePath); err != nil {`
`37`		`- return nil, fmt.Errorf("Could not parse CloudStack config: %w", err)`
	`37`	`+ return nil, fmt.Errorf("could not parse CloudStack config: %w", err)`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`return &Config{`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,12 @@ import (`
`5`	`5`	`"fmt"`
`6`	`6`	`"math/rand"`
`7`	`7`
`8`		`- "github.com/apalia/cloudstack-csi-driver/pkg/cloud"`
`9`		`- "github.com/apalia/cloudstack-csi-driver/pkg/util"`
`10`	`8`	`"github.com/container-storage-interface/spec/lib/go/csi"`
`11`	`9`	`"google.golang.org/grpc/codes"`
`12`	`10`	`"google.golang.org/grpc/status"`
	`11`	`+`
	`12`	`+ "github.com/apalia/cloudstack-csi-driver/pkg/cloud"`
	`13`	`+ "github.com/apalia/cloudstack-csi-driver/pkg/util"`
`13`	`14`	`)`
`14`	`15`
`15`	`16`	`// onlyVolumeCapAccessMode is the only volume capability access`
`@@ -177,7 +178,7 @@ func determineSize(req *csi.CreateVolumeRequest) (int64, error) {`
`177`	`178`
`178`	`179`	`if limit := capRange.GetLimitBytes(); limit > 0 {`
`179`	`180`	`if util.GigaBytesToBytes(sizeInGB) > limit {`
`180`		`- return 0, fmt.Errorf("After round-up, volume size %v GB exceeds the limit specified of %v bytes", sizeInGB, limit)`
	`181`	`+ return 0, fmt.Errorf("after round-up, volume size %v GB exceeds the limit specified of %v bytes", sizeInGB, limit)`
`181`	`182`	`}`
`182`	`183`	`}`
`183`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,13 +24,13 @@ func (cs *cloudstackDriver) serve(ids csi.IdentityServer, ctrls csi.ControllerSe`
`24`	`24`	`addr = "/" + addr`
`25`	`25`	`}`
`26`	`26`	`if err := os.Remove(addr); err != nil && !os.IsNotExist(err) {`
`27`		`- return fmt.Errorf("Failed to remove %s, error: %s", addr, err.Error())`
	`27`	`+ return fmt.Errorf("failed to remove %s, error: %s", addr, err.Error())`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`listener, err := net.Listen(proto, addr)`
`32`	`32`	`if err != nil {`
`33`		`- return fmt.Errorf("Failed to listen: %w", err)`
	`33`	`+ return fmt.Errorf("failed to listen: %w", err)`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`// Log every request and payloads (request + response)`
`@@ -66,5 +66,5 @@ func parseEndpoint(ep string) (string, string, error) {`
`66`	`66`	`return s[0], s[1], nil`
`67`	`67`	`}`
`68`	`68`	`}`
`69`		`- return "", "", fmt.Errorf("Invalid endpoint: %v", ep)`
	`69`	`+ return "", "", fmt.Errorf("invalid endpoint: %v", ep)`
`70`	`70`	`}`