Skip to content

Commit

Permalink
Move checkHelptextRecursive forward a bit
Browse files Browse the repository at this point in the history
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
  • Loading branch information
magik6k committed Jan 3, 2019
1 parent d06cf14 commit bcd9d90
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 16 deletions.
51 changes: 35 additions & 16 deletions core/commands/helptext_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,48 @@ import (
)

func checkHelptextRecursive(t *testing.T, name []string, c *cmds.Command) {
if c.Helptext.Tagline == "" {
t.Errorf("%s has no tagline!", strings.Join(name, " "))
}

if c.Helptext.LongDescription == "" {
t.Errorf("%s has no long description!", strings.Join(name, " "))
}

if c.Helptext.ShortDescription == "" {
t.Errorf("%s has no short description!", strings.Join(name, " "))
}

if c.Helptext.Synopsis == "" {
t.Errorf("%s has no synopsis!", strings.Join(name, " "))
}
c.ProcessHelp()

t.Run(strings.Join(name, "_"), func(t *testing.T) {
if c.External {
t.Skip("external")
}

t.Run("tagline", func(t *testing.T) {
if c.Helptext.Tagline == "" {
t.Error("no Tagline!")
}
})

t.Run("longDescription", func(t *testing.T) {
t.Skip("not everywhere yet")
if c.Helptext.LongDescription == "" {
t.Error("no LongDescription!")
}
})

t.Run("shortDescription", func(t *testing.T) {
t.Skip("not everywhere yet")
if c.Helptext.ShortDescription == "" {
t.Error("no ShortDescription!")
}
})

t.Run("synopsis", func(t *testing.T) {
t.Skip("autogenerated in go-ipfs-cmds")
if c.Helptext.Synopsis == "" {
t.Error("no Synopsis!")
}
})
})

for subname, sub := range c.Subcommands {
checkHelptextRecursive(t, append(name, subname), sub)
}
}

func TestHelptexts(t *testing.T) {
t.Skip("sill isn't 100%")
//t.Skip("sill isn't 100%")
Root.ProcessHelp()
checkHelptextRecursive(t, []string{"ipfs"}, Root)
}
3 changes: 3 additions & 0 deletions core/commands/urlstore.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import (
)

var urlStoreCmd = &cmds.Command{
Helptext: cmdkit.HelpText{
Tagline: "Interact with urlstore.",
},
Subcommands: map[string]*cmds.Command{
"add": urlAdd,
},
Expand Down

0 comments on commit bcd9d90

Please sign in to comment.