github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-24 20:24:09 +00:00
Code Issues Projects Releases Wiki Activity

Ignore flags that could precede the Cobra command

Browse Source 
See https://github.com/kubernetes/kubectl/issues/1119

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
This commit is contained in:
Marc Khouzam 2021-09-20 18:20:49 -04:00
parent e703b3d253
commit d41c2685b6
2 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
staging/src/k8s.io/kubectl/pkg/cmd/cmd.go
View File

@ -105,7 +105,15 @@ func NewDefaultKubectlCommandWithArgs(pluginHandler PluginHandler, args []string
// Also check the commands that will be added by Cobra.
// These commands are only added once rootCmd.Execute() is called, so we
// need to check them explicitly here.
switch cmdPathPieces[0] {
var cmdName string // first "non-flag" arguments
for _, arg := range cmdPathPieces {
if !strings.HasPrefix(arg, "-") {
cmdName = arg
break
}
}
switch cmdName {
case "help", cobra.ShellCompRequestCmd, cobra.ShellCompNoDescRequestCmd:
// Don't search for a plugin
default:

32
staging/src/k8s.io/kubectl/pkg/cmd/cmd_test.go
View File

@ -79,6 +79,7 @@ func TestKubectlCommandHandlesPlugins(t *testing.T) {
args: []string{"kubectl", "version"},
},
// The following tests make sure that commands added by Cobra cannot be shadowed by a plugin
// See https://github.com/kubernetes/kubectl/issues/1116
{
name: "test that a plugin does not execute over Cobra's help command",
args: []string{"kubectl", "help"},
@ -91,6 +92,36 @@ func TestKubectlCommandHandlesPlugins(t *testing.T) {
name: "test that a plugin does not execute over Cobra's __completeNoDesc command",
args: []string{"kubectl", cobra.ShellCompNoDescRequestCmd},
},
// The following tests make sure that commands added by Cobra cannot be shadowed by a plugin
// even when a flag is specified first. This can happen when using aliases.
// See https://github.com/kubernetes/kubectl/issues/1119
{
name: "test that a flag does not break Cobra's help command",
args: []string{"kubectl", "--kubeconfig=/path/to/kubeconfig", "help"},
},
{
name: "test that a flag does not break Cobra's __complete command",
args: []string{"kubectl", "--kubeconfig=/path/to/kubeconfig", cobra.ShellCompRequestCmd},
},
{
name: "test that a flag does not break Cobra's __completeNoDesc command",
args: []string{"kubectl", "--kubeconfig=/path/to/kubeconfig", cobra.ShellCompNoDescRequestCmd},
},
// As for the previous tests, an alias could add a flag without using the = form.
// We don't support this case as parsing the flags becomes quite complicated (flags
// that take a value, versus flags that don't)
// {
// name: "test that a flag with a space does not break Cobra's help command",
// args: []string{"kubectl", "--kubeconfig", "/path/to/kubeconfig", "help"},
// },
// {
// name: "test that a flag with a space does not break Cobra's __complete command",
// args: []string{"kubectl", "--kubeconfig", "/path/to/kubeconfig", cobra.ShellCompRequestCmd},
// },
// {
// name: "test that a flag with a space does not break Cobra's __completeNoDesc command",
// args: []string{"kubectl", "--kubeconfig", "/path/to/kubeconfig", cobra.ShellCompNoDescRequestCmd},
// },
}
for _, test := range tests {
@ -105,6 +136,7 @@ func TestKubectlCommandHandlesPlugins(t *testing.T) {
})
root := NewDefaultKubectlCommandWithArgs(pluginsHandler, test.args, in, out, errOut)
root.SetOut(out)
if err := root.Execute(); err != nil {
t.Fatalf("unexpected error: %v", err)
}