-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[release-v1.61] Fix PVC webhook rendering segfault (#3563)
* Fix PVC webhook rendering segfault When there is no default StorageClass and no virt default StorageClass, creating a PVC with no StorageClass specified will cause a segfault in the webhook: Error from server (InternalError): error when creating "pvc_render.yaml": Internal error occurred: failed calling webhook "pvc-mutate.cdi.kubevirt.io": failed to call webhook: Post "https://cdi-api.cdi.svc:443/pvc-mutate?timeout=10s": EOF In cdi-apiserver log: panic({0x1b49360?, 0x3295550?}) GOROOT/src/runtime/panic.go:770 +0x132 kubevirt.io/containerized-data-importer/pkg/controller/datavolume. renderPvcSpecVolumeModeAndAccessModesAndStorageClass({0x2164d00, 0xc000156090}, {0x0, 0x0}, 0x0?, 0x0, 0xc0002e86a8, {0x1e09ed8?, 0xc0002e8530?}) pkg/controller/datavolume/util.go:162 +0xb37 renderPvcSpecVolumeModeAndAccessModesAndStorageClass() is used from both DV controller and PVC webhook rendering. In the PVC mutating webhook (cdi-apiserver) we don't have logr.Logger (unlike in cdi-deployment), but klog which has different api, and no reason to log there as we return the failure anyway to the user when she creates the PVC. We also don't have a DV there, and no event recorder. Signed-off-by: Arnon Gilboa <agilboa@redhat.com> * Rephrase rendering errors Signed-off-by: Arnon Gilboa <agilboa@redhat.com> * Add some utests Signed-off-by: Arnon Gilboa <agilboa@redhat.com> --------- Signed-off-by: Arnon Gilboa <agilboa@redhat.com> Co-authored-by: Arnon Gilboa <agilboa@redhat.com>
- Loading branch information
1 parent
f1124ef
commit 8fa3932
Showing
3 changed files
with
207 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| /* | ||
| * This file is part of the CDI project | ||
| * | ||
| * 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. | ||
| * | ||
| * Copyright 2024 Red Hat, Inc. | ||
| * | ||
| */ | ||
|
|
||
| package webhooks | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "sort" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
|
|
||
| "github.com/appscode/jsonpatch" | ||
|
|
||
| admissionv1 "k8s.io/api/admission/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| storagev1 "k8s.io/api/storage/v1" | ||
| "k8s.io/apimachinery/pkg/api/resource" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/utils/ptr" | ||
|
|
||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/fake" | ||
|
|
||
| cdiv1 "kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1" | ||
| "kubevirt.io/containerized-data-importer/pkg/common" | ||
| ) | ||
|
|
||
| var _ = Describe("Mutating PVC Webhook", func() { | ||
| Context("with PVC admission review", func() { | ||
| It("should reject review without request", func() { | ||
| ar := &admissionv1.AdmissionReview{} | ||
| resp := mutatePvc(ar) | ||
| Expect(resp.Allowed).To(BeFalse()) | ||
| Expect(resp.Result.Message).Should(Equal("AdmissionReview.Request is nil")) | ||
| }) | ||
|
|
||
| const testStorageClassName = "sc_test" | ||
|
|
||
| var ( | ||
| storageClass = storagev1.StorageClass{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: testStorageClassName, | ||
| }, | ||
| } | ||
| defaultStorageClass = storagev1.StorageClass{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: testStorageClassName, | ||
| Annotations: map[string]string{ | ||
| "storageclass.kubernetes.io/is-default-class": "true", | ||
| }, | ||
| }, | ||
| } | ||
| storageProfile = cdiv1.StorageProfile{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: testStorageClassName}, | ||
| Status: cdiv1.StorageProfileStatus{ | ||
| ClaimPropertySets: []cdiv1.ClaimPropertySet{{ | ||
| VolumeMode: ptr.To[corev1.PersistentVolumeMode](corev1.PersistentVolumeBlock), | ||
| AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteMany}, | ||
| }}, | ||
| }, | ||
| } | ||
| partialStorageProfile = cdiv1.StorageProfile{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: testStorageClassName}, | ||
| Status: cdiv1.StorageProfileStatus{ | ||
| ClaimPropertySets: []cdiv1.ClaimPropertySet{{ | ||
| VolumeMode: ptr.To[corev1.PersistentVolumeMode](corev1.PersistentVolumeBlock), | ||
| }}, | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| DescribeTable("should", func(allowed bool, message string, objs ...client.Object) { | ||
| pvc := newPvc() | ||
| dvBytes, _ := json.Marshal(&pvc) | ||
|
|
||
| ar := &admissionv1.AdmissionReview{ | ||
| Request: &admissionv1.AdmissionRequest{ | ||
| Operation: admissionv1.Create, | ||
| Resource: metav1.GroupVersionResource{ | ||
| Group: corev1.SchemeGroupVersion.Group, | ||
| Version: corev1.SchemeGroupVersion.Version, | ||
| Resource: "persistentvolumeclaims", | ||
| }, | ||
| Object: runtime.RawExtension{ | ||
| Raw: dvBytes, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| resp := mutatePvc(ar, objs...) | ||
|
|
||
| if !allowed { | ||
| Expect(resp.Allowed).To(BeFalse()) | ||
| Expect(resp.Result).ToNot(BeNil()) | ||
| Expect(resp.Result.Message).To(Equal(message)) | ||
| return | ||
| } | ||
|
|
||
| Expect(resp.Allowed).To(BeTrue()) | ||
| Expect(resp.Result).To(BeNil()) | ||
| Expect(resp.Patch).ToNot(BeNil()) | ||
|
|
||
| var patchObjs []jsonpatch.Operation | ||
| err := json.Unmarshal(resp.Patch, &patchObjs) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
| Expect(patchObjs).Should(HaveLen(3)) | ||
|
|
||
| sort.Slice(patchObjs, func(i, j int) bool { | ||
| return patchObjs[i].Path < patchObjs[j].Path | ||
| }) | ||
|
|
||
| Expect(patchObjs[0].Operation).Should(Equal("add")) | ||
| Expect(patchObjs[0].Path).Should(Equal("/spec/accessModes")) | ||
| accessModes, ok := patchObjs[0].Value.([]interface{}) | ||
| Expect(ok).Should(BeTrue()) | ||
| Expect(accessModes).Should(HaveLen(1)) | ||
| Expect(accessModes[0]).Should(Equal("ReadWriteMany")) | ||
|
|
||
| Expect(patchObjs[1].Operation).Should(Equal("add")) | ||
| Expect(patchObjs[1].Path).Should(Equal("/spec/storageClassName")) | ||
| Expect(patchObjs[1].Value).Should(Equal(testStorageClassName)) | ||
|
|
||
| Expect(patchObjs[2].Operation).Should(Equal("add")) | ||
| Expect(patchObjs[2].Path).Should(Equal("/spec/volumeMode")) | ||
| Expect(patchObjs[2].Value).Should(Equal("Block")) | ||
| }, | ||
| Entry("fail with no storage classes", false, | ||
| "PVC spec is missing accessMode and no storageClass to choose profile"), | ||
| Entry("fail with no default storage classes", false, | ||
| "PVC spec is missing accessMode and no storageClass to choose profile", &storageClass, &storageProfile), | ||
| Entry("fail with default storage classes but with partial storage profile", false, | ||
| fmt.Sprintf("no accessMode specified in StorageProfile %s", testStorageClassName), &defaultStorageClass, &partialStorageProfile), | ||
| Entry("succeed with default storage classes and complete storage profile", true, "", &defaultStorageClass, &storageProfile), | ||
| ) | ||
| }) | ||
| }) | ||
|
|
||
| func newPvc() *corev1.PersistentVolumeClaim { | ||
| pvc := &corev1.PersistentVolumeClaim{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "testPvc", | ||
| Labels: map[string]string{common.PvcApplyStorageProfileLabel: "true"}, | ||
| }, | ||
| Spec: corev1.PersistentVolumeClaimSpec{ | ||
| Resources: corev1.VolumeResourceRequirements{ | ||
| Requests: corev1.ResourceList{ | ||
| corev1.ResourceStorage: resource.MustParse("1G"), | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| return pvc | ||
| } | ||
|
|
||
| func mutatePvc(ar *admissionv1.AdmissionReview, objs ...client.Object) *admissionv1.AdmissionResponse { | ||
| _ = storagev1.AddToScheme(scheme) | ||
| fakeClient := fake.NewClientBuilder(). | ||
| WithScheme(scheme). | ||
| WithObjects(objs...). | ||
| Build() | ||
|
|
||
| wh := NewPvcMutatingWebhook(fakeClient) | ||
|
|
||
| return serve(ar, wh) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters