/* Copyright 2016 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 testing import ( "fmt" "sync" "time" v1 "k8s.io/api/core/v1" storagev1 "k8s.io/api/storage/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/types" "k8s.io/apimachinery/pkg/watch" "k8s.io/client-go/kubernetes/fake" core "k8s.io/client-go/testing" "k8s.io/kubernetes/pkg/volume" "k8s.io/kubernetes/pkg/volume/util" ) const TestPluginName = "kubernetes.io/testPlugin" // GetTestVolumeSpec returns a test volume spec func GetTestVolumeSpec(volumeName string, diskName v1.UniqueVolumeName) *volume.Spec { return &volume.Spec{ Volume: &v1.Volume{ Name: volumeName, VolumeSource: v1.VolumeSource{ GCEPersistentDisk: &v1.GCEPersistentDiskVolumeSource{ PDName: string(diskName), FSType: "fake", ReadOnly: false, }, }, }, PersistentVolume: &v1.PersistentVolume{ Spec: v1.PersistentVolumeSpec{ AccessModes: []v1.PersistentVolumeAccessMode{ v1.ReadWriteOnce, }, }, }, } } func CreateTestClient() *fake.Clientset { var extraPods *v1.PodList var volumeAttachments *storagev1.VolumeAttachmentList var pvs *v1.PersistentVolumeList var nodes *v1.NodeList fakeClient := &fake.Clientset{} extraPods = &v1.PodList{} fakeClient.AddReactor("list", "pods", func(action core.Action) (handled bool, ret runtime.Object, err error) { obj := &v1.PodList{} podNamePrefix := "mypod" namespace := "mynamespace" for i := 0; i < 5; i++ { podName := fmt.Sprintf("%s-%d", podNamePrefix, i) pod := v1.Pod{ Status: v1.PodStatus{ Phase: v1.PodRunning, }, ObjectMeta: metav1.ObjectMeta{ Name: podName, UID: types.UID(podName), Namespace: namespace, Labels: map[string]string{ "name": podName, }, }, Spec: v1.PodSpec{ Containers: []v1.Container{ { Name: "containerName", Image: "containerImage", VolumeMounts: []v1.VolumeMount{ { Name: "volumeMountName", ReadOnly: false, MountPath: "/mnt", }, }, }, }, Volumes: []v1.Volume{ { Name: "volumeName", VolumeSource: v1.VolumeSource{ GCEPersistentDisk: &v1.GCEPersistentDiskVolumeSource{ PDName: "pdName", FSType: "ext4", ReadOnly: false, }, }, }, }, NodeName: "mynode", }, } obj.Items = append(obj.Items, pod) } obj.Items = append(obj.Items, extraPods.Items...) return true, obj, nil }) fakeClient.AddReactor("create", "pods", func(action core.Action) (handled bool, ret runtime.Object, err error) { createAction := action.(core.CreateAction) pod := createAction.GetObject().(*v1.Pod) extraPods.Items = append(extraPods.Items, *pod) return true, createAction.GetObject(), nil }) fakeClient.AddReactor("list", "csinodes", func(action core.Action) (handled bool, ret runtime.Object, err error) { obj := &storagev1.CSINodeList{} nodeNamePrefix := "mynode" for i := 0; i < 5; i++ { var nodeName string if i != 0 { nodeName = fmt.Sprintf("%s-%d", nodeNamePrefix, i) } else { // We want also the "mynode" node since all the testing pods live there nodeName = nodeNamePrefix } csiNode := storagev1.CSINode{ ObjectMeta: metav1.ObjectMeta{ Name: nodeName, }, } obj.Items = append(obj.Items, csiNode) } return true, obj, nil }) nodes = &v1.NodeList{} nodeNamePrefix := "mynode" for i := 0; i < 5; i++ { var nodeName string if i != 0 { nodeName = fmt.Sprintf("%s-%d", nodeNamePrefix, i) } else { // We want also the "mynode" node since all the testing pods live there nodeName = nodeNamePrefix } attachVolumeToNode(nodes, "lostVolumeName", nodeName) } fakeClient.AddReactor("update", "nodes", func(action core.Action) (handled bool, ret runtime.Object, err error) { updateAction := action.(core.UpdateAction) node := updateAction.GetObject().(*v1.Node) for index, n := range nodes.Items { if n.Name == node.Name { nodes.Items[index] = *node } } return true, updateAction.GetObject(), nil }) fakeClient.AddReactor("list", "nodes", func(action core.Action) (handled bool, ret runtime.Object, err error) { obj := &v1.NodeList{} obj.Items = append(obj.Items, nodes.Items...) return true, obj, nil }) volumeAttachments = &storagev1.VolumeAttachmentList{} fakeClient.AddReactor("list", "volumeattachments", func(action core.Action) (handled bool, ret runtime.Object, err error) { obj := &storagev1.VolumeAttachmentList{} obj.Items = append(obj.Items, volumeAttachments.Items...) return true, obj, nil }) fakeClient.AddReactor("create", "volumeattachments", func(action core.Action) (handled bool, ret runtime.Object, err error) { createAction := action.(core.CreateAction) va := createAction.GetObject().(*storagev1.VolumeAttachment) volumeAttachments.Items = append(volumeAttachments.Items, *va) return true, createAction.GetObject(), nil }) pvs = &v1.PersistentVolumeList{} fakeClient.AddReactor("list", "persistentvolumes", func(action core.Action) (handled bool, ret runtime.Object, err error) { obj := &v1.PersistentVolumeList{} obj.Items = append(obj.Items, pvs.Items...) return true, obj, nil }) fakeClient.AddReactor("create", "persistentvolumes", func(action core.Action) (handled bool, ret runtime.Object, err error) { createAction := action.(core.CreateAction) pv := createAction.GetObject().(*v1.PersistentVolume) pvs.Items = append(pvs.Items, *pv) return true, createAction.GetObject(), nil }) fakeWatch := watch.NewFake() fakeClient.AddWatchReactor("*", core.DefaultWatchReactor(fakeWatch, nil)) return fakeClient } // NewPod returns a test pod object func NewPod(uid, name string) *v1.Pod { return &v1.Pod{ ObjectMeta: metav1.ObjectMeta{ UID: types.UID(uid), Name: name, Namespace: name, }, } } // NewPodWithVolume returns a test pod object func NewPodWithVolume(podName, volumeName, nodeName string) *v1.Pod { return &v1.Pod{ ObjectMeta: metav1.ObjectMeta{ UID: types.UID(podName), Name: podName, Namespace: "mynamespace", Labels: map[string]string{ "name": podName, }, }, Spec: v1.PodSpec{ Containers: []v1.Container{ { Name: "containerName", Image: "containerImage", VolumeMounts: []v1.VolumeMount{ { Name: "volumeMountName", ReadOnly: false, MountPath: "/mnt", }, }, }, }, Volumes: []v1.Volume{ { Name: volumeName, VolumeSource: v1.VolumeSource{ GCEPersistentDisk: &v1.GCEPersistentDiskVolumeSource{ PDName: "pdName", FSType: "ext4", ReadOnly: false, }, }, }, }, NodeName: nodeName, }, } } // Returns a volumeAttachment object func NewVolumeAttachment(vaName, pvName, nodeName string, status bool) *storagev1.VolumeAttachment { return &storagev1.VolumeAttachment{ ObjectMeta: metav1.ObjectMeta{ UID: types.UID(vaName), Name: vaName, }, Spec: storagev1.VolumeAttachmentSpec{ Attacher: "test.storage.gke.io", NodeName: nodeName, Source: storagev1.VolumeAttachmentSource{ PersistentVolumeName: &pvName, }, }, Status: storagev1.VolumeAttachmentStatus{ Attached: status, }, } } // Returns a persistentVolume object func NewPV(pvName, volumeName string) *v1.PersistentVolume { return &v1.PersistentVolume{ ObjectMeta: metav1.ObjectMeta{ UID: types.UID(pvName), Name: pvName, }, Spec: v1.PersistentVolumeSpec{ PersistentVolumeSource: v1.PersistentVolumeSource{ GCEPersistentDisk: &v1.GCEPersistentDiskVolumeSource{ PDName: volumeName, }, }, }, } } // Returns an NFS PV. This can be used for an in-tree volume that is not migrated (unlike NewPV, which uses the GCE persistent disk). func NewNFSPV(pvName, volumeName string) *v1.PersistentVolume { return &v1.PersistentVolume{ ObjectMeta: metav1.ObjectMeta{ UID: types.UID(pvName), Name: pvName, }, Spec: v1.PersistentVolumeSpec{ PersistentVolumeSource: v1.PersistentVolumeSource{ NFS: &v1.NFSVolumeSource{ Server: volumeName, }, }, }, } } func attachVolumeToNode(nodes *v1.NodeList, volumeName, nodeName string) { // if nodeName exists, get the object.. if not create node object var node *v1.Node found := false nodes.Size() for i := range nodes.Items { curNode := nodes.Items[i] if curNode.ObjectMeta.Name == nodeName { node = &curNode found = true break } } if !found { node = &v1.Node{ ObjectMeta: metav1.ObjectMeta{ Name: nodeName, Labels: map[string]string{ "name": nodeName, }, Annotations: map[string]string{ util.ControllerManagedAttachAnnotation: "true", }, }, Status: v1.NodeStatus{ VolumesAttached: []v1.AttachedVolume{ { Name: v1.UniqueVolumeName(TestPluginName + "/" + volumeName), DevicePath: "fake/path", }, }, }, } } else { volumeAttached := v1.AttachedVolume{ Name: v1.UniqueVolumeName(TestPluginName + "/" + volumeName), DevicePath: "fake/path", } node.Status.VolumesAttached = append(node.Status.VolumesAttached, volumeAttached) } nodes.Items = append(nodes.Items, *node) } type TestPlugin struct { ErrorEncountered bool attachedVolumeMap map[string][]string detachedVolumeMap map[string][]string pluginLock *sync.RWMutex } func (plugin *TestPlugin) Init(host volume.VolumeHost) error { return nil } func (plugin *TestPlugin) GetPluginName() string { return TestPluginName } func (plugin *TestPlugin) GetVolumeName(spec *volume.Spec) (string, error) { plugin.pluginLock.Lock() defer plugin.pluginLock.Unlock() if spec == nil { plugin.ErrorEncountered = true return "", fmt.Errorf("GetVolumeName called with nil volume spec") } if spec.Volume != nil { return spec.Name(), nil } else if spec.PersistentVolume != nil { if spec.PersistentVolume.Spec.PersistentVolumeSource.GCEPersistentDisk != nil { return spec.PersistentVolume.Spec.PersistentVolumeSource.GCEPersistentDisk.PDName, nil } else if spec.PersistentVolume.Spec.PersistentVolumeSource.NFS != nil { return spec.PersistentVolume.Spec.PersistentVolumeSource.NFS.Server, nil } else if spec.PersistentVolume.Spec.PersistentVolumeSource.RBD != nil { return spec.PersistentVolume.Spec.PersistentVolumeSource.RBD.RBDImage, nil } return "", fmt.Errorf("GetVolumeName called with unexpected PersistentVolume: %v", spec) } else { return "", nil } } func (plugin *TestPlugin) CanSupport(spec *volume.Spec) bool { plugin.pluginLock.Lock() defer plugin.pluginLock.Unlock() if spec == nil { plugin.ErrorEncountered = true } return true } func (plugin *TestPlugin) RequiresRemount(spec *volume.Spec) bool { return false } func (plugin *TestPlugin) NewMounter(spec *volume.Spec, podRef *v1.Pod, opts volume.VolumeOptions) (volume.Mounter, error) { plugin.pluginLock.Lock() defer plugin.pluginLock.Unlock() if spec == nil { plugin.ErrorEncountered = true } return nil, nil } func (plugin *TestPlugin) NewUnmounter(name string, podUID types.UID) (volume.Unmounter, error) { return nil, nil } func (plugin *TestPlugin) ConstructVolumeSpec(volumeName, mountPath string) (volume.ReconstructedVolume, error) { fakeVolume := &v1.Volume{ Name: volumeName, VolumeSource: v1.VolumeSource{ GCEPersistentDisk: &v1.GCEPersistentDiskVolumeSource{ PDName: "pdName", FSType: "ext4", ReadOnly: false, }, }, } return volume.ReconstructedVolume{ Spec: volume.NewSpecFromVolume(fakeVolume), }, nil } func (plugin *TestPlugin) NewAttacher() (volume.Attacher, error) { attacher := testPluginAttacher{ ErrorEncountered: &plugin.ErrorEncountered, attachedVolumeMap: plugin.attachedVolumeMap, pluginLock: plugin.pluginLock, } return &attacher, nil } func (plugin *TestPlugin) NewDeviceMounter() (volume.DeviceMounter, error) { return plugin.NewAttacher() } func (plugin *TestPlugin) NewDetacher() (volume.Detacher, error) { detacher := testPluginDetacher{ detachedVolumeMap: plugin.detachedVolumeMap, pluginLock: plugin.pluginLock, } return &detacher, nil } func (plugin *TestPlugin) CanAttach(spec *volume.Spec) (bool, error) { return true, nil } func (plugin *TestPlugin) CanDeviceMount(spec *volume.Spec) (bool, error) { return true, nil } func (plugin *TestPlugin) NewDeviceUnmounter() (volume.DeviceUnmounter, error) { return plugin.NewDetacher() } func (plugin *TestPlugin) GetDeviceMountRefs(deviceMountPath string) ([]string, error) { return []string{}, nil } func (plugin *TestPlugin) SupportsMountOption() bool { return false } func (plugin *TestPlugin) SupportsBulkVolumeVerification() bool { return false } func (plugin *TestPlugin) SupportsSELinuxContextMount(spec *volume.Spec) (bool, error) { return false, nil } func (plugin *TestPlugin) GetErrorEncountered() bool { plugin.pluginLock.RLock() defer plugin.pluginLock.RUnlock() return plugin.ErrorEncountered } func (plugin *TestPlugin) GetAttachedVolumes() map[string][]string { plugin.pluginLock.RLock() defer plugin.pluginLock.RUnlock() ret := make(map[string][]string) for nodeName, volumeList := range plugin.attachedVolumeMap { ret[nodeName] = make([]string, len(volumeList)) copy(ret[nodeName], volumeList) } return ret } func (plugin *TestPlugin) GetDetachedVolumes() map[string][]string { plugin.pluginLock.RLock() defer plugin.pluginLock.RUnlock() ret := make(map[string][]string) for nodeName, volumeList := range plugin.detachedVolumeMap { ret[nodeName] = make([]string, len(volumeList)) copy(ret[nodeName], volumeList) } return ret } func CreateTestPlugin() []volume.VolumePlugin { attachedVolumes := make(map[string][]string) detachedVolumes := make(map[string][]string) return []volume.VolumePlugin{&TestPlugin{ ErrorEncountered: false, attachedVolumeMap: attachedVolumes, detachedVolumeMap: detachedVolumes, pluginLock: &sync.RWMutex{}, }} } // Attacher type testPluginAttacher struct { ErrorEncountered *bool attachedVolumeMap map[string][]string pluginLock *sync.RWMutex } func (attacher *testPluginAttacher) Attach(spec *volume.Spec, nodeName types.NodeName) (string, error) { attacher.pluginLock.Lock() defer attacher.pluginLock.Unlock() if spec == nil { *attacher.ErrorEncountered = true return "", fmt.Errorf("Attach called with nil volume spec") } attacher.attachedVolumeMap[string(nodeName)] = append(attacher.attachedVolumeMap[string(nodeName)], spec.Name()) return spec.Name(), nil } func (attacher *testPluginAttacher) VolumesAreAttached(specs []*volume.Spec, nodeName types.NodeName) (map[*volume.Spec]bool, error) { return nil, nil } func (attacher *testPluginAttacher) WaitForAttach(spec *volume.Spec, devicePath string, pod *v1.Pod, timeout time.Duration) (string, error) { attacher.pluginLock.Lock() defer attacher.pluginLock.Unlock() if spec == nil { *attacher.ErrorEncountered = true return "", fmt.Errorf("WaitForAttach called with nil volume spec") } fakePath := fmt.Sprintf("%s/%s", devicePath, spec.Name()) return fakePath, nil } func (attacher *testPluginAttacher) GetDeviceMountPath(spec *volume.Spec) (string, error) { attacher.pluginLock.Lock() defer attacher.pluginLock.Unlock() if spec == nil { *attacher.ErrorEncountered = true return "", fmt.Errorf("GetDeviceMountPath called with nil volume spec") } return "", nil } func (attacher *testPluginAttacher) MountDevice(spec *volume.Spec, devicePath string, deviceMountPath string, _ volume.DeviceMounterArgs) error { attacher.pluginLock.Lock() defer attacher.pluginLock.Unlock() if spec == nil { *attacher.ErrorEncountered = true return fmt.Errorf("MountDevice called with nil volume spec") } return nil } // Detacher type testPluginDetacher struct { detachedVolumeMap map[string][]string pluginLock *sync.RWMutex } func (detacher *testPluginDetacher) Detach(volumeName string, nodeName types.NodeName) error { detacher.pluginLock.Lock() defer detacher.pluginLock.Unlock() detacher.detachedVolumeMap[string(nodeName)] = append(detacher.detachedVolumeMap[string(nodeName)], volumeName) return nil } func (detacher *testPluginDetacher) UnmountDevice(deviceMountPath string) error { return nil }