Merge pull request #886 from lonelyCZ/cmdutil

replace err report with RunE

cmd/karmadactl/karmadactl.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"fmt"
 	"os"
 
 	"k8s.io/component-base/logs"
@@ -14,7 +13,6 @@ func main() {
 	defer logs.FlushLogs()
 
 	if err := karmadactl.NewKarmadaCtlCommand(os.Stdout, "karmadactl", "karmadactl").Execute(); err != nil {
-		fmt.Fprintf(os.Stderr, "%v\n", err)
 		os.Exit(1)
 	}
 }

pkg/karmadactl/cordon.go

@@ -12,7 +12,6 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
-	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/strategicpatch"
 	"k8s.io/klog/v2"
 
@@ -45,25 +44,19 @@ const (
 func NewCmdCordon(cmdOut io.Writer, karmadaConfig KarmadaConfig, cmdStr string) *cobra.Command {
 	opts := CommandCordonOption{}
 	cmd := &cobra.Command{
-		Use:     "cordon CLUSTER",
+		Use:          "cordon CLUSTER",
-		Short:   cordonShort,
+		Short:        cordonShort,
-		Long:    cordonLong,
+		Long:         cordonLong,
-		Example: fmt.Sprintf(cordonExample, cmdStr),
+		Example:      fmt.Sprintf(cordonExample, cmdStr),
-		Run: func(cmd *cobra.Command, args []string) {
+		SilenceUsage: true,
-			err := opts.Complete(args)
+		RunE: func(cmd *cobra.Command, args []string) error {
-			if err != nil {
+			if err := opts.Complete(args); err != nil {
-				klog.Fatalf("Error: %v", err)
+				return err
 			}
-
+			if err := RunCordonOrUncordon(cmdOut, desiredCordon, karmadaConfig, opts); err != nil {
-			if errs := opts.Validate(); len(errs) != 0 {
+				return err
-				klog.Fatalf("Error: %v", utilerrors.NewAggregate(errs).Error())
-			}
-
-			err = RunCordonOrUncordon(cmdOut, desiredCordon, karmadaConfig, opts)
-			if err != nil {
-				klog.Fatalf("Error: %v", err)
-				return
 			}
+			return nil
 		},
 	}
 
@@ -74,28 +67,19 @@ func NewCmdCordon(cmdOut io.Writer, karmadaConfig KarmadaConfig, cmdStr string)
 func NewCmdUncordon(cmdOut io.Writer, karmadaConfig KarmadaConfig, cmdStr string) *cobra.Command {
 	opts := CommandCordonOption{}
 	cmd := &cobra.Command{
-		Use:     "uncordon CLUSTER",
+		Use:          "uncordon CLUSTER",
-		Short:   uncordonShort,
+		Short:        uncordonShort,
-		Long:    uncordonLong,
+		Long:         uncordonLong,
-		Example: fmt.Sprintf(uncordonExample, cmdStr),
+		Example:      fmt.Sprintf(uncordonExample, cmdStr),
-		Run: func(cmd *cobra.Command, args []string) {
+		SilenceUsage: true,
-			// Set default values
+		RunE: func(cmd *cobra.Command, args []string) error {
-			err := opts.Complete(args)
+			if err := opts.Complete(args); err != nil {
-			if err != nil {
+				return err
-				klog.Errorf("Error: %v", err)
-				return
 			}
-
+			if err := RunCordonOrUncordon(cmdOut, desiredUnCordon, karmadaConfig, opts); err != nil {
-			if errs := opts.Validate(); len(errs) != 0 {
+				return err
-				klog.Error(utilerrors.NewAggregate(errs).Error())
-				return
-			}
-
-			err = RunCordonOrUncordon(cmdOut, desiredUnCordon, karmadaConfig, opts)
-			if err != nil {
-				klog.Errorf("Error: %v", err)
-				return
 			}
+			return nil
 		},
 	}
 
@@ -128,12 +112,6 @@ func (o *CommandCordonOption) Complete(args []string) error {
 	return nil
 }
 
-// Validate checks option and return a slice of found errs.
-func (o *CommandCordonOption) Validate() []error {
-	var errs []error
-	return errs
-}
-
 // AddFlags adds flags to the specified FlagSet.
 func (o *CommandCordonOption) AddFlags(flags *pflag.FlagSet) {
 	flags.StringVar(&o.KubeConfig, "kubeconfig", "", "Path to the control plane kubeconfig file.")

pkg/karmadactl/get.go

@@ -61,9 +61,15 @@ func NewCmdGet(out io.Writer, karmadaConfig KarmadaConfig) *cobra.Command {
 		Use:                   "get [NAME | -l label | -n namespace]  [flags]",
 		DisableFlagsInUseLine: true,
 		Short:                 getShort,
-		Run: func(cmd *cobra.Command, args []string) {
+		SilenceUsage:          true,
-			cmdutil.CheckErr(o.Complete(cmd, args))
+		RunE: func(cmd *cobra.Command, args []string) error {
-			cmdutil.CheckErr(o.Run(karmadaConfig, cmd, args))
+			if err := o.Complete(cmd, args); err != nil {
+				return err
+			}
+			if err := o.Run(karmadaConfig, cmd, args); err != nil {
+				return err
+			}
+			return nil
 		},
 	}
 	cmd.Flags().StringVarP(&o.Namespace, "namespace", "n", "default", "-n=namespace or -n namespace")

pkg/karmadactl/join.go

@@ -15,7 +15,6 @@ import (
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
-	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/wait"
 	kubeclient "k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
@@ -33,6 +32,7 @@ var (
 	joinShort   = `Register a cluster to control plane`
 	joinLong    = `Join registers a cluster to control plane.`
 	joinExample = `
+# Join cluster into karamada control plane
 %s join CLUSTER_NAME --cluster-kubeconfig=<KUBECONFIG>
 `
 )
@@ -62,25 +62,22 @@ func NewCmdJoin(cmdOut io.Writer, karmadaConfig KarmadaConfig, cmdStr string) *c
 	opts := CommandJoinOption{}
 
 	cmd := &cobra.Command{
-		Use:     "join CLUSTER_NAME --cluster-kubeconfig=<KUBECONFIG>",
+		Use:          "join CLUSTER_NAME --cluster-kubeconfig=<KUBECONFIG>",
-		Short:   joinShort,
+		Short:        joinShort,
-		Long:    joinLong,
+		Long:         joinLong,
-		Example: fmt.Sprintf(joinExample, cmdStr),
+		Example:      fmt.Sprintf(joinExample, cmdStr),
-		Run: func(cmd *cobra.Command, args []string) {
+		SilenceUsage: true,
-			// Set default values
+		RunE: func(cmd *cobra.Command, args []string) error {
-			err := opts.Complete(args)
+			if err := opts.Complete(args); err != nil {
-			if err != nil {
+				return err
-				klog.Fatalf("Error: %v", err)
 			}
-
+			if err := opts.Validate(); err != nil {
-			if errs := opts.Validate(); len(errs) != 0 {
+				return err
-				klog.Fatalf("Error: %v", utilerrors.NewAggregate(errs).Error())
 			}
-
+			if err := RunJoin(cmdOut, karmadaConfig, opts); err != nil {
-			err = RunJoin(cmdOut, karmadaConfig, opts)
+				return err
-			if err != nil {
-				klog.Fatalf("Error: %v", err)
 			}
+			return nil
 		},
 	}
 
@@ -121,13 +118,12 @@ func (j *CommandJoinOption) Complete(args []string) error {
 }
 
 // Validate checks option and return a slice of found errs.
-func (j *CommandJoinOption) Validate() []error {
+func (j *CommandJoinOption) Validate() error {
-	var errs []error
 	if errMsgs := validation.ValidateClusterName(j.ClusterName); len(errMsgs) != 0 {
-		errs = append(errs, fmt.Errorf("invalid cluster name(%s): %s", j.ClusterName, strings.Join(errMsgs, ";")))
+		return fmt.Errorf("invalid cluster name(%s): %s", j.ClusterName, strings.Join(errMsgs, ";"))
 	}
 
-	return errs
+	return nil
 }
 
 // AddFlags adds flags to the specified FlagSet.

pkg/karmadactl/unjoin.go

@@ -11,7 +11,6 @@ import (
 	"github.com/spf13/pflag"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	utilerrors "k8s.io/apimachinery/pkg/util/errors"
 	"k8s.io/apimachinery/pkg/util/wait"
 	kubeclient "k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
@@ -40,23 +39,22 @@ func NewCmdUnjoin(cmdOut io.Writer, karmadaConfig KarmadaConfig, cmdStr string)
 	opts := CommandUnjoinOption{}
 
 	cmd := &cobra.Command{
-		Use:     "unjoin CLUSTER_NAME --cluster-kubeconfig=<KUBECONFIG>",
+		Use:          "unjoin CLUSTER_NAME --cluster-kubeconfig=<KUBECONFIG>",
-		Short:   unjoinShort,
+		Short:        unjoinShort,
-		Long:    unjoinLong,
+		Long:         unjoinLong,
-		Example: getUnjoinExample(cmdStr),
+		Example:      getUnjoinExample(cmdStr),
-		Run: func(cmd *cobra.Command, args []string) {
+		SilenceUsage: true,
-			err := opts.Complete(args)
+		RunE: func(cmd *cobra.Command, args []string) error {
-			if err != nil {
+			if err := opts.Complete(args); err != nil {
-				klog.Fatalf("Error: %v", err)
+				return err
 			}
-			if errs := opts.Validate(); len(errs) != 0 {
+			if err := opts.Validate(); err != nil {
-				klog.Fatalf("Error: %v", utilerrors.NewAggregate(errs).Error())
+				return err
 			}
-
+			if err := RunUnjoin(cmdOut, karmadaConfig, opts); err != nil {
-			err = RunUnjoin(cmdOut, karmadaConfig, opts)
+				return err
-			if err != nil {
-				klog.Fatalf("Error: %v", err)
 			}
+			return nil
 		},
 	}
 
@@ -106,13 +104,11 @@ func (j *CommandUnjoinOption) Complete(args []string) error {
 }
 
 // Validate ensures that command unjoin options are valid.
-func (j *CommandUnjoinOption) Validate() []error {
+func (j *CommandUnjoinOption) Validate() error {
-	var errs []error
-
 	if j.Wait < 0 {
-		errs = append(errs, fmt.Errorf(" --wait %v  must be a positive duration, e.g. 1m0s ", j.Wait))
+		return fmt.Errorf(" --wait %v  must be a positive duration, e.g. 1m0s ", j.Wait)
 	}
-	return errs
+	return nil
 }
 
 // AddFlags adds flags to the specified FlagSet.