/* Copyright 2020 The CDI 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 controller import ( "context" "sync" "time" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" "sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/client/fake" "sigs.k8s.io/controller-runtime/pkg/reconcile" logf "sigs.k8s.io/controller-runtime/pkg/runtime/log" corev1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/types" "k8s.io/apimachinery/pkg/util/intstr" k8sfake "k8s.io/client-go/kubernetes/fake" "k8s.io/client-go/kubernetes/scheme" cdiv1 "kubevirt.io/containerized-data-importer/pkg/apis/core/v1alpha1" cdifake "kubevirt.io/containerized-data-importer/pkg/client/clientset/versioned/fake" "kubevirt.io/containerized-data-importer/pkg/common" "kubevirt.io/containerized-data-importer/pkg/util/cert/fetcher" ) const ( uploadRequestAnnotation = "cdi.kubevirt.io/storage.upload.target" podPhaseAnnotation = "cdi.kubevirt.io/storage.pod.phase" podReadyAnnotation = "cdi.kubevirt.io/storage.pod.ready" cloneRequestAnnotation = "k8s.io/CloneRequest" ) var ( testUploadServerCASecret *corev1.Secret testUploadServerCASecretOnce sync.Once testUploadServerClientCASecret *corev1.Secret testUploadServerClientCASecretOnce sync.Once uploadLog = logf.Log.WithName("upload-controller-test") ) var _ = Describe("Upload controller reconcile loop", func() { It("Should return nil and not create a pod, if pvc can not be found", func() { reconciler := createUploadReconciler() _, err := reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).ToNot(HaveOccurred()) podList := &corev1.PodList{} err = reconciler.Client.List(context.TODO(), podList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(podList.Items)).To(Equal(0)) }) It("Should return nil and not create a pod, if neither upload nor clone annotations exist", func() { reconciler := createUploadReconciler(createPvc("testPvc1", "default", map[string]string{}, nil)) _, err := reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).ToNot(HaveOccurred()) podList := &corev1.PodList{} err = reconciler.Client.List(context.TODO(), podList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(podList.Items)).To(Equal(0)) }) It("Should return error and not create a pod, if neither upload nor clone annotations exist", func() { reconciler := createUploadReconciler(createPvc("testPvc1", "default", map[string]string{AnnUploadRequest: "", AnnCloneRequest: ""}, nil)) _, err := reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("PVC has both clone and upload annotations")) podList := &corev1.PodList{} err = reconciler.Client.List(context.TODO(), podList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(podList.Items)).To(Equal(0)) }) It("Should return nil and remove any service and pod, if neither upload nor clone annotations exist", func() { testPvc := createPvc("testPvc1", "default", map[string]string{}, nil) reconciler := createUploadReconciler(testPvc, createUploadPod(testPvc), createUploadService(testPvc), ) By("Verifying the pod and service exists") uploadPod := &corev1.Pod{} err := reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).ToNot(HaveOccurred()) Expect(uploadPod.Name).To(Equal(getUploadResourceName(testPvc.Name))) uploadService := &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).ToNot(HaveOccurred()) Expect(uploadService.Name).To(Equal(getUploadResourceName(testPvc.Name))) _, err = reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).ToNot(HaveOccurred()) By("Verifying the pod and service no longer exist") podList := &corev1.PodList{} err = reconciler.Client.List(context.TODO(), podList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(podList.Items)).To(Equal(0)) serviceList := &corev1.ServiceList{} err = reconciler.Client.List(context.TODO(), serviceList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(serviceList.Items)).To(Equal(0)) }) It("Should return nil and remove any service and pod if succeeded", func() { testPvc := createPvc("testPvc1", "default", map[string]string{AnnUploadRequest: "", AnnPodPhase: string(corev1.PodSucceeded)}, nil) reconciler := createUploadReconciler(testPvc, createUploadPod(testPvc), createUploadService(testPvc), ) By("Verifying the pod and service exists") uploadPod := &corev1.Pod{} err := reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).ToNot(HaveOccurred()) Expect(uploadPod.Name).To(Equal(getUploadResourceName(testPvc.Name))) uploadService := &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).ToNot(HaveOccurred()) Expect(uploadService.Name).To(Equal(getUploadResourceName(testPvc.Name))) _, err = reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).ToNot(HaveOccurred()) By("Verifying the pod and service no longer exist") podList := &corev1.PodList{} err = reconciler.Client.List(context.TODO(), podList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(podList.Items)).To(Equal(0)) serviceList := &corev1.ServiceList{} err = reconciler.Client.List(context.TODO(), serviceList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(serviceList.Items)).To(Equal(0)) }) It("Should return nil and remove any service and pod if pvc marked for deletion", func() { testPvc := createPvc("testPvc1", "default", map[string]string{AnnUploadRequest: "", AnnPodPhase: string(corev1.PodPending)}, nil) now := metav1.NewTime(time.Now()) testPvc.DeletionTimestamp = &now reconciler := createUploadReconciler(testPvc, createUploadPod(testPvc), createUploadService(testPvc), ) By("Verifying the pod and service exists") uploadPod := &corev1.Pod{} err := reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).ToNot(HaveOccurred()) Expect(uploadPod.Name).To(Equal(getUploadResourceName(testPvc.Name))) uploadService := &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).ToNot(HaveOccurred()) Expect(uploadService.Name).To(Equal(getUploadResourceName(testPvc.Name))) _, err = reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).ToNot(HaveOccurred()) By("Verifying the pod and service no longer exist") podList := &corev1.PodList{} err = reconciler.Client.List(context.TODO(), podList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(podList.Items)).To(Equal(0)) serviceList := &corev1.ServiceList{} err = reconciler.Client.List(context.TODO(), serviceList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(serviceList.Items)).To(Equal(0)) }) It("Should return err and not clone if validation error occurs", func() { storageClassName := "test" testPvc := createPvcInStorageClass("testPvc1", "default", &storageClassName, map[string]string{cloneRequestAnnotation: "default/sourcePvc"}, nil) sourcePvc := createPvcInStorageClass("sourcePvc", "default", &storageClassName, nil, nil) vm := corev1.PersistentVolumeBlock sourcePvc.Spec.VolumeMode = &vm reconciler := createUploadReconciler(testPvc, sourcePvc) _, err := reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("Source and target volume Modes do not match")) }) It("Should return nil and create a pod and service when a clone pvc", func() { testPvc := createPvc("testPvc1", "default", map[string]string{AnnCloneRequest: "default/testPvc2"}, nil) testPvcSource := createPvc("testPvc2", "default", map[string]string{}, nil) reconciler := createUploadReconciler(testPvc, testPvcSource) By("Verifying the pod and service do not exist") uploadPod := &corev1.Pod{} err := reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).To(HaveOccurred()) uploadService := &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).To(HaveOccurred()) _, err = reconciler.Reconcile(reconcile.Request{NamespacedName: types.NamespacedName{Name: "testPvc1", Namespace: "default"}}) Expect(err).ToNot(HaveOccurred()) By("Verifying the pod and service now exist") uploadPod = &corev1.Pod{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).ToNot(HaveOccurred()) Expect(uploadPod.Name).To(Equal(getUploadResourceName(testPvc.Name))) uploadService = &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).ToNot(HaveOccurred()) Expect(uploadService.Name).To(Equal(getUploadResourceName(testPvc.Name))) }) }) var _ = Describe("reconcilePVC loop", func() { Context("Is clone", func() { isClone := true It("Should create the service and pod", func() { testPvc := createPvc("testPvc1", "default", map[string]string{AnnCloneRequest: "default/testPvc2"}, nil) testPvcSource := createPvc("testPvc2", "default", map[string]string{}, nil) reconciler := createUploadReconciler(testPvc, testPvcSource) By("Verifying the pod and service do not exist") uploadPod := &corev1.Pod{} err := reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).To(HaveOccurred()) uploadService := &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).To(HaveOccurred()) _, err = reconciler.reconcilePVC(reconciler.Log, testPvc, isClone) Expect(err).ToNot(HaveOccurred()) By("Verifying the pod and service now exist") uploadPod = &corev1.Pod{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).ToNot(HaveOccurred()) Expect(uploadPod.Name).To(Equal(getUploadResourceName(testPvc.Name))) uploadService = &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).ToNot(HaveOccurred()) Expect(uploadService.Name).To(Equal(getUploadResourceName(testPvc.Name))) resultPvc := &corev1.PersistentVolumeClaim{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: "testPvc1", Namespace: "default"}, resultPvc) Expect(err).ToNot(HaveOccurred()) Expect(resultPvc.GetAnnotations()[AnnPodPhase]).To(BeEquivalentTo(uploadPod.Status.Phase)) Expect(resultPvc.GetAnnotations()[AnnPodReady]).To(Equal("false")) }) }) Context("Is upload", func() { isClone := false It("Should create the service and pod", func() { testPvc := createPvc("testPvc1", "default", map[string]string{AnnUploadRequest: ""}, nil) reconciler := createUploadReconciler(testPvc) By("Verifying the pod and service do not exist") uploadPod := &corev1.Pod{} err := reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).To(HaveOccurred()) uploadService := &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).To(HaveOccurred()) _, err = reconciler.reconcilePVC(reconciler.Log, testPvc, isClone) Expect(err).ToNot(HaveOccurred()) By("Verifying the pod and service now exist") uploadPod = &corev1.Pod{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadPod) Expect(err).ToNot(HaveOccurred()) Expect(uploadPod.Name).To(Equal(getUploadResourceName(testPvc.Name))) uploadService = &corev1.Service{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: getUploadResourceName("testPvc1"), Namespace: "default"}, uploadService) Expect(err).ToNot(HaveOccurred()) Expect(uploadService.Name).To(Equal(getUploadResourceName(testPvc.Name))) // TODO, have scratch space creation use the runtime lib client, instead of client-go _, err = reconciler.K8sClient.CoreV1().PersistentVolumeClaims("default").Get("testPvc1-scratch", metav1.GetOptions{}) Expect(err).ToNot(HaveOccurred()) }) }) }) var _ = Describe("Update PVC", func() { It("Should update AnnPodRestarts on pvc from upload pod restarts", func() { testPvc := createPvc("testPvc1", "default", map[string]string{ AnnUploadRequest: "", AnnPodPhase: string(corev1.PodPending), AnnPodRestarts: "1"}, nil) pod := createUploadPod(testPvc) pod.Status = corev1.PodStatus{ Phase: corev1.PodFailed, ContainerStatuses: []corev1.ContainerStatus{ { RestartCount: 2, LastTerminationState: corev1.ContainerState{ Terminated: &corev1.ContainerStateTerminated{ ExitCode: 1, Message: "I went poof", }, }, }, }, } reconciler := createUploadReconciler(testPvc, pod, createUploadService(testPvc)) _, err := reconciler.reconcilePVC(reconciler.Log, testPvc, false) Expect(err).ToNot(HaveOccurred()) By("Verifying the pvc has restarts updated") actualPvc := &corev1.PersistentVolumeClaim{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: "testPvc1", Namespace: "default"}, actualPvc) Expect(err).ToNot(HaveOccurred()) Expect(actualPvc.Annotations[AnnPodRestarts]).To(Equal("2")) }) It("Should not update AnnPodRestarts on pvc from pod if pod has lower restart count value ", func() { testPvc := createPvc("testPvc1", "default", map[string]string{ AnnUploadRequest: "", AnnPodPhase: string(corev1.PodPending), AnnPodRestarts: "3"}, nil) pod := createUploadPod(testPvc) pod.Status = corev1.PodStatus{ Phase: corev1.PodFailed, ContainerStatuses: []corev1.ContainerStatus{ { RestartCount: 2, LastTerminationState: corev1.ContainerState{ Terminated: &corev1.ContainerStateTerminated{ ExitCode: 1, Message: "I went poof", }, }, }, }, } reconciler := createUploadReconciler(testPvc, pod, createUploadService(testPvc)) _, err := reconciler.reconcilePVC(reconciler.Log, testPvc, false) Expect(err).ToNot(HaveOccurred()) By("Verifying the pvc has original restart count") actualPvc := &corev1.PersistentVolumeClaim{} err = reconciler.Client.Get(context.TODO(), types.NamespacedName{Name: "testPvc1", Namespace: "default"}, actualPvc) Expect(err).ToNot(HaveOccurred()) Expect(actualPvc.Annotations[AnnPodRestarts]).To(Equal("3")) }) }) func createUploadReconciler(objects ...runtime.Object) *UploadReconciler { objs := []runtime.Object{} objs = append(objs, objects...) // Append empty CDIConfig object that normally is created by the reconcile loop cdiConfig := MakeEmptyCDIConfigSpec(common.ConfigName) cdiConfig.Status = cdiv1.CDIConfigStatus{ DefaultPodResourceRequirements: createDefaultPodResourceRequirements(int64(0), int64(0), int64(0), int64(0)), } objs = append(objs, cdiConfig) cdifakeclientset := cdifake.NewSimpleClientset(cdiConfig) k8sfakeclientset := k8sfake.NewSimpleClientset() // Register operator types with the runtime scheme. s := scheme.Scheme cdiv1.AddToScheme(s) // Create a fake client to mock API calls. cl := fake.NewFakeClientWithScheme(s, objs...) // Create a ReconcileMemcached object with the scheme and fake client. r := &UploadReconciler{ Client: cl, Scheme: s, Log: uploadLog, CdiClient: cdifakeclientset, K8sClient: k8sfakeclientset, serverCertGenerator: &fakeCertGenerator{}, clientCAFetcher: &fetcher.MemCertBundleFetcher{Bundle: []byte("baz")}, } return r } func createUploadPod(pvc *corev1.PersistentVolumeClaim) *corev1.Pod { pod := createUploadClonePod(pvc, "client.upload-server.cdi.kubevirt.io") pod.Spec.Volumes = append(pod.Spec.Volumes, corev1.Volume{ Name: ScratchVolName, VolumeSource: corev1.VolumeSource{ PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{ ClaimName: pvc.Name + "-scratch", ReadOnly: false, }, }, }) pod.Spec.Containers[0].VolumeMounts = append(pod.Spec.Containers[0].VolumeMounts, corev1.VolumeMount{ Name: ScratchVolName, MountPath: "/scratch", }) return pod } func createUploadClonePod(pvc *corev1.PersistentVolumeClaim, clientName string) *corev1.Pod { name := "cdi-upload-" + pvc.Name requestImageSize, _ := getRequestedImageSize(pvc) pod := &corev1.Pod{ TypeMeta: metav1.TypeMeta{ Kind: "Pod", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Namespace: pvc.Namespace, Annotations: map[string]string{ annCreatedByUpload: "yes", }, Labels: map[string]string{ "app": "containerized-data-importer", "cdi.kubevirt.io": "cdi-upload-server", "service": name, }, OwnerReferences: []metav1.OwnerReference{ MakePVCOwnerReference(pvc), }, }, Spec: corev1.PodSpec{ SecurityContext: &corev1.PodSecurityContext{ RunAsUser: &[]int64{0}[0], }, Containers: []corev1.Container{ { Name: "cdi-upload-server", Image: "test/myimage", ImagePullPolicy: corev1.PullPolicy("Always"), VolumeMounts: []corev1.VolumeMount{ { Name: DataVolName, MountPath: "/data", }, }, Env: []corev1.EnvVar{ { Name: "TLS_KEY", Value: "bar", }, { Name: "TLS_CERT", Value: "foo", }, { Name: "CLIENT_CERT", Value: "baz", }, { Name: common.UploadImageSize, Value: requestImageSize, }, { Name: "CLIENT_NAME", Value: clientName, }, }, Args: []string{"-v=" + "5"}, ReadinessProbe: &corev1.Probe{ Handler: corev1.Handler{ HTTPGet: &corev1.HTTPGetAction{ Path: "/healthz", Port: intstr.IntOrString{ Type: intstr.Int, IntVal: 8080, }, }, }, InitialDelaySeconds: 2, PeriodSeconds: 5, }, }, }, RestartPolicy: corev1.RestartPolicyOnFailure, Volumes: []corev1.Volume{ { Name: DataVolName, VolumeSource: corev1.VolumeSource{ PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{ ClaimName: pvc.Name, ReadOnly: false, }, }, }, }, }, } return pod } func createUploadService(pvc *corev1.PersistentVolumeClaim) *corev1.Service { name := "cdi-upload-" + pvc.Name blockOwnerDeletion := true isController := true service := &corev1.Service{ TypeMeta: metav1.TypeMeta{ Kind: "Service", APIVersion: "v1", }, ObjectMeta: metav1.ObjectMeta{ Name: name, Namespace: pvc.Namespace, Annotations: map[string]string{ annCreatedByUpload: "yes", }, Labels: map[string]string{ "app": "containerized-data-importer", "cdi.kubevirt.io": "cdi-upload-server", }, OwnerReferences: []metav1.OwnerReference{ { APIVersion: "v1", Kind: "PersistentVolumeClaim", Name: pvc.Name, UID: pvc.GetUID(), BlockOwnerDeletion: &blockOwnerDeletion, Controller: &isController, }, }, }, Spec: corev1.ServiceSpec{ Ports: []corev1.ServicePort{ { Protocol: "TCP", Port: 443, TargetPort: intstr.IntOrString{ Type: intstr.Int, IntVal: 8443, }, }, }, Selector: map[string]string{ "service": name, }, }, } return service }