Print a warning on an unrecognised CDI hook

Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>

Author: ArangoGutierrez

cmd/nvidia-cdi-hook/commands/commands.go

@@ -17,6 +17,9 @@
 package commands
 
 import (
+	"context"
+	"strings"
+
 	"github.com/urfave/cli/v3"
 
 	"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/chmod"
@@ -51,3 +54,46 @@ func IssueUnsupportedHookWarning(logger logger.Interface, c *cli.Command) {
 		logger.Warningf("Unsupported CDI hook: %v", args[0])
 	}
 }
+
+// ConfigureCDIHookCommand configures a base command with supported CDI
+// hooks and error handling for unsupported hooks.
+func ConfigureCDIHookCommand(base *cli.Command, logger logger.Interface) *cli.Command {
+	// We set the default action for the command to issue a warning and
+	// exit with no error.
+	// This means that if an unsupported hook is run, a container will not
+	// fail to launch. An unsupported hook could be the result of a CDI
+	// specification referring to a new hook that is not yet supported by an
+	// older NVIDIA Container Toolkit version or a hook that has been removed
+	// in newer version.
+	base.Action = func(ctx context.Context, cmd *cli.Command) error {
+		IssueUnsupportedHookWarning(logger, cmd)
+		return nil
+	}
+	// Handle unrecognized commands when help is requested (e.g., help
+	// unknowncommand)
+	base.CommandNotFound = func(ctx context.Context, cmd *cli.Command, commandName string) {
+		IssueUnsupportedHookWarning(logger, cmd)
+	}
+	// Handle usage errors. For unrecognized commands with flags, we suppress
+	// the error to maintain backwards compatibility.
+	base.OnUsageError = func(ctx context.Context, cmd *cli.Command, err error, isSubcommand bool) error {
+		// If this is a flag parsing error for an unrecognized command,
+		// suppress it and let the default Action handle it
+		errMsg := err.Error()
+		if strings.HasPrefix(errMsg, "flag provided but not defined: -") {
+			// Check if the first argument is an unrecognized command
+			args := cmd.Args().Slice()
+			if len(args) > 0 && cmd.Command(args[0]) == nil {
+				// This is an unrecognized hook with flags - issue a warning
+				// and let the default Action handle it
+				logger.Warningf("Unsupported CDI hook: %v", args[0])
+				return nil
+			}
+		}
+		// For other usage errors, return the error as-is
+		return err
+	}
+	base.Commands = New(logger)
+
+	return base
+}

cmd/nvidia-cdi-hook/main.go

@@ -61,19 +61,6 @@ func main() {
 			logger.SetLevel(logLevel)
 			return ctx, nil
 		},
-		// We set the default action for the `nvidia-cdi-hook` command to issue a
-		// warning and exit with no error.
-		// This means that if an unsupported hook is run, a container will not fail
-		// to launch. An unsupported hook could be the result of a CDI specification
-		// referring to a new hook that is not yet supported by an older NVIDIA
-		// Container Toolkit version or a hook that has been removed in newer
-		// version.
-		Action: func(ctx context.Context, cmd *cli.Command) error {
-			commands.IssueUnsupportedHookWarning(logger, cmd)
-			return nil
-		},
-		// Define the subcommands
-		Commands: commands.New(logger),
 		Flags: []cli.Flag{
 			&cli.BoolFlag{
 				Name:        "debug",
@@ -92,6 +79,7 @@ func main() {
 			},
 		},
 	}
+	commands.ConfigureCDIHookCommand(&c, logger)
 
 	// Run the CLI
 	err := c.Run(context.Background(), os.Args)

cmd/nvidia-ctk/hook/hook.go

@@ -17,8 +17,6 @@
 package hook
 
 import (
-	"context"
-
 	"github.com/NVIDIA/nvidia-container-toolkit/cmd/nvidia-cdi-hook/commands"
 	"github.com/NVIDIA/nvidia-container-toolkit/internal/logger"
 
@@ -39,23 +37,9 @@ func NewCommand(logger logger.Interface) *cli.Command {
 
 // build
 func (m hookCommand) build() *cli.Command {
-	// Create the 'hook' subcommand
-	hook := cli.Command{
+	hook := &cli.Command{
 		Name:  "hook",
 		Usage: "A collection of hooks that may be injected into an OCI spec",
-		// We set the default action for the `hook` subcommand to issue a
-		// warning and exit with no error.
-		// This means that if an unsupported hook is run, a container will not fail
-		// to launch. An unsupported hook could be the result of a CDI specification
-		// referring to a new hook that is not yet supported by an older NVIDIA
-		// Container Toolkit version or a hook that has been removed in newer
-		// version.
-		Action: func(ctx context.Context, cmd *cli.Command) error {
-			commands.IssueUnsupportedHookWarning(m.logger, cmd)
-			return nil
-		},
-		Commands: commands.New(m.logger),
 	}
-
-	return &hook
+	return commands.ConfigureCDIHookCommand(hook, m.logger)
 }