github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add ports autocompletion for kubectl port-forward command

Browse Source 
Signed-off-by: TessaIO <ahmedgrati1999@gmail.com>
This commit is contained in:
TessaIO
2024-05-01 23:33:39 +02:00
parent c1ef6c44f5
commit a84e893afa
3 changed files with 246 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -107,7 +107,7 @@ func NewCmdPortForward(f cmdutil.Factory, streams genericiooptions.IOStreams) *c
Short: i18n.T("Forward one or more local ports to a pod"),
Long: portforwardLong,
Example: portforwardExample,
ValidArgsFunction: completion.PodResourceNameCompletionFunc(f),
ValidArgsFunction: completion.ResourceAndPortCompletionFunc(f),
Run: func(cmd *cobra.Command, args []string) {
cmdutil.CheckErr(opts.Complete(f, cmd, args))
cmdutil.CheckErr(opts.Validate())

54
staging/src/k8s.io/kubectl/pkg/util/completion/completion.go
View File

@@ -94,6 +94,36 @@ func PodResourceNameCompletionFunc(f cmdutil.Factory) func(*cobra.Command, []str
}
}
// ResourceAndPortCompletionFunc Returns a completion function that completes, as a first argument:
// 1- resources that match the toComplete prefix
// 2- the ports of the specific resource. i.e: container ports for pod resources and port for services
func ResourceAndPortCompletionFunc(f cmdutil.Factory) func(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective) {
return func(_ *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
var comps []string
var resourceType string
directive := cobra.ShellCompDirectiveNoFileComp
if len(args) == 0 {
comps, directive = doPodResourceCompletion(f, toComplete)
} else if len(args) == 1 {
t := strings.Split(args[0], "/")
// if we specify directly the pod, then resource type is pod, otherwise it would be the resource type passed
// by the user
if len(t) == 1 {
resourceType = "pod"
} else {
resourceType = t[0]
}
if resourceType == "service" || resourceType == "services" || resourceType == "svc" {
comps = CompGetServicePorts(f, t[1], toComplete)
} else {
podName := convertResourceNameToPodName(f, args[0])
comps = CompGetPodContainerPorts(f, podName, toComplete)
}
}
return comps, directive
}
}
// PodResourceNameAndContainerCompletionFunc Returns a completion function that completes, as a first argument:
// 1- pod names that match the toComplete prefix
// 2- resource types containing pods which match the toComplete prefix
@@ -167,6 +197,30 @@ func CompGetContainers(f cmdutil.Factory, podName string, toComplete string) []s
return CompGetFromTemplate(&template, f, "", []string{"pod", podName}, toComplete)
}
// CompGetPodContainerPorts retrieves the list of ports for containers within the specified pod that start with `toComplete`.
func CompGetPodContainerPorts(f cmdutil.Factory, podName string, toComplete string) []string {
var template string
exposedPort := strings.Split(toComplete, ":")[0]
if toComplete == "" {
exposedPort = "{{ .containerPort }}"
}
template = fmt.Sprintf("{{ range .spec.containers }}{{ range .ports }}%s:{{ .containerPort }} {{ end }}{{ end }}", exposedPort)
return CompGetFromTemplate(&template, f, "", []string{"pod", podName}, toComplete)
}
// CompGetServicePorts gets the list of ports of the specified service which begin with `toComplete`.
func CompGetServicePorts(f cmdutil.Factory, serviceName string, toComplete string) []string {
var template string
exposedPort := strings.Split(toComplete, ":")[0]
if toComplete == "" {
exposedPort = "{{ .port }}"
}
template = fmt.Sprintf("{{ range .spec.ports }}%s:{{ .port }} {{ end }}", exposedPort)
return CompGetFromTemplate(&template, f, "", []string{"service", serviceName}, toComplete)
}
// CompGetFromTemplate executes a Get operation using the specified template and args and returns the results
// which begin with `toComplete`.
func CompGetFromTemplate(template *string, f cmdutil.Factory, namespace string, args []string, toComplete string) []string {

220
staging/src/k8s.io/kubectl/pkg/util/completion/completion_test.go
View File

@@ -23,6 +23,9 @@ import (
"github.com/spf13/cobra"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/cli-runtime/pkg/genericiooptions"
"k8s.io/cli-runtime/pkg/resource"
"k8s.io/client-go/rest/fake"
@@ -110,7 +113,8 @@ func TestUserCompletionFunc(t *testing.T) {
func TestResourceTypeAndNameCompletionFuncOneArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceTypeAndNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod"}, "b")
@@ -119,7 +123,8 @@ func TestResourceTypeAndNameCompletionFuncOneArg(t *testing.T) {
func TestResourceTypeAndNameCompletionFuncRepeating(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceTypeAndNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod", "bar"}, "")
@@ -129,7 +134,8 @@ func TestResourceTypeAndNameCompletionFuncRepeating(t *testing.T) {
func TestResourceTypeAndNameCompletionFuncJointForm(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceTypeAndNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "pod/b")
@@ -138,7 +144,8 @@ func TestResourceTypeAndNameCompletionFuncJointForm(t *testing.T) {
func TestResourceTypeAndNameCompletionFuncJointFormRepeating(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceTypeAndNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod/bar"}, "pod/")
@@ -148,7 +155,8 @@ func TestResourceTypeAndNameCompletionFuncJointFormRepeating(t *testing.T) {
func TestSpecifiedResourceTypeAndNameCompletionFuncNoArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameCompletionFunc(tf, []string{"pod", "service", "statefulset"})
comps, directive := compFunc(cmd, []string{}, "s")
@@ -157,7 +165,8 @@ func TestSpecifiedResourceTypeAndNameCompletionFuncNoArgs(t *testing.T) {
func TestSpecifiedResourceTypeAndNameCompletionFuncOneArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{"pod"}, "b")
@@ -166,7 +175,8 @@ func TestSpecifiedResourceTypeAndNameCompletionFuncOneArg(t *testing.T) {
func TestSpecifiedResourceTypeAndNameCompletionFuncRepeating(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{"pod", "bar"}, "")
@@ -176,7 +186,8 @@ func TestSpecifiedResourceTypeAndNameCompletionFuncRepeating(t *testing.T) {
func TestSpecifiedResourceTypeAndNameCompletionFuncJointFormOneArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{}, "pod/b")
@@ -185,7 +196,8 @@ func TestSpecifiedResourceTypeAndNameCompletionFuncJointFormOneArg(t *testing.T)
func TestSpecifiedResourceTypeAndNameCompletionFuncJointFormRepeating(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{"pod/bar"}, "pod/")
@@ -194,7 +206,8 @@ func TestSpecifiedResourceTypeAndNameCompletionFuncJointFormRepeating(t *testing
}
func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncOneArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameNoRepeatCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{"pod"}, "b")
@@ -203,7 +216,8 @@ func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncOneArg(t *testing.T)
func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncMultiArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameNoRepeatCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{"pod", "bar"}, "")
@@ -213,7 +227,8 @@ func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncMultiArg(t *testing.T
func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncJointFormOneArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameNoRepeatCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{}, "pod/b")
@@ -222,7 +237,8 @@ func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncJointFormOneArg(t *te
func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncJointFormMultiArg(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := SpecifiedResourceTypeAndNameNoRepeatCompletionFunc(tf, []string{"pod"})
comps, directive := compFunc(cmd, []string{"pod/bar"}, "pod/")
@@ -232,7 +248,8 @@ func TestSpecifiedResourceTypeAndNameCompletionNoRepeatFuncJointFormMultiArg(t *
func TestResourceNameCompletionFuncNoArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceNameCompletionFunc(tf, "pod")
comps, directive := compFunc(cmd, []string{}, "b")
@@ -241,7 +258,8 @@ func TestResourceNameCompletionFuncNoArgs(t *testing.T) {
func TestResourceNameCompletionFuncTooManyArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceNameCompletionFunc(tf, "pod")
comps, directive := compFunc(cmd, []string{"pod-name"}, "")
@@ -250,7 +268,8 @@ func TestResourceNameCompletionFuncTooManyArgs(t *testing.T) {
func TestResourceNameCompletionFuncJointFormNoArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := ResourceNameCompletionFunc(tf, "pod")
comps, directive := compFunc(cmd, []string{}, "pod/b")
@@ -260,7 +279,8 @@ func TestResourceNameCompletionFuncJointFormNoArgs(t *testing.T) {
func TestPodResourceNameCompletionFuncNoArgsPodName(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "b")
@@ -269,7 +289,8 @@ func TestPodResourceNameCompletionFuncNoArgsPodName(t *testing.T) {
func TestPodResourceNameCompletionFuncNoArgsResources(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "d")
@@ -280,7 +301,8 @@ func TestPodResourceNameCompletionFuncNoArgsResources(t *testing.T) {
func TestPodResourceNameCompletionFuncTooManyArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod-name"}, "")
@@ -289,7 +311,8 @@ func TestPodResourceNameCompletionFuncTooManyArgs(t *testing.T) {
func TestPodResourceNameCompletionFuncJointFormNoArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "pod/b")
@@ -299,7 +322,8 @@ func TestPodResourceNameCompletionFuncJointFormNoArgs(t *testing.T) {
func TestPodResourceNameCompletionFuncJointFormTooManyArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod/name"}, "pod/b")
@@ -308,7 +332,8 @@ func TestPodResourceNameCompletionFuncJointFormTooManyArgs(t *testing.T) {
func TestPodResourceNameAndContainerCompletionFuncNoArgsPodName(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameAndContainerCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "b")
@@ -317,7 +342,8 @@ func TestPodResourceNameAndContainerCompletionFuncNoArgsPodName(t *testing.T) {
func TestPodResourceNameAndContainerCompletionFuncNoArgsResources(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameAndContainerCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "s")
@@ -329,7 +355,8 @@ func TestPodResourceNameAndContainerCompletionFuncNoArgsResources(t *testing.T)
func TestPodResourceNameAndContainerCompletionFuncTooManyArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameAndContainerCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod-name", "container-name"}, "")
@@ -338,7 +365,8 @@ func TestPodResourceNameAndContainerCompletionFuncTooManyArgs(t *testing.T) {
func TestPodResourceNameAndContainerCompletionFuncJointFormNoArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameAndContainerCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{}, "pod/b")
@@ -347,13 +375,111 @@ func TestPodResourceNameAndContainerCompletionFuncJointFormNoArgs(t *testing.T)
func TestPodResourceNameAndContainerCompletionFuncJointFormTooManyArgs(t *testing.T) {
tf, cmd := prepareCompletionTest()
addPodsToFactory(tf)
pods, _, _ := cmdtesting.TestData()
addResourceToFactory(tf, pods)
compFunc := PodResourceNameAndContainerCompletionFunc(tf)
comps, directive := compFunc(cmd, []string{"pod/pod-name", "container-name"}, "")
checkCompletion(t, comps, []string{}, directive, cobra.ShellCompDirectiveNoFileComp)
}
func TestResourceAndPortCompletionFunc(t *testing.T) {
barPod := getTestPod()
bazService := getTestService()
testCases := []struct {
name string
obj runtime.Object
args []string
toComplete string
expectedComps []string
expectedDirective cobra.ShellCompDirective
}{
{
name: "no args pod name",
obj: barPod,
args: []string{},
toComplete: "b",
expectedComps: []string{"bar"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "no args resources",
obj: barPod,
args: []string{},
toComplete: "s",
expectedComps: []string{"services/", "statefulsets/"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp | cobra.ShellCompDirectiveNoSpace,
},
{
name: "too many args",
obj: barPod,
args: []string{"pod-name", "port-number"},
toComplete: "",
expectedComps: []string{},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "joint from no args",
obj: barPod,
args: []string{},
toComplete: "pod/b",
expectedComps: []string{"pod/bar"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "joint from too many args",
obj: barPod,
args: []string{"pod/pod-name", "port-number"},
toComplete: "",
expectedComps: []string{},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "complete container port with default exposed port",
obj: barPod,
args: []string{"bar"},
toComplete: "",
expectedComps: []string{"80:80", "81:81"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "complete container port with custom exposed port",
obj: barPod,
args: []string{"bar"},
toComplete: "90",
expectedComps: []string{"90:80", "90:81"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "complete service port with default exposed port",
obj: bazService,
args: []string{"service/baz"},
toComplete: "",
expectedComps: []string{"8080:8080", "8081:8081"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
{
name: "complete container port with custom exposed port",
obj: bazService,
args: []string{"service/baz"},
toComplete: "9090",
expectedComps: []string{"9090:8080", "9090:8081"},
expectedDirective: cobra.ShellCompDirectiveNoFileComp,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
tf, cmd := prepareCompletionTest()
addResourceToFactory(tf, tc.obj)
compFunc := ResourceAndPortCompletionFunc(tf)
comps, directive := compFunc(cmd, tc.args, tc.toComplete)
checkCompletion(t, comps, tc.expectedComps, directive, tc.expectedDirective)
})
}
}
func setMockFactory(config api.Config) {
clientConfig := clientcmd.NewDefaultClientConfig(config, nil)
testFactory := cmdtesting.NewTestFactory().WithClientConfig(clientConfig)
@@ -369,12 +495,11 @@ func prepareCompletionTest() (*cmdtesting.TestFactory, *cobra.Command) {
return tf, cmd
}
func addPodsToFactory(tf *cmdtesting.TestFactory) {
pods, _, _ := cmdtesting.TestData()
func addResourceToFactory(tf *cmdtesting.TestFactory, obj runtime.Object) {
codec := scheme.Codecs.LegacyCodec(scheme.Scheme.PrioritizedVersionsAllGroups()...)
tf.UnstructuredClient = &fake.RESTClient{
NegotiatedSerializer: resource.UnstructuredPlusDefaultContentConfig().NegotiatedSerializer,
Resp: &http.Response{StatusCode: http.StatusOK, Header: cmdtesting.DefaultHeader(), Body: cmdtesting.ObjBody(codec, pods)},
Resp: &http.Response{StatusCode: http.StatusOK, Header: cmdtesting.DefaultHeader(), Body: cmdtesting.ObjBody(codec, obj)},
}
}
@@ -397,3 +522,40 @@ func checkCompletion(t *testing.T, comps, expectedComps []string, directive, exp
}
}
}
func getTestPod() *corev1.Pod {
return &corev1.Pod{
ObjectMeta: metav1.ObjectMeta{Name: "bar", Namespace: "test", ResourceVersion: "11"},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "bar",
Ports: []corev1.ContainerPort{
{
ContainerPort: 80,
},
{
ContainerPort: 81,
},
},
},
},
},
}
}
func getTestService() *corev1.Service {
return &corev1.Service{
ObjectMeta: metav1.ObjectMeta{Name: "baz", Namespace: "test", ResourceVersion: "12"},
Spec: corev1.ServiceSpec{
Ports: []corev1.ServicePort{
{
Port: 8080,
},
{
Port: 8081,
},
},
},
}
}