Add golangci-lint github action workflow file

 Enable and conform to gofumpt

Author: Andrew Kerr

.github/workflows/golangci-lint.yml

@@ -0,0 +1,43 @@
+name: golangci-lint
+on:
+  pull_request:
+    branches:
+      - master
+      - stable/**
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.17
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          version: v1.45.2
+
+          # Optional: working directory, useful for monorepos
+          # working-directory: somedir
+
+          # Optional: golangci-lint command line arguments.
+          # args: --issues-exit-code=0
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          # only-new-issues: true
+
+          # Optional: if set to true then the all caching functionality will be complete disabled,
+          #           takes precedence over all other caching options.
+          # skip-cache: true
+
+          # Optional: if set to true then the action don't cache or restore ~/go/pkg.
+          # skip-pkg-cache: true
+
+          # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
+          # skip-build-cache: true

.golangci.yml

@@ -5,3 +5,51 @@ run:
 
 linters:
   disable-all: true
+  # Enable specific linter
+  # https://golangci-lint.run/usage/linters/#enabled-by-default-linters
+  enable:
+    - gofumpt
+      # - goimports
+      # - lll
+
+issues:
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test\.go
+      linters:
+        - gocyclo
+        - errcheck
+        - dupl
+        - gosec
+    # Exclude `lll` issues for long lines with `go:generate`.
+    - linters:
+        - lll
+      source: "^//go:generate "
+
+linters-settings:
+  gofumpt:
+    # Select the Go version to target.
+    # Default: 1.15
+    lang-version: "1.17"
+    
+    # Choose whether to use the extra rules.
+    # Default: false
+    extra-rules: true
+    
+    # Module path which contains the source code being formatted.
+    # Default: empty string
+    module-path: github.com/netapp/trident
+  
+  goimports:
+    # Put imports beginning with prefix after 3rd-party packages.
+    # It's a comma-separated list of prefixes.
+    local-prefixes: github.com/netapp/trident
+
+  lll:
+    # Max line length, lines longer will be reported.
+    # '\t' is counted as 1 character by default, and can be changed with the tab-width option.
+    # Default: 120.
+    line-length: 120
+    # Tab width in spaces.
+    # Default: 1
+    tab-width: 4

cli/api/rest.go

@@ -13,8 +13,7 @@ import (
 
 const HTTPClientTimeout = time.Second * 300
 
-func InvokeRESTAPI(method string, url string, requestBody []byte, debug bool) (*http.Response, []byte, error) {
-
+func InvokeRESTAPI(method, url string, requestBody []byte, debug bool) (*http.Response, []byte, error) {
 	var request *http.Request
 	var err error
 
@@ -35,7 +34,6 @@ func InvokeRESTAPI(method string, url string, requestBody []byte, debug bool) (*
 
 	client := &http.Client{Timeout: HTTPClientTimeout}
 	response, err := client.Do(request)
-
 	if err != nil {
 		err = fmt.Errorf("error communicating with Trident REST API; %v", err)
 		return nil, nil, err

cli/cmd/create_backend.go

@@ -38,7 +38,6 @@ var createBackendCmd = &cobra.Command{
 	Short:   "Add a backend to Trident",
 	Aliases: []string{"b"},
 	RunE: func(cmd *cobra.Command, args []string) error {
-
 		jsonData, err := getBackendData(createFilename, createBase64Data)
 		if err != nil {
 			return err
@@ -55,7 +54,6 @@ var createBackendCmd = &cobra.Command{
 }
 
 func getBackendData(filename, b64Data string) ([]byte, error) {
-
 	var err error
 	var rawData []byte
 
@@ -85,7 +83,6 @@ func getBackendData(filename, b64Data string) ([]byte, error) {
 }
 
 func backendCreate(postData []byte) error {
-
 	// Send the file to Trident
 	url := BaseURL() + "/backend"
 

cli/cmd/delete_backend.go

@@ -37,7 +37,6 @@ var deleteBackendCmd = &cobra.Command{
 }
 
 func backendDelete(backendNames []string) error {
-
 	var err error
 
 	if allBackends {

cli/cmd/delete_node.go

@@ -38,7 +38,6 @@ var deleteNodeCmd = &cobra.Command{
 }
 
 func nodeDelete(nodeNames []string) error {
-
 	var err error
 
 	if allNodes {

cli/cmd/delete_snapshot.go

@@ -47,7 +47,6 @@ var deleteSnapshotCmd = &cobra.Command{
 }
 
 func snapshotDelete(snapshotIDs []string) error {
-
 	var err error
 
 	if allSnapshotsInVolume != "" {

cli/cmd/delete_storageclass.go

@@ -37,7 +37,6 @@ var deleteStorageClassCmd = &cobra.Command{
 }
 
 func storageClassDelete(storageClassNames []string) error {
-
 	var err error
 
 	if allStorageClasses {

cli/cmd/delete_volume.go

@@ -37,7 +37,6 @@ var deleteVolumeCmd = &cobra.Command{
 }
 
 func volumeDelete(volumeNames []string) error {
-
 	var err error
 
 	if allVolumes {

cli/cmd/get.go

@@ -24,13 +24,11 @@ var getCmd = &cobra.Command{
 }
 
 func WriteJSON(out interface{}) {
-
 	jsonBytes, _ := json.MarshalIndent(out, "", "  ")
 	fmt.Println(string(jsonBytes))
 }
 
 func WriteYAML(out interface{}) {
-
 	jsonBytes, _ := json.Marshal(out)
 	yamlBytes, _ := yaml.JSONToYAML(jsonBytes)
 	fmt.Println(string(yamlBytes))

cli/cmd/get_backend.go

@@ -40,7 +40,6 @@ var getBackendCmd = &cobra.Command{
 }
 
 func backendList(backendNames []string) error {
-
 	var err error
 
 	// If no backends were specified, we'll get all of them
@@ -74,7 +73,6 @@ func backendList(backendNames []string) error {
 }
 
 func GetBackends() ([]string, error) {
-
 	url := BaseURL() + "/backend"
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -95,7 +93,6 @@ func GetBackends() ([]string, error) {
 }
 
 func GetBackend(backendName string) (storage.BackendExternal, error) {
-
 	url := BaseURL() + "/backend/" + backendName
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -122,7 +119,6 @@ func GetBackend(backendName string) (storage.BackendExternal, error) {
 }
 
 func GetBackendByBackendUUID(backendUUID string) (storage.BackendExternal, error) {
-
 	url := BaseURL() + "/backend/" + backendUUID
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -184,7 +180,8 @@ func getOntapStorageDriverConfig(configAsMap map[string]interface{}) (*drivers.O
 }
 
 func getSolidfireStorageDriverConfig(configAsMap map[string]interface{}) (*drivers.SolidfireStorageDriverConfig,
-	error) {
+	error,
+) {
 	jsonBytes, marshalError := json.MarshalIndent(configAsMap, "", "  ")
 	if marshalError != nil {
 		return nil, marshalError
@@ -199,7 +196,6 @@ func getSolidfireStorageDriverConfig(configAsMap map[string]interface{}) (*drive
 }
 
 func writeBackendTable(backends []storage.BackendExternal) {
-
 	table := tablewriter.NewWriter(os.Stdout)
 	table.SetHeader([]string{"Name", "Storage Driver", "UUID", "State", "Volumes"})
 
@@ -224,7 +220,6 @@ func writeBackendTable(backends []storage.BackendExternal) {
 }
 
 func writeBackendNames(backends []storage.BackendExternal) {
-
 	for _, b := range backends {
 		fmt.Println(b.Name)
 	}

cli/cmd/get_node.go

@@ -39,7 +39,6 @@ var getNodeCmd = &cobra.Command{
 }
 
 func nodeList(nodeNames []string) error {
-
 	var err error
 
 	// If no nodes were specified, we'll get all of them
@@ -73,7 +72,6 @@ func nodeList(nodeNames []string) error {
 }
 
 func GetNodes() ([]string, error) {
-
 	url := BaseURL() + "/node"
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -94,7 +92,6 @@ func GetNodes() ([]string, error) {
 }
 
 func GetNode(nodeName string) (*utils.Node, error) {
-
 	url := BaseURL() + "/node/" + nodeName
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -136,7 +133,6 @@ func WriteNodes(nodes []utils.Node) {
 }
 
 func writeNodeTable(nodes []utils.Node) {
-
 	table := tablewriter.NewWriter(os.Stdout)
 	table.SetHeader([]string{"Name"})
 
@@ -150,7 +146,6 @@ func writeNodeTable(nodes []utils.Node) {
 }
 
 func writeWideNodeTable(nodes []utils.Node) {
-
 	table := tablewriter.NewWriter(os.Stdout)
 
 	header := []string{
@@ -186,7 +181,6 @@ func writeWideNodeTable(nodes []utils.Node) {
 }
 
 func writeNodeNames(nodes []utils.Node) {
-
 	for _, n := range nodes {
 		fmt.Println(n.Name)
 	}

cli/cmd/get_snapshot.go

@@ -48,7 +48,6 @@ var getSnapshotCmd = &cobra.Command{
 }
 
 func snapshotList(snapshotIDs []string) error {
-
 	var err error
 
 	// If no snapshots were specified, we'll get all of them
@@ -82,7 +81,6 @@ func snapshotList(snapshotIDs []string) error {
 }
 
 func GetSnapshots(volume string) ([]string, error) {
-
 	var url string
 	if volume == "" {
 		url = BaseURL() + "/snapshot"
@@ -107,7 +105,6 @@ func GetSnapshots(volume string) ([]string, error) {
 }
 
 func GetSnapshot(snapshotID string) (storage.SnapshotExternal, error) {
-
 	if !strings.ContainsRune(snapshotID, '/') {
 		return storage.SnapshotExternal{}, utils.InvalidInputError(fmt.Sprintf("invalid snapshot ID: %s; "+
 			"Please use the format <volume name>/<snapshot name>", snapshotID))
@@ -157,12 +154,10 @@ func WriteSnapshots(snapshots []storage.SnapshotExternal) {
 }
 
 func writeSnapshotTable(snapshots []storage.SnapshotExternal) {
-
 	table := tablewriter.NewWriter(os.Stdout)
 	table.SetHeader([]string{"Name", "Volume"})
 
 	for _, snapshot := range snapshots {
-
 		table.Append([]string{
 			snapshot.Config.Name,
 			snapshot.Config.VolumeName,
@@ -173,7 +168,6 @@ func writeSnapshotTable(snapshots []storage.SnapshotExternal) {
 }
 
 func writeWideSnapshotTable(snapshots []storage.SnapshotExternal) {
-
 	table := tablewriter.NewWriter(os.Stdout)
 	header := []string{
 		"Name",
@@ -185,7 +179,6 @@ func writeWideSnapshotTable(snapshots []storage.SnapshotExternal) {
 	table.SetHeader(header)
 
 	for _, snapshot := range snapshots {
-
 		table.Append([]string{
 			snapshot.Config.Name,
 			snapshot.Config.VolumeName,

cli/cmd/get_storageclass.go

@@ -37,7 +37,6 @@ var getStorageClassCmd = &cobra.Command{
 }
 
 func storageClassList(storageClassNames []string) error {
-
 	var err error
 
 	// If no storage classes were specified, we'll get all of them
@@ -71,7 +70,6 @@ func storageClassList(storageClassNames []string) error {
 }
 
 func GetStorageClasses() ([]string, error) {
-
 	url := BaseURL() + "/storageclass"
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -92,7 +90,6 @@ func GetStorageClasses() ([]string, error) {
 }
 
 func GetStorageClass(storageClassName string) (api.StorageClass, error) {
-
 	url := BaseURL() + "/storageclass/" + storageClassName
 
 	response, responseBody, err := api.InvokeRESTAPI("GET", url, nil, Debug)
@@ -132,7 +129,6 @@ func WriteStorageClasses(storageClasses []api.StorageClass) {
 }
 
 func writeStorageClassTable(storageClasses []api.StorageClass) {
-
 	table := tablewriter.NewWriter(os.Stdout)
 	table.SetHeader([]string{"Name"})
 
@@ -146,7 +142,6 @@ func writeStorageClassTable(storageClasses []api.StorageClass) {
 }
 
 func writeStorageClassNames(storageClasses []api.StorageClass) {
-
 	for _, sc := range storageClasses {
 		fmt.Println(sc.Config.Name)
 	}