Merge 5452222cb4 into f576d29563

cobra_test.go

@@ -23,33 +23,44 @@ const strtwoParentHelp = "help message for parent flag strtwo"
 const strtwoChildHelp = "help message for child flag strtwo"
 
 var cmdPrint = &Command{
-	Use:   "print [string to print]",
+	Use:       "print [string to print]",
-	Short: "Print anything to the screen",
+	Short:     "Print anything to the screen",
-	Long:  `an absolutely utterly useless command for testing.`,
+	Long:      `an absolutely utterly useless command for testing.`,
+	TakesArgs: true,
 	Run: func(cmd *Command, args []string) {
 		tp = args
 	},
 }
 
 var cmdEcho = &Command{
-	Use:     "echo [string to echo]",
+	Use:       "echo [string to echo]",
-	Aliases: []string{"say"},
+	Aliases:   []string{"say"},
-	Short:   "Echo anything to the screen",
+	Short:     "Echo anything to the screen",
-	Long:    `an utterly useless command for testing.`,
+	Long:      `an utterly useless command for testing.`,
+	TakesArgs: true,
 	Run: func(cmd *Command, args []string) {
 		te = args
 	},
 }
 
 var cmdTimes = &Command{
-	Use:   "times [# times] [string to echo]",
+	Use:       "times [# times] [string to echo]",
-	Short: "Echo anything to the screen more times",
+	Short:     "Echo anything to the screen more times",
-	Long:  `a slightly useless command for testing.`,
+	Long:      `a slightly useless command for testing.`,
+	TakesArgs: true,
 	Run: func(cmd *Command, args []string) {
 		tt = args
 	},
 }
 
+var cmdNoArgs = &Command{
+	Use:   "noargs [because they don't work!!]",
+	Short: "Runnable, but won't take non-flag args",
+	Long:  `something in long form, just because.`,
+	Run: func(cmd *Command, args []string) {
+	},
+}
+
 var cmdRootNoRun = &Command{
 	Use:   "cobra-test",
 	Short: "The root can run it's own function",
@@ -93,6 +104,7 @@ func flagInit() {
 	cmdEcho.ResetFlags()
 	cmdPrint.ResetFlags()
 	cmdTimes.ResetFlags()
+	cmdNoArgs.ResetFlags()
 	cmdRootNoRun.ResetFlags()
 	cmdRootSameName.ResetFlags()
 	cmdRootWithRun.ResetFlags()
@@ -187,7 +199,7 @@ func fullTester(c *Command, input string) resulter {
 	// Testing flag with invalid input
 	c.SetOutput(buf)
 	cmdEcho.AddCommand(cmdTimes)
-	c.AddCommand(cmdPrint, cmdEcho)
+	c.AddCommand(cmdPrint, cmdEcho, cmdNoArgs)
 	c.SetArgs(strings.Split(input, " "))
 
 	err := c.Execute()
@@ -557,6 +569,12 @@ func TestInvalidSubcommandWhenArgsAllowed(t *testing.T) {
 	}
 }
 
+func TestInvalidSubcommandWhenArgsDisallowed(t *testing.T) {
+	x := fullSetupTest("noargs invalid-sub")
+
+	checkResultContains(t, x, "Error: unknown command \"invalid-sub\"\n")
+}
+
 func TestRootFlags(t *testing.T) {
 	fullSetupTest("-i 17 -b")
 

command.go

@@ -44,6 +44,10 @@ type Command struct {
 	Long string
 	// Examples of how to use the command
 	Example string
+	// Accepts arguments that are not defined in flags. This makes subcommand checking and
+	// error reporting less strict as we can cannot tell if `command [arg]` is an incorrect
+	// subcommand or just an argument this command will process.
+	TakesArgs bool
 	// Full set of flags
 	flags *flag.FlagSet
 	// Set of flags childrens of this command will inherit
@@ -379,8 +383,8 @@ func (c *Command) Find(arrs []string) (*Command, []string, error) {
 
 	commandFound, a := innerfind(c, arrs)
 
-	// If we matched on the root, but we asked for a subcommand, return an error
+	// Reject if there are args left and the command doesn't take args
-	if commandFound.Name() == c.Name() && len(stripFlags(arrs, c)) > 0 && commandFound.Name() != arrs[0] {
+	if commandFound.TakesArgs == false && len(stripFlags(a, commandFound)) > 0 {
 		return nil, a, fmt.Errorf("unknown command %q", a[0])
 	}
 
@@ -527,7 +531,8 @@ func (c *Command) initHelp() {
 			Short: "Help about any command",
 			Long: `Help provides help for any command in the application.
     Simply type ` + c.Name() + ` help [path to command] for full details.`,
-			Run: c.HelpFunc(),
+			TakesArgs: true,
+			Run:       c.HelpFunc(),
 		}
 	}
 	c.AddCommand(c.helpCommand)