/* Copyright 2017 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 server import ( "errors" "testing" "time" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "golang.org/x/net/context" "github.com/containerd/containerd/api/types/container" "k8s.io/kubernetes/pkg/kubelet/api/v1alpha1/runtime" "github.com/kubernetes-incubator/cri-containerd/pkg/metadata" servertesting "github.com/kubernetes-incubator/cri-containerd/pkg/server/testing" ) // Variables used in the following test. const ( sandboxStatusTestID = "test-id" sandboxStatusTestIP = "10.10.10.10" sandboxStatusTestNetNS = "test-netns" ) func getSandboxStatusTestData() (*metadata.SandboxMetadata, *runtime.PodSandboxStatus) { config := &runtime.PodSandboxConfig{ Metadata: &runtime.PodSandboxMetadata{ Name: "test-name", Uid: "test-uid", Namespace: "test-ns", Attempt: 1, }, Linux: &runtime.LinuxPodSandboxConfig{ SecurityContext: &runtime.LinuxSandboxSecurityContext{ NamespaceOptions: &runtime.NamespaceOption{ HostNetwork: true, HostPid: false, HostIpc: true, }, }, }, Labels: map[string]string{"a": "b"}, Annotations: map[string]string{"c": "d"}, } createdAt := time.Now().UnixNano() metadata := &metadata.SandboxMetadata{ ID: sandboxStatusTestID, Name: "test-name", Config: config, CreatedAt: createdAt, NetNS: sandboxStatusTestNetNS, } expectedStatus := &runtime.PodSandboxStatus{ Id: sandboxStatusTestID, Metadata: config.GetMetadata(), CreatedAt: createdAt, Network: &runtime.PodSandboxNetworkStatus{Ip: ""}, Linux: &runtime.LinuxPodSandboxStatus{ Namespaces: &runtime.Namespace{ Network: sandboxStatusTestNetNS, Options: &runtime.NamespaceOption{ HostNetwork: true, HostPid: false, HostIpc: true, }, }, }, Labels: config.GetLabels(), Annotations: config.GetAnnotations(), } return metadata, expectedStatus } func TestToCRISandboxStatus(t *testing.T) { for desc, test := range map[string]struct { state runtime.PodSandboxState expectNetNS string }{ "ready sandbox should have network namespace": { state: runtime.PodSandboxState_SANDBOX_READY, expectNetNS: sandboxStatusTestNetNS, }, "not ready sandbox should not have network namespace": { state: runtime.PodSandboxState_SANDBOX_NOTREADY, expectNetNS: "", }, } { metadata, expect := getSandboxStatusTestData() status := toCRISandboxStatus(metadata, test.state, sandboxStatusTestIP) expect.Linux.Namespaces.Network = test.expectNetNS expect.State = test.state expect.Network.Ip = sandboxStatusTestIP assert.Equal(t, expect, status, desc) } } func TestPodSandboxStatus(t *testing.T) { for desc, test := range map[string]struct { sandboxContainers []container.Container injectMetadata bool injectErr error injectIP bool injectCNIErr error expectState runtime.PodSandboxState expectErr bool expectCalls []string expectedCNICalls []string }{ "sandbox status without metadata": { injectMetadata: false, expectErr: true, expectCalls: []string{}, expectedCNICalls: []string{}, }, "sandbox status with running sandbox container": { sandboxContainers: []container.Container{{ ID: sandboxStatusTestID, Pid: 1, Status: container.Status_RUNNING, }}, injectMetadata: true, expectState: runtime.PodSandboxState_SANDBOX_READY, expectCalls: []string{"info"}, expectedCNICalls: []string{"GetContainerNetworkStatus"}, }, "sandbox status with stopped sandbox container": { sandboxContainers: []container.Container{{ ID: sandboxStatusTestID, Pid: 1, Status: container.Status_STOPPED, }}, injectMetadata: true, expectState: runtime.PodSandboxState_SANDBOX_NOTREADY, expectCalls: []string{"info"}, expectedCNICalls: []string{"GetContainerNetworkStatus"}, }, "sandbox status with non-existing sandbox container": { sandboxContainers: []container.Container{}, injectMetadata: true, expectState: runtime.PodSandboxState_SANDBOX_NOTREADY, expectCalls: []string{"info"}, expectedCNICalls: []string{"GetContainerNetworkStatus"}, }, "sandbox status with arbitrary error": { sandboxContainers: []container.Container{{ ID: sandboxStatusTestID, Pid: 1, Status: container.Status_RUNNING, }}, injectMetadata: true, expectState: runtime.PodSandboxState_SANDBOX_READY, injectErr: errors.New("arbitrary error"), expectErr: true, expectCalls: []string{"info"}, expectedCNICalls: []string{}, }, "sandbox status with IP address": { sandboxContainers: []container.Container{{ ID: sandboxStatusTestID, Pid: 1, Status: container.Status_RUNNING, }}, injectMetadata: true, expectState: runtime.PodSandboxState_SANDBOX_READY, expectCalls: []string{"info"}, injectIP: true, expectedCNICalls: []string{"GetContainerNetworkStatus"}, }, "sandbox status with GetContainerNetworkStatus returns error": { sandboxContainers: []container.Container{{ ID: sandboxStatusTestID, Pid: 1, Status: container.Status_RUNNING, }}, injectMetadata: true, expectState: runtime.PodSandboxState_SANDBOX_READY, expectCalls: []string{"info"}, expectedCNICalls: []string{"GetContainerNetworkStatus"}, injectCNIErr: errors.New("get container network status error"), }, } { t.Logf("TestCase %q", desc) metadata, expect := getSandboxStatusTestData() expect.Network.Ip = "" c := newTestCRIContainerdService() fake := c.containerService.(*servertesting.FakeExecutionClient) fakeCNIPlugin := c.netPlugin.(*servertesting.FakeCNIPlugin) fake.SetFakeContainers(test.sandboxContainers) if test.injectMetadata { assert.NoError(t, c.sandboxIDIndex.Add(metadata.ID)) assert.NoError(t, c.sandboxStore.Create(*metadata)) } if test.injectErr != nil { fake.InjectError("info", test.injectErr) } if test.injectCNIErr != nil { fakeCNIPlugin.InjectError("GetContainerNetworkStatus", test.injectCNIErr) } if test.injectIP { fakeCNIPlugin.SetFakePodNetwork(metadata.NetNS, metadata.Config.GetMetadata().GetNamespace(), metadata.Config.GetMetadata().GetName(), sandboxStatusTestID, sandboxStatusTestIP) expect.Network.Ip = sandboxStatusTestIP } res, err := c.PodSandboxStatus(context.Background(), &runtime.PodSandboxStatusRequest{ PodSandboxId: sandboxStatusTestID, }) assert.Equal(t, test.expectCalls, fake.GetCalledNames()) assert.Equal(t, test.expectedCNICalls, fakeCNIPlugin.GetCalledNames()) if test.expectErr { assert.Error(t, err) assert.Nil(t, res) continue } assert.NoError(t, err) require.NotNil(t, res) expect.State = test.expectState if expect.State == runtime.PodSandboxState_SANDBOX_NOTREADY { expect.Linux.Namespaces.Network = "" } assert.Equal(t, expect, res.GetStatus()) } }