/* Copyright 2021 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" "fmt" . "github.com/onsi/ginkgo" "github.com/onsi/ginkgo/extensions/table" . "github.com/onsi/gomega" prometheus "github.com/prometheus/client_golang/prometheus/testutil" "sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/client/fake" logf "sigs.k8s.io/controller-runtime/pkg/log" "sigs.k8s.io/controller-runtime/pkg/reconcile" v1 "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/api/resource" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/types" "k8s.io/client-go/kubernetes/scheme" cdiv1 "kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1" "kubevirt.io/containerized-data-importer/pkg/common" . "kubevirt.io/containerized-data-importer/pkg/controller/common" "kubevirt.io/containerized-data-importer/pkg/storagecapabilities" ) var ( storageProfileLog = logf.Log.WithName("storageprofile-controller-test") storageClassName = "testSC" lsoLabels = map[string]string{ "local.storage.openshift.io/owner-name": "local", "local.storage.openshift.io/owner-namespace": "openshift-local-storage", } ) var _ = Describe("Storage profile controller reconcile loop", func() { It("Should not requeue if storage class can not be found", func() { reconciler := createStorageProfileReconciler() res, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(res.Requeue).ToNot(BeTrue()) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(0)) }) It("Should give correct results and not panic with isIncomplete", func() { storageProfile := cdiv1.StorageProfile{ ObjectMeta: metav1.ObjectMeta{ Name: storageClassName, }, Spec: cdiv1.StorageProfileSpec{ ClaimPropertySets: []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce}}, }, }, } incomplete := isIncomplete(storageProfile.Status.ClaimPropertySets) Expect(incomplete).To(BeTrue()) storageProfile = cdiv1.StorageProfile{ ObjectMeta: metav1.ObjectMeta{ Name: storageClassName, }, Spec: cdiv1.StorageProfileSpec{ ClaimPropertySets: []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce}}, }, }, Status: cdiv1.StorageProfileStatus{}, } incomplete = isIncomplete(storageProfile.Status.ClaimPropertySets) Expect(incomplete).To(BeTrue()) storageProfile = cdiv1.StorageProfile{ ObjectMeta: metav1.ObjectMeta{ Name: storageClassName, }, Spec: cdiv1.StorageProfileSpec{ ClaimPropertySets: []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce}, VolumeMode: &BlockMode}, }, }, Status: cdiv1.StorageProfileStatus{ ClaimPropertySets: []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce}, VolumeMode: &BlockMode}, }, }, } incomplete = isIncomplete(storageProfile.Status.ClaimPropertySets) Expect(incomplete).To(BeFalse()) }) It("Should delete storage profile when corresponding storage class gets deleted", func() { storageClass := CreateStorageClass(storageClassName, map[string]string{AnnDefaultStorageClass: "true"}) reconciler := createStorageProfileReconciler(storageClass) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) err = reconciler.client.Delete(context.TODO(), storageClass) Expect(err).ToNot(HaveOccurred()) _, err = reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(0)) }) It("Should create storage profile without claim property set for storage class not in capabilitiesByProvisionerKey map", func() { reconciler := createStorageProfileReconciler(CreateStorageClass(storageClassName, map[string]string{AnnDefaultStorageClass: "true"})) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(len(sp.Status.ClaimPropertySets)).To(Equal(0)) }) It("Should create storage profile with default claim property set for storage class", func() { scProvisioner := "rook-ceph.rbd.csi.ceph.com" reconciler := createStorageProfileReconciler(CreateStorageClassWithProvisioner(storageClassName, map[string]string{AnnDefaultStorageClass: "true"}, map[string]string{}, scProvisioner)) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) claimPropertySets := []cdiv1.ClaimPropertySet{} capabilities := storagecapabilities.CapabilitiesByProvisionerKey[scProvisioner] for i := range capabilities { claimPropertySet := cdiv1.ClaimPropertySet{ AccessModes: []v1.PersistentVolumeAccessMode{capabilities[i].AccessMode}, VolumeMode: &capabilities[i].VolumeMode, } claimPropertySets = append(claimPropertySets, claimPropertySet) } Expect(sp.Status.ClaimPropertySets).To(Equal(claimPropertySets)) }) It("Should find storage capabilities for no-provisioner LSO storage class", func() { storageClass := CreateStorageClassWithProvisioner(storageClassName, map[string]string{AnnDefaultStorageClass: "true"}, lsoLabels, "kubernetes.io/no-provisioner") pv := CreatePv("my-pv", storageClassName) reconciler := createStorageProfileReconciler(storageClass, pv) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(storageProfileList.Items).To(HaveLen(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(sp.Status.ClaimPropertySets).ToNot(BeEmpty()) }) It("Should not have storage capabilities for no-provisioner LSO storage class if there are no PVs for it", func() { storageClass := CreateStorageClassWithProvisioner(storageClassName, map[string]string{AnnDefaultStorageClass: "true"}, lsoLabels, "kubernetes.io/no-provisioner") reconciler := createStorageProfileReconciler(storageClass) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(storageProfileList.Items).To(HaveLen(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(sp.Status.ClaimPropertySets).To(BeEmpty()) }) It("Should update storage profile with editted claim property sets", func() { reconciler := createStorageProfileReconciler(CreateStorageClass(storageClassName, map[string]string{AnnDefaultStorageClass: "true"})) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(len(sp.Status.ClaimPropertySets)).To(Equal(0)) claimPropertySets := []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadOnlyMany}, VolumeMode: &BlockMode}, {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce}, VolumeMode: &FilesystemMode}, } sp.Spec.ClaimPropertySets = claimPropertySets err = reconciler.client.Update(context.TODO(), sp.DeepCopy()) Expect(err).ToNot(HaveOccurred()) _, err = reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList = &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) updatedSp := storageProfileList.Items[0] Expect(*updatedSp.Status.StorageClass).To(Equal(storageClassName)) Expect(updatedSp.Spec.ClaimPropertySets).To(Equal(claimPropertySets)) Expect(updatedSp.Status.ClaimPropertySets).To(Equal(claimPropertySets)) }) It("Should update storage profile with labels when the value changes", func() { reconciler := createStorageProfileReconciler(CreateStorageClass(storageClassName, map[string]string{AnnDefaultStorageClass: "true"})) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(sp.Labels[common.AppKubernetesPartOfLabel]).To(Equal("testing")) claimPropertySets := []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadOnlyMany}, VolumeMode: &BlockMode}, {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce}, VolumeMode: &FilesystemMode}, } sp.Spec.ClaimPropertySets = claimPropertySets reconciler.installerLabels[common.AppKubernetesPartOfLabel] = "newtesting" err = reconciler.client.Update(context.TODO(), sp.DeepCopy()) Expect(err).ToNot(HaveOccurred()) _, err = reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList = &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) updatedSp := storageProfileList.Items[0] Expect(updatedSp.Labels[common.AppKubernetesPartOfLabel]).To(Equal("newtesting")) }) It("Should error when updating storage profile with missing access modes", func() { reconciler := createStorageProfileReconciler(CreateStorageClass(storageClassName, map[string]string{AnnDefaultStorageClass: "true"})) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(len(sp.Status.ClaimPropertySets)).To(Equal(0)) claimPropertySets := []cdiv1.ClaimPropertySet{ {AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadOnlyMany}, VolumeMode: &BlockMode}, {VolumeMode: &FilesystemMode}, } sp.Spec.ClaimPropertySets = claimPropertySets err = reconciler.client.Update(context.TODO(), sp.DeepCopy()) Expect(err).ToNot(HaveOccurred()) _, err = reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring(fmt.Sprintf("must provide access mode for volume mode: %s", FilesystemMode))) err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) updatedSp := storageProfileList.Items[0] Expect(*updatedSp.Status.StorageClass).To(Equal(storageClassName)) Expect(len(updatedSp.Status.ClaimPropertySets)).To(Equal(0)) Expect(updatedSp.Spec.ClaimPropertySets).To(Equal(claimPropertySets)) }) table.DescribeTable("should create clone strategy", func(cloneStrategy cdiv1.CDICloneStrategy) { storageClass := CreateStorageClass(storageClassName, map[string]string{AnnDefaultStorageClass: "true"}) storageClass.Annotations["cdi.kubevirt.io/clone-strategy"] = string(cloneStrategy) reconciler := createStorageProfileReconciler(storageClass) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(*sp.Status.CloneStrategy).To(Equal(cloneStrategy)) }, table.Entry("None", cdiv1.CloneStrategyHostAssisted), table.Entry("Snapshot", cdiv1.CloneStrategySnapshot), table.Entry("Clone", cdiv1.CloneStrategyCsiClone), ) table.DescribeTable("Should set the IncompleteProfileGauge correctly", func(provisioner string, count int) { reconciler := createStorageProfileReconciler(CreateStorageClassWithProvisioner(storageClassName, map[string]string{AnnDefaultStorageClass: "true"}, map[string]string{}, provisioner)) _, err := reconciler.Reconcile(context.TODO(), reconcile.Request{NamespacedName: types.NamespacedName{Name: storageClassName}}) Expect(err).ToNot(HaveOccurred()) storageProfileList := &cdiv1.StorageProfileList{} err = reconciler.client.List(context.TODO(), storageProfileList, &client.ListOptions{}) Expect(err).ToNot(HaveOccurred()) Expect(len(storageProfileList.Items)).To(Equal(1)) sp := storageProfileList.Items[0] Expect(*sp.Status.StorageClass).To(Equal(storageClassName)) Expect(len(sp.Status.ClaimPropertySets)).To(Equal(0)) Expect(int(prometheus.ToFloat64(IncompleteProfileGauge))).To(Equal(count)) }, table.Entry("Noobaa (not supported)", storagecapabilities.ProvisionerNoobaa, 0), table.Entry("Unknown provisioner", "unknown-provisioner", 1), ) }) func createStorageProfileReconciler(objects ...runtime.Object) *StorageProfileReconciler { objs := []runtime.Object{} objs = append(objs, objects...) objs = append(objs, MakeEmptyCDICR()) // Append empty CDIConfig object that normally is created by the reconcile loop cdiConfig := MakeEmptyCDIConfigSpec(common.ConfigName) cdiConfig.Status = cdiv1.CDIConfigStatus{ // ScratchSpaceStorageClass: storageClassName, } objs = append(objs, cdiConfig) // 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 := &StorageProfileReconciler{ client: cl, uncachedClient: cl, scheme: s, log: storageProfileLog, installerLabels: map[string]string{ common.AppKubernetesPartOfLabel: "testing", common.AppKubernetesVersionLabel: "v0.0.0-tests", }, } return r } func CreatePv(name string, storageClassName string) *v1.PersistentVolume { volumeMode := v1.PersistentVolumeFilesystem pv := &v1.PersistentVolume{ ObjectMeta: metav1.ObjectMeta{ Name: name, UID: types.UID(name), }, Spec: v1.PersistentVolumeSpec{ AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadOnlyMany, v1.ReadWriteOnce}, Capacity: v1.ResourceList{ v1.ResourceName(v1.ResourceStorage): resource.MustParse("1G"), }, StorageClassName: storageClassName, VolumeMode: &volumeMode, }, } return pv }