Merge pull request #780 from wzshiming/clean/code

Clean up some code
kubernetes-sigs · Aug 23, 2023 · d8efe2c · d8efe2c
2 parents baa0edf + bb435ba
commit d8efe2c
Show file tree

Hide file tree

Showing 22 changed files with 734 additions and 380 deletions.
diff --git a/.github/workflows/golangci-lint.yaml b/.github/workflows/golangci-lint.yaml
@@ -17,3 +17,4 @@ jobs:
         uses: golangci/golangci-lint-action@v3
         with:
           version: v1.51.2
+          args: --timeout=30m --config=.golangci.yaml
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -82,7 +82,7 @@ linters-settings:
       # Use sigs.k8s.io/kwok/pkg/utils/slices, which is a wrapper around slices
       - k8s.io/utils/strings/slices: "please use `sigs.k8s.io/kwok/pkg/utils/slices` instead"
   gocyclo:
-    min-complexity: 60
+    min-complexity: 50
   gosec:
     excludes:
       - G110

diff --git a/pkg/consts/consts.go b/pkg/consts/consts.go
@@ -74,3 +74,15 @@ const (
 	RuntimeTypePodman     = "podman"
 	RuntimeTypeBinary     = "binary"
 )
+
+// The following components is provided.
+const (
+	ComponentEtcd                  = "etcd"
+	ComponentKubeApiserver         = "kube-apiserver"
+	ComponentKubeControllerManager = "kube-controller-manager"
+	ComponentKubeScheduler         = "kube-scheduler"
+	ComponentKwokController        = "kwok-controller"
+	ComponentDashboard             = "dashboard"
+	ComponentPrometheus            = "prometheus"
+	ComponentJaeger                = "jaeger"
+)
diff --git a/pkg/kwok/server/debugging_exec.go b/pkg/kwok/server/debugging_exec.go
@@ -104,11 +104,11 @@ func (s *Server) execInContainer(ctx context.Context, cmd []string, in io.Reader
 }
 
 func (s *Server) getExecTarget(podName, podNamespace string, containerName string) (*internalversion.ExecTarget, error) {
-	pf, has := slices.Find(s.execs.Get(), func(pf *internalversion.Exec) bool {
+	e, has := slices.Find(s.execs.Get(), func(pf *internalversion.Exec) bool {
 		return pf.Name == podName && pf.Namespace == podNamespace
 	})
 	if has {
-		exec, found := findContainerInExecs(containerName, pf.Spec.Execs)
+		exec, found := findContainerInExecs(containerName, e.Spec.Execs)
 		if found {
 			return exec, nil
 		}

diff --git a/pkg/kwokctl/components/dashboard.go b/pkg/kwokctl/components/dashboard.go
@@ -18,6 +18,7 @@ package components
 
 import (
 	"sigs.k8s.io/kwok/pkg/apis/internalversion"
+	"sigs.k8s.io/kwok/pkg/consts"
 	"sigs.k8s.io/kwok/pkg/utils/format"
 	"sigs.k8s.io/kwok/pkg/utils/version"
 )
@@ -101,10 +102,10 @@ func BuildDashboardComponent(conf BuildDashboardComponentConfig) (component inte
 	}
 
 	component = internalversion.Component{
-		Name:  "dashboard",
+		Name:  consts.ComponentDashboard,
 		Image: conf.Image,
 		Links: []string{
-			"kube-apiserver",
+			consts.ComponentKubeApiserver,
 		},
 		WorkDir: conf.Workdir,
 		Ports:   ports,

diff --git a/pkg/kwokctl/components/etcd.go b/pkg/kwokctl/components/etcd.go
@@ -20,6 +20,7 @@ import (
 	"runtime"
 
 	"sigs.k8s.io/kwok/pkg/apis/internalversion"
+	"sigs.k8s.io/kwok/pkg/consts"
 	"sigs.k8s.io/kwok/pkg/log"
 	"sigs.k8s.io/kwok/pkg/utils/format"
 	"sigs.k8s.io/kwok/pkg/utils/version"
@@ -136,10 +137,10 @@ func BuildEtcdComponent(conf BuildEtcdComponentConfig) (component internalversio
 	envs = append(envs, conf.ExtraEnvs...)
 
 	return internalversion.Component{
-		Name:    "etcd",
+		Name:    consts.ComponentEtcd,
 		Version: conf.Version.String(),
 		Volumes: volumes,
-		Command: []string{"etcd"},
+		Command: []string{consts.ComponentEtcd},
 		Args:    etcdArgs,
 		Binary:  conf.Binary,
 		Ports:   ports,

diff --git a/pkg/kwokctl/components/jaeger.go b/pkg/kwokctl/components/jaeger.go
@@ -18,6 +18,7 @@ package components
 
 import (
 	"sigs.k8s.io/kwok/pkg/apis/internalversion"
+	"sigs.k8s.io/kwok/pkg/consts"
 	"sigs.k8s.io/kwok/pkg/log"
 	"sigs.k8s.io/kwok/pkg/utils/format"
 	"sigs.k8s.io/kwok/pkg/utils/net"
@@ -70,7 +71,7 @@ func BuildJaegerComponent(conf BuildJaegerComponentConfig) (component internalve
 	}
 
 	return internalversion.Component{
-		Name:    "jaeger",
+		Name:    consts.ComponentJaeger,
 		Version: conf.Version.String(),
 		Ports:   ports,
 		Volumes: volumes,

diff --git a/pkg/kwokctl/components/kube_apiserver.go b/pkg/kwokctl/components/kube_apiserver.go
@@ -21,6 +21,7 @@ import (
 	"strings"
 
 	"sigs.k8s.io/kwok/pkg/apis/internalversion"
+	"sigs.k8s.io/kwok/pkg/consts"
 	"sigs.k8s.io/kwok/pkg/log"
 	"sigs.k8s.io/kwok/pkg/utils/format"
 	"sigs.k8s.io/kwok/pkg/utils/version"
@@ -257,16 +258,16 @@ func BuildKubeApiserverComponent(conf BuildKubeApiserverComponentConfig) (compon
 	envs := []internalversion.Env{}
 	envs = append(envs, conf.ExtraEnvs...)
 
-	links := []string{"etcd"}
+	links := []string{consts.ComponentEtcd}
 	if conf.TracingConfigPath != "" {
-		links = append(links, "jaeger")
+		links = append(links, consts.ComponentJaeger)
 	}
 
 	return internalversion.Component{
-		Name:    "kube-apiserver",
+		Name:    consts.ComponentKubeApiserver,
 		Version: conf.Version.String(),
 		Links:   links,
-		Command: []string{"kube-apiserver"},
+		Command: []string{consts.ComponentKubeApiserver},
 		Ports:   ports,
 		Volumes: volumes,
 		Args:    kubeApiserverArgs,

diff --git a/pkg/kwokctl/components/kube_controller_manager.go b/pkg/kwokctl/components/kube_controller_manager.go
@@ -198,12 +198,12 @@ func BuildKubeControllerManagerComponent(conf BuildKubeControllerManagerComponen
 	envs = append(envs, conf.ExtraEnvs...)
 
 	return internalversion.Component{
-		Name:    "kube-controller-manager",
+		Name:    consts.ComponentKubeControllerManager,
 		Version: conf.Version.String(),
 		Links: []string{
-			"kube-apiserver",
+			consts.ComponentKubeApiserver,
 		},
-		Command: []string{"kube-controller-manager"},
+		Command: []string{consts.ComponentKubeControllerManager},
 		Volumes: volumes,
 		Args:    kubeControllerManagerArgs,
 		Ports:   ports,

diff --git a/pkg/kwokctl/components/kube_scheduler.go b/pkg/kwokctl/components/kube_scheduler.go
@@ -188,12 +188,12 @@ func BuildKubeSchedulerComponent(conf BuildKubeSchedulerComponentConfig) (compon
 	envs = append(envs, conf.ExtraEnvs...)
 
 	return internalversion.Component{
-		Name:    "kube-scheduler",
+		Name:    consts.ComponentKubeScheduler,
 		Version: conf.Version.String(),
 		Links: []string{
-			"kube-apiserver",
+			consts.ComponentKubeApiserver,
 		},
-		Command: []string{"kube-scheduler"},
+		Command: []string{consts.ComponentKubeScheduler},
 		Volumes: volumes,
 		Args:    kubeSchedulerArgs,
 		Binary:  conf.Binary,

diff --git a/pkg/kwokctl/components/kwok_controller.go b/pkg/kwokctl/components/kwok_controller.go
@@ -18,6 +18,7 @@ package components
 
 import (
 	"sigs.k8s.io/kwok/pkg/apis/internalversion"
+	"sigs.k8s.io/kwok/pkg/consts"
 	"sigs.k8s.io/kwok/pkg/log"
 	"sigs.k8s.io/kwok/pkg/utils/format"
 	"sigs.k8s.io/kwok/pkg/utils/version"
@@ -124,10 +125,10 @@ func BuildKwokControllerComponent(conf BuildKwokControllerComponentConfig) (comp
 	envs = append(envs, conf.ExtraEnvs...)
 
 	return internalversion.Component{
-		Name:    "kwok-controller",
+		Name:    consts.ComponentKwokController,
 		Version: conf.Version.String(),
 		Links: []string{
-			"kube-apiserver",
+			consts.ComponentKubeApiserver,
 		},
 		Ports:   ports,
 		Command: []string{"kwok"},

diff --git a/pkg/kwokctl/components/prometheus.go b/pkg/kwokctl/components/prometheus.go
@@ -18,6 +18,7 @@ package components
 
 import (
 	"sigs.k8s.io/kwok/pkg/apis/internalversion"
+	"sigs.k8s.io/kwok/pkg/consts"
 	"sigs.k8s.io/kwok/pkg/log"
 	"sigs.k8s.io/kwok/pkg/utils/format"
 	"sigs.k8s.io/kwok/pkg/utils/version"
@@ -92,16 +93,16 @@ func BuildPrometheusComponent(conf BuildPrometheusComponentConfig) (component in
 	envs = append(envs, conf.ExtraEnvs...)
 
 	return internalversion.Component{
-		Name:    "prometheus",
+		Name:    consts.ComponentPrometheus,
 		Version: conf.Version.String(),
 		Links: []string{
-			"etcd",
-			"kube-apiserver",
-			"kube-controller-manager",
-			"kube-scheduler",
-			"kwok-controller",
+			consts.ComponentEtcd,
+			consts.ComponentKubeApiserver,
+			consts.ComponentKubeControllerManager,
+			consts.ComponentKubeScheduler,
+			consts.ComponentKwokController,
 		},
-		Command: []string{"prometheus"},
+		Command: []string{consts.ComponentPrometheus},
 		Ports:   ports,
 		Volumes: volumes,
 		Args:    prometheusArgs,