[bugfix] fix StatefulsetReady check (#705)

* fix sts ready parameter

* update status

* update fmt

* update fix

* update fix

Author: LuyuZhang00

pkg/utils/statefulset/statefulset_utils.go

@@ -46,6 +46,6 @@ func GetParentNameAndOrdinal(name string) (string, int) {
 
 // StatefulsetReady checks whether a sts is ready.
 func StatefulsetReady(sts appsv1.StatefulSet) bool {
-	return *sts.Spec.Replicas == sts.Status.Replicas &&
+	return *sts.Spec.Replicas == sts.Status.AvailableReplicas &&
 		sts.Status.CurrentRevision == sts.Status.UpdateRevision
 }

pkg/utils/statefulset/statefulset_utils_test.go

@@ -20,6 +20,7 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
+	appsv1 "k8s.io/api/apps/v1"
 )
 
 func TestGetParentNameAndOrdinal(t *testing.T) {
@@ -76,3 +77,77 @@ func TestGetParentNameAndOrdinal(t *testing.T) {
 		})
 	}
 }
+
+func TestStatefulsetReady(t *testing.T) {
+	replicas := int32(3)
+	tests := []struct {
+		name     string
+		sts      appsv1.StatefulSet
+		wantBool bool
+	}{
+		{
+			name: "statefulset is ready when AvailableReplicas equals Spec.Replicas and revisions match",
+			sts: appsv1.StatefulSet{
+				Spec: appsv1.StatefulSetSpec{
+					Replicas: &replicas,
+				},
+				Status: appsv1.StatefulSetStatus{
+					AvailableReplicas: 3,
+					CurrentRevision:   "rev-1",
+					UpdateRevision:    "rev-1",
+				},
+			},
+			wantBool: true,
+		},
+		{
+			name: "statefulset is not ready when AvailableReplicas less than Spec.Replicas",
+			sts: appsv1.StatefulSet{
+				Spec: appsv1.StatefulSetSpec{
+					Replicas: &replicas,
+				},
+				Status: appsv1.StatefulSetStatus{
+					AvailableReplicas: 2,
+					CurrentRevision:   "rev-1",
+					UpdateRevision:    "rev-1",
+				},
+			},
+			wantBool: false,
+		},
+		{
+			name: "statefulset is not ready when CurrentRevision != UpdateRevision",
+			sts: appsv1.StatefulSet{
+				Spec: appsv1.StatefulSetSpec{
+					Replicas: &replicas,
+				},
+				Status: appsv1.StatefulSetStatus{
+					AvailableReplicas: 3,
+					CurrentRevision:   "rev-1",
+					UpdateRevision:    "rev-2",
+				},
+			},
+			wantBool: false,
+		},
+		{
+			name: "statefulset is not ready when both conditions fail",
+			sts: appsv1.StatefulSet{
+				Spec: appsv1.StatefulSetSpec{
+					Replicas: &replicas,
+				},
+				Status: appsv1.StatefulSetStatus{
+					AvailableReplicas: 2,
+					CurrentRevision:   "rev-1",
+					UpdateRevision:    "rev-2",
+				},
+			},
+			wantBool: false,
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			got := StatefulsetReady(tc.sts)
+			if diff := cmp.Diff(tc.wantBool, got); diff != "" {
+				t.Errorf("unexpected StatefulsetReady result: %s", diff)
+			}
+		})
+	}
+}

test/testutils/util.go

@@ -392,6 +392,7 @@ func SetPodGroupToReady(ctx context.Context, k8sClient client.Client, statefulse
 		}
 
 		sts.Status.ReadyReplicas = *sts.Spec.Replicas
+		sts.Status.AvailableReplicas = *sts.Spec.Replicas
 		sts.Status.Replicas = *sts.Spec.Replicas
 		sts.Status.CurrentRevision = ""
 		sts.Status.UpdateRevision = ""
@@ -703,6 +704,7 @@ func SetLeaderPodsToReady(ctx context.Context, k8sClient client.Client, lws *lea
 			return err
 		}
 		sts.Status.ReadyReplicas = *sts.Spec.Replicas
+		sts.Status.AvailableReplicas = *sts.Spec.Replicas
 		sts.Status.Replicas = *sts.Spec.Replicas
 		sts.Status.CurrentRevision = ""
 		sts.Status.UpdateRevision = ""