fix(kumactl) Only warn about version compatibility where it makes sense

Warn for: apply, config, delete, generate, get, inspect Don't warn for: completion, install, uninstall, version Signed-off-by: Michael Beaumont <mjboamail@gmail.com>
kumahq · Sep 24, 2021 · 667c3d2 · 667c3d2
1 parent bbe7b6b
commit 667c3d2
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 26 deletions.
diff --git a/app/kumactl/cmd/apply/apply.go b/app/kumactl/cmd/apply/apply.go
@@ -57,6 +57,10 @@ Apply a resource from external URL
 $ kumactl apply -f https://example.com/resource.yaml
 `,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if err := pctx.CheckServerVersionCompatibility(); err != nil {
+				cmd.PrintErrln(err)
+			}
+
 			var b []byte
 			var err error
 

diff --git a/app/kumactl/cmd/config/config.go b/app/kumactl/cmd/config/config.go
@@ -7,13 +7,22 @@ import (
 )
 
 func NewConfigCmd(pctx *kumactl_cmd.RootContext) *cobra.Command {
-	cmd := &cobra.Command{
+	configCmd := &cobra.Command{
 		Use:   "config",
 		Short: "Manage kumactl config",
 		Long:  `Manage kumactl config.`,
 	}
+	configCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
+		if err := kumactl_cmd.RunParentPreRunE(configCmd, args); err != nil {
+			return err
+		}
+		if err := pctx.CheckServerVersionCompatibility(); err != nil {
+			cmd.PrintErrln(err)
+		}
+		return nil
+	}
 	// sub-commands
-	cmd.AddCommand(newConfigViewCmd(pctx))
-	cmd.AddCommand(newConfigControlPlanesCmd(pctx))
-	return cmd
+	configCmd.AddCommand(newConfigViewCmd(pctx))
+	configCmd.AddCommand(newConfigControlPlanesCmd(pctx))
+	return configCmd
 }
diff --git a/app/kumactl/cmd/delete/delete.go b/app/kumactl/cmd/delete/delete.go
@@ -27,6 +27,10 @@ func NewDeleteCmd(pctx *kumactl_cmd.RootContext) *cobra.Command {
 		Long:  `Delete Kuma resources.`,
 		Args:  cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if err := pctx.CheckServerVersionCompatibility(); err != nil {
+				cmd.PrintErrln(err)
+			}
+
 			resourceTypeArg := args[0]
 			name := args[1]
 

diff --git a/app/kumactl/cmd/generate/generate.go b/app/kumactl/cmd/generate/generate.go
@@ -7,14 +7,23 @@ import (
 )
 
 func NewGenerateCmd(pctx *kumactl_cmd.RootContext) *cobra.Command {
-	cmd := &cobra.Command{
+	generateCmd := &cobra.Command{
 		Use:   "generate",
 		Short: "Generate resources, tokens, etc",
 		Long:  `Generate resources, tokens, etc.`,
 	}
+	generateCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
+		if err := kumactl_cmd.RunParentPreRunE(generateCmd, args); err != nil {
+			return err
+		}
+		if err := pctx.CheckServerVersionCompatibility(); err != nil {
+			cmd.PrintErrln(err)
+		}
+		return nil
+	}
 	// sub-commands
-	cmd.AddCommand(NewGenerateDataplaneTokenCmd(pctx))
-	cmd.AddCommand(NewGenerateZoneIngressTokenCmd(pctx))
-	cmd.AddCommand(NewGenerateCertificateCmd(pctx))
-	return cmd
+	generateCmd.AddCommand(NewGenerateDataplaneTokenCmd(pctx))
+	generateCmd.AddCommand(NewGenerateZoneIngressTokenCmd(pctx))
+	generateCmd.AddCommand(NewGenerateCertificateCmd(pctx))
+	return generateCmd
 }
diff --git a/app/kumactl/cmd/get/get.go b/app/kumactl/cmd/get/get.go
@@ -11,18 +11,27 @@ import (
 )
 
 func NewGetCmd(pctx *kumactl_cmd.RootContext) *cobra.Command {
-	cmd := &cobra.Command{
+	getCmd := &cobra.Command{
 		Use:   "get",
 		Short: "Show Kuma resources",
 		Long:  `Show Kuma resources.`,
 	}
+	getCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
+		if err := kumactl_cmd.RunParentPreRunE(getCmd, args); err != nil {
+			return err
+		}
+		if err := pctx.CheckServerVersionCompatibility(); err != nil {
+			cmd.PrintErrln(err)
+		}
+		return nil
+	}
 	// flags
-	cmd.PersistentFlags().StringVarP(&pctx.GetContext.Args.OutputFormat, "output", "o", string(output.TableFormat), kuma_cmd.UsageOptions("output format", output.TableFormat, output.YAMLFormat, output.JSONFormat))
+	getCmd.PersistentFlags().StringVarP(&pctx.GetContext.Args.OutputFormat, "output", "o", string(output.TableFormat), kuma_cmd.UsageOptions("output format", output.TableFormat, output.YAMLFormat, output.JSONFormat))
 	for _, cmdInst := range pctx.Runtime.Registry.ObjectDescriptors(model.HasKumactlEnabled()) {
-		cmd.AddCommand(WithPaginationArgs(NewGetResourcesCmd(pctx, cmdInst), &pctx.ListContext))
-		cmd.AddCommand(NewGetResourceCmd(pctx, cmdInst))
+		getCmd.AddCommand(WithPaginationArgs(NewGetResourcesCmd(pctx, cmdInst), &pctx.ListContext))
+		getCmd.AddCommand(NewGetResourceCmd(pctx, cmdInst))
 	}
-	return cmd
+	return getCmd
 }
 
 func WithPaginationArgs(cmd *cobra.Command, ctx *get_context.ListContext) *cobra.Command {

diff --git a/app/kumactl/cmd/inspect/inspect.go b/app/kumactl/cmd/inspect/inspect.go
@@ -9,18 +9,27 @@ import (
 )
 
 func NewInspectCmd(pctx *kumactl_cmd.RootContext) *cobra.Command {
-	cmd := &cobra.Command{
+	inspectCmd := &cobra.Command{
 		Use:   "inspect",
 		Short: "Inspect Kuma resources",
 		Long:  `Inspect Kuma resources.`,
 	}
+	inspectCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error {
+		if err := kumactl_cmd.RunParentPreRunE(inspectCmd, args); err != nil {
+			return err
+		}
+		if err := pctx.CheckServerVersionCompatibility(); err != nil {
+			cmd.PrintErrln(err)
+		}
+		return nil
+	}
 	// flags
-	cmd.PersistentFlags().StringVarP(&pctx.InspectContext.Args.OutputFormat, "output", "o", string(output.TableFormat), kuma_cmd.UsageOptions("output format", output.TableFormat, output.YAMLFormat, output.JSONFormat))
+	inspectCmd.PersistentFlags().StringVarP(&pctx.InspectContext.Args.OutputFormat, "output", "o", string(output.TableFormat), kuma_cmd.UsageOptions("output format", output.TableFormat, output.YAMLFormat, output.JSONFormat))
 	// sub-commands
-	cmd.AddCommand(newInspectDataplanesCmd(pctx))
-	cmd.AddCommand(newInspectZoneIngressesCmd(pctx))
-	cmd.AddCommand(newInspectZonesCmd(pctx))
-	cmd.AddCommand(newInspectMeshesCmd(pctx))
-	cmd.AddCommand(newInspectServicesCmd(pctx))
-	return cmd
+	inspectCmd.AddCommand(newInspectDataplanesCmd(pctx))
+	inspectCmd.AddCommand(newInspectZoneIngressesCmd(pctx))
+	inspectCmd.AddCommand(newInspectZonesCmd(pctx))
+	inspectCmd.AddCommand(newInspectMeshesCmd(pctx))
+	inspectCmd.AddCommand(newInspectServicesCmd(pctx))
+	return inspectCmd
 }
diff --git a/app/kumactl/cmd/root.go b/app/kumactl/cmd/root.go
@@ -66,10 +66,6 @@ func NewRootCmd(root *kumactl_cmd.RootContext) *cobra.Command {
 				return err
 			}
 
-			if err := root.CheckServerVersionCompatibility(); err != nil {
-				cmd.PrintErrln(err)
-			}
-
 			return nil
 		},
 	}

diff --git a/app/kumactl/pkg/cmd/util.go b/app/kumactl/pkg/cmd/util.go
@@ -0,0 +1,16 @@
+package cmd
+
+import "github.com/spf13/cobra"
+
+// RunParentPreRunE checks if the parent command has a PersistentPreRunE set and
+// executes it. This is for use in PersistentPreRun and is necessary because
+// only the first PersistentPreRun* of the command's ancestors is executed by
+// cobra.
+func RunParentPreRunE(cmd *cobra.Command, args []string) error {
+	if p := cmd.Parent(); p != nil && p.PersistentPreRunE != nil {
+		if err := p.PersistentPreRunE(p, args); err != nil {
+			return err
+		}
+	}
+	return nil
+}