base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Stop flag interpretation at unknown flags

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-26 14:37:33 +00:00
parent 473fb027a1
commit 230187296f
3 changed files with 63 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
internal/cobra/flags.go
View File

@@ -27,9 +27,8 @@ func interpretFlagTokens(argv []string, flags []commandmeta.Flag, aliases []comm
}
spellings := make(map[string][]string)
occurrences := make([]commandmeta.FlagOccurrence, 0, len(argv))
interpreted := make([]string, 0, len(argv))
recordingOccurrences := true
var occurrences []commandmeta.FlagOccurrence
var interpreted []string
for index := 0; index < len(argv); {
token := argv[index]
if token == "--" {
@@ -50,35 +49,27 @@ func interpretFlagTokens(argv []string, flags []commandmeta.Flag, aliases []comm
}
if !ok {
interpreted = append(interpreted, token)
recordingOccurrences = false
index++
continue
return interpreted, spellings, occurrences, nil
}
spellings[flag.Name] = append(spellings[flag.Name], original)
if equal >= 0 {
value := body[equal+1:]
interpreted = append(interpreted, "--"+flag.Name+"="+value)
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
index++
continue
}
if !flag.Boolean && index+1 < len(argv) {
value := argv[index+1]
interpreted = append(interpreted, "--"+flag.Name+"="+value)
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
index += 2
continue
}
if !flag.Boolean {
return interpreted, spellings, occurrences, &commandmeta.Failure{Message: fmt.Sprintf("flag needs an argument: %s", original)}
}
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: "true"})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: "true"})
interpreted = append(interpreted, "--"+flag.Name)
index++
continue
@@ -98,8 +89,7 @@ func interpretFlagTokens(argv []string, flags []commandmeta.Flag, aliases []comm
}
if !ok {
interpreted = append(interpreted, "-"+token[offset:])
recordingOccurrences = false
break
return interpreted, spellings, occurrences, nil
}
spellings[flag.Name] = append(spellings[flag.Name], original)
suffix := token[offset+1:]
@@ -107,14 +97,10 @@ func interpretFlagTokens(argv []string, flags []commandmeta.Flag, aliases []comm
if strings.HasPrefix(suffix, "=") {
value := suffix[1:]
interpreted = append(interpreted, "--"+flag.Name+"="+value)
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
break
}
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: "true"})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: "true"})
interpreted = append(interpreted, "--"+flag.Name)
offset++
continue
@@ -125,17 +111,13 @@ func interpretFlagTokens(argv []string, flags []commandmeta.Flag, aliases []comm
value = value[1:]
}
interpreted = append(interpreted, "--"+flag.Name+"="+value)
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
break
}
if index+1 < len(argv) {
value := argv[index+1]
interpreted = append(interpreted, "--"+flag.Name+"="+value)
if recordingOccurrences {
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
}
occurrences = append(occurrences, commandmeta.FlagOccurrence{Name: flag.Name, Spelling: original, RawValue: value})
index += 2
consumedNext = true
break

28
internal/cobra/flags_test.go
View File

@@ -264,3 +264,31 @@ func TestParseFailuresRetainEnteredFlagSpellings(t *testing.T) {
t.Fatalf("earlier parser failure = %#v", result.Failure)
}
}
func TestFlagInterpretationStopsAtTheBackendFailurePrefix(t *testing.T) {
for _, test := range []struct {
name string
args []string
want []string
}{
{"long", []string{"--debug", "--unknown"}, []string{"--debug", "--unknown"}},
{"short cluster", []string{"-dqz"}, []string{"--debug", "--quiet", "-z"}},
} {
t.Run(test.name, func(t *testing.T) {
// The later value must not be canonicalized or retained in spellings.
args := append(append([]string(nil), test.args...), "--message="+strings.Repeat("value", 1024), "--quiet=false")
flags := append(commandmeta.ReportingFlags(), commandmeta.Flag{Name: "message"})
interpreted, spellings, occurrences, failure := interpretFlagTokens(args, flags, reportingFlagOptions().FlagAliases)
if failure != nil || !reflect.DeepEqual(interpreted, test.want) || len(spellings["message"]) != 0 {
t.Fatalf("interpreted=%q spellings=%v failure=%v", interpreted, spellings, failure)
}
if len(occurrences) != len(test.want)-1 || occurrences[0].Name != "debug" {
t.Fatalf("consumed occurrences=%#v", occurrences)
}
result := Parse(reportingFlagTree(), append([]string{"run"}, args...), reportingFlagOptions())
if result.Failure == nil || !strings.Contains(result.Failure.Message, "unknown") || !reflect.DeepEqual(result.FlagOccurrences, occurrences) {
t.Fatalf("backend result=%#v", result)
}
})
}
}