|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409 |
- package cli
-
- import (
- "bytes"
- "flag"
- "fmt"
- "runtime"
- "strings"
- "testing"
- )
-
- func Test_ShowAppHelp_NoAuthor(t *testing.T) {
- output := new(bytes.Buffer)
- app := NewApp()
- app.Writer = output
-
- c := NewContext(app, nil, nil)
-
- ShowAppHelp(c)
-
- if bytes.Index(output.Bytes(), []byte("AUTHOR(S):")) != -1 {
- t.Errorf("expected\n%snot to include %s", output.String(), "AUTHOR(S):")
- }
- }
-
- func Test_ShowAppHelp_NoVersion(t *testing.T) {
- output := new(bytes.Buffer)
- app := NewApp()
- app.Writer = output
-
- app.Version = ""
-
- c := NewContext(app, nil, nil)
-
- ShowAppHelp(c)
-
- if bytes.Index(output.Bytes(), []byte("VERSION:")) != -1 {
- t.Errorf("expected\n%snot to include %s", output.String(), "VERSION:")
- }
- }
-
- func Test_ShowAppHelp_HideVersion(t *testing.T) {
- output := new(bytes.Buffer)
- app := NewApp()
- app.Writer = output
-
- app.HideVersion = true
-
- c := NewContext(app, nil, nil)
-
- ShowAppHelp(c)
-
- if bytes.Index(output.Bytes(), []byte("VERSION:")) != -1 {
- t.Errorf("expected\n%snot to include %s", output.String(), "VERSION:")
- }
- }
-
- func Test_Help_Custom_Flags(t *testing.T) {
- oldFlag := HelpFlag
- defer func() {
- HelpFlag = oldFlag
- }()
-
- HelpFlag = BoolFlag{
- Name: "help, x",
- Usage: "show help",
- }
-
- app := App{
- Flags: []Flag{
- BoolFlag{Name: "foo, h"},
- },
- Action: func(ctx *Context) error {
- if ctx.Bool("h") != true {
- t.Errorf("custom help flag not set")
- }
- return nil
- },
- }
- output := new(bytes.Buffer)
- app.Writer = output
- app.Run([]string{"test", "-h"})
- if output.Len() > 0 {
- t.Errorf("unexpected output: %s", output.String())
- }
- }
-
- func Test_Version_Custom_Flags(t *testing.T) {
- oldFlag := VersionFlag
- defer func() {
- VersionFlag = oldFlag
- }()
-
- VersionFlag = BoolFlag{
- Name: "version, V",
- Usage: "show version",
- }
-
- app := App{
- Flags: []Flag{
- BoolFlag{Name: "foo, v"},
- },
- Action: func(ctx *Context) error {
- if ctx.Bool("v") != true {
- t.Errorf("custom version flag not set")
- }
- return nil
- },
- }
- output := new(bytes.Buffer)
- app.Writer = output
- app.Run([]string{"test", "-v"})
- if output.Len() > 0 {
- t.Errorf("unexpected output: %s", output.String())
- }
- }
-
- func Test_helpCommand_Action_ErrorIfNoTopic(t *testing.T) {
- app := NewApp()
-
- set := flag.NewFlagSet("test", 0)
- set.Parse([]string{"foo"})
-
- c := NewContext(app, set, nil)
-
- err := helpCommand.Action.(func(*Context) error)(c)
-
- if err == nil {
- t.Fatalf("expected error from helpCommand.Action(), but got nil")
- }
-
- exitErr, ok := err.(*ExitError)
- if !ok {
- t.Fatalf("expected ExitError from helpCommand.Action(), but instead got: %v", err.Error())
- }
-
- if !strings.HasPrefix(exitErr.Error(), "No help topic for") {
- t.Fatalf("expected an unknown help topic error, but got: %v", exitErr.Error())
- }
-
- if exitErr.exitCode != 3 {
- t.Fatalf("expected exit value = 3, got %d instead", exitErr.exitCode)
- }
- }
-
- func Test_helpCommand_InHelpOutput(t *testing.T) {
- app := NewApp()
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"test", "--help"})
-
- s := output.String()
-
- if strings.Contains(s, "\nCOMMANDS:\nGLOBAL OPTIONS:\n") {
- t.Fatalf("empty COMMANDS section detected: %q", s)
- }
-
- if !strings.Contains(s, "help, h") {
- t.Fatalf("missing \"help, h\": %q", s)
- }
- }
-
- func Test_helpSubcommand_Action_ErrorIfNoTopic(t *testing.T) {
- app := NewApp()
-
- set := flag.NewFlagSet("test", 0)
- set.Parse([]string{"foo"})
-
- c := NewContext(app, set, nil)
-
- err := helpSubcommand.Action.(func(*Context) error)(c)
-
- if err == nil {
- t.Fatalf("expected error from helpCommand.Action(), but got nil")
- }
-
- exitErr, ok := err.(*ExitError)
- if !ok {
- t.Fatalf("expected ExitError from helpCommand.Action(), but instead got: %v", err.Error())
- }
-
- if !strings.HasPrefix(exitErr.Error(), "No help topic for") {
- t.Fatalf("expected an unknown help topic error, but got: %v", exitErr.Error())
- }
-
- if exitErr.exitCode != 3 {
- t.Fatalf("expected exit value = 3, got %d instead", exitErr.exitCode)
- }
- }
-
- func TestShowAppHelp_CommandAliases(t *testing.T) {
- app := &App{
- Commands: []Command{
- {
- Name: "frobbly",
- Aliases: []string{"fr", "frob"},
- Action: func(ctx *Context) error {
- return nil
- },
- },
- },
- }
-
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"foo", "--help"})
-
- if !strings.Contains(output.String(), "frobbly, fr, frob") {
- t.Errorf("expected output to include all command aliases; got: %q", output.String())
- }
- }
-
- func TestShowCommandHelp_CommandAliases(t *testing.T) {
- app := &App{
- Commands: []Command{
- {
- Name: "frobbly",
- Aliases: []string{"fr", "frob", "bork"},
- Action: func(ctx *Context) error {
- return nil
- },
- },
- },
- }
-
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"foo", "help", "fr"})
-
- if !strings.Contains(output.String(), "frobbly") {
- t.Errorf("expected output to include command name; got: %q", output.String())
- }
-
- if strings.Contains(output.String(), "bork") {
- t.Errorf("expected output to exclude command aliases; got: %q", output.String())
- }
- }
-
- func TestShowSubcommandHelp_CommandAliases(t *testing.T) {
- app := &App{
- Commands: []Command{
- {
- Name: "frobbly",
- Aliases: []string{"fr", "frob", "bork"},
- Action: func(ctx *Context) error {
- return nil
- },
- },
- },
- }
-
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"foo", "help"})
-
- if !strings.Contains(output.String(), "frobbly, fr, frob, bork") {
- t.Errorf("expected output to include all command aliases; got: %q", output.String())
- }
- }
-
- func TestShowCommandHelp_Customtemplate(t *testing.T) {
- app := &App{
- Commands: []Command{
- {
- Name: "frobbly",
- Action: func(ctx *Context) error {
- return nil
- },
- HelpName: "foo frobbly",
- CustomHelpTemplate: `NAME:
- {{.HelpName}} - {{.Usage}}
-
- USAGE:
- {{.HelpName}} [FLAGS] TARGET [TARGET ...]
-
- FLAGS:
- {{range .VisibleFlags}}{{.}}
- {{end}}
- EXAMPLES:
- 1. Frobbly runs with this param locally.
- $ {{.HelpName}} wobbly
- `,
- },
- },
- }
-
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"foo", "help", "frobbly"})
-
- if strings.Contains(output.String(), "2. Frobbly runs without this param locally.") {
- t.Errorf("expected output to exclude \"2. Frobbly runs without this param locally.\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "1. Frobbly runs with this param locally.") {
- t.Errorf("expected output to include \"1. Frobbly runs with this param locally.\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "$ foo frobbly wobbly") {
- t.Errorf("expected output to include \"$ foo frobbly wobbly\"; got: %q", output.String())
- }
- }
-
- func TestShowAppHelp_HiddenCommand(t *testing.T) {
- app := &App{
- Commands: []Command{
- {
- Name: "frobbly",
- Action: func(ctx *Context) error {
- return nil
- },
- },
- {
- Name: "secretfrob",
- Hidden: true,
- Action: func(ctx *Context) error {
- return nil
- },
- },
- },
- }
-
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"app", "--help"})
-
- if strings.Contains(output.String(), "secretfrob") {
- t.Errorf("expected output to exclude \"secretfrob\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "frobbly") {
- t.Errorf("expected output to include \"frobbly\"; got: %q", output.String())
- }
- }
-
- func TestShowAppHelp_CustomAppTemplate(t *testing.T) {
- app := &App{
- Commands: []Command{
- {
- Name: "frobbly",
- Action: func(ctx *Context) error {
- return nil
- },
- },
- {
- Name: "secretfrob",
- Hidden: true,
- Action: func(ctx *Context) error {
- return nil
- },
- },
- },
- ExtraInfo: func() map[string]string {
- platform := fmt.Sprintf("OS: %s | Arch: %s", runtime.GOOS, runtime.GOARCH)
- goruntime := fmt.Sprintf("Version: %s | CPUs: %d", runtime.Version(), runtime.NumCPU())
- return map[string]string{
- "PLATFORM": platform,
- "RUNTIME": goruntime,
- }
- },
- CustomAppHelpTemplate: `NAME:
- {{.Name}} - {{.Usage}}
-
- USAGE:
- {{.Name}} {{if .VisibleFlags}}[FLAGS] {{end}}COMMAND{{if .VisibleFlags}} [COMMAND FLAGS | -h]{{end}} [ARGUMENTS...]
-
- COMMANDS:
- {{range .VisibleCommands}}{{join .Names ", "}}{{ "\t" }}{{.Usage}}
- {{end}}{{if .VisibleFlags}}
- GLOBAL FLAGS:
- {{range .VisibleFlags}}{{.}}
- {{end}}{{end}}
- VERSION:
- 2.0.0
- {{"\n"}}{{range $key, $value := ExtraInfo}}
- {{$key}}:
- {{$value}}
- {{end}}`,
- }
-
- output := &bytes.Buffer{}
- app.Writer = output
- app.Run([]string{"app", "--help"})
-
- if strings.Contains(output.String(), "secretfrob") {
- t.Errorf("expected output to exclude \"secretfrob\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "frobbly") {
- t.Errorf("expected output to include \"frobbly\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "PLATFORM:") ||
- !strings.Contains(output.String(), "OS:") ||
- !strings.Contains(output.String(), "Arch:") {
- t.Errorf("expected output to include \"PLATFORM:, OS: and Arch:\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "RUNTIME:") ||
- !strings.Contains(output.String(), "Version:") ||
- !strings.Contains(output.String(), "CPUs:") {
- t.Errorf("expected output to include \"RUNTIME:, Version: and CPUs:\"; got: %q", output.String())
- }
-
- if !strings.Contains(output.String(), "VERSION:") ||
- !strings.Contains(output.String(), "2.0.0") {
- t.Errorf("expected output to include \"VERSION:, 2.0.0\"; got: %q", output.String())
- }
- }
|