Skip to content

Commit

Permalink
Fix crash on errors in package-level MustParse
Browse files Browse the repository at this point in the history
  • Loading branch information
hhromic committed Jun 26, 2024
1 parent dfca71d commit aa844c7
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 2 deletions.
7 changes: 7 additions & 0 deletions example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ func Example_helpText() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand Down Expand Up @@ -195,6 +196,7 @@ func Example_helpPlaceholder() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand Down Expand Up @@ -235,6 +237,7 @@ func Example_helpTextWithSubcommand() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand Down Expand Up @@ -272,6 +275,7 @@ func Example_helpTextWhenUsingSubcommand() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand Down Expand Up @@ -392,6 +396,7 @@ func Example_errorText() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand All @@ -415,6 +420,7 @@ func Example_errorTextForSubcommand() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand Down Expand Up @@ -450,6 +456,7 @@ func Example_subcommand() {

// This is only necessary when running inside golang's runnable example harness
mustParseExit = func(int) {}
mustParseOut = os.Stdout

MustParse(&args)

Expand Down
5 changes: 3 additions & 2 deletions parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,13 @@ var ErrHelp = errors.New("help requested by user")
// ErrVersion indicates that the builtin --version was provided
var ErrVersion = errors.New("version requested by user")

// for monkey patching in example code
// for monkey patching in example and test code
var mustParseExit = os.Exit
var mustParseOut io.Writer = os.Stdout

// MustParse processes command line arguments and exits upon failure
func MustParse(dest ...interface{}) *Parser {
return mustParse(Config{Exit: mustParseExit}, dest...)
return mustParse(Config{Exit: mustParseExit, Out: mustParseOut}, dest...)
}

// mustParse is a helper that facilitates testing
Expand Down
15 changes: 15 additions & 0 deletions parse_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,21 @@ func TestMustParse(t *testing.T) {
assert.NotNil(t, parser)
}

func TestMustParseError(t *testing.T) {
var args struct {
Foo []string `default:""`
}
var exitCode int
var stdout bytes.Buffer
mustParseExit = func(code int) { exitCode = code }
mustParseOut = &stdout
os.Args = []string{"example"}
parser := MustParse(&args)
assert.Nil(t, parser)
assert.Equal(t, -1, exitCode)
assert.Contains(t, stdout.String(), "default values are not supported for slice or map fields")
}

func TestEnvironmentVariable(t *testing.T) {
var args struct {
Foo string `arg:"env"`
Expand Down

0 comments on commit aa844c7

Please sign in to comment.