Skip to content

Preserve StringArray flag values without a CSV round trip #62

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

Open
puncsky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Preserve StringArray flag values without a CSV round trip #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions pkg/command/inputs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,15 @@ func getStringSliceValue(flags *pflag.FlagSet, tag string) ([]string, error) {

// StringArray flags support multiple invocations: --flag a --flag b
// Unlike StringSlice which expects comma-separated: --flag=a,b
// Read the stored values directly: GetStringArray round-trips them
// through CSV, which turns an interior CRLF into LF and drops an
// explicitly empty argument.
if flag.Value.Type() == "stringArray" {
val, err := flags.GetStringArray(tag)
if err != nil {
return nil, err
sliceValue, ok := flag.Value.(pflag.SliceValue)
if !ok {
return nil, fmt.Errorf("unexpected string array type")
}
return val, nil
return sliceValue.GetSlice(), nil
}
}

Expand Down
27 changes: 27 additions & 0 deletions pkg/command/inputs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,33 @@ func TestParseCommand(t *testing.T) {
require.Equal(t, []string{"bar", "baz"}, v.Foo)
})

t.Run("parse string array keeps values verbatim", func(t *testing.T) {
type testStruct struct {
Foo []string `cli:"foo"`
}
for _, tc := range []struct {
name string
args []string
want []string
}{
{"interior CRLF", []string{"--foo", "K=first\r\nsecond"}, []string{"K=first\r\nsecond"}},
{"LF, lone CR and tab", []string{"--foo", "K=a\nb\rc\td"}, []string{"K=a\nb\rc\td"}},
{"commas and quotes", []string{"--foo", `K="a,b"`, "--foo", "L=c,d"}, []string{`K="a,b"`, "L=c,d"}},
{"explicit empty argument", []string{"--foo="}, []string{""}},
{"valid empty value", []string{"--foo", "K="}, []string{"K="}},
{"no flag", nil, []string{}},
} {
t.Run(tc.name, func(t *testing.T) {
var v testStruct
cmd := &cobra.Command{}
cmd.Flags().StringArray("foo", []string{}, "")
require.NoError(t, cmd.ParseFlags(tc.args))
require.NoError(t, command.ParseCommand(cmd, []string{}, &v))
require.Equal(t, tc.want, v.Foo)
})
}
})

t.Run("arg parsing", func(t *testing.T) {
t.Run("simple arg", func(t *testing.T) {
type testStruct struct {
Expand Down