Add golangci-lint config and fix linter errors (#353)

* Add golangci-lint and fixes * Use consistent line breaks on AddCommand * Correct some load balancer command docs * Update workflows to use go v1.21 * Add exclude rules to printer functions The errors will be addressed in another, more complicated changeset * Remove unecessary whitespace * Remove obsolete nolint directive
vultr · Sep 28, 2023 · 20f4990 · 20f4990
1 parent 289dba0
commit 20f4990
Show file tree

Hide file tree

Showing 35 changed files with 668 additions and 197 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -12,7 +12,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: "1.20"
+          go-version: "1.21"
 
       - name: Run unit tests and coverage test
         id: test-coverage

diff --git a/.github/workflows/gochecks.yml b/.github/workflows/gochecks.yml
@@ -14,7 +14,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: "1.20"
+          go-version: "1.21"
 
       - name: Install dependencies
         run: |
@@ -34,7 +34,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: "1.20"
+          go-version: "1.21"
 
       - name: Run fmt
         run: |

diff --git a/.github/workflows/releaser.yml b/.github/workflows/releaser.yml
@@ -53,7 +53,7 @@ jobs:
         name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: "1.20"
+          go-version: "1.21"
       -
         name: Docker Login
         env:

diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,135 @@
+linters-settings:
+  dupl:
+    threshold: 300
+  funlen:
+    lines: -1 # the number of lines (code + empty lines) is not a right metric and leads to code without empty line or one-liner.
+    statements: 50
+  goconst:
+    min-len: 2
+    min-occurrences: 3
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+    disabled-checks:
+      - dupImport # https://github.com/go-critic/go-critic/issues/845
+      - ifElseChain
+      - octalLiteral
+      - whyNoLint
+  gocyclo:
+    min-complexity: 15
+  goimports:
+    local-prefixes: github.com/golangci/golangci-lint
+  gomnd:
+    # don't include the "operation" and "assign"
+    checks:
+      - argument
+      - case
+      - condition
+      - return
+    ignored-numbers:
+      - '0'
+      - '1'
+      - '2'
+      - '3'
+    ignored-functions:
+      - strings.SplitN
+
+  govet:
+    check-shadowing: true
+    settings:
+      printf:
+        funcs:
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+  lll:
+    line-length: 140
+  misspell:
+    locale: US
+  nolintlint:
+    allow-unused: false # report any unused nolint directives
+    require-explanation: false # don't require an explanation for nolint directives
+    require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+  revive:
+    rules:
+      - name: unexported-return
+        disabled: true
+
+linters:
+  disable-all: true
+  enable:
+    - dogsled
+    - dupl
+    - errcheck
+    - exportloopref
+    - funlen
+    - gocritic
+    - gocyclo
+    - gofmt
+    - goimports
+    - gomnd
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nakedret
+    - noctx
+    - nolintlint
+    - revive
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - whitespace
+
+  # don't enable:
+  # - bodyclose
+  # - depguard
+  # - asciicheck
+  # - scopelint
+  # - gochecknoglobals
+  # - gocognit
+  # - godot
+  # - godox
+  # - goerr113
+  # - interfacer
+  # - maligned
+  # - nestif
+  # - prealloc
+  # - testpackage
+  # - wsl
+
+issues:
+  # List of regexps of issue texts to exclude.
+  #
+  # But independently of this option we use default exclude patterns,
+  # it can be disabled by `exclude-use-default: false`.
+  # To list all excluded by default patterns execute `golangci-lint run --help`
+  #
+  # Default: https://golangci-lint.run/usage/false-positives/#default-exclusions
+  exclude:
+    - abcdef
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: cmd/printer/
+      linters:
+        - funlen
+        - gocyclo
+        - dupl
+        - lll
+        - gomnd
+        - gocritic
+        - stylecheck
+
+run:
+  timeout: 5m
diff --git a/cmd/application.go b/cmd/application.go
@@ -34,7 +34,7 @@ func Applications() *cobra.Command {
 	appsCmd.AddCommand(appsList)
 
 	appsList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	appsList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	appsList.Flags().IntP("per-page", "p", perPageDefault, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
 
 	return appsCmd
 }

diff --git a/cmd/backups.go b/cmd/backups.go
@@ -35,7 +35,7 @@ func Backups() *cobra.Command {
 	backupsCmd.AddCommand(backupsList, backupsGet)
 
 	backupsList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	backupsList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	backupsList.Flags().IntP("per-page", "p", perPageDefault, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
 
 	return backupsCmd
 }

diff --git a/cmd/bareMetal.go b/cmd/bareMetal.go
@@ -96,29 +96,79 @@ func BareMetal() *cobra.Command {
 		os.Exit(1)
 	}
 	bareMetalCreate.Flags().IntP("os", "o", 0, "ID of the operating system that will be installed on the server.")
-	bareMetalCreate.Flags().StringP("script", "s", "", "(optional) ID of the startup script that will run after the server is created.")
-	bareMetalCreate.Flags().StringP("snapshot", "", "", "(optional) ID of the snapshot that the server will be restored from.")
-	bareMetalCreate.Flags().StringP("ipv6", "i", "", "(optional) Whether IPv6 is enabled on the server. Possible values: 'yes', 'no'. Defaults to 'no'.")
+	bareMetalCreate.Flags().StringP(
+		"script",
+		"s",
+		"",
+		"(optional) ID of the startup script that will run after the server is created.",
+	)
+	bareMetalCreate.Flags().StringP(
+		"snapshot",
+		"",
+		"",
+		"(optional) ID of the snapshot that the server will be restored from.",
+	)
+	bareMetalCreate.Flags().StringP(
+		"ipv6",
+		"i",
+		"",
+		"(optional) Whether IPv6 is enabled on the server. Possible values: 'yes', 'no'. Defaults to 'no'.",
+	)
 	bareMetalCreate.Flags().StringP("label", "l", "", "(optional) The label to assign to the server.")
-	bareMetalCreate.Flags().StringSliceP("ssh", "k", []string{}, "(optional) Comma separated list of SSH key IDs that will be added to the server.")
-	bareMetalCreate.Flags().IntP("app", "a", 0, "(optional) ID of the application that will be installed on the server.")
+	bareMetalCreate.Flags().StringSliceP(
+		"ssh",
+		"k",
+		[]string{},
+		"(optional) Comma separated list of SSH key IDs that will be added to the server.",
+	)
+	bareMetalCreate.Flags().IntP(
+		"app",
+		"a",
+		0,
+		"(optional) ID of the application that will be installed on the server.",
+	)
 	bareMetalCreate.Flags().StringP("image", "", "", "(optional) Image ID of the application that will be installed on the server.")
-	bareMetalCreate.Flags().StringP("userdata", "u", "", "(optional) A generic data store, which some provisioning tools and cloud operating systems use as a configuration file.")
-	bareMetalCreate.Flags().StringP("notify", "n", "", "(optional) Whether an activation email will be sent when the server is ready. Possible values: 'yes', 'no'. Defaults to 'yes'.")
+	bareMetalCreate.Flags().StringP(
+		"userdata",
+		"u",
+		"",
+		"(optional) A generic data store, which some provisioning tools and cloud operating systems use as a configuration file.",
+	)
+	bareMetalCreate.Flags().StringP(
+		"notify",
+		"n",
+		"",
+		"(optional) Whether an activation email will be sent when the server is ready. Possible values: 'yes', 'no'. Defaults to 'yes'.",
+	)
 	bareMetalCreate.Flags().StringP("hostname", "m", "", "(optional) The hostname to assign to the server.")
 	bareMetalCreate.Flags().StringP("tag", "t", "", "Deprecated: use `tags` instead. (optional) The tag to assign to the server.")
 	bareMetalCreate.Flags().StringSliceP("tags", "", []string{}, "(optional) A comma separated list of tags to assign to the server.")
 	bareMetalCreate.Flags().StringP("ripv4", "v", "", "(optional) IP address of the floating IP to use as the main IP of this server.")
 	bareMetalCreate.Flags().BoolP("persistent_pxe", "x", false, "enable persistent_pxe | true or false")
 
 	bareMetalList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	bareMetalList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	bareMetalList.Flags().IntP(
+		"per-page",
+		"p",
+		perPageDefault,
+		"(optional) Number of items requested per page. Default is 100 and Max is 500.",
+	)
 
 	bareMetalListIPV4.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	bareMetalListIPV4.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	bareMetalListIPV4.Flags().IntP(
+		"per-page",
+		"p",
+		perPageDefault,
+		"(optional) Number of items requested per page. Default is 100 and Max is 500.",
+	)
 
 	bareMetalListIPV6.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	bareMetalListIPV6.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	bareMetalListIPV6.Flags().IntP(
+		"per-page",
+		"p",
+		perPageDefault,
+		"(optional) Number of items requested per page. Default is 100 and Max is 500.",
+	)
 
 	bareMetalTags.Flags().StringSliceP("tags", "t", []string{}, "A comma separated list of tags to apply to the server")
 	if err := bareMetalTags.MarkFlagRequired("tags"); err != nil {

diff --git a/cmd/bareMetalUserData.go b/cmd/bareMetalUserData.go
@@ -20,6 +20,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 
 	"github.com/spf13/cobra"
 	"github.com/vultr/govultr/v3"
@@ -71,9 +72,10 @@ var bareMetalSetUserData = &cobra.Command{
 		return nil
 	},
 	Run: func(cmd *cobra.Command, args []string) {
-		userData, _ := cmd.Flags().GetString("userdata")
+		userDataPath, _ := cmd.Flags().GetString("userdata")
+		userDataPath = filepath.Clean(userDataPath)
 
-		rawData, err := os.ReadFile(userData)
+		rawData, err := os.ReadFile(userDataPath)
 		if err != nil {
 			fmt.Printf("error reading user-data : %v\n", err)
 			os.Exit(1)

diff --git a/cmd/billing.go b/cmd/billing.go
@@ -115,15 +115,25 @@ func Billing() *cobra.Command {
 	}
 
 	invoicesList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	invoicesList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	invoicesList.Flags().IntP("per-page", "p", perPageDefault, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
 
 	invoiceItemsList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	invoiceItemsList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	invoiceItemsList.Flags().IntP(
+		"per-page",
+		"p",
+		perPageDefault,
+		"(optional) Number of items requested per page. Default is 100 and Max is 500.",
+	)
 
 	invoiceCmd.AddCommand(invoicesList, invoiceGet, invoiceItemsList)
 
 	billingHistoryList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	billingHistoryList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	billingHistoryList.Flags().IntP(
+		"per-page",
+		"p",
+		perPageDefault,
+		"(optional) Number of items requested per page. Default is 100 and Max is 500.",
+	)
 
 	billingCmd.AddCommand(historyCmd, invoiceCmd)
 

diff --git a/cmd/blockStorage.go b/cmd/blockStorage.go
@@ -107,7 +107,6 @@ var (
 
 // BlockStorageCmd represents the blockStorage command
 func BlockStorageCmd() *cobra.Command {
-
 	bsCmd := &cobra.Command{
 		Use:     "block-storage",
 		Aliases: []string{"bs"},
@@ -119,7 +118,7 @@ func BlockStorageCmd() *cobra.Command {
 
 	// List
 	bsList.Flags().StringP("cursor", "c", "", "(optional) Cursor for paging.")
-	bsList.Flags().IntP("per-page", "p", 100, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
+	bsList.Flags().IntP("per-page", "p", perPageDefault, "(optional) Number of items requested per page. Default is 100 and Max is 500.")
 
 	// Attach
 	bsAttach.Flags().StringP("instance", "i", "", "instance id you want to attach to")
@@ -146,7 +145,13 @@ func BlockStorageCmd() *cobra.Command {
 
 	bsCreate.Flags().StringP("label", "l", "", "label you want to give the block storage")
 
-	bsCreate.Flags().StringP("block-type", "b", "", "(optional) Block type you want to give the block storage. Possible values: 'high_perf', 'storage_opt'. Currently defaults to 'high_perf'.")
+	bsCreate.Flags().StringP(
+		"block-type",
+		"b",
+		"",
+		`(optional) Block type you want to give the block storage.
+		Possible values: 'high_perf', 'storage_opt'. Currently defaults to 'high_perf'.`,
+	)
 
 	// Label
 	bsLabelSet.Flags().StringP("label", "l", "", "label you want your block storage to have")