mirror of
https://github.com/spf13/cobra
synced 2024-06-30 23:59:07 +00:00
5df1341f93
Just like the last commit, but now for manpages. genMan still works with a buffer and returns []byte instead of working directly with an io.Writer. This is because, in turn, md2man takes byte slices instead of readers and writers. Wrapping genMan around a writer is unnecessary especially since it's not an exported function, and also because we'd still need a buffer to get the output bytes.
98 lines
2.5 KiB
Go
98 lines
2.5 KiB
Go
package doc
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
var _ = fmt.Println
|
|
var _ = os.Stderr
|
|
|
|
func translate(in string) string {
|
|
return strings.Replace(in, "-", "\\-", -1)
|
|
}
|
|
|
|
func TestGenManDoc(t *testing.T) {
|
|
c := initializeWithRootCmd()
|
|
// Need two commands to run the command alphabetical sort
|
|
cmdEcho.AddCommand(cmdTimes, cmdEchoSub, cmdDeprecated)
|
|
c.AddCommand(cmdPrint, cmdEcho)
|
|
cmdRootWithRun.PersistentFlags().StringVarP(&flags2a, "rootflag", "r", "two", strtwoParentHelp)
|
|
|
|
out := new(bytes.Buffer)
|
|
|
|
header := &GenManHeader{
|
|
Title: "Project",
|
|
Section: "2",
|
|
}
|
|
// We generate on a subcommand so we have both subcommands and parents
|
|
if err := GenMan(cmdEcho, header, out); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
found := out.String()
|
|
|
|
// Make sure parent has - in CommandPath() in SEE ALSO:
|
|
parentPath := cmdEcho.Parent().CommandPath()
|
|
dashParentPath := strings.Replace(parentPath, " ", "-", -1)
|
|
expected := translate(dashParentPath)
|
|
expected = expected + "(" + header.Section + ")"
|
|
checkStringContains(t, found, expected)
|
|
|
|
// Our description
|
|
expected = translate(cmdEcho.Name())
|
|
checkStringContains(t, found, expected)
|
|
|
|
// Better have our example
|
|
expected = translate(cmdEcho.Name())
|
|
checkStringContains(t, found, expected)
|
|
|
|
// A local flag
|
|
expected = "boolone"
|
|
checkStringContains(t, found, expected)
|
|
|
|
// persistent flag on parent
|
|
expected = "rootflag"
|
|
checkStringContains(t, found, expected)
|
|
|
|
// We better output info about our parent
|
|
expected = translate(cmdRootWithRun.Name())
|
|
checkStringContains(t, found, expected)
|
|
|
|
// And about subcommands
|
|
expected = translate(cmdEchoSub.Name())
|
|
checkStringContains(t, found, expected)
|
|
|
|
unexpected := translate(cmdDeprecated.Name())
|
|
checkStringOmits(t, found, unexpected)
|
|
|
|
// auto generated
|
|
expected = translate("Auto generated")
|
|
checkStringContains(t, found, expected)
|
|
}
|
|
|
|
func TestGenManNoGenTag(t *testing.T) {
|
|
c := initializeWithRootCmd()
|
|
// Need two commands to run the command alphabetical sort
|
|
cmdEcho.AddCommand(cmdTimes, cmdEchoSub, cmdDeprecated)
|
|
c.AddCommand(cmdPrint, cmdEcho)
|
|
cmdRootWithRun.PersistentFlags().StringVarP(&flags2a, "rootflag", "r", "two", strtwoParentHelp)
|
|
cmdEcho.DisableAutoGenTag = true
|
|
out := new(bytes.Buffer)
|
|
|
|
header := &GenManHeader{
|
|
Title: "Project",
|
|
Section: "2",
|
|
}
|
|
// We generate on a subcommand so we have both subcommands and parents
|
|
if err := GenMan(cmdEcho, header, out); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
found := out.String()
|
|
|
|
unexpected := translate("#HISTORY")
|
|
checkStringOmits(t, found, unexpected)
|
|
}
|