Move UnknownSubcommandAction to helpers

Signed-off-by: apostasie <[email protected]>

Author: apostasie

cmd/nerdctl/apparmor_linux.go

@@ -27,7 +27,7 @@ func newApparmorCommand() *cobra.Command {
 		Annotations:   map[string]string{helpers.Category: helpers.Management},
 		Use:           "apparmor",
 		Short:         "Manage AppArmor profiles",
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/nerdctl/builder.go

@@ -35,7 +35,7 @@ func newBuilderCommand() *cobra.Command {
 		Annotations:   map[string]string{helpers.Category: helpers.Management},
 		Use:           "builder",
 		Short:         "Manage builds",
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/nerdctl/compose.go

@@ -19,14 +19,15 @@ package main
 import (
 	"github.com/spf13/cobra"
 
+	"github.com/containerd/nerdctl/v2/cmd/nerdctl/helpers"
 	"github.com/containerd/nerdctl/v2/pkg/composer"
 )
 
 func newComposeCommand() *cobra.Command {
 	var composeCommand = &cobra.Command{
 		Use:              "compose [flags] COMMAND",
 		Short:            "Compose",
-		RunE:             unknownSubcommandAction,
+		RunE:             helpers.UnknownSubcommandAction,
 		SilenceUsage:     true,
 		SilenceErrors:    true,
 		TraverseChildren: true, // required for global short hands like -f

cmd/nerdctl/container.go

@@ -27,7 +27,7 @@ func newContainerCommand() *cobra.Command {
 		Annotations:   map[string]string{helpers.Category: helpers.Management},
 		Use:           "container",
 		Short:         "Manage containers",
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/nerdctl/helpers/cobra.go

@@ -0,0 +1,43 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package helpers
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// UnknownSubcommandAction is needed to let `nerdctl system non-existent-command` fail
+// https://github.com/containerd/nerdctl/issues/487
+//
+// Ideally this should be implemented in Cobra itself.
+func UnknownSubcommandAction(cmd *cobra.Command, args []string) error {
+	if len(args) == 0 {
+		return cmd.Help()
+	}
+	// The output mimics https://github.com/spf13/cobra/blob/v1.2.1/command.go#L647-L662
+	msg := fmt.Sprintf("unknown subcommand %q for %q", args[0], cmd.Name())
+	if suggestions := cmd.SuggestionsFor(args[0]); len(suggestions) > 0 {
+		msg += "\n\nDid you mean this?\n"
+		for _, s := range suggestions {
+			msg += fmt.Sprintf("\t%v\n", s)
+		}
+	}
+	return errors.New(msg)
+}

cmd/nerdctl/image.go

@@ -27,7 +27,7 @@ func newImageCommand() *cobra.Command {
 		Annotations:   map[string]string{helpers.Category: helpers.Management},
 		Use:           "image",
 		Short:         "Manage images",
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/nerdctl/ipfs.go

@@ -27,7 +27,7 @@ func newIPFSCommand() *cobra.Command {
 		Annotations:   map[string]string{helpers.Category: helpers.Management},
 		Use:           "ipfs",
 		Short:         "Distributing images on IPFS",
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/nerdctl/ipfs_registry.go

@@ -28,7 +28,7 @@ func newIPFSRegistryCommand() *cobra.Command {
 		Use:           "registry",
 		Short:         "Manage read-only registry backed by IPFS",
 		PreRunE:       checkExperimental("ipfs"),
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}

cmd/nerdctl/main.go

@@ -234,7 +234,7 @@ Config file ($NERDCTL_TOML): %s
 		}
 		return nil
 	}
-	rootCmd.RunE = unknownSubcommandAction
+	rootCmd.RunE = helpers.UnknownSubcommandAction
 	rootCmd.AddCommand(
 		newCreateCommand(),
 		// #region Run & Exec
@@ -346,25 +346,6 @@ func globalFlags(cmd *cobra.Command) (string, []string) {
 	return args0, args
 }
 
-// unknownSubcommandAction is needed to let `nerdctl system non-existent-command` fail
-// https://github.com/containerd/nerdctl/issues/487
-//
-// Ideally this should be implemented in Cobra itself.
-func unknownSubcommandAction(cmd *cobra.Command, args []string) error {
-	if len(args) == 0 {
-		return cmd.Help()
-	}
-	// The output mimics https://github.com/spf13/cobra/blob/v1.2.1/command.go#L647-L662
-	msg := fmt.Sprintf("unknown subcommand %q for %q", args[0], cmd.Name())
-	if suggestions := cmd.SuggestionsFor(args[0]); len(suggestions) > 0 {
-		msg += "\n\nDid you mean this?\n"
-		for _, s := range suggestions {
-			msg += fmt.Sprintf("\t%v\n", s)
-		}
-	}
-	return errors.New(msg)
-}
-
 // AddStringFlag is similar to cmd.Flags().String but supports aliases and env var
 func AddStringFlag(cmd *cobra.Command, name string, aliases []string, value string, env, usage string) {
 	if env != "" {

cmd/nerdctl/namespace.go

@@ -40,7 +40,7 @@ func newNamespaceCommand() *cobra.Command {
 		Aliases:       []string{"ns"},
 		Short:         "Manage containerd namespaces",
 		Long:          "Unrelated to Linux namespaces and Kubernetes namespaces",
-		RunE:          unknownSubcommandAction,
+		RunE:          helpers.UnknownSubcommandAction,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}