Merge pull request #3457 from xrstf/improve-lint

Improve linting config

Author: kcp-ci-bot

.golangci.yaml

@@ -14,13 +14,15 @@ linters:
     - durationcheck
     - errcheck
     - errchkjson
+    - fatcontext
     - gocritic
     - godot
     - goprintffuncname
     - gosec
     - govet
     - importas
     - ineffassign
+    - intrange
     - misspell
     - nilerr
     - noctx
@@ -41,25 +43,18 @@ linters:
       disabled-checks:
         - appendAssign
         - dupImport # https://github.com/go-critic/go-critic/issues/845
-        - evalOrder
         - ifElseChain
         - octalLiteral
-        - regexpSimplify
-        - sloppyReassign
-        - truncateCmp
         - typeDefFirst
         - unnamedResult
-        - unnecessaryDefer
         - whyNoLint
-        - wrapperFunc
         - unnecessaryBlock
         - rangeValCopy
         - hugeParam
         - commentedOutCode
         - emptyStringTest
         - singleCaseSwitch
         - nestingReduce
-        - filepathJoin
         - tooManyResultsChecker
       enabled-tags:
         - diagnostic
@@ -83,7 +78,7 @@ linters:
       require-specific: true
       allow-unused: false
     revive:
-    # make sure error-strings issues actually surface (default confidence is 0.8)
+      # make sure error-strings issues actually surface (default confidence is 0.8)
       confidence: 0.6
       rules:
         - name: context-keys-type
@@ -121,22 +116,12 @@ linters:
       - legacy
       - std-error-handling
     rules:
-      - linters:
-          - unparam
-        text: always receives
-      - linters:
-          - gosec
-        path: _test\.go
-        text: 'G112: Potential Slowloris Attack because ReadHeaderTimeout is not configured in the http.Server'
       - linters:
           - gosec
         path: test/e2e/*
-      - linters:
-          - goconst
-        path: (.+)_test\.go
       - linters:
           - staticcheck
-        text: QF1008
+        text: QF1008 # "could remove embedded field" often impedes readability and clarity
     paths:
       - third_party$
       - builtin$

cmd/sharded-test-server/cache.go

@@ -136,7 +136,7 @@ func startCacheServer(ctx context.Context, logDirPath, workingDir, hostIP string
 				},
 				CurrentContext: "cache",
 			}
-			if err = clientcmd.WriteToFile(cacheServerKubeConfig, cacheKubeconfigPath); err != nil {
+			if err := clientcmd.WriteToFile(cacheServerKubeConfig, cacheKubeconfigPath); err != nil {
 				return nil, "", err
 			}
 		}

cmd/sharded-test-server/frontproxy.go

@@ -79,17 +79,17 @@ func startFrontProxy(
 			Path: "/services/",
 			// TODO: support multiple virtual workspace backend servers
 			Backend:         fmt.Sprintf("https://localhost:%s", vwPort),
-			BackendServerCA: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
-			ProxyClientCert: filepath.Join(workDirPath, ".kcp-front-proxy/requestheader.crt"),
-			ProxyClientKey:  filepath.Join(workDirPath, ".kcp-front-proxy/requestheader.key"),
+			BackendServerCA: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
+			ProxyClientCert: filepath.Join(workDirPath, ".kcp-front-proxy", "requestheader.crt"),
+			ProxyClientKey:  filepath.Join(workDirPath, ".kcp-front-proxy", "requestheader.key"),
 		},
 		{
 			Path: "/clusters/",
 			// TODO: support multiple shard backend servers
 			Backend:         "https://localhost:6444",
-			BackendServerCA: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
-			ProxyClientCert: filepath.Join(workDirPath, ".kcp-front-proxy/requestheader.crt"),
-			ProxyClientKey:  filepath.Join(workDirPath, ".kcp-front-proxy/requestheader.key"),
+			BackendServerCA: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
+			ProxyClientCert: filepath.Join(workDirPath, ".kcp-front-proxy", "requestheader.crt"),
+			ProxyClientKey:  filepath.Join(workDirPath, ".kcp-front-proxy", "requestheader.key"),
 		},
 	}
 
@@ -98,13 +98,13 @@ func startFrontProxy(
 		return fmt.Errorf("error marshaling mappings yaml: %w", err)
 	}
 
-	if err := os.WriteFile(filepath.Join(workDirPath, ".kcp-front-proxy/mapping.yaml"), mappingsYAML, 0644); err != nil {
+	if err := os.WriteFile(filepath.Join(workDirPath, ".kcp-front-proxy", "mapping.yaml"), mappingsYAML, 0644); err != nil {
 		return fmt.Errorf("failed to create front-proxy mapping.yaml: %w", err)
 	}
 
 	// write root shard kubeconfig
 	configLoader := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(
-		&clientcmd.ClientConfigLoadingRules{ExplicitPath: filepath.Join(workDirPath, ".kcp-0/admin.kubeconfig")},
+		&clientcmd.ClientConfigLoadingRules{ExplicitPath: filepath.Join(workDirPath, ".kcp-0", "admin.kubeconfig")},
 		&clientcmd.ConfigOverrides{CurrentContext: "shard-base"},
 	)
 	raw, err := configLoader.RawConfig()
@@ -115,31 +115,31 @@ func startFrontProxy(
 	if err := clientcmdapi.MinifyConfig(&raw); err != nil {
 		return err
 	}
-	if err := clientcmd.WriteToFile(raw, filepath.Join(workDirPath, ".kcp/root.kubeconfig")); err != nil {
+	if err := clientcmd.WriteToFile(raw, filepath.Join(workDirPath, ".kcp", "root.kubeconfig")); err != nil {
 		return err
 	}
 
 	// create serving cert
-	hostnames := sets.New[string]("localhost", hostIP)
+	hostnames := sets.New("localhost", hostIP)
 	logger.Info("creating kcp-front-proxy serving cert with hostnames", "hostnames", hostnames)
 	cert, err := servingCA.MakeServerCert(hostnames, 365)
 	if err != nil {
 		return fmt.Errorf("failed to create server cert: %w", err)
 	}
-	if err := cert.WriteCertConfigFile(filepath.Join(workDirPath, ".kcp-front-proxy/apiserver.crt"), filepath.Join(workDirPath, ".kcp-front-proxy/apiserver.key")); err != nil {
+	if err := cert.WriteCertConfigFile(filepath.Join(workDirPath, ".kcp-front-proxy", "apiserver.crt"), filepath.Join(workDirPath, ".kcp-front-proxy", "apiserver.key")); err != nil {
 		return fmt.Errorf("failed to write server cert: %w", err)
 	}
 
 	// run front-proxy command
 	commandLine := append(kcptestingserver.Command("kcp-front-proxy", "front-proxy"),
 		"--bind-address="+hostIP,
-		fmt.Sprintf("--mapping-file=%s", filepath.Join(workDirPath, ".kcp-front-proxy/mapping.yaml")),
+		fmt.Sprintf("--mapping-file=%s", filepath.Join(workDirPath, ".kcp-front-proxy", "mapping.yaml")),
 		fmt.Sprintf("--root-directory=%s", filepath.Join(workDirPath, ".kcp-front-proxy")),
-		fmt.Sprintf("--root-kubeconfig=%s", filepath.Join(workDirPath, ".kcp/root.kubeconfig")),
-		fmt.Sprintf("--shards-kubeconfig=%s", filepath.Join(workDirPath, ".kcp-front-proxy/shards.kubeconfig")),
-		fmt.Sprintf("--client-ca-file=%s", filepath.Join(workDirPath, ".kcp/client-ca.crt")),
-		fmt.Sprintf("--tls-cert-file=%s", filepath.Join(workDirPath, ".kcp-front-proxy/apiserver.crt")),
-		fmt.Sprintf("--tls-private-key-file=%s", filepath.Join(workDirPath, ".kcp-front-proxy/apiserver.key")),
+		fmt.Sprintf("--root-kubeconfig=%s", filepath.Join(workDirPath, ".kcp", "root.kubeconfig")),
+		fmt.Sprintf("--shards-kubeconfig=%s", filepath.Join(workDirPath, ".kcp-front-proxy", "shards.kubeconfig")),
+		fmt.Sprintf("--client-ca-file=%s", filepath.Join(workDirPath, ".kcp", "client-ca.crt")),
+		fmt.Sprintf("--tls-cert-file=%s", filepath.Join(workDirPath, ".kcp-front-proxy", "apiserver.crt")),
+		fmt.Sprintf("--tls-private-key-file=%s", filepath.Join(workDirPath, ".kcp-front-proxy", "apiserver.key")),
 		"--secure-port=6443",
 		"--v=4",
 	)
@@ -148,7 +148,7 @@ func startFrontProxy(
 
 	cmd := exec.CommandContext(ctx, commandLine[0], commandLine[1:]...) //nolint:gosec
 
-	logFilePath := filepath.Join(workDirPath, ".kcp-front-proxy/proxy.log")
+	logFilePath := filepath.Join(workDirPath, ".kcp-front-proxy", "proxy.log")
 	if logDirPath != "" {
 		logFilePath = filepath.Join(logDirPath, "kcp-front-proxy.log")
 	}
@@ -204,7 +204,7 @@ func startFrontProxy(
 		}
 
 		// intentionally load again every iteration because it can change
-		configLoader := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(&clientcmd.ClientConfigLoadingRules{ExplicitPath: filepath.Join(workDirPath, ".kcp/admin.kubeconfig")},
+		configLoader := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(&clientcmd.ClientConfigLoadingRules{ExplicitPath: filepath.Join(workDirPath, ".kcp", "admin.kubeconfig")},
 			&clientcmd.ConfigOverrides{CurrentContext: "base"},
 		)
 		config, err := configLoader.ClientConfig()
@@ -249,7 +249,7 @@ func scrapeMetrics(ctx context.Context, cfg *rest.Config, workDir string) error
 	if !set || promUrl == "" {
 		return nil
 	}
-	return kcptestingserver.ScrapeMetrics(ctx, cfg, promUrl, workDir, "kcp-front-proxy", filepath.Join(workDir, ".kcp-front-proxy/apiserver.crt"), map[string]string{
+	return kcptestingserver.ScrapeMetrics(ctx, cfg, promUrl, workDir, "kcp-front-proxy", filepath.Join(workDir, ".kcp-front-proxy", "apiserver.crt"), map[string]string{
 		"server": "kcp-front-proxy",
 	})
 }
@@ -260,18 +260,18 @@ func writeAdminKubeConfig(hostIP string, workDirPath string) error {
 	var kubeConfig clientcmdapi.Config
 	kubeConfig.AuthInfos = map[string]*clientcmdapi.AuthInfo{
 		"kcp-admin": {
-			ClientKey:         filepath.Join(workDirPath, ".kcp/kcp-admin.key"),
-			ClientCertificate: filepath.Join(workDirPath, ".kcp/kcp-admin.crt"),
+			ClientKey:         filepath.Join(workDirPath, ".kcp", "kcp-admin.key"),
+			ClientCertificate: filepath.Join(workDirPath, ".kcp", "kcp-admin.crt"),
 		},
 	}
 	kubeConfig.Clusters = map[string]*clientcmdapi.Cluster{
 		"root": {
 			Server:               baseHost + "/clusters/root",
-			CertificateAuthority: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
+			CertificateAuthority: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
 		},
 		"base": {
 			Server:               baseHost,
-			CertificateAuthority: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
+			CertificateAuthority: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
 		},
 	}
 	kubeConfig.Contexts = map[string]*clientcmdapi.Context{
@@ -284,20 +284,20 @@ func writeAdminKubeConfig(hostIP string, workDirPath string) error {
 		return err
 	}
 
-	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp/admin.kubeconfig"))
+	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp", "admin.kubeconfig"))
 }
 
 func writeShardKubeConfig(workDirPath string) error {
 	var kubeConfig clientcmdapi.Config
 	kubeConfig.AuthInfos = map[string]*clientcmdapi.AuthInfo{
 		"shard-admin": {
-			ClientKey:         filepath.Join(workDirPath, ".kcp-front-proxy/shard-admin.key"),
-			ClientCertificate: filepath.Join(workDirPath, ".kcp-front-proxy/shard-admin.crt"),
+			ClientKey:         filepath.Join(workDirPath, ".kcp-front-proxy", "shard-admin.key"),
+			ClientCertificate: filepath.Join(workDirPath, ".kcp-front-proxy", "shard-admin.crt"),
 		},
 	}
 	kubeConfig.Clusters = map[string]*clientcmdapi.Cluster{
 		"base": {
-			CertificateAuthority: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
+			CertificateAuthority: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
 		},
 	}
 	kubeConfig.Contexts = map[string]*clientcmdapi.Context{
@@ -309,7 +309,7 @@ func writeShardKubeConfig(workDirPath string) error {
 		return err
 	}
 
-	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp-front-proxy/shards.kubeconfig"))
+	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp-front-proxy", "shards.kubeconfig"))
 }
 
 func writeLogicalClusterAdminKubeConfig(hostIP, workDirPath string) error {
@@ -321,14 +321,14 @@ func writeLogicalClusterAdminKubeConfig(hostIP, workDirPath string) error {
 	var kubeConfig clientcmdapi.Config
 	kubeConfig.AuthInfos = map[string]*clientcmdapi.AuthInfo{
 		"logical-cluster-admin": {
-			ClientKey:         filepath.Join(workDirPath, ".kcp/logical-cluster-admin.key"),
-			ClientCertificate: filepath.Join(workDirPath, ".kcp/logical-cluster-admin.crt"),
+			ClientKey:         filepath.Join(workDirPath, ".kcp", "logical-cluster-admin.key"),
+			ClientCertificate: filepath.Join(workDirPath, ".kcp", "logical-cluster-admin.crt"),
 		},
 	}
 	kubeConfig.Clusters = map[string]*clientcmdapi.Cluster{
 		"base": {
 			Server:               baseHost,
-			CertificateAuthority: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
+			CertificateAuthority: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
 		},
 	}
 	kubeConfig.Contexts = map[string]*clientcmdapi.Context{
@@ -340,7 +340,7 @@ func writeLogicalClusterAdminKubeConfig(hostIP, workDirPath string) error {
 		return err
 	}
 
-	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp/logical-cluster-admin.kubeconfig"))
+	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp", "logical-cluster-admin.kubeconfig"))
 }
 
 func writeExternalLogicalClusterAdminKubeConfig(hostIP, workDirPath string) error {
@@ -350,14 +350,14 @@ func writeExternalLogicalClusterAdminKubeConfig(hostIP, workDirPath string) erro
 	var kubeConfig clientcmdapi.Config
 	kubeConfig.AuthInfos = map[string]*clientcmdapi.AuthInfo{
 		"external-logical-cluster-admin": {
-			ClientKey:         filepath.Join(workDirPath, ".kcp/external-logical-cluster-admin.key"),
-			ClientCertificate: filepath.Join(workDirPath, ".kcp/external-logical-cluster-admin.crt"),
+			ClientKey:         filepath.Join(workDirPath, ".kcp", "external-logical-cluster-admin.key"),
+			ClientCertificate: filepath.Join(workDirPath, ".kcp", "external-logical-cluster-admin.crt"),
 		},
 	}
 	kubeConfig.Clusters = map[string]*clientcmdapi.Cluster{
 		"base": {
 			Server:               baseHost,
-			CertificateAuthority: filepath.Join(workDirPath, ".kcp/serving-ca.crt"),
+			CertificateAuthority: filepath.Join(workDirPath, ".kcp", "serving-ca.crt"),
 		},
 	}
 	kubeConfig.Contexts = map[string]*clientcmdapi.Context{
@@ -369,5 +369,5 @@ func writeExternalLogicalClusterAdminKubeConfig(hostIP, workDirPath string) erro
 		return err
 	}
 
-	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp/external-logical-cluster-admin.kubeconfig"))
+	return clientcmd.WriteToFile(kubeConfig, filepath.Join(workDirPath, ".kcp", "external-logical-cluster-admin.kubeconfig"))
 }