build: address all lint issues by v2 (#20804)

* fix QF1011: could omit type *os.File from declaration; it will be inferred from the right-hand side

* fix QF1012: Use fmt.Fprintf(x, ...) instead of x.Write(fmt.Sprintf(...))

* fix QF1001: could apply De Morgan's law

* fix QF1003: could use tagged switch

* fix weakCond: suspicious ; nil check may not be enough, check for len (gocritic)

* fix docStub: silencing go lint doc-comment warnings is unadvised

* fix builtinShadow: shadowing of predeclared identifier: error

* fix importShadow: shadow of imported package

* fix nestingReduce: invert if cond, replace body with , move old body after the statement

* useless-break: useless break in case clause (revive)

* Clear the redundant content in golangci.yaml file

Author: LJTian

.golangci.yaml

@@ -23,23 +23,8 @@ linters:
         - "-ST1020"
         - "-ST1021"
         - "-ST1022"
-        ##### TODO: fix and enable these
-        # 4 occurrences.
-        # Use fmt.Fprintf(x, ...) instead of x.Write(fmt.Sprintf(...)) https://staticcheck.dev/docs/checks#QF1012
-        - "-QF1012"
-        # 3 occurrences.
-        # Apply De Morgan’s law https://staticcheck.dev/docs/checks#QF1001
-        - "-QF1001"
-        # 9 occurrences.
-        # Convert if/else-if chain to tagged switch https://staticcheck.dev/docs/checks#QF1003
-        - "-QF1003"
-        # 1 occurrence.
-        # could omit type *os.File from declaration; it will be inferred from the right-hand side
-        - "-QF1011"
-        ##### These have been vetted to be disabled.
-        # 19 occurrences. Omit embedded fields from selector expression https://staticcheck.dev/docs/checks#QF1008
-        # Usefulness is questionable.
         - "-QF1008"
+        
     revive:
       enable-all-rules: true
       rules:
@@ -150,23 +135,22 @@ linters:
       # - yodaStyleExpr
       # - typeUnparen
 
-      ##### TODO: fix and enable these
       # We enabled these and we pass
       - nilValReturn
-      # - weakCond # pkg/minikube/config/profile.go:61:9: weakCond: suspicious `cc.Nodes != nil && cc.Nodes[0].Name == node.Name`; nil check may not be enough, check for len (gocritic)
+      - weakCond 
       - indexAlloc
       - rangeExprCopy
       - boolExprSimplify
       - commentedOutImport
-      # - docStub         # pkg/minikube/tunnel/kic/service_tunnel.go:51:1: docStub: silencing go lint doc-comment warnings is unadvised (gocritic)
+      - docStub        
       - emptyFallthrough
       - hexLiteral
       - typeAssertChain
       - unlabelStmt
-      # - builtinShadow # cmd/minikube/cmd/delete.go:89:7: builtinShadow: shadowing of predeclared identifier: error (gocritic) 
-      # - importShadow # pkg/storage/storage_provisioner.go:60:2: importShadow: shadow of imported package 'path' (gocritic)
+      - builtinShadow  
+      - importShadow 
       - initClause
-      # - nestingReduce # pkg/minikube/tunnel/registry.go:94:3: nestingReduce: invert if cond, replace body with `continue`, move old body after the statement (gocritic)
+      - nestingReduce 
       - unnecessaryBlock
 
   exclusions:
@@ -181,7 +165,3 @@ linters:
       - path: '(.+)\.go$'
         text: "Error return value of `.*` is not checked"
         linter: errcheck
-      # This code is doubtful and I don't understand it. Location: Line 456
-      - path: 'cmd/minikube/cmd/docker-env.go'
-        text: "useless-break: useless break in case clause"
-        linter: revive

cmd/minikube/cmd/completion.go

@@ -162,7 +162,7 @@ func GenerateBashCompletion(w io.Writer, cmd *cobra.Command) error {
 }
 
 // GenerateZshCompletion generates the completion for the zsh shell
-func GenerateZshCompletion(out io.Writer, cmd *cobra.Command) error {
+func GenerateZshCompletion(w io.Writer, cmd *cobra.Command) error {
 	zshAutoloadTag := `#compdef minikube
 `
 
@@ -300,17 +300,17 @@ __minikube_convert_bash_to_zsh() {
 	<<'BASH_COMPLETION_EOF'
 `
 
-	_, err := out.Write([]byte(zshAutoloadTag))
+	_, err := w.Write([]byte(zshAutoloadTag))
 	if err != nil {
 		return err
 	}
 
-	_, err = out.Write([]byte(boilerPlate))
+	_, err = w.Write([]byte(boilerPlate))
 	if err != nil {
 		return err
 	}
 
-	_, err = out.Write([]byte(zshInitialization))
+	_, err = w.Write([]byte(zshInitialization))
 	if err != nil {
 		return err
 	}
@@ -320,7 +320,7 @@ __minikube_convert_bash_to_zsh() {
 	if err != nil {
 		return errors.Wrap(err, "Error generating zsh completion")
 	}
-	_, err = out.Write(buf.Bytes())
+	_, err = w.Write(buf.Bytes())
 	if err != nil {
 		return err
 	}
@@ -330,7 +330,7 @@ BASH_COMPLETION_EOF
 }
 __minikube_bash_source <(__minikube_convert_bash_to_zsh)
 `
-	_, err = out.Write([]byte(zshTail))
+	_, err = w.Write([]byte(zshTail))
 	if err != nil {
 		return err
 	}

cmd/minikube/cmd/config/configure.go

@@ -133,7 +133,7 @@ func loadAddonConfigFile(addon, configFilePath string) (ac *addonConfig) {
 	type configFile struct {
 		Addons addonConfig `json:"addons"`
 	}
-	var config configFile
+	var cf configFile
 
 	if configFilePath != "" {
 		out.Ln("Reading %s configs from %s", addon, configFilePath)
@@ -150,14 +150,14 @@ func loadAddonConfigFile(addon, configFilePath string) (ac *addonConfig) {
 				fmt.Sprintf("error opening config file: %s", configFilePath))
 		}
 
-		if err = json.Unmarshal(confData, &config); err != nil {
+		if err = json.Unmarshal(confData, &cf); err != nil {
 			// err = errors2.Wrapf(err, "error reading config file (%s)", configFilePath)
 			klog.Errorf("error reading config file (%s): %v", configFilePath, err)
 			exit.Message(reason.Kind{ExitCode: reason.ExProgramConfig, Advice: "provide a valid config file"},
 				fmt.Sprintf("error reading config file: %v", err))
 		}
 
-		return &config.Addons
+		return &cf.Addons
 	}
 	return nil
 }

cmd/minikube/cmd/config/configure_registry_creds.go

@@ -92,7 +92,9 @@ func processRegistryCredsConfig(profile string, ac *addonConfig) {
 
 	regCredsConf := &ac.RegistryCreds
 	awsEcrAction := regCredsConf.EnableAWSEcr // regCredsConf. "enableAWSEcr")
-	if awsEcrAction == "prompt" || awsEcrAction == "" {
+
+	switch awsEcrAction {
+	case "prompt", "":
 		enableAWSECR := AskForYesNoConfirmation("\nDo you want to enable AWS Elastic Container Registry?", posResponses, negResponses)
 		if enableAWSECR {
 			awsAccessID = AskForStaticValue("-- Enter AWS Access Key ID: ")
@@ -102,7 +104,7 @@ func processRegistryCredsConfig(profile string, ac *addonConfig) {
 			awsAccount = AskForStaticValue("-- Enter 12 digit AWS Account ID (Comma separated list): ")
 			awsRole = AskForStaticValueOptional("-- (Optional) Enter ARN of AWS role to assume: ")
 		}
-	} else if awsEcrAction == "enable" {
+	case "enable":
 		out.Ln("Loading AWS ECR configs from: %s", addonConfigFile)
 		// Then read the configs
 		awsAccessID = regCredsConf.EcrConfigs.AccessID
@@ -111,15 +113,17 @@ func processRegistryCredsConfig(profile string, ac *addonConfig) {
 		awsRegion = regCredsConf.EcrConfigs.Region
 		awsAccount = regCredsConf.EcrConfigs.Account
 		awsRole = regCredsConf.EcrConfigs.Role
-	} else if awsEcrAction == "disable" {
+	case "disable":
 		out.Ln("Ignoring AWS ECR configs")
-	} else {
+	default:
 		out.Ln("Disabling AWS ECR.  Invalid value for enableAWSEcr (%s).  Must be one of 'disable', 'enable' or 'prompt'", awsEcrAction)
 	}
 
 	gcrPath := ""
 	gcrAction := regCredsConf.EnableGCR
-	if gcrAction == "prompt" || gcrAction == "" {
+
+	switch gcrAction {
+	case "prompt", "":
 		enableGCR := AskForYesNoConfirmation("\nDo you want to enable Google Container Registry?", posResponses, negResponses)
 		if enableGCR {
 			gcrPath = AskForStaticValue("-- Enter path to credentials (e.g. /home/user/.config/gcloud/application_default_credentials.json):")
@@ -129,14 +133,14 @@ func processRegistryCredsConfig(profile string, ac *addonConfig) {
 				gcrURL = AskForStaticValue("-- Enter GCR URL (e.g. https://asia.gcr.io):")
 			}
 		}
-	} else if gcrAction == "enable" {
+	case "enable":
 		out.Ln("Loading GCR configs from: %s", addonConfigFile)
 		// Then read the configs
 		gcrPath = regCredsConf.GcrConfigs.GcrPath
 		gcrURL = regCredsConf.GcrConfigs.GcrURL
-	} else if gcrAction == "disable" {
+	case "disable":
 		out.Ln("Ignoring GCR configs")
-	} else {
+	default:
 		out.Ln("Disabling GCR.  Invalid value for enableGCR (%s).  Must be one of 'disable', 'enable' or 'prompt'", gcrAction)
 	}
 
@@ -152,40 +156,44 @@ func processRegistryCredsConfig(profile string, ac *addonConfig) {
 	}
 
 	dockerRegistryAction := regCredsConf.EnableDockerRegistry
-	if dockerRegistryAction == "prompt" || dockerRegistryAction == "" {
+
+	switch dockerRegistryAction {
+	case "prompt", "":
 		enableDR := AskForYesNoConfirmation("\nDo you want to enable Docker Registry?", posResponses, negResponses)
 		if enableDR {
 			dockerServer = AskForStaticValue("-- Enter docker registry server url: ")
 			dockerUser = AskForStaticValue("-- Enter docker registry username: ")
 			dockerPass = AskForPasswordValue("-- Enter docker registry password: ")
 		}
-	} else if dockerRegistryAction == "enable" {
+	case "enable":
 		out.Ln("Loading Docker Registry configs from: %s", addonConfigFile)
 		dockerServer = regCredsConf.DockerConfigs.DockerServer
 		dockerUser = regCredsConf.DockerConfigs.DockerUser
 		dockerPass = regCredsConf.DockerConfigs.DockerPass
-	} else if dockerRegistryAction == "disable" {
+	case "disable":
 		out.Ln("Ignoring Docker Registry configs")
-	} else {
+	default:
 		out.Ln("Disabling Docker Registry.  Invalid value for enableDockerRegistry (%s).  Must be one of 'disable', 'enable' or 'prompt'", dockerRegistryAction)
 	}
 
 	acrAction := regCredsConf.EnableACR
-	if acrAction == "prompt" || acrAction == "" {
+
+	switch acrAction {
+	case "prompt", "":
 		enableACR := AskForYesNoConfirmation("\nDo you want to enable Azure Container Registry?", posResponses, negResponses)
 		if enableACR {
 			acrURL = AskForStaticValue("-- Enter Azure Container Registry (ACR) URL: ")
 			acrClientID = AskForStaticValue("-- Enter client ID (service principal ID) to access ACR: ")
 			acrPassword = AskForPasswordValue("-- Enter service principal password to access Azure Container Registry: ")
 		}
-	} else if acrAction == "enable" {
+	case "enable":
 		out.Ln("Loading ACR configs from: ", addonConfigFile)
 		acrURL = regCredsConf.AcrConfigs.AcrURL
 		acrClientID = regCredsConf.AcrConfigs.AcrClientID
 		acrPassword = regCredsConf.AcrConfigs.AcrPassword
-	} else if acrAction == "disable" {
+	case "disable":
 		out.Ln("Ignoring ACR configs")
-	} else {
+	default:
 		out.Stringf("Disabling ACR.  Invalid value for enableACR (%s).  Must be one of 'disable', 'enable' or 'prompt'", acrAction)
 	}
 

cmd/minikube/cmd/dashboard.go

@@ -157,7 +157,7 @@ func kubectlProxy(kubectlVersion string, binaryURL string, contextName string, p
 	klog.Infof("Waiting for kubectl to output host:port ...")
 	reader := bufio.NewReader(stdoutPipe)
 
-	var out []byte
+	var outData []byte
 	for {
 		r, timedOut, err := readByteWithTimeout(reader, 5*time.Second)
 		if err != nil {
@@ -170,10 +170,10 @@ func kubectlProxy(kubectlVersion string, binaryURL string, contextName string, p
 			klog.Infof("timed out waiting for input: possibly due to an old kubectl version.")
 			break
 		}
-		out = append(out, r)
+		outData = append(outData, r)
 	}
-	klog.Infof("proxy stdout: %s", string(out))
-	return cmd, hostPortRe.FindString(string(out)), nil
+	klog.Infof("proxy stdout: %s", string(outData))
+	return cmd, hostPortRe.FindString(string(outData)), nil
 }
 
 // readByteWithTimeout returns a byte from a reader or an indicator that a timeout has occurred.
@@ -203,9 +203,9 @@ func readByteWithTimeout(r io.ByteReader, timeout time.Duration) (byte, bool, er
 }
 
 // dashboardURL generates a URL for accessing the dashboard service
-func dashboardURL(proxy string, ns string, svc string) string {
+func dashboardURL(addr string, ns string, svc string) string {
 	// Reference: https://github.com/kubernetes/dashboard/wiki/Accessing-Dashboard---1.7.X-and-above
-	return fmt.Sprintf("http://%s/api/v1/namespaces/%s/services/http:%s:/proxy/", proxy, ns, svc)
+	return fmt.Sprintf("http://%s/api/v1/namespaces/%s/services/http:%s:/proxy/", addr, ns, svc)
 }
 
 // checkURL checks if a URL returns 200 HTTP OK

cmd/minikube/cmd/delete.go

@@ -86,8 +86,8 @@ type DeletionError struct {
 	Errtype typeOfError
 }
 
-func (error DeletionError) Error() string {
-	return error.Err.Error()
+func (deletionError DeletionError) Error() string {
+	return deletionError.Err.Error()
 }
 
 var hostAndDirsDeleter = func(api libmachine.API, cc *config.ClusterConfig, profileName string) error {
@@ -527,11 +527,11 @@ func uninstallKubernetes(api libmachine.API, cc config.ClusterConfig, n config.N
 }
 
 // HandleDeletionErrors handles deletion errors from DeleteProfiles
-func HandleDeletionErrors(errors []error) {
-	if len(errors) == 1 {
-		handleSingleDeletionError(errors[0])
+func HandleDeletionErrors(errs []error) {
+	if len(errs) == 1 {
+		handleSingleDeletionError(errs[0])
 	} else {
-		handleMultipleDeletionErrors(errors)
+		handleMultipleDeletionErrors(errs)
 	}
 }
 
@@ -556,10 +556,10 @@ func handleSingleDeletionError(err error) {
 	}
 }
 
-func handleMultipleDeletionErrors(errors []error) {
+func handleMultipleDeletionErrors(errs []error) {
 	out.ErrT(style.Sad, "Multiple errors deleting profiles")
 
-	for _, err := range errors {
+	for _, err := range errs {
 		deletionError, ok := err.(DeletionError)
 
 		if ok {
@@ -706,14 +706,14 @@ var isMinikubeProcess = func(pid int) (bool, error) {
 // getPids opens the file at PATH and tries to read
 // one or more space separated pids
 func getPids(path string) ([]int, error) {
-	out, err := os.ReadFile(path)
+	data, err := os.ReadFile(path)
 	if err != nil {
 		return nil, errors.Wrap(err, "ReadFile")
 	}
-	klog.Infof("pidfile contents: %s", out)
+	klog.Infof("pidfile contents: %s", data)
 
 	pids := []int{}
-	strPids := strings.Fields(string(out))
+	strPids := strings.Fields(string(data))
 	for _, p := range strPids {
 		intPid, err := strconv.Atoi(p)
 		if err != nil {