Merge pull request #616 from stuggi/depl_ready

[deployment/statefulset] add IsReady func

Author: abays

modules/common/deployment/deployment.go

@@ -127,3 +127,14 @@ func GetDeploymentWithName(
 
 	return depl, nil
 }
+
+// IsReady - validates when deployment is ready deployed to whats being requested
+// - the requested replicas in the spec matches the ReadyReplicas of the status
+// - the Status.Replicas match Status.ReadyReplicas. if a deployment update is in progress, Replicas > ReadyReplicas
+// - both when the Generatation of the object matches the ObservedGeneration of the Status
+func IsReady(deployment appsv1.Deployment) bool {
+	return deployment.Spec.Replicas != nil &&
+		*deployment.Spec.Replicas == deployment.Status.ReadyReplicas &&
+		deployment.Status.Replicas == deployment.Status.ReadyReplicas &&
+		deployment.Generation == deployment.Status.ObservedGeneration
+}

modules/common/statefulset/statefulset.go

@@ -138,3 +138,12 @@ func (s *StatefulSet) Delete(
 
 	return nil
 }
+
+// IsReady - validates when deployment is ready deployed to whats being requested
+// - the requested replicas in the spec matches the ReadyReplicas of the status
+// - both when the Generatation of the object matches the ObservedGeneration of the Status
+func IsReady(deployment appsv1.StatefulSet) bool {
+	return deployment.Spec.Replicas != nil &&
+		*deployment.Spec.Replicas == deployment.Status.ReadyReplicas &&
+		deployment.Generation == deployment.Status.ObservedGeneration
+}

modules/common/test/helpers/deployment.go

@@ -15,6 +15,7 @@ package helpers
 
 import (
 	"encoding/json"
+	"fmt"
 
 	networkv1 "github.com/k8snetworkplumbingwg/network-attachment-definition-client/pkg/apis/k8s.cni.cncf.io/v1"
 	"github.com/onsi/gomega"
@@ -59,8 +60,10 @@ func (tc *TestHelper) SimulateDeploymentAnyNumberReplicaReady(name types.Namespa
 	gomega.Eventually(func(g gomega.Gomega) {
 		deployment := tc.GetDeployment(name)
 
+		deployment.Status.AvailableReplicas = replica
 		deployment.Status.Replicas = replica
 		deployment.Status.ReadyReplicas = replica
+		deployment.Status.UpdatedReplicas = replica
 		deployment.Status.ObservedGeneration = deployment.Generation
 		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, deployment)).To(gomega.Succeed())
 	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
@@ -77,8 +80,10 @@ func (tc *TestHelper) SimulateDeploymentReplicaReady(name types.NamespacedName)
 	gomega.Eventually(func(g gomega.Gomega) {
 		deployment := tc.GetDeployment(name)
 
+		deployment.Status.AvailableReplicas = *deployment.Spec.Replicas
 		deployment.Status.Replicas = *deployment.Spec.Replicas
 		deployment.Status.ReadyReplicas = *deployment.Spec.Replicas
+		deployment.Status.UpdatedReplicas = *deployment.Spec.Replicas
 		deployment.Status.ObservedGeneration = deployment.Generation
 		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, deployment)).To(gomega.Succeed())
 	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
@@ -139,8 +144,10 @@ func (tc *TestHelper) SimulateDeploymentReadyWithPods(name types.NamespacedName,
 
 	gomega.Eventually(func(g gomega.Gomega) {
 		depl := tc.GetDeployment(name)
+		depl.Status.AvailableReplicas = *depl.Spec.Replicas
 		depl.Status.Replicas = *depl.Spec.Replicas
 		depl.Status.ReadyReplicas = *depl.Spec.Replicas
+		depl.Status.UpdatedReplicas = *depl.Spec.Replicas
 		depl.Status.ObservedGeneration = depl.Generation
 		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, depl)).To(gomega.Succeed())
 
@@ -157,3 +164,106 @@ func (tc *TestHelper) AssertDeploymentDoesNotExist(name types.NamespacedName) {
 		g.Expect(k8s_errors.IsNotFound(err)).To(gomega.BeTrue())
 	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
 }
+
+// SimulateDeploymentProgressing function retrieves the Deployment resource and
+// simulate that replicas are progressing
+// Example usage:
+//
+//	th.SimulateDeploymentProgressing(ironicNames.INAName)
+func (tc *TestHelper) SimulateDeploymentProgressing(name types.NamespacedName) {
+	gomega.Eventually(func(g gomega.Gomega) {
+		deployment := tc.GetDeployment(name)
+
+		deployment.Status.AvailableReplicas = *deployment.Spec.Replicas
+		deployment.Status.Replicas = *deployment.Spec.Replicas + 1
+		deployment.Status.ReadyReplicas = *deployment.Spec.Replicas
+		deployment.Status.UpdatedReplicas = *deployment.Spec.Replicas
+		deployment.Status.ObservedGeneration = deployment.Generation
+
+		/*
+			conditions:
+			- lastTransitionTime: "2025-03-11T10:53:00Z"
+			  lastUpdateTime: "2025-03-11T10:53:00Z"
+			  message: Deployment has minimum availability.
+			  reason: MinimumReplicasAvailable
+			  status: "True"
+			  type: Available
+			- lastTransitionTime: "2025-03-11T16:17:41Z"
+			  lastUpdateTime: "2025-03-11T16:27:31Z"
+			  message: ReplicaSet "keystone-869cb5d44c" is progressing.
+			  reason: ReplicaSetUpdated
+			  status: "True"
+			  type: Progressing
+		*/
+
+		deployment.Status.Conditions = []appsv1.DeploymentCondition{
+			{
+				Message: "Deployment has minimum availability",
+				Reason:  "MinimumReplicasAvailable",
+				Status:  corev1.ConditionTrue,
+				Type:    appsv1.DeploymentAvailable,
+			},
+			{
+				Message: fmt.Sprintf("ReplicaSet \"%s-869cb5d44c\" is progressing.", deployment.Name),
+				Reason:  "ReplicaSetUpdated",
+				Status:  corev1.ConditionTrue,
+				Type:    appsv1.DeploymentProgressing,
+			}}
+
+		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, deployment)).To(gomega.Succeed())
+	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
+
+	tc.Logger.Info("Simulated Deployment progressing", "on", name)
+}
+
+// SimulateDeploymentProgressDeadlineExceeded function retrieves the Deployment resource and
+// simulate that it hit ProgressDeadlineExceeded
+// Example usage:
+//
+//	th.SimulateDeploymentProgressDeadlineExceeded(ironicNames.INAName)
+func (tc *TestHelper) SimulateDeploymentProgressDeadlineExceeded(name types.NamespacedName) {
+	gomega.Eventually(func(g gomega.Gomega) {
+		deployment := tc.GetDeployment(name)
+
+		deployment.Status.AvailableReplicas = *deployment.Spec.Replicas
+		deployment.Status.Replicas = *deployment.Spec.Replicas + 1
+		deployment.Status.ReadyReplicas = *deployment.Spec.Replicas
+		deployment.Status.UpdatedReplicas = *deployment.Spec.Replicas
+		deployment.Status.ObservedGeneration = deployment.Generation
+		deployment.Status.UnavailableReplicas = 1
+
+		/*
+			conditions:
+			- lastTransitionTime: "2025-03-14T11:09:42Z"
+			  lastUpdateTime: "2025-03-14T11:09:42Z"
+			  message: Deployment has minimum availability.
+			  reason: MinimumReplicasAvailable
+			  status: "True"
+			  type: Available
+			- lastTransitionTime: "2025-03-18T13:49:18Z"
+			  lastUpdateTime: "2025-03-18T13:49:18Z"
+			  message: ReplicaSet "keystone-5d9c965546" has timed out progressing.
+			  reason: ProgressDeadlineExceeded
+			  status: "False"
+			  type: Progressing
+		*/
+
+		deployment.Status.Conditions = []appsv1.DeploymentCondition{
+			{
+				Message: "Deployment has minimum availability",
+				Reason:  "MinimumReplicasAvailable",
+				Status:  corev1.ConditionTrue,
+				Type:    appsv1.DeploymentAvailable,
+			},
+			{
+				Message: fmt.Sprintf("ReplicaSet \"%s-869cb5d44c\" has timed out progressing.", deployment.Name),
+				Reason:  "ProgressDeadlineExceeded",
+				Status:  corev1.ConditionFalse,
+				Type:    appsv1.DeploymentProgressing,
+			}}
+
+		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, deployment)).To(gomega.Succeed())
+	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
+
+	tc.Logger.Info("Simulated Deployment ProgressDeadlineExceeded", "on", name)
+}

modules/common/test/helpers/statefulset.go

@@ -47,8 +47,10 @@ func (tc *TestHelper) GetStatefulSet(name types.NamespacedName) *appsv1.Stateful
 func (tc *TestHelper) SimulateStatefulSetReplicaReady(name types.NamespacedName) {
 	gomega.Eventually(func(g gomega.Gomega) {
 		ss := tc.GetStatefulSet(name)
+		ss.Status.AvailableReplicas = *ss.Spec.Replicas
 		ss.Status.Replicas = *ss.Spec.Replicas
 		ss.Status.ReadyReplicas = *ss.Spec.Replicas
+		ss.Status.UpdatedReplicas = *ss.Spec.Replicas
 		ss.Status.ObservedGeneration = ss.Generation
 		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, ss)).To(gomega.Succeed())
 
@@ -108,8 +110,10 @@ func (tc *TestHelper) SimulateStatefulSetReplicaReadyWithPods(name types.Namespa
 
 	gomega.Eventually(func(g gomega.Gomega) {
 		ss := tc.GetStatefulSet(name)
+		ss.Status.AvailableReplicas = *ss.Spec.Replicas
 		ss.Status.Replicas = *ss.Spec.Replicas
 		ss.Status.ReadyReplicas = *ss.Spec.Replicas
+		ss.Status.UpdatedReplicas = *ss.Spec.Replicas
 		ss.Status.ObservedGeneration = ss.Generation
 		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, ss)).To(gomega.Succeed())
 
@@ -126,3 +130,23 @@ func (tc *TestHelper) AssertStatefulSetDoesNotExist(name types.NamespacedName) {
 		g.Expect(k8s_errors.IsNotFound(err)).To(gomega.BeTrue())
 	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
 }
+
+// SimulateStatefulSetProgressing function retrieves the StatefulSet resource and
+// simulate that replicas are progressing
+// Example usage:
+//
+//	th.SimulateStatefulSetReplicaReady(types.NamespacedName{Name: "test-statefulset", Namespace: "test-namespace"})
+func (tc *TestHelper) SimulateStatefulSetProgressing(name types.NamespacedName) {
+	gomega.Eventually(func(g gomega.Gomega) {
+		ss := tc.GetStatefulSet(name)
+		ss.Status.AvailableReplicas = *ss.Spec.Replicas - 1
+		ss.Status.Replicas = *ss.Spec.Replicas
+		ss.Status.ReadyReplicas = *ss.Spec.Replicas - 1
+		ss.Status.UpdatedReplicas = *ss.Spec.Replicas
+		ss.Status.ObservedGeneration = ss.Generation
+
+		g.Expect(tc.K8sClient.Status().Update(tc.Ctx, ss)).To(gomega.Succeed())
+
+	}, tc.Timeout, tc.Interval).Should(gomega.Succeed())
+	tc.Logger.Info("Simulated statefulset progressing", "on", name)
+}