containerized-data-importer/pkg/controller/datavolume/conditions_test.go
Arnon Gilboa 363d3122b1
Set DV Bound condition to False instead of Unknown (#3590)
Align DataVolume Bound condition with the Ready condition when the PVC
does not exist or has no phase set.

Signed-off-by: Arnon Gilboa <agilboa@redhat.com>
2025-01-15 23:26:45 +01:00

296 lines
15 KiB
Go

/*
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 datavolume
import (
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
corev1 "k8s.io/api/core/v1"
cdiv1 "kubevirt.io/containerized-data-importer-api/pkg/apis/core/v1beta1"
. "kubevirt.io/containerized-data-importer/pkg/controller/common"
)
var _ = Describe("findConditionByType", func() {
It("should locate the right condition by type", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
readyCondition := cdiv1.DataVolumeCondition{
Type: cdiv1.DataVolumeReady,
}
conditions = append(conditions, readyCondition)
runningCondition := cdiv1.DataVolumeCondition{
Type: cdiv1.DataVolumeRunning,
}
conditions = append(conditions, runningCondition)
boundCondition := cdiv1.DataVolumeCondition{
Type: cdiv1.DataVolumeBound,
}
conditions = append(conditions, boundCondition)
Expect(*FindConditionByType(cdiv1.DataVolumeReady, conditions)).To(Equal(readyCondition))
Expect(*FindConditionByType(cdiv1.DataVolumeRunning, conditions)).To(Equal(runningCondition))
Expect(*FindConditionByType(cdiv1.DataVolumeBound, conditions)).To(Equal(boundCondition))
})
})
var _ = Describe("updateRunningCondition", func() {
It("should create condition if it doesn't exist", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = updateRunningCondition(conditions, make(map[string]string))
Expect(conditions).To(HaveLen(1))
Expect(conditions[0].Type).To(Equal(cdiv1.DataVolumeRunning))
Expect(conditions[0].Message).To(BeEmpty())
Expect(conditions[0].Status).To(Equal(corev1.ConditionFalse))
Expect(conditions[0].Reason).To(Equal(""))
})
It("should have empty message if annotation is empty", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = updateRunningCondition(conditions, map[string]string{AnnRunningConditionMessage: ""})
Expect(conditions).To(HaveLen(1))
Expect(conditions[0].Type).To(Equal(cdiv1.DataVolumeRunning))
Expect(conditions[0].Message).To(BeEmpty())
Expect(conditions[0].Status).To(Equal(corev1.ConditionFalse))
Expect(conditions[0].Reason).To(Equal(""))
})
It("should properly escape message from annotation", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = updateRunningCondition(conditions, map[string]string{AnnRunningConditionMessage: "this is a message with quotes \"", AnnRunningConditionReason: "this is a \" reason with \" quotes"})
Expect(conditions).To(HaveLen(1))
Expect(conditions[0].Type).To(Equal(cdiv1.DataVolumeRunning))
Expect(conditions[0].Message).To(Equal("this is a message with quotes \""))
Expect(conditions[0].Status).To(Equal(corev1.ConditionFalse))
Expect(conditions[0].Reason).To(Equal("this is a \" reason with \" quotes"))
})
DescribeTable("runningCondition", func(conditionString string, status corev1.ConditionStatus, noAnnotation bool) {
conditions := make([]cdiv1.DataVolumeCondition, 0)
if noAnnotation {
conditions = updateRunningCondition(conditions, map[string]string{})
} else {
conditions = updateRunningCondition(conditions, map[string]string{AnnRunningCondition: conditionString})
}
condition := FindConditionByType(cdiv1.DataVolumeRunning, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeRunning))
Expect(condition.Message).To(BeEmpty())
Expect(condition.Status).To(Equal(status))
},
Entry("condition true", "true", corev1.ConditionTrue, false),
Entry("condition false", "false", corev1.ConditionFalse, false),
Entry("condition invalid", "invalid", corev1.ConditionUnknown, false),
Entry("no condition", "", corev1.ConditionFalse, true),
)
DescribeTable("runningConditionAndsource", func(conditionString, message, reason, sourceConditionString, sourceConditionMessage, sourceConditionReason string, status corev1.ConditionStatus, expectedMessage, expectedReason string) {
conditions := make([]cdiv1.DataVolumeCondition, 0)
if sourceConditionString != "" {
conditions = updateRunningCondition(conditions, map[string]string{AnnRunningCondition: conditionString, AnnRunningConditionMessage: message, AnnRunningConditionReason: reason, AnnSourceRunningCondition: sourceConditionString, AnnSourceRunningConditionMessage: sourceConditionMessage, AnnSourceRunningConditionReason: sourceConditionReason})
} else {
conditions = updateRunningCondition(conditions, map[string]string{AnnRunningCondition: conditionString, AnnRunningConditionMessage: message, AnnRunningConditionReason: reason})
}
condition := FindConditionByType(cdiv1.DataVolumeRunning, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeRunning))
Expect(condition.Message).To(Equal(expectedMessage))
Expect(condition.Reason).To(Equal(expectedReason))
Expect(condition.Status).To(Equal(status))
},
Entry("condition true, source true", "true", "", "", "true", "", "", corev1.ConditionTrue, "", ""),
Entry("condition true, source false", "true", "", "", "false", "scratch creating", "Creating Scratch", corev1.ConditionFalse, "scratch creating", "Creating Scratch"),
Entry("condition true, source unknown", "true", "", "", "invalid", "unknown message", "unknown reason", corev1.ConditionUnknown, "unknown message", "unknown reason"),
Entry("condition true, no source", "true", "", "", "", "", "", corev1.ConditionTrue, "", ""),
Entry("condition false, source true", "false", "Pod Pending", "Pending", "true", "", "", corev1.ConditionFalse, "Pod Pending", "Pending"),
Entry("condition false, source false", "false", "Pod Pending", "Pending", "false", "Pod Pending", "Pending", corev1.ConditionFalse, "Pod Pending and Pod Pending", "Pending and Pending"),
Entry("condition false, source unknown", "false", "Pod Pending", "Pending", "unknown", "unknown", "unknown", corev1.ConditionUnknown, "Pod Pending and unknown", "Pending and unknown"),
)
})
var _ = Describe("updateReadyCondition", func() {
It("should create condition if it doesn't exist", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = UpdateReadyCondition(conditions, corev1.ConditionTrue, "message", "reason")
Expect(conditions).To(HaveLen(1))
Expect(conditions[0].Type).To(Equal(cdiv1.DataVolumeReady))
Expect(conditions[0].Message).To(Equal("message"))
Expect(conditions[0].Reason).To(Equal("reason"))
Expect(conditions[0].Status).To(Equal(corev1.ConditionTrue))
})
})
var _ = Describe("updateBoundCondition", func() {
It("should create condition if it doesn't exist", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = updateBoundCondition(conditions, nil, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("No PVC found"))
Expect(condition.Reason).To(Equal(NotFound))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should create condition with reason if it doesn't exist", func() {
reason := "exceeded quota"
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = updateBoundCondition(conditions, nil, "", reason)
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("No PVC found"))
Expect(condition.Reason).To(Equal(reason))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should create condition with message if one passed", func() {
message := "message"
conditions := make([]cdiv1.DataVolumeCondition, 0)
conditions = updateBoundCondition(conditions, nil, message, "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal(message))
Expect(condition.Reason).To(Equal(NotFound))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should not be bound if PVC has no phase set", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, nil, nil)
pvc.Status.Phase = ""
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
Expect(condition.Message).To(BeEmpty())
Expect(condition.Reason).To(BeEmpty())
})
It("should be bound if PVC bound", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, nil, nil)
pvc.Status.Phase = corev1.ClaimBound
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(1))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("PVC test Bound"))
Expect(condition.Reason).To(Equal(pvcBound))
Expect(condition.Status).To(Equal(corev1.ConditionTrue))
})
It("should be bound if PVC bound and other PVC is bound", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, map[string]string{AnnBoundCondition: "true"}, nil)
pvc.Status.Phase = corev1.ClaimBound
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(1))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("PVC test Bound"))
Expect(condition.Reason).To(Equal(pvcBound))
Expect(condition.Status).To(Equal(corev1.ConditionTrue))
})
It("should be pending if PVC bound and other PVC is not bound", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, map[string]string{AnnBoundCondition: "false", AnnBoundConditionReason: "not bound", AnnBoundConditionMessage: "scratch PVC not bound"}, nil)
pvc.Status.Phase = corev1.ClaimBound
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("scratch PVC not bound"))
Expect(condition.Reason).To(Equal("not bound"))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
condition = FindConditionByType(cdiv1.DataVolumeReady, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeReady))
Expect(condition.Message).To(BeEmpty())
Expect(condition.Reason).To(BeEmpty())
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should be pending if PVC pending", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, nil, nil)
pvc.Status.Phase = corev1.ClaimPending
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("PVC test Pending"))
Expect(condition.Reason).To(Equal(pvcPending))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
condition = FindConditionByType(cdiv1.DataVolumeReady, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeReady))
Expect(condition.Message).To(BeEmpty())
Expect(condition.Reason).To(BeEmpty())
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should be pending if PVC pending, even if scratch PVC is bound", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, map[string]string{AnnBoundCondition: "true"}, nil)
pvc.Status.Phase = corev1.ClaimPending
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("PVC test Pending"))
Expect(condition.Reason).To(Equal(pvcPending))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
condition = FindConditionByType(cdiv1.DataVolumeReady, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeReady))
Expect(condition.Message).To(BeEmpty())
Expect(condition.Reason).To(BeEmpty())
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should be pending if PVC pending, if scratch PVC is not bound, message should be combined", func() {
reason := "not bound"
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, map[string]string{AnnBoundCondition: "false", AnnBoundConditionReason: reason, AnnBoundConditionMessage: "scratch PVC not bound"}, nil)
pvc.Status.Phase = corev1.ClaimPending
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("target PVC test Pending and scratch PVC not bound"))
Expect(condition.Reason).To(Equal(reason))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
condition = FindConditionByType(cdiv1.DataVolumeReady, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeReady))
Expect(condition.Message).To(BeEmpty())
Expect(condition.Reason).To(BeEmpty())
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
It("should be lost if PVC lost", func() {
conditions := make([]cdiv1.DataVolumeCondition, 0)
pvc := CreatePvc("test", corev1.NamespaceDefault, nil, nil)
pvc.Status.Phase = corev1.ClaimLost
conditions = updateBoundCondition(conditions, pvc, "", "")
Expect(conditions).To(HaveLen(2))
condition := FindConditionByType(cdiv1.DataVolumeBound, conditions)
Expect(condition.Type).To(Equal(cdiv1.DataVolumeBound))
Expect(condition.Message).To(Equal("Claim Lost"))
Expect(condition.Reason).To(Equal(ClaimLost))
Expect(condition.Status).To(Equal(corev1.ConditionFalse))
})
})