340 lines
11 KiB
Go
340 lines
11 KiB
Go
package cli
|
|
|
|
import (
|
|
"errors"
|
|
"flag"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
func TestCommandFlagParsing(t *testing.T) {
|
|
cases := []struct {
|
|
testArgs []string
|
|
skipFlagParsing bool
|
|
useShortOptionHandling bool
|
|
expectedErr error
|
|
}{
|
|
// Test normal "not ignoring flags" flow
|
|
{testArgs: []string{"test-cmd", "-break", "blah", "blah"}, skipFlagParsing: false, useShortOptionHandling: false, expectedErr: errors.New("flag provided but not defined: -break")},
|
|
{[]string{"test-cmd", "blah", "blah", "-break"}, false, false, nil, false},
|
|
// Test no arg reorder
|
|
{[]string{"test-cmd", "blah", "blah", "-break"}, false, true, nil, false},
|
|
{[]string{"test-cmd", "blah", "blah", "-break", "ls", "-l"}, false, true, nil, true},
|
|
{[]string{"test-cmd", "blah", "blah"}, true, false, nil, false}, // Test SkipFlagParsing without any args that look like flags
|
|
{[]string{"test-cmd", "blah", "-break"}, true, false, nil, false}, // Test SkipFlagParsing with random flag arg
|
|
{[]string{"test-cmd", "blah", "-help"}, true, false, nil, false}, // Test SkipFlagParsing with "special" help flag arg
|
|
{[]string{"test-cmd", "blah"}, false, false, nil, true}, // Test UseShortOptionHandling
|
|
{testArgs: []string{"test-cmd", "blah", "blah"}, skipFlagParsing: true, useShortOptionHandling: false, expectedErr: nil}, // Test SkipFlagParsing without any args that look like flags
|
|
{testArgs: []string{"test-cmd", "blah", "-break"}, skipFlagParsing: true, useShortOptionHandling: false, expectedErr: nil}, // Test SkipFlagParsing with random flag arg
|
|
{testArgs: []string{"test-cmd", "blah", "-help"}, skipFlagParsing: true, useShortOptionHandling: false, expectedErr: nil}, // Test SkipFlagParsing with "special" help flag arg
|
|
{testArgs: []string{"test-cmd", "blah", "-h"}, skipFlagParsing: false, useShortOptionHandling: true, expectedErr: nil}, // Test UseShortOptionHandling
|
|
}
|
|
|
|
for _, c := range cases {
|
|
app := &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,
|
|
}
|
|
|
|
err := command.Run(context)
|
|
|
|
expect(t, err, c.expectedErr)
|
|
expect(t, context.Args().Slice(), c.testArgs)
|
|
}
|
|
}
|
|
|
|
func TestParseAndRunShortOpts(t *testing.T) {
|
|
cases := []struct {
|
|
testArgs args
|
|
expectedErr error
|
|
expectedArgs Args
|
|
}{
|
|
{testArgs: args{"foo", "test", "-a"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "-c", "arg1", "arg2"}, expectedErr: nil, expectedArgs: &args{"arg1", "arg2"}},
|
|
{testArgs: args{"foo", "test", "-f"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "-ac", "--fgh"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "-af"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "-cf"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "-acf"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "--acf"}, expectedErr: errors.New("flag provided but not defined: -acf"), expectedArgs: nil},
|
|
{testArgs: args{"foo", "test", "-invalid"}, expectedErr: errors.New("flag provided but not defined: -invalid"), expectedArgs: nil},
|
|
{testArgs: args{"foo", "test", "-acf", "-invalid"}, expectedErr: errors.New("flag provided but not defined: -invalid"), expectedArgs: nil},
|
|
{testArgs: args{"foo", "test", "--invalid"}, expectedErr: errors.New("flag provided but not defined: -invalid"), expectedArgs: nil},
|
|
{testArgs: args{"foo", "test", "-acf", "--invalid"}, expectedErr: errors.New("flag provided but not defined: -invalid"), expectedArgs: nil},
|
|
{testArgs: args{"foo", "test", "-acf", "arg1", "-invalid"}, expectedErr: nil, expectedArgs: &args{"arg1", "-invalid"}},
|
|
{testArgs: args{"foo", "test", "-acf", "arg1", "--invalid"}, expectedErr: nil, expectedArgs: &args{"arg1", "--invalid"}},
|
|
{testArgs: args{"foo", "test", "-acfi", "not-arg", "arg1", "-invalid"}, expectedErr: nil, expectedArgs: &args{"arg1", "-invalid"}},
|
|
{testArgs: args{"foo", "test", "-i", "ivalue"}, expectedErr: nil, expectedArgs: &args{}},
|
|
{testArgs: args{"foo", "test", "-i", "ivalue", "arg1"}, expectedErr: nil, expectedArgs: &args{"arg1"}},
|
|
{testArgs: args{"foo", "test", "-i"}, expectedErr: errors.New("flag needs an argument: -i"), expectedArgs: nil},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
var args Args
|
|
cmd := &Command{
|
|
Name: "test",
|
|
Usage: "this is for testing",
|
|
Description: "testing",
|
|
Action: func(c *Context) error {
|
|
args = c.Args()
|
|
return nil
|
|
},
|
|
UseShortOptionHandling: true,
|
|
Flags: []Flag{
|
|
&BoolFlag{Name: "abc", Aliases: []string{"a"}},
|
|
&BoolFlag{Name: "cde", Aliases: []string{"c"}},
|
|
&BoolFlag{Name: "fgh", Aliases: []string{"f"}},
|
|
&StringFlag{Name: "ijk", Aliases: []string{"i"}},
|
|
},
|
|
}
|
|
|
|
app := NewApp()
|
|
app.Commands = []*Command{cmd}
|
|
|
|
err := app.Run(c.testArgs)
|
|
|
|
expect(t, err, c.expectedErr)
|
|
expect(t, args, c.expectedArgs)
|
|
}
|
|
}
|
|
|
|
func TestCommand_Run_DoesNotOverwriteErrorFromBefore(t *testing.T) {
|
|
app := &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 := &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_hasCommandContext(t *testing.T) {
|
|
app := &App{
|
|
Commands: []*Command{
|
|
{
|
|
Name: "bar",
|
|
Flags: []Flag{
|
|
&IntFlag{Name: "flag"},
|
|
},
|
|
OnUsageError: func(c *Context, err error, _ bool) error {
|
|
return fmt.Errorf("intercepted in %s: %s", c.Command.Name, 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 in bar") {
|
|
t.Errorf("Expect an intercepted error, but got \"%v\"", err)
|
|
}
|
|
}
|
|
|
|
func TestCommand_OnUsageError_WithWrongFlagValue(t *testing.T) {
|
|
app := &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_OnUsageError_WithSubcommand(t *testing.T) {
|
|
app := &App{
|
|
Commands: []*Command{
|
|
{
|
|
Name: "bar",
|
|
Subcommands: []*Command{
|
|
{
|
|
Name: "baz",
|
|
},
|
|
},
|
|
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 := &App{
|
|
ErrWriter: ioutil.Discard,
|
|
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)
|
|
}
|
|
}
|
|
|
|
func TestCommandSkipFlagParsing(t *testing.T) {
|
|
cases := []struct {
|
|
testArgs args
|
|
expectedArgs *args
|
|
expectedErr error
|
|
}{
|
|
{testArgs: args{"some-exec", "some-command", "some-arg", "--flag", "foo"}, expectedArgs: &args{"some-arg", "--flag", "foo"}, expectedErr: nil},
|
|
{testArgs: args{"some-exec", "some-command", "some-arg", "--flag=foo"}, expectedArgs: &args{"some-arg", "--flag=foo"}, expectedErr: nil},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
var args Args
|
|
app := &App{
|
|
Commands: []*Command{
|
|
{
|
|
SkipFlagParsing: true,
|
|
Name: "some-command",
|
|
Flags: []Flag{
|
|
&StringFlag{Name: "flag"},
|
|
},
|
|
Action: func(c *Context) error {
|
|
fmt.Printf("%+v\n", c.String("flag"))
|
|
args = c.Args()
|
|
return nil
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
err := app.Run(c.testArgs)
|
|
expect(t, err, c.expectedErr)
|
|
expect(t, args, c.expectedArgs)
|
|
}
|
|
}
|