/* 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" "io" "os" "testing" "time" "github.com/containerd/containerd/api/services/execution" "github.com/containerd/containerd/api/types/mount" "github.com/containerd/containerd/api/types/task" imagespec "github.com/opencontainers/image-spec/specs-go/v1" runtimespec "github.com/opencontainers/runtime-spec/specs-go" "github.com/opencontainers/runtime-tools/generate" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "golang.org/x/net/context" runtime "k8s.io/kubernetes/pkg/kubelet/apis/cri/v1alpha1" "github.com/kubernetes-incubator/cri-containerd/pkg/metadata" ostesting "github.com/kubernetes-incubator/cri-containerd/pkg/os/testing" servertesting "github.com/kubernetes-incubator/cri-containerd/pkg/server/testing" ) func checkMount(t *testing.T, mounts []runtimespec.Mount, src, dest, typ string, contains, notcontains []string) { found := false for _, m := range mounts { if m.Source == src && m.Destination == dest { assert.Equal(t, m.Type, typ) for _, c := range contains { assert.Contains(t, m.Options, c) } for _, n := range notcontains { assert.NotContains(t, m.Options, n) } found = true break } } assert.True(t, found, "mount from %q to %q not found", src, dest) } func getStartContainerTestData() (*runtime.ContainerConfig, *runtime.PodSandboxConfig, *imagespec.ImageConfig, func(*testing.T, string, uint32, *runtimespec.Spec)) { config := &runtime.ContainerConfig{ Metadata: &runtime.ContainerMetadata{ Name: "test-name", Attempt: 1, }, Command: []string{"test", "command"}, Args: []string{"test", "args"}, WorkingDir: "test-cwd", Envs: []*runtime.KeyValue{ {Key: "k1", Value: "v1"}, {Key: "k2", Value: "v2"}, }, Mounts: []*runtime.Mount{ { ContainerPath: "container-path-1", HostPath: "host-path-1", }, { ContainerPath: "container-path-2", HostPath: "host-path-2", Readonly: true, }, }, Labels: map[string]string{"a": "b"}, Annotations: map[string]string{"c": "d"}, Linux: &runtime.LinuxContainerConfig{ Resources: &runtime.LinuxContainerResources{ CpuPeriod: 100, CpuQuota: 200, CpuShares: 300, MemoryLimitInBytes: 400, OomScoreAdj: 500, }, SecurityContext: &runtime.LinuxContainerSecurityContext{ Capabilities: &runtime.Capability{ AddCapabilities: []string{"SYS_ADMIN"}, DropCapabilities: []string{"CHOWN"}, }, SupplementalGroups: []int64{1111, 2222}, }, }, } sandboxConfig := &runtime.PodSandboxConfig{ Metadata: &runtime.PodSandboxMetadata{ Name: "test-sandbox-name", Uid: "test-sandbox-uid", Namespace: "test-sandbox-ns", Attempt: 2, }, Linux: &runtime.LinuxPodSandboxConfig{ CgroupParent: "/test/cgroup/parent", }, } imageConfig := &imagespec.ImageConfig{ Env: []string{"ik1=iv1", "ik2=iv2"}, Entrypoint: []string{"/entrypoint"}, Cmd: []string{"cmd"}, WorkingDir: "/workspace", } specCheck := func(t *testing.T, id string, sandboxPid uint32, spec *runtimespec.Spec) { assert.Equal(t, relativeRootfsPath, spec.Root.Path) assert.Equal(t, []string{"test", "command", "test", "args"}, spec.Process.Args) assert.Equal(t, "test-cwd", spec.Process.Cwd) assert.Contains(t, spec.Process.Env, "k1=v1", "k2=v2", "ik1=iv1", "ik2=iv2") t.Logf("Check cgroups bind mount") checkMount(t, spec.Mounts, "cgroup", "/sys/fs/cgroup", "cgroup", []string{"ro"}, nil) t.Logf("Check bind mount") checkMount(t, spec.Mounts, "host-path-1", "container-path-1", "bind", []string{"rw"}, nil) checkMount(t, spec.Mounts, "host-path-2", "container-path-2", "bind", []string{"ro"}, nil) t.Logf("Check resource limits") assert.EqualValues(t, *spec.Linux.Resources.CPU.Period, 100) assert.EqualValues(t, *spec.Linux.Resources.CPU.Quota, 200) assert.EqualValues(t, *spec.Linux.Resources.CPU.Shares, 300) assert.EqualValues(t, *spec.Linux.Resources.Memory.Limit, 400) assert.EqualValues(t, *spec.Linux.Resources.OOMScoreAdj, 500) t.Logf("Check capabilities") assert.Contains(t, spec.Process.Capabilities.Bounding, "CAP_SYS_ADMIN") assert.Contains(t, spec.Process.Capabilities.Effective, "CAP_SYS_ADMIN") assert.Contains(t, spec.Process.Capabilities.Inheritable, "CAP_SYS_ADMIN") assert.Contains(t, spec.Process.Capabilities.Permitted, "CAP_SYS_ADMIN") assert.Contains(t, spec.Process.Capabilities.Ambient, "CAP_SYS_ADMIN") assert.NotContains(t, spec.Process.Capabilities.Bounding, "CAP_CHOWN") assert.NotContains(t, spec.Process.Capabilities.Effective, "CAP_CHOWN") assert.NotContains(t, spec.Process.Capabilities.Inheritable, "CAP_CHOWN") assert.NotContains(t, spec.Process.Capabilities.Permitted, "CAP_CHOWN") assert.NotContains(t, spec.Process.Capabilities.Ambient, "CAP_CHOWN") t.Logf("Check supplemental groups") assert.Contains(t, spec.Process.User.AdditionalGids, uint32(1111)) assert.Contains(t, spec.Process.User.AdditionalGids, uint32(2222)) t.Logf("Check cgroup path") assert.Equal(t, getCgroupsPath("/test/cgroup/parent", id), spec.Linux.CgroupsPath) t.Logf("Check namespaces") assert.Contains(t, spec.Linux.Namespaces, runtimespec.LinuxNamespace{ Type: runtimespec.NetworkNamespace, Path: getNetworkNamespace(sandboxPid), }) assert.Contains(t, spec.Linux.Namespaces, runtimespec.LinuxNamespace{ Type: runtimespec.IPCNamespace, Path: getIPCNamespace(sandboxPid), }) assert.Contains(t, spec.Linux.Namespaces, runtimespec.LinuxNamespace{ Type: runtimespec.UTSNamespace, Path: getUTSNamespace(sandboxPid), }) assert.Contains(t, spec.Linux.Namespaces, runtimespec.LinuxNamespace{ Type: runtimespec.PIDNamespace, Path: getPIDNamespace(sandboxPid), }) } return config, sandboxConfig, imageConfig, specCheck } func TestGeneralContainerSpec(t *testing.T) { testID := "test-id" testPid := uint32(1234) config, sandboxConfig, imageConfig, specCheck := getStartContainerTestData() c := newTestCRIContainerdService() spec, err := c.generateContainerSpec(testID, testPid, config, sandboxConfig, imageConfig, nil) assert.NoError(t, err) specCheck(t, testID, testPid, spec) } func TestContainerSpecTty(t *testing.T) { testID := "test-id" testPid := uint32(1234) config, sandboxConfig, imageConfig, specCheck := getStartContainerTestData() c := newTestCRIContainerdService() for _, tty := range []bool{true, false} { config.Tty = tty spec, err := c.generateContainerSpec(testID, testPid, config, sandboxConfig, imageConfig, nil) assert.NoError(t, err) specCheck(t, testID, testPid, spec) assert.Equal(t, tty, spec.Process.Terminal) } } func TestContainerSpecReadonlyRootfs(t *testing.T) { testID := "test-id" testPid := uint32(1234) config, sandboxConfig, imageConfig, specCheck := getStartContainerTestData() c := newTestCRIContainerdService() for _, readonly := range []bool{true, false} { config.Linux.SecurityContext.ReadonlyRootfs = readonly spec, err := c.generateContainerSpec(testID, testPid, config, sandboxConfig, imageConfig, nil) assert.NoError(t, err) specCheck(t, testID, testPid, spec) assert.Equal(t, readonly, spec.Root.Readonly) } } func TestContainerSpecWithExtraMounts(t *testing.T) { testID := "test-id" testPid := uint32(1234) config, sandboxConfig, imageConfig, specCheck := getStartContainerTestData() c := newTestCRIContainerdService() mountInConfig := &runtime.Mount{ ContainerPath: "test-container-path", HostPath: "test-host-path", Readonly: false, } config.Mounts = append(config.Mounts, mountInConfig) extraMount := &runtime.Mount{ ContainerPath: "test-container-path", HostPath: "test-host-path-extra", Readonly: true, } spec, err := c.generateContainerSpec(testID, testPid, config, sandboxConfig, imageConfig, []*runtime.Mount{extraMount}) assert.NoError(t, err) specCheck(t, testID, testPid, spec) var mounts []runtimespec.Mount for _, m := range spec.Mounts { if m.Destination == "test-container-path" { mounts = append(mounts, m) } } t.Logf("Extra mounts should come first") require.Len(t, mounts, 2) assert.Equal(t, "test-host-path-extra", mounts[0].Source) assert.Contains(t, mounts[0].Options, "ro") assert.Equal(t, "test-host-path", mounts[1].Source) assert.Contains(t, mounts[1].Options, "rw") } func TestContainerSpecCommand(t *testing.T) { for desc, test := range map[string]struct { criEntrypoint []string criArgs []string imageEntrypoint []string imageArgs []string expected []string expectErr bool }{ "should use cri entrypoint if it's specified": { criEntrypoint: []string{"a", "b"}, imageEntrypoint: []string{"c", "d"}, imageArgs: []string{"e", "f"}, expected: []string{"a", "b"}, }, "should use cri entrypoint if it's specified even if it's empty": { criEntrypoint: []string{}, criArgs: []string{"a", "b"}, imageEntrypoint: []string{"c", "d"}, imageArgs: []string{"e", "f"}, expected: []string{"a", "b"}, }, "should use cri entrypoint and args if they are specified": { criEntrypoint: []string{"a", "b"}, criArgs: []string{"c", "d"}, imageEntrypoint: []string{"e", "f"}, imageArgs: []string{"g", "h"}, expected: []string{"a", "b", "c", "d"}, }, "should use image entrypoint if cri entrypoint is not specified": { criArgs: []string{"a", "b"}, imageEntrypoint: []string{"c", "d"}, imageArgs: []string{"e", "f"}, expected: []string{"c", "d", "a", "b"}, }, "should use image args if both cri entrypoint and args are not specified": { imageEntrypoint: []string{"c", "d"}, imageArgs: []string{"e", "f"}, expected: []string{"c", "d", "e", "f"}, }, "should return error if both entrypoint and args are empty": { expectErr: true, }, } { config, _, imageConfig, _ := getStartContainerTestData() g := generate.New() config.Command = test.criEntrypoint config.Args = test.criArgs imageConfig.Entrypoint = test.imageEntrypoint imageConfig.Cmd = test.imageArgs err := setOCIProcessArgs(&g, config, imageConfig) if test.expectErr { assert.Error(t, err) continue } assert.NoError(t, err) assert.Equal(t, test.expected, g.Spec().Process.Args, desc) } } func TestGenerateContainerMounts(t *testing.T) { testSandboxRootDir := "test-sandbox-root" for desc, test := range map[string]struct { securityContext *runtime.LinuxContainerSecurityContext expectedMounts []*runtime.Mount }{ "should setup ro mount when rootfs is read-only": { securityContext: &runtime.LinuxContainerSecurityContext{ ReadonlyRootfs: true, }, expectedMounts: []*runtime.Mount{ { ContainerPath: "/etc/hosts", HostPath: testSandboxRootDir + "/hosts", Readonly: true, }, { ContainerPath: resolvConfPath, HostPath: testSandboxRootDir + "/resolv.conf", Readonly: true, }, { ContainerPath: "/dev/shm", HostPath: testSandboxRootDir + "/shm", Readonly: false, }, }, }, "should setup rw mount when rootfs is read-write": { securityContext: &runtime.LinuxContainerSecurityContext{}, expectedMounts: []*runtime.Mount{ { ContainerPath: "/etc/hosts", HostPath: testSandboxRootDir + "/hosts", Readonly: false, }, { ContainerPath: resolvConfPath, HostPath: testSandboxRootDir + "/resolv.conf", Readonly: false, }, { ContainerPath: "/dev/shm", HostPath: testSandboxRootDir + "/shm", Readonly: false, }, }, }, "should use host /dev/shm when host ipc is set": { securityContext: &runtime.LinuxContainerSecurityContext{ NamespaceOptions: &runtime.NamespaceOption{HostIpc: true}, }, expectedMounts: []*runtime.Mount{ { ContainerPath: "/etc/hosts", HostPath: testSandboxRootDir + "/hosts", Readonly: false, }, { ContainerPath: resolvConfPath, HostPath: testSandboxRootDir + "/resolv.conf", Readonly: false, }, { ContainerPath: "/dev/shm", HostPath: "/dev/shm", Readonly: false, }, }, }, } { config := &runtime.ContainerConfig{ Metadata: &runtime.ContainerMetadata{ Name: "test-name", Attempt: 1, }, Linux: &runtime.LinuxContainerConfig{ SecurityContext: test.securityContext, }, } c := newTestCRIContainerdService() mounts := c.generateContainerMounts(testSandboxRootDir, config) assert.Equal(t, test.expectedMounts, mounts, desc) } } func TestPrivilegedBindMount(t *testing.T) { for desc, test := range map[string]struct { privileged bool readonlyRootFS bool expectedSysFSRO bool expectedCgroupFSRO bool }{ "sysfs and cgroupfs should mount as 'ro' by default": { expectedSysFSRO: true, expectedCgroupFSRO: true, }, "sysfs and cgroupfs should not mount as 'ro' if privileged": { privileged: true, expectedSysFSRO: false, expectedCgroupFSRO: false, }, "sysfs should mount as 'ro' if root filrsystem is readonly": { privileged: true, readonlyRootFS: true, expectedSysFSRO: true, expectedCgroupFSRO: false, }, } { t.Logf("TestCase %q", desc) g := generate.New() g.SetRootReadonly(test.readonlyRootFS) addOCIBindMounts(&g, nil, test.privileged) spec := g.Spec() if test.expectedSysFSRO { checkMount(t, spec.Mounts, "sysfs", "/sys", "sysfs", []string{"ro"}, nil) } else { checkMount(t, spec.Mounts, "sysfs", "/sys", "sysfs", nil, []string{"ro"}) } if test.expectedCgroupFSRO { checkMount(t, spec.Mounts, "cgroup", "/sys/fs/cgroup", "cgroup", []string{"ro"}, nil) } else { checkMount(t, spec.Mounts, "cgroup", "/sys/fs/cgroup", "cgroup", nil, []string{"ro"}) } } } func TestStartContainer(t *testing.T) { testID := "test-id" testSandboxID := "test-sandbox-id" testSandboxPid := uint32(4321) testImageID := "sha256:c75bebcdd211f41b3a460c7bf82970ed6c75acaab9cd4c9a4e125b03ca113799" config, sandboxConfig, imageConfig, _ := getStartContainerTestData() // TODO: declare and test specCheck see below testMetadata := &metadata.ContainerMetadata{ ID: testID, Name: "test-name", SandboxID: testSandboxID, Config: config, ImageRef: testImageID, CreatedAt: time.Now().UnixNano(), } testSandboxMetadata := &metadata.SandboxMetadata{ ID: testSandboxID, Name: "test-sandbox-name", Config: sandboxConfig, } testSandboxContainer := &task.Task{ ID: testSandboxID, Pid: testSandboxPid, Status: task.StatusRunning, } testMounts := []*mount.Mount{{Type: "bind", Source: "test-source"}} for desc, test := range map[string]struct { containerMetadata *metadata.ContainerMetadata sandboxMetadata *metadata.SandboxMetadata sandboxContainerdContainer *task.Task imageMetadataErr bool snapshotMountsErr bool prepareFIFOErr error createContainerErr error startContainerErr error expectStateChange bool expectCalls []string expectErr bool }{ "should return error when container does not exist": { containerMetadata: nil, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, expectCalls: []string{}, expectErr: true, }, "should return error when container is not in created state": { containerMetadata: &metadata.ContainerMetadata{ ID: testID, Name: "test-name", SandboxID: testSandboxID, Config: config, CreatedAt: time.Now().UnixNano(), StartedAt: time.Now().UnixNano(), }, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, expectCalls: []string{}, expectErr: true, }, "should return error when container is in removing state": { containerMetadata: &metadata.ContainerMetadata{ ID: testID, Name: "test-name", SandboxID: testSandboxID, Config: config, CreatedAt: time.Now().UnixNano(), Removing: true, }, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, expectCalls: []string{}, expectErr: true, }, "should return error when sandbox does not exist": { containerMetadata: testMetadata, sandboxMetadata: nil, sandboxContainerdContainer: testSandboxContainer, expectStateChange: true, expectCalls: []string{}, expectErr: true, }, "should return error when sandbox is not running": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: &task.Task{ ID: testSandboxID, Pid: testSandboxPid, Status: task.StatusStopped, }, expectStateChange: true, expectCalls: []string{"info"}, expectErr: true, }, "should return error when image doesn't exist": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, imageMetadataErr: true, expectStateChange: true, expectCalls: []string{"info"}, expectErr: true, }, "should return error when snapshot mounts fails": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, snapshotMountsErr: true, expectStateChange: true, expectCalls: []string{"info"}, expectErr: true, }, "should return error when fail to open streaming pipes": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, prepareFIFOErr: errors.New("open error"), expectStateChange: true, expectCalls: []string{"info"}, expectErr: true, }, "should return error when fail to create container": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, createContainerErr: errors.New("create error"), expectStateChange: true, expectCalls: []string{"info", "create"}, expectErr: true, }, "should return error when fail to start container": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, startContainerErr: errors.New("start error"), expectStateChange: true, // cleanup the containerd container. expectCalls: []string{"info", "create", "start", "delete"}, expectErr: true, }, "should be able to start container successfully": { containerMetadata: testMetadata, sandboxMetadata: testSandboxMetadata, sandboxContainerdContainer: testSandboxContainer, expectStateChange: true, expectCalls: []string{"info", "create", "start"}, expectErr: false, }, } { t.Logf("TestCase %q", desc) c := newTestCRIContainerdService() fake := c.containerService.(*servertesting.FakeExecutionClient) fakeOS := c.os.(*ostesting.FakeOS) fakeSnapshotClient := c.snapshotService.(*servertesting.FakeSnapshotClient) if test.containerMetadata != nil { assert.NoError(t, c.containerStore.Create(*test.containerMetadata)) } if test.sandboxMetadata != nil { assert.NoError(t, c.sandboxStore.Create(*test.sandboxMetadata)) } if test.sandboxContainerdContainer != nil { fake.SetFakeContainers([]task.Task{*test.sandboxContainerdContainer}) } if !test.imageMetadataErr { assert.NoError(t, c.imageMetadataStore.Create(metadata.ImageMetadata{ ID: testImageID, Config: imageConfig, })) } if !test.snapshotMountsErr { fakeSnapshotClient.SetFakeMounts(testID, testMounts) } // TODO(random-liu): Test behavior with different streaming config. fakeOS.OpenFifoFn = func(context.Context, string, int, os.FileMode) (io.ReadWriteCloser, error) { return nopReadWriteCloser{}, test.prepareFIFOErr } if test.createContainerErr != nil { fake.InjectError("create", test.createContainerErr) } if test.startContainerErr != nil { fake.InjectError("start", test.startContainerErr) } resp, err := c.StartContainer(context.Background(), &runtime.StartContainerRequest{ ContainerId: testID, }) // Check containerd functions called. assert.Equal(t, test.expectCalls, fake.GetCalledNames()) // Check results returned. if test.expectErr { assert.Error(t, err) assert.Nil(t, resp) } else { assert.NoError(t, err) assert.NotNil(t, resp) } // Check container state. meta, err := c.containerStore.Get(testID) if !test.expectStateChange { // Do not check the error, because container may not exist // in the test case. assert.Equal(t, meta, test.containerMetadata) continue } assert.NoError(t, err) require.NotNil(t, meta) if test.expectErr { t.Logf("container state should be in exited state when fail to start") assert.Equal(t, runtime.ContainerState_CONTAINER_EXITED, meta.State()) assert.Zero(t, meta.Pid) assert.EqualValues(t, errorStartExitCode, meta.ExitCode) assert.Equal(t, errorStartReason, meta.Reason) assert.NotEmpty(t, meta.Message) _, err := fake.Info(context.Background(), &execution.InfoRequest{ContainerID: testID}) assert.True(t, isContainerdContainerNotExistError(err), "containerd container should be cleaned up after when fail to start") continue } t.Logf("container state should be running when start successfully") assert.Equal(t, runtime.ContainerState_CONTAINER_RUNNING, meta.State()) info, err := fake.Info(context.Background(), &execution.InfoRequest{ContainerID: testID}) assert.NoError(t, err) pid := info.Task.Pid assert.Equal(t, pid, meta.Pid) assert.Equal(t, task.StatusRunning, info.Task.Status) // Check runtime spec calls := fake.GetCalledDetails() createOpts, ok := calls[1].Argument.(*execution.CreateRequest) assert.True(t, ok, "2nd call should be create") assert.Equal(t, testMounts, createOpts.Rootfs, "rootfs mounts should be correct") // TODO(random-liu): Test other create options. // TODO: Need to create container first.. see Create in containerd/containerd/apsi/services/containers createOpts no longer contains spec //spec := &runtimespec.Spec{} //assert.NoError(t, json.Unmarshal(createOpts.Spec.Value, spec)) //specCheck(t, testID, testSandboxPid, spec) } }