Skip to content

Commit

Permalink
Fix incorrect merge of pflag.CommandLine to cmd.Flags()
Browse files Browse the repository at this point in the history
Fix #443
  • Loading branch information
n10v committed May 12, 2017
1 parent 3454e0e commit 7d22e77
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
4 changes: 2 additions & 2 deletions cobra_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1150,12 +1150,12 @@ func TestGlobalNormFuncPropagation(t *testing.T) {

func TestFlagOnPflagCommandLine(t *testing.T) {
flagName := "flagOnCommandLine"
pflag.CommandLine.String(flagName, "", "about my flag")
pflag.String(flagName, "", "about my flag")
r := fullSetupTest("--help")

checkResultContains(t, r, flagName)

// reset CommandLine flagset
// Reset pflag.CommandLine flagset.
pflag.CommandLine = pflag.NewFlagSet(os.Args[0], pflag.ExitOnError)
}

Expand Down
2 changes: 1 addition & 1 deletion command.go
Original file line number Diff line number Diff line change
Expand Up @@ -1275,8 +1275,8 @@ func (c *Command) Parent() *Command {
// mergePersistentFlags merges c.PersistentFlags() to c.Flags()
// and adds missing persistent flags of all parents.
func (c *Command) mergePersistentFlags() {
c.Flags().AddFlagSet(c.PersistentFlags())
c.updateParentsPflags()
c.Flags().AddFlagSet(c.PersistentFlags())
c.Flags().AddFlagSet(c.parentsPflags)
}

Expand Down
26 changes: 21 additions & 5 deletions command_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ func TestFlagErrorFunc(t *testing.T) {

// TestSortedFlags checks,
// if cmd.LocalFlags() is unsorted when cmd.Flags().SortFlags set to false.
// https://github.com/spf13/cobra/issues/404
// Related to https://github.com/spf13/cobra/issues/404.
func TestSortedFlags(t *testing.T) {
cmd := &Command{}
cmd.Flags().SortFlags = false
Expand Down Expand Up @@ -263,13 +263,13 @@ func isStringInStringSlice(s string, ss []string) bool {
// TestHelpFlagInHelp checks,
// if '--help' flag is shown in help for child (executing `parent help child`),
// that has no other flags.
// https://github.com/spf13/cobra/issues/302
// Related to https://github.com/spf13/cobra/issues/302.
func TestHelpFlagInHelp(t *testing.T) {
output := new(bytes.Buffer)
parent := &Command{Use: "parent", Long: "long", Run: func(*Command, []string) { return }}
parent := &Command{Use: "parent", Run: func(*Command, []string) {}}
parent.SetOutput(output)

child := &Command{Use: "child", Long: "long", Run: func(*Command, []string) { return }}
child := &Command{Use: "child", Run: func(*Command, []string) {}}
parent.AddCommand(child)

parent.SetArgs([]string{"help", "child"})
Expand All @@ -279,6 +279,22 @@ func TestHelpFlagInHelp(t *testing.T) {
}

if !strings.Contains(output.String(), "[flags]") {
t.Fatalf("\nExpecting to contain: %v\nGot: %v", "[flags]", output.String())
t.Errorf("\nExpecting to contain: %v\nGot: %v", "[flags]", output.String())
}
}

// TestMergeCommandLineToFlags checks,
// if pflag.CommandLine is correctly merged to c.Flags() after first call
// of c.mergePersistentFlags.
// Related to https://github.com/spf13/cobra/issues/443.
func TestMergeCommandLineToFlags(t *testing.T) {
pflag.Bool("boolflag", false, "")
c := &Command{Use: "c", Run: func(*Command, []string) {}}
c.mergePersistentFlags()
if c.Flags().Lookup("boolflag") == nil {
t.Fatal("Expecting to have flag from CommandLine in c.Flags()")
}

// Reset pflag.CommandLine flagset.
pflag.CommandLine = pflag.NewFlagSet(os.Args[0], pflag.ExitOnError)
}

0 comments on commit 7d22e77

Please sign in to comment.