|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184 |
- package cli
-
- import (
- "errors"
- "flag"
- "fmt"
- "io/ioutil"
- "strings"
- "testing"
- )
-
- func TestCommandFlagParsing(t *testing.T) {
- cases := []struct {
- testArgs []string
- skipFlagParsing bool
- skipArgReorder bool
- expectedErr error
- }{
- // Test normal "not ignoring flags" flow
- {[]string{"test-cmd", "blah", "blah", "-break"}, false, false, errors.New("flag provided but not defined: -break")},
-
- // Test no arg reorder
- {[]string{"test-cmd", "blah", "blah", "-break"}, false, true, nil},
-
- {[]string{"test-cmd", "blah", "blah"}, true, false, nil}, // Test SkipFlagParsing without any args that look like flags
- {[]string{"test-cmd", "blah", "-break"}, true, false, nil}, // Test SkipFlagParsing with random flag arg
- {[]string{"test-cmd", "blah", "-help"}, true, false, nil}, // Test SkipFlagParsing with "special" help flag arg
- }
-
- for _, c := range cases {
- app := NewApp()
- app.Writer = ioutil.Discard
- set := flag.NewFlagSet("test", 0)
- set.Parse(c.testArgs)
-
- context := NewContext(app, set, nil)
-
- command := Command{
- Name: "test-cmd",
- Aliases: []string{"tc"},
- Usage: "this is for testing",
- Description: "testing",
- Action: func(_ *Context) error { return nil },
- SkipFlagParsing: c.skipFlagParsing,
- SkipArgReorder: c.skipArgReorder,
- }
-
- err := command.Run(context)
-
- expect(t, err, c.expectedErr)
- expect(t, []string(context.Args()), c.testArgs)
- }
- }
-
- func TestCommand_Run_DoesNotOverwriteErrorFromBefore(t *testing.T) {
- app := NewApp()
- app.Commands = []Command{
- {
- Name: "bar",
- Before: func(c *Context) error {
- return fmt.Errorf("before error")
- },
- After: func(c *Context) error {
- return fmt.Errorf("after error")
- },
- },
- }
-
- err := app.Run([]string{"foo", "bar"})
- if err == nil {
- t.Fatalf("expected to receive error from Run, got none")
- }
-
- if !strings.Contains(err.Error(), "before error") {
- t.Errorf("expected text of error from Before method, but got none in \"%v\"", err)
- }
- if !strings.Contains(err.Error(), "after error") {
- t.Errorf("expected text of error from After method, but got none in \"%v\"", err)
- }
- }
-
- func TestCommand_Run_BeforeSavesMetadata(t *testing.T) {
- var receivedMsgFromAction string
- var receivedMsgFromAfter string
-
- app := NewApp()
- app.Commands = []Command{
- {
- Name: "bar",
- Before: func(c *Context) error {
- c.App.Metadata["msg"] = "hello world"
- return nil
- },
- Action: func(c *Context) error {
- msg, ok := c.App.Metadata["msg"]
- if !ok {
- return errors.New("msg not found")
- }
- receivedMsgFromAction = msg.(string)
- return nil
- },
- After: func(c *Context) error {
- msg, ok := c.App.Metadata["msg"]
- if !ok {
- return errors.New("msg not found")
- }
- receivedMsgFromAfter = msg.(string)
- return nil
- },
- },
- }
-
- err := app.Run([]string{"foo", "bar"})
- if err != nil {
- t.Fatalf("expected no error from Run, got %s", err)
- }
-
- expectedMsg := "hello world"
-
- if receivedMsgFromAction != expectedMsg {
- t.Fatalf("expected msg from Action to match. Given: %q\nExpected: %q",
- receivedMsgFromAction, expectedMsg)
- }
- if receivedMsgFromAfter != expectedMsg {
- t.Fatalf("expected msg from After to match. Given: %q\nExpected: %q",
- receivedMsgFromAction, expectedMsg)
- }
- }
-
- func TestCommand_OnUsageError_WithWrongFlagValue(t *testing.T) {
- app := NewApp()
- app.Commands = []Command{
- {
- Name: "bar",
- Flags: []Flag{
- IntFlag{Name: "flag"},
- },
- OnUsageError: func(c *Context, err error, _ bool) error {
- if !strings.HasPrefix(err.Error(), "invalid value \"wrong\"") {
- t.Errorf("Expect an invalid value error, but got \"%v\"", err)
- }
- return errors.New("intercepted: " + err.Error())
- },
- },
- }
-
- err := app.Run([]string{"foo", "bar", "--flag=wrong"})
- if err == nil {
- t.Fatalf("expected to receive error from Run, got none")
- }
-
- if !strings.HasPrefix(err.Error(), "intercepted: invalid value") {
- t.Errorf("Expect an intercepted error, but got \"%v\"", err)
- }
- }
-
- func TestCommand_Run_SubcommandsCanUseErrWriter(t *testing.T) {
- app := NewApp()
- app.ErrWriter = ioutil.Discard
- app.Commands = []Command{
- {
- Name: "bar",
- Usage: "this is for testing",
- Subcommands: []Command{
- {
- Name: "baz",
- Usage: "this is for testing",
- Action: func(c *Context) error {
- if c.App.ErrWriter != ioutil.Discard {
- return fmt.Errorf("ErrWriter not passed")
- }
-
- return nil
- },
- },
- },
- },
- }
-
- err := app.Run([]string{"foo", "bar", "baz"})
- if err != nil {
- t.Fatal(err)
- }
- }
|