Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

helpful error message when flag is missing values #310

Merged
merged 2 commits into from Jun 11, 2022
Merged

helpful error message when flag is missing values #310

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63df81c
helpful error message when flag is missing values
pyqlsa Jun 11, 2022
39be08f
argument -> value
pyqlsa Jun 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
100 changes: 100 additions & 0 deletions kong_test.go
View file
Open in desktop
Expand Up @@ -1561,3 +1561,103 @@ func TestHelpShouldStillWork(t *testing.T) {
// program; errors will not propagate in the real world).
require.Error(t, err)
}

func TestSliceDecoderHelpfulErrorMsg(t *testing.T) {
tests := []struct {
name string
cli interface{}
args []string
err string
}{
{
"DefaultRune",
&struct {
Stuff []string
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<arg>,..."`,
},
{
"SpecifiedRune",
&struct {
Stuff []string `sep:","`
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<arg>,..."`,
},
{
"SpaceRune",
&struct {
Stuff []string `sep:" "`
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<arg> ..."`,
},
{
"OtherRune",
&struct {
Stuff []string `sep:"_"`
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<arg>_..."`,
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
p := mustNew(t, test.cli)
_, err := p.Parse(test.args)
require.EqualError(t, err, test.err)
})
}
}

func TestMapDecoderHelpfulErrorMsg(t *testing.T) {
tests := []struct {
name string
cli interface{}
args []string
expected string
}{
{
"DefaultRune",
&struct {
Stuff map[string]int
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<key>=<value>;..."`,
},
{
"SpecifiedRune",
&struct {
Stuff map[string]int `mapsep:";"`
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<key>=<value>;..."`,
},
{
"SpaceRune",
&struct {
Stuff map[string]int `mapsep:" "`
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<key>=<value> ..."`,
},
{
"OtherRune",
&struct {
Stuff map[string]int `mapsep:","`
}{},
[]string{"--stuff"},
`--stuff: missing argument: expecting "<key>=<value>,..."`,
},
}
for _, test := range tests {
test := test
t.Run(test.name, func(t *testing.T) {
p := mustNew(t, test.cli)
_, err := p.Parse(test.args)
require.EqualError(t, err, test.expected)
})
}
}
8 changes: 4 additions & 4 deletions mapper.go
View file
Open in desktop
Expand Up @@ -439,17 +439,17 @@ func mapDecoder(r *Registry) MapperFunc {
target.Set(reflect.MakeMap(target.Type()))
}
el := target.Type()
sep := ctx.Value.Tag.MapSep
mapsep := ctx.Value.Tag.MapSep
var childScanner *Scanner
if ctx.Value.Flag != nil {
t := ctx.Scan.Pop()
// If decoding a flag, we need an argument.
if t.IsEOL() {
return errors.New("unexpected EOL")
return fmt.Errorf("missing argument: expecting \"<key>=<value>%c...\"", mapsep)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome thank you, just two minor things.

  1. Please replace "argument" with "value", as "argument" has an existing, different, meaning.
  2. Please change "value: expecting" to "value, expecting"

}
switch v := t.Value.(type) {
case string:
childScanner = ScanAsType(t.Type, SplitEscaped(v, sep)...)
childScanner = ScanAsType(t.Type, SplitEscaped(v, mapsep)...)

case []map[string]interface{}:
for _, m := range v {
Expand Down Expand Up @@ -520,7 +520,7 @@ func sliceDecoder(r *Registry) MapperFunc {
t := ctx.Scan.Pop()
// If decoding a flag, we need an argument.
if t.IsEOL() {
return errors.New("unexpected EOL")
return fmt.Errorf("missing argument: expecting \"<arg>%c...\"", sep)
}
switch v := t.Value.(type) {
case string:
Expand Down