kubernetes
/
kubectl
mirror of https://github.com/kubernetes/kubectl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

kubectl: fix plugin lookup with positional arguments 

Signed-off-by: Dr. Stefan Schimanski <stefan.schimanski@gmail.com>

Kubernetes-commit: 62d379fa5abd4f109b1f1dfe2112feff03c569b4
This commit is contained in:
Dr. Stefan Schimanski 2024-03-31 19:44:03 +02:00 committed by Kubernetes Publisher
parent b465426392
commit bea8dbbff9
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pkg/cmd/cmd.go
View File

@ -136,7 +136,7 @@ func NewDefaultKubectlCommandWithArgs(o KubectlOptions) *cobra.Command {
case "help", cobra.ShellCompRequestCmd, cobra.ShellCompNoDescRequestCmd: case "help", cobra.ShellCompRequestCmd, cobra.ShellCompNoDescRequestCmd:
// Don't search for a plugin // Don't search for a plugin
default: default:
if err := HandlePluginCommand(o.PluginHandler, cmdPathPieces, false); err != nil { if err := HandlePluginCommand(o.PluginHandler, cmdPathPieces, 1); err != nil {
fmt.Fprintf(o.IOStreams.ErrOut, "Error: %v\n", err) fmt.Fprintf(o.IOStreams.ErrOut, "Error: %v\n", err)
os.Exit(1) os.Exit(1)
} }
@ -157,7 +157,7 @@ func NewDefaultKubectlCommandWithArgs(o KubectlOptions) *cobra.Command {
} }
if !builtinSubcmdExist { if !builtinSubcmdExist {
if err := HandlePluginCommand(o.PluginHandler, cmdPathPieces, true); err != nil { if err := HandlePluginCommand(o.PluginHandler, cmdPathPieces, len(cmdPathPieces)-len(foundArgs)+1); err != nil {
fmt.Fprintf(o.IOStreams.ErrOut, "Error: %v\n", err) fmt.Fprintf(o.IOStreams.ErrOut, "Error: %v\n", err)
os.Exit(1) os.Exit(1)
} }
@ -259,7 +259,7 @@ func (h *DefaultPluginHandler) Execute(executablePath string, cmdArgs, environme
// HandlePluginCommand receives a pluginHandler and command-line arguments and attempts to find // HandlePluginCommand receives a pluginHandler and command-line arguments and attempts to find
// a plugin executable on the PATH that satisfies the given arguments. // a plugin executable on the PATH that satisfies the given arguments.
func HandlePluginCommand(pluginHandler PluginHandler, cmdArgs []string, exactMatch bool) error { func HandlePluginCommand(pluginHandler PluginHandler, cmdArgs []string, minArgs int) error {
var remainingArgs []string // all "non-flag" arguments var remainingArgs []string // all "non-flag" arguments
for _, arg := range cmdArgs { for _, arg := range cmdArgs {
if strings.HasPrefix(arg, "-") { if strings.HasPrefix(arg, "-") {
@ -279,13 +279,14 @@ func HandlePluginCommand(pluginHandler PluginHandler, cmdArgs []string, exactMat
for len(remainingArgs) > 0 { for len(remainingArgs) > 0 {
path, found := pluginHandler.Lookup(strings.Join(remainingArgs, "-")) path, found := pluginHandler.Lookup(strings.Join(remainingArgs, "-"))
if !found { if !found {
if exactMatch { remainingArgs = remainingArgs[:len(remainingArgs)-1]
// if exactMatch is true, we shouldn't continue searching with shorter names. if len(remainingArgs) < minArgs {
// we shouldn't continue searching with shorter names.
// this is especially for not searching kubectl-create plugin // this is especially for not searching kubectl-create plugin
// when kubectl-create-foo plugin is not found. // when kubectl-create-foo plugin is not found.
break break
} }
remainingArgs = remainingArgs[:len(remainingArgs)-1]
continue continue
} }

13
pkg/cmd/cmd_test.go
View File

@ -196,6 +196,18 @@ func TestKubectlCommandHandlesPlugins(t *testing.T) {
expectPlugin: "plugin/testdata/kubectl-foo", expectPlugin: "plugin/testdata/kubectl-foo",
expectPluginArgs: []string{"--bar"}, expectPluginArgs: []string{"--bar"},
}, },
{
name: "test that a plugin executable is found based on command args with positional argument",
args: []string{"kubectl", "foo", "positional", "--bar"},
expectPlugin: "plugin/testdata/kubectl-foo",
expectPluginArgs: []string{"positional", "--bar"},
},
{
name: "test that an allowed subcommand plugin executable is found based on command args with positional argument",
args: []string{"kubectl", "create", "foo", "positional", "--bar"},
expectPlugin: "plugin/testdata/kubectl-create-foo",
expectPluginArgs: []string{"positional", "--bar"},
},
{ {
name: "test that a plugin does not execute over an existing command by the same name", name: "test that a plugin does not execute over an existing command by the same name",
args: []string{"kubectl", "version", "--client=true"}, args: []string{"kubectl", "version", "--client=true"},
@ -330,6 +342,7 @@ func (h *testPluginHandler) Lookup(filename string) (string, bool) {
for _, p := range plugins { for _, p := range plugins {
filenameWithSuportedPrefix = fmt.Sprintf("%s-%s", prefix, filename) filenameWithSuportedPrefix = fmt.Sprintf("%s-%s", prefix, filename)
if p.Name() == filenameWithSuportedPrefix { if p.Name() == filenameWithSuportedPrefix {
h.lookupErr = nil
return fmt.Sprintf("%s/%s", h.pluginsDirectory, p.Name()), true return fmt.Sprintf("%s/%s", h.pluginsDirectory, p.Name()), true
} }
} }