/* 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" "encoding/json" "fmt" "io" "io/ioutil" "net/http" "os" "reflect" stdstrings "strings" "testing" "time" "github.com/spf13/cobra" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime/schema" restclient "k8s.io/client-go/rest" "k8s.io/client-go/rest/fake" "k8s.io/kubernetes/pkg/api/legacyscheme" "k8s.io/kubernetes/pkg/api/testapi" apitesting "k8s.io/kubernetes/pkg/api/testing" api "k8s.io/kubernetes/pkg/apis/core" "k8s.io/kubernetes/pkg/kubectl/cmd/resource" cmdtesting "k8s.io/kubernetes/pkg/kubectl/cmd/testing" cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util" "k8s.io/kubernetes/pkg/kubectl/scheme" "k8s.io/kubernetes/pkg/printers" "k8s.io/kubernetes/pkg/util/strings" ) // This init should be removed after switching this command and its tests to user external types. func init() { api.AddToScheme(scheme.Scheme) } func initTestErrorHandler(t *testing.T) { cmdutil.BehaviorOnFatal(func(str string, code int) { t.Errorf("Error running command (exit code %d): %s", code, str) }) } func defaultHeader() http.Header { header := http.Header{} header.Set("Content-Type", runtime.ContentTypeJSON) return header } func defaultClientConfig() *restclient.Config { return &restclient.Config{ APIPath: "/api", ContentConfig: restclient.ContentConfig{ NegotiatedSerializer: scheme.Codecs, ContentType: runtime.ContentTypeJSON, GroupVersion: &schema.GroupVersion{Version: "v1"}, }, } } func testData() (*api.PodList, *api.ServiceList, *api.ReplicationControllerList) { pods := &api.PodList{ ListMeta: metav1.ListMeta{ ResourceVersion: "15", }, Items: []api.Pod{ { ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "test", ResourceVersion: "10"}, Spec: apitesting.DeepEqualSafePodSpec(), }, { ObjectMeta: metav1.ObjectMeta{Name: "bar", Namespace: "test", ResourceVersion: "11"}, Spec: apitesting.DeepEqualSafePodSpec(), }, }, } svc := &api.ServiceList{ ListMeta: metav1.ListMeta{ ResourceVersion: "16", }, Items: []api.Service{ { ObjectMeta: metav1.ObjectMeta{Name: "baz", Namespace: "test", ResourceVersion: "12"}, Spec: api.ServiceSpec{ SessionAffinity: "None", Type: api.ServiceTypeClusterIP, }, }, }, } rc := &api.ReplicationControllerList{ ListMeta: metav1.ListMeta{ ResourceVersion: "17", }, Items: []api.ReplicationController{ { ObjectMeta: metav1.ObjectMeta{Name: "rc1", Namespace: "test", ResourceVersion: "18"}, Spec: api.ReplicationControllerSpec{ Replicas: 1, }, }, }, } return pods, svc, rc } type testPrinter struct { Objects []runtime.Object Err error GenericPrinter bool } func (t *testPrinter) PrintObj(obj runtime.Object, out io.Writer) error { t.Objects = append(t.Objects, obj) fmt.Fprintf(out, "%#v", obj) return t.Err } // TODO: implement HandledResources() func (t *testPrinter) HandledResources() []string { return []string{} } func (t *testPrinter) AfterPrint(output io.Writer, res string) error { return nil } func (t *testPrinter) IsGeneric() bool { return t.GenericPrinter } type testDescriber struct { Name, Namespace string Settings printers.DescriberSettings Output string Err error } func (t *testDescriber) Describe(namespace, name string, describerSettings printers.DescriberSettings) (output string, err error) { t.Namespace, t.Name = namespace, name t.Settings = describerSettings return t.Output, t.Err } func objBody(codec runtime.Codec, obj runtime.Object) io.ReadCloser { return ioutil.NopCloser(bytes.NewReader([]byte(runtime.EncodeOrDie(codec, obj)))) } func policyObjBody(obj runtime.Object) io.ReadCloser { return ioutil.NopCloser(bytes.NewReader([]byte(runtime.EncodeOrDie(testapi.Policy.Codec(), obj)))) } func bytesBody(bodyBytes []byte) io.ReadCloser { return ioutil.NopCloser(bytes.NewReader(bodyBytes)) } func stringBody(body string) io.ReadCloser { return ioutil.NopCloser(bytes.NewReader([]byte(body))) } func Example_printMultiContainersReplicationControllerWithWide() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } cmd := NewCmdRun(tf, os.Stdin, os.Stdout, os.Stderr) ctrl := &api.ReplicationController{ ObjectMeta: metav1.ObjectMeta{ Name: "foo", Labels: map[string]string{"foo": "bar"}, CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.ReplicationControllerSpec{ Replicas: 1, Selector: map[string]string{"foo": "bar"}, Template: &api.PodTemplateSpec{ ObjectMeta: metav1.ObjectMeta{ Labels: map[string]string{"foo": "bar"}, }, Spec: api.PodSpec{ Containers: []api.Container{ { Name: "foo", Image: "someimage", }, { Name: "foo2", Image: "someimage2", }, }, }, }, }, Status: api.ReplicationControllerStatus{ Replicas: 1, }, } cmd.Flags().Set("output", "wide") err := cmdutil.PrintObject(cmd, ctrl, os.Stdout) if err != nil { fmt.Printf("Unexpected error: %v", err) } // Output: // NAME DESIRED CURRENT READY AGE CONTAINERS IMAGES SELECTOR // foo 1 1 0 10y foo,foo2 someimage,someimage2 foo=bar } func Example_printReplicationController() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } cmd := NewCmdRun(tf, os.Stdin, os.Stdout, os.Stderr) ctrl := &api.ReplicationController{ ObjectMeta: metav1.ObjectMeta{ Name: "foo", Labels: map[string]string{"foo": "bar"}, CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.ReplicationControllerSpec{ Replicas: 1, Selector: map[string]string{"foo": "bar"}, Template: &api.PodTemplateSpec{ ObjectMeta: metav1.ObjectMeta{ Labels: map[string]string{"foo": "bar"}, }, Spec: api.PodSpec{ Containers: []api.Container{ { Name: "foo", Image: "someimage", }, { Name: "foo2", Image: "someimage", }, }, }, }, }, Status: api.ReplicationControllerStatus{ Replicas: 1, }, } err := cmdutil.PrintObject(cmd, ctrl, os.Stdout) if err != nil { fmt.Printf("Unexpected error: %v", err) } // Output: // NAME DESIRED CURRENT READY AGE // foo 1 1 0 10y } func Example_printPodWithWideFormat() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } nodeName := "kubernetes-node-abcd" cmd := NewCmdRun(tf, os.Stdin, os.Stdout, os.Stderr) pod := &api.Pod{ ObjectMeta: metav1.ObjectMeta{ Name: "test1", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: "podPhase", ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, PodIP: "10.1.1.3", }, } cmd.Flags().Set("output", "wide") err := cmdutil.PrintObject(cmd, pod, os.Stdout) if err != nil { fmt.Printf("Unexpected error: %v", err) } // Output: // NAME READY STATUS RESTARTS AGE IP NODE // test1 1/2 podPhase 6 10y 10.1.1.3 kubernetes-node-abcd } func Example_printPodWithShowLabels() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } nodeName := "kubernetes-node-abcd" cmd := NewCmdRun(tf, os.Stdin, os.Stdout, os.Stderr) pod := &api.Pod{ ObjectMeta: metav1.ObjectMeta{ Name: "test1", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, Labels: map[string]string{ "l1": "key", "l2": "value", }, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: "podPhase", ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, }, } cmd.Flags().Set("show-labels", "true") err := cmdutil.PrintObject(cmd, pod, os.Stdout) if err != nil { fmt.Printf("Unexpected error: %v", err) } // Output: // NAME READY STATUS RESTARTS AGE LABELS // test1 1/2 podPhase 6 10y l1=key,l2=value } func newAllPhasePodList() *api.PodList { nodeName := "kubernetes-node-abcd" return &api.PodList{ Items: []api.Pod{ { ObjectMeta: metav1.ObjectMeta{ Name: "test1", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: api.PodPending, ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, }, }, { ObjectMeta: metav1.ObjectMeta{ Name: "test2", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: api.PodRunning, ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, }, }, { ObjectMeta: metav1.ObjectMeta{ Name: "test3", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: api.PodSucceeded, ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, }, }, { ObjectMeta: metav1.ObjectMeta{ Name: "test4", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: api.PodFailed, ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, }, }, { ObjectMeta: metav1.ObjectMeta{ Name: "test5", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, }, Spec: api.PodSpec{ Containers: make([]api.Container, 2), NodeName: nodeName, }, Status: api.PodStatus{ Phase: api.PodUnknown, ContainerStatuses: []api.ContainerStatus{ {Ready: true, RestartCount: 3, State: api.ContainerState{Running: &api.ContainerStateRunning{}}}, {RestartCount: 3}, }, }, }}, } } func Example_printPodShowTerminated() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } cmd := NewCmdRun(tf, os.Stdin, os.Stdout, os.Stderr) podList := newAllPhasePodList() // filter pods filterFuncs := tf.DefaultResourceFilterFunc() filterOpts := cmdutil.ExtractCmdPrintOptions(cmd, false) _, filteredPodList, errs := cmdutil.FilterResourceList(podList, filterFuncs, filterOpts) if errs != nil { fmt.Printf("Unexpected filter error: %v\n", errs) } printer, err := cmdutil.PrinterForOptions(cmdutil.ExtractCmdPrintOptions(cmd, false)) if err != nil { fmt.Printf("Unexpected printer get error: %v\n", errs) } for _, pod := range filteredPodList { err := printer.PrintObj(pod, os.Stdout) if err != nil { fmt.Printf("Unexpected error: %v", err) } } // Output: // NAME READY STATUS RESTARTS AGE // test1 1/2 Pending 6 10y // test2 1/2 Running 6 10y // test3 1/2 Succeeded 6 10y // test4 1/2 Failed 6 10y // test5 1/2 Unknown 6 10y } func Example_printPodShowAll() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } cmd := NewCmdRun(tf, os.Stdin, os.Stdout, os.Stderr) podList := newAllPhasePodList() err := cmdutil.PrintObject(cmd, podList, os.Stdout) if err != nil { fmt.Printf("Unexpected error: %v", err) } // Output: // NAME READY STATUS RESTARTS AGE // test1 1/2 Pending 6 10y // test2 1/2 Running 6 10y // test3 1/2 Succeeded 6 10y // test4 1/2 Failed 6 10y // test5 1/2 Unknown 6 10y } func Example_printServiceWithLabels() { tf := cmdtesting.NewTestFactory() defer tf.Cleanup() ns := legacyscheme.Codecs tf.Client = &fake.RESTClient{ NegotiatedSerializer: ns, Client: nil, } cmd := resource.NewCmdGet(tf, os.Stdout, os.Stderr) svc := &api.ServiceList{ Items: []api.Service{ { ObjectMeta: metav1.ObjectMeta{ Name: "svc1", Namespace: "ns1", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, Labels: map[string]string{ "l1": "value", }, }, Spec: api.ServiceSpec{ Ports: []api.ServicePort{ {Protocol: "UDP", Port: 53}, {Protocol: "TCP", Port: 53}, }, Selector: map[string]string{ "s": "magic", }, ClusterIP: "10.1.1.1", Type: api.ServiceTypeClusterIP, }, Status: api.ServiceStatus{}, }, { ObjectMeta: metav1.ObjectMeta{ Name: "svc2", Namespace: "ns2", CreationTimestamp: metav1.Time{Time: time.Now().AddDate(-10, 0, 0)}, Labels: map[string]string{ "l1": "dolla-bill-yall", }, }, Spec: api.ServiceSpec{ Ports: []api.ServicePort{ {Protocol: "TCP", Port: 80}, {Protocol: "TCP", Port: 8080}, }, Selector: map[string]string{ "s": "kazam", }, ClusterIP: "10.1.1.2", Type: api.ServiceTypeClusterIP, }, Status: api.ServiceStatus{}, }}, } ld := strings.NewLineDelimiter(os.Stdout, "|") defer ld.Flush() cmd.Flags().Set("label-columns", "l1") err := cmdutil.PrintObject(cmd, svc, ld) if err != nil { fmt.Printf("Unexpected error: %v", err) } // Output: // |NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE L1| // |svc1 ClusterIP 10.1.1.1 53/UDP,53/TCP 10y value| // |svc2 ClusterIP 10.1.1.2 80/TCP,8080/TCP 10y dolla-bill-yall| // || } func TestNormalizationFuncGlobalExistence(t *testing.T) { // This test can be safely deleted when we will not support multiple flag formats root := NewKubectlCommand(cmdutil.NewFactory(nil), os.Stdin, os.Stdout, os.Stderr) if root.Parent() != nil { t.Fatal("We expect the root command to be returned") } if root.GlobalNormalizationFunc() == nil { t.Fatal("We expect that root command has a global normalization function") } if reflect.ValueOf(root.GlobalNormalizationFunc()).Pointer() != reflect.ValueOf(root.Flags().GetNormalizeFunc()).Pointer() { t.Fatal("root command seems to have a wrong normalization function") } sub := root for sub.HasSubCommands() { sub = sub.Commands()[0] } // In case of failure of this test check this PR: spf13/cobra#110 if reflect.ValueOf(sub.Flags().GetNormalizeFunc()).Pointer() != reflect.ValueOf(root.Flags().GetNormalizeFunc()).Pointer() { t.Fatal("child and root commands should have the same normalization functions") } } func genResponseWithJsonEncodedBody(bodyStruct interface{}) (*http.Response, error) { jsonBytes, err := json.Marshal(bodyStruct) if err != nil { return nil, err } return &http.Response{StatusCode: 200, Header: defaultHeader(), Body: bytesBody(jsonBytes)}, nil } func Test_deprecatedAlias(t *testing.T) { var correctCommandCalled bool makeCobraCommand := func() *cobra.Command { cobraCmd := new(cobra.Command) cobraCmd.Use = "print five lines" cobraCmd.Run = func(*cobra.Command, []string) { correctCommandCalled = true } return cobraCmd } original := makeCobraCommand() alias := deprecatedAlias("echo", makeCobraCommand()) if len(alias.Deprecated) == 0 { t.Error("deprecatedAlias should always have a non-empty .Deprecated") } if !stdstrings.Contains(alias.Deprecated, "print") { t.Error("deprecatedAlias should give the name of the new function in its .Deprecated field") } if !alias.Hidden { t.Error("deprecatedAlias should never have .Hidden == false (deprecated aliases should be hidden)") } if alias.Name() != "echo" { t.Errorf("deprecatedAlias has name %q, expected %q", alias.Name(), "echo") } if original.Name() != "print" { t.Errorf("original command has name %q, expected %q", original.Name(), "print") } buffer := new(bytes.Buffer) alias.SetOutput(buffer) alias.Execute() str := buffer.String() if !stdstrings.Contains(str, "deprecated") || !stdstrings.Contains(str, "print") { t.Errorf("deprecation warning %q does not include enough information", str) } // It would be nice to test to see that original.Run == alias.Run // Unfortunately Golang does not allow comparing functions. I could do // this with reflect, but that's technically invoking undefined // behavior. Best we can do is make sure that the function is called. if !correctCommandCalled { t.Errorf("original function doesn't appear to have been called by alias") } }