Skip to content

Commit

Permalink
exit with status 1 if help is called on an invalid command.
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Nephin <[email protected]>
  • Loading branch information
dnephin committed Nov 23, 2016
1 parent 1640bb2 commit bb7601a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 11 deletions.
19 changes: 19 additions & 0 deletions cli/cobra.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli

import (
"fmt"
"strings"

"github.com/spf13/cobra"
)
Expand All @@ -17,6 +18,7 @@ func SetupRootCommand(rootCmd *cobra.Command) {
rootCmd.SetUsageTemplate(usageTemplate)
rootCmd.SetHelpTemplate(helpTemplate)
rootCmd.SetFlagErrorFunc(FlagErrorFunc)
rootCmd.SetHelpCommand(helpCommand)

rootCmd.PersistentFlags().BoolP("help", "h", false, "Print usage")
rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help")
Expand All @@ -39,6 +41,23 @@ func FlagErrorFunc(cmd *cobra.Command, err error) error {
}
}

var helpCommand = &cobra.Command{
Use: "help [command]",
Short: "Help about the command",
PersistentPreRun: func(cmd *cobra.Command, args []string) {},
PersistentPostRun: func(cmd *cobra.Command, args []string) {},
RunE: func(c *cobra.Command, args []string) error {
cmd, args, e := c.Root().Find(args)
if cmd == nil || e != nil || len(args) > 0 {
return fmt.Errorf("unknown help topic: %v", strings.Join(args, " "))
}

helpFunc := cmd.HelpFunc()
helpFunc(cmd, args)
return nil
},
}

func hasSubCommands(cmd *cobra.Command) bool {
return len(operationSubCommands(cmd)) > 0
}
Expand Down
25 changes: 14 additions & 11 deletions cmd/docker/docker_test.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
package main

import (
"io/ioutil"
"os"
"testing"

"github.com/Sirupsen/logrus"
"github.com/docker/docker/utils"

"github.com/docker/docker/cli/command"
"github.com/docker/docker/pkg/testutil/assert"
"github.com/docker/docker/utils"
)

func TestClientDebugEnabled(t *testing.T) {
Expand All @@ -16,14 +17,16 @@ func TestClientDebugEnabled(t *testing.T) {
cmd := newDockerCommand(&command.DockerCli{})
cmd.Flags().Set("debug", "true")

if err := cmd.PersistentPreRunE(cmd, []string{}); err != nil {
t.Fatalf("Unexpected error: %s", err.Error())
}
err := cmd.PersistentPreRunE(cmd, []string{})
assert.NilError(t, err)
assert.Equal(t, os.Getenv("DEBUG"), "1")
assert.Equal(t, logrus.GetLevel(), logrus.DebugLevel)
}

if os.Getenv("DEBUG") != "1" {
t.Fatal("expected debug enabled, got false")
}
if logrus.GetLevel() != logrus.DebugLevel {
t.Fatalf("expected logrus debug level, got %v", logrus.GetLevel())
}
func TestExitStatusForInvalidSubcommandWithHelpFlag(t *testing.T) {
discard := ioutil.Discard
cmd := newDockerCommand(command.NewDockerCli(os.Stdin, discard, discard))
cmd.SetArgs([]string{"help", "invalid"})
err := cmd.Execute()
assert.Error(t, err, "unknown help topic: invalid")
}

0 comments on commit bb7601a

Please sign in to comment.