50172148e4
Automatic merge from submit-queue Support terminal resizing for exec/attach/run ```release-note Add support for terminal resizing for exec, attach, and run. Note that for Docker, exec sessions inherit the environment from the primary process, so if the container was created with tty=false, that means the exec session's TERM variable will default to "dumb". Users can override this by setting TERM=xterm (or whatever is appropriate) to get the correct "smart" terminal behavior. ``` Fixes #13585
313 lines
9.2 KiB
Go
313 lines
9.2 KiB
Go
/*
|
|
Copyright 2014 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"k8s.io/kubernetes/pkg/api"
|
|
"k8s.io/kubernetes/pkg/api/testapi"
|
|
"k8s.io/kubernetes/pkg/api/unversioned"
|
|
"k8s.io/kubernetes/pkg/client/restclient"
|
|
"k8s.io/kubernetes/pkg/client/unversioned/fake"
|
|
"k8s.io/kubernetes/pkg/util/term"
|
|
)
|
|
|
|
type fakeRemoteAttach struct {
|
|
method string
|
|
url *url.URL
|
|
err error
|
|
}
|
|
|
|
func (f *fakeRemoteAttach) Attach(method string, url *url.URL, config *restclient.Config, stdin io.Reader, stdout, stderr io.Writer, tty bool, terminalSizeQueue term.TerminalSizeQueue) error {
|
|
f.method = method
|
|
f.url = url
|
|
return f.err
|
|
}
|
|
|
|
func TestPodAndContainerAttach(t *testing.T) {
|
|
tests := []struct {
|
|
args []string
|
|
p *AttachOptions
|
|
name string
|
|
expectError bool
|
|
expectedPod string
|
|
expectedContainer string
|
|
}{
|
|
{
|
|
p: &AttachOptions{},
|
|
expectError: true,
|
|
name: "empty",
|
|
},
|
|
{
|
|
p: &AttachOptions{},
|
|
args: []string{"foo", "bar"},
|
|
expectError: true,
|
|
name: "too many args",
|
|
},
|
|
{
|
|
p: &AttachOptions{},
|
|
args: []string{"foo"},
|
|
expectedPod: "foo",
|
|
name: "no container, no flags",
|
|
},
|
|
{
|
|
p: &AttachOptions{ContainerName: "bar"},
|
|
args: []string{"foo"},
|
|
expectedPod: "foo",
|
|
expectedContainer: "bar",
|
|
name: "container in flag",
|
|
},
|
|
{
|
|
p: &AttachOptions{ContainerName: "initfoo"},
|
|
args: []string{"foo"},
|
|
expectedPod: "foo",
|
|
expectedContainer: "initfoo",
|
|
name: "init container in flag",
|
|
},
|
|
{
|
|
p: &AttachOptions{ContainerName: "bar"},
|
|
args: []string{"foo", "-c", "wrong"},
|
|
expectError: true,
|
|
name: "non-existing container in flag",
|
|
},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
f, tf, _, ns := NewAPIFactory()
|
|
tf.Client = &fake.RESTClient{
|
|
NegotiatedSerializer: ns,
|
|
Client: fake.CreateHTTPClient(func(req *http.Request) (*http.Response, error) { return nil, nil }),
|
|
}
|
|
tf.Namespace = "test"
|
|
tf.ClientConfig = &restclient.Config{}
|
|
|
|
cmd := &cobra.Command{}
|
|
options := test.p
|
|
err := options.Complete(f, cmd, test.args)
|
|
if test.expectError && err == nil {
|
|
t.Errorf("unexpected non-error (%s)", test.name)
|
|
}
|
|
if !test.expectError && err != nil {
|
|
t.Errorf("unexpected error: %v (%s)", err, test.name)
|
|
}
|
|
if err != nil {
|
|
continue
|
|
}
|
|
if options.PodName != test.expectedPod {
|
|
t.Errorf("expected: %s, got: %s (%s)", test.expectedPod, options.PodName, test.name)
|
|
}
|
|
if options.ContainerName != test.expectedContainer {
|
|
t.Errorf("expected: %s, got: %s (%s)", test.expectedContainer, options.ContainerName, test.name)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestAttach(t *testing.T) {
|
|
version := testapi.Default.GroupVersion().Version
|
|
tests := []struct {
|
|
name, version, podPath, attachPath, container string
|
|
pod *api.Pod
|
|
remoteAttachErr bool
|
|
exepctedErr string
|
|
}{
|
|
{
|
|
name: "pod attach",
|
|
version: version,
|
|
podPath: "/api/" + version + "/namespaces/test/pods/foo",
|
|
attachPath: "/api/" + version + "/namespaces/test/pods/foo/attach",
|
|
pod: attachPod(),
|
|
container: "bar",
|
|
},
|
|
{
|
|
name: "pod attach error",
|
|
version: version,
|
|
podPath: "/api/" + version + "/namespaces/test/pods/foo",
|
|
attachPath: "/api/" + version + "/namespaces/test/pods/foo/attach",
|
|
pod: attachPod(),
|
|
remoteAttachErr: true,
|
|
container: "bar",
|
|
exepctedErr: "attach error",
|
|
},
|
|
{
|
|
name: "container not found error",
|
|
version: version,
|
|
podPath: "/api/" + version + "/namespaces/test/pods/foo",
|
|
attachPath: "/api/" + version + "/namespaces/test/pods/foo/attach",
|
|
pod: attachPod(),
|
|
container: "foo",
|
|
exepctedErr: "cannot attach to the container: container not found (foo)",
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
f, tf, codec, ns := NewAPIFactory()
|
|
tf.Client = &fake.RESTClient{
|
|
NegotiatedSerializer: ns,
|
|
Client: fake.CreateHTTPClient(func(req *http.Request) (*http.Response, error) {
|
|
switch p, m := req.URL.Path, req.Method; {
|
|
case p == test.podPath && m == "GET":
|
|
body := objBody(codec, test.pod)
|
|
return &http.Response{StatusCode: 200, Header: defaultHeader(), Body: body}, nil
|
|
default:
|
|
// Ensures no GET is performed when deleting by name
|
|
t.Errorf("%s: unexpected request: %s %#v\n%#v", test.name, req.Method, req.URL, req)
|
|
return nil, fmt.Errorf("unexpected request")
|
|
}
|
|
}),
|
|
}
|
|
tf.Namespace = "test"
|
|
tf.ClientConfig = &restclient.Config{ContentConfig: restclient.ContentConfig{GroupVersion: &unversioned.GroupVersion{Version: test.version}}}
|
|
bufOut := bytes.NewBuffer([]byte{})
|
|
bufErr := bytes.NewBuffer([]byte{})
|
|
bufIn := bytes.NewBuffer([]byte{})
|
|
remoteAttach := &fakeRemoteAttach{}
|
|
if test.remoteAttachErr {
|
|
remoteAttach.err = fmt.Errorf("attach error")
|
|
}
|
|
params := &AttachOptions{
|
|
ContainerName: test.container,
|
|
In: bufIn,
|
|
Out: bufOut,
|
|
Err: bufErr,
|
|
Attach: remoteAttach,
|
|
}
|
|
cmd := &cobra.Command{}
|
|
if err := params.Complete(f, cmd, []string{"foo"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
err := params.Run()
|
|
if test.exepctedErr != "" && err.Error() != test.exepctedErr {
|
|
t.Errorf("%s: Unexpected exec error: %v", test.name, err)
|
|
continue
|
|
}
|
|
if test.exepctedErr == "" && err != nil {
|
|
t.Errorf("%s: Unexpected error: %v", test.name, err)
|
|
continue
|
|
}
|
|
if test.exepctedErr != "" {
|
|
continue
|
|
}
|
|
if remoteAttach.url.Path != test.attachPath {
|
|
t.Errorf("%s: Did not get expected path for exec request", test.name)
|
|
continue
|
|
}
|
|
if remoteAttach.method != "POST" {
|
|
t.Errorf("%s: Did not get method for attach request: %s", test.name, remoteAttach.method)
|
|
}
|
|
if remoteAttach.url.Query().Get("container") != "bar" {
|
|
t.Errorf("%s: Did not have query parameters: %s", test.name, remoteAttach.url.Query())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestAttachWarnings(t *testing.T) {
|
|
version := testapi.Default.GroupVersion().Version
|
|
tests := []struct {
|
|
name, container, version, podPath, expectedErr, expectedOut string
|
|
pod *api.Pod
|
|
stdin, tty bool
|
|
}{
|
|
{
|
|
name: "fallback tty if not supported",
|
|
version: version,
|
|
podPath: "/api/" + version + "/namespaces/test/pods/foo",
|
|
pod: attachPod(),
|
|
stdin: true,
|
|
tty: true,
|
|
expectedErr: "Unable to use a TTY - container bar did not allocate one",
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
f, tf, codec, ns := NewAPIFactory()
|
|
tf.Client = &fake.RESTClient{
|
|
NegotiatedSerializer: ns,
|
|
Client: fake.CreateHTTPClient(func(req *http.Request) (*http.Response, error) {
|
|
switch p, m := req.URL.Path, req.Method; {
|
|
case p == test.podPath && m == "GET":
|
|
body := objBody(codec, test.pod)
|
|
return &http.Response{StatusCode: 200, Header: defaultHeader(), Body: body}, nil
|
|
default:
|
|
t.Errorf("%s: unexpected request: %s %#v\n%#v", test.name, req.Method, req.URL, req)
|
|
return nil, fmt.Errorf("unexpected request")
|
|
}
|
|
}),
|
|
}
|
|
tf.Namespace = "test"
|
|
tf.ClientConfig = &restclient.Config{ContentConfig: restclient.ContentConfig{GroupVersion: &unversioned.GroupVersion{Version: test.version}}}
|
|
bufOut := bytes.NewBuffer([]byte{})
|
|
bufErr := bytes.NewBuffer([]byte{})
|
|
bufIn := bytes.NewBuffer([]byte{})
|
|
ex := &fakeRemoteAttach{}
|
|
params := &AttachOptions{
|
|
ContainerName: test.container,
|
|
In: bufIn,
|
|
Out: bufOut,
|
|
Err: bufErr,
|
|
Stdin: test.stdin,
|
|
TTY: test.tty,
|
|
Attach: ex,
|
|
}
|
|
cmd := &cobra.Command{}
|
|
if err := params.Complete(f, cmd, []string{"foo"}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := params.Run(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if test.stdin && test.tty {
|
|
if !test.pod.Spec.Containers[0].TTY {
|
|
if !strings.Contains(bufErr.String(), test.expectedErr) {
|
|
t.Errorf("%s: Expected TTY fallback warning for attach request: %s", test.name, bufErr.String())
|
|
continue
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func attachPod() *api.Pod {
|
|
return &api.Pod{
|
|
ObjectMeta: api.ObjectMeta{Name: "foo", Namespace: "test", ResourceVersion: "10"},
|
|
Spec: api.PodSpec{
|
|
RestartPolicy: api.RestartPolicyAlways,
|
|
DNSPolicy: api.DNSClusterFirst,
|
|
Containers: []api.Container{
|
|
{
|
|
Name: "bar",
|
|
},
|
|
},
|
|
InitContainers: []api.Container{
|
|
{
|
|
Name: "initfoo",
|
|
},
|
|
},
|
|
},
|
|
Status: api.PodStatus{
|
|
Phase: api.PodRunning,
|
|
},
|
|
}
|
|
}
|