feat: add condition related utilities (#406)

Azure · Jul 3, 2023 · 4104a44 · 4104a44
1 parent bbac37f
commit 4104a44
Show file tree

Hide file tree

Showing 2 changed files with 275 additions and 0 deletions.
diff --git a/pkg/utils/condition/condition.go b/pkg/utils/condition/condition.go
@@ -0,0 +1,41 @@
+/*
+Copyright (c) Microsoft Corporation.
+Licensed under the MIT license.
+*/
+
+// Package condition provides condition related utils.
+package condition
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EqualCondition compares one condition with another; it ignores the LastTransitionTime and Message fields,
+// and will consider the ObservedGeneration values from the two conditions a match if the current
+// condition is newer.
+func EqualCondition(current, desired *metav1.Condition) bool {
+	if current == nil && desired == nil {
+		return true
+	}
+	return current != nil &&
+		desired != nil &&
+		current.Type == desired.Type &&
+		current.Status == desired.Status &&
+		current.Reason == desired.Reason &&
+		current.ObservedGeneration >= desired.ObservedGeneration
+}
+
+// EqualConditionIgnoreReason compares one condition with another; it ignores the Reason, LastTransitionTime, and
+// Message fields, and will consider the ObservedGeneration values from the two conditions a match if the current
+// condition is newer.
+func EqualConditionIgnoreReason(current, desired *metav1.Condition) bool {
+	if current == nil && desired == nil {
+		return true
+	}
+
+	return current != nil &&
+		desired != nil &&
+		current.Type == desired.Type &&
+		current.Status == desired.Status &&
+		current.ObservedGeneration >= desired.ObservedGeneration
+}
diff --git a/pkg/utils/condition/condition_test.go b/pkg/utils/condition/condition_test.go
@@ -0,0 +1,234 @@
+/*
+Copyright (c) Microsoft Corporation.
+Licensed under the MIT license.
+*/
+
+package condition
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	conditionType    = "some-type"
+	altConditionType = "some-other-type"
+	reason           = "some reason"
+	altReason        = "some other reason"
+	message          = "some message"
+	altMessage       = "some other message"
+)
+
+func TestEqualCondition(t *testing.T) {
+	tests := []struct {
+		name    string
+		current *metav1.Condition
+		desired *metav1.Condition
+		want    bool
+	}{
+		{
+			name:    "both are nil",
+			current: nil,
+			desired: nil,
+			want:    true,
+		},
+		{
+			name:    "current is nil",
+			current: nil,
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            message,
+				ObservedGeneration: 1,
+			},
+			want: false,
+		},
+		{
+			name: "messages are different",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            message,
+				ObservedGeneration: 1,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            altMessage,
+				ObservedGeneration: 1,
+			},
+			want: true,
+		},
+		{
+			name: "observedGenerations are different (current is larger)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            message,
+				ObservedGeneration: 2,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            altMessage,
+				ObservedGeneration: 1,
+			},
+			want: true,
+		},
+		{
+			name: "observedGenerations are different (current is smaller)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            message,
+				ObservedGeneration: 3,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				Reason:             reason,
+				Message:            altMessage,
+				ObservedGeneration: 4,
+			},
+			want: false,
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			got := EqualCondition(tc.current, tc.desired)
+			if !cmp.Equal(got, tc.want) {
+				t.Errorf("EqualCondition() = %v, want %v", got, tc.want)
+			}
+		})
+	}
+}
+
+// TestEqualConditionIgnoreReason tests the EqualConditionIgnoreReason function.
+func TestEqualConditionIgnoreReason(t *testing.T) {
+	testCases := []struct {
+		name    string
+		current *metav1.Condition
+		desired *metav1.Condition
+		want    bool
+	}{
+		{
+			name:    "nil conditions",
+			current: nil,
+			desired: nil,
+			want:    true,
+		},
+		{
+			name:    "current is nil",
+			current: nil,
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				ObservedGeneration: 7,
+			},
+			want: false,
+		},
+		{
+			name: "conditions are equal",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionTrue,
+				ObservedGeneration: 0,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionTrue,
+				ObservedGeneration: 0,
+			},
+			want: true,
+		},
+		{
+			name: "conditions are equal (different reasons)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionTrue,
+				Reason:             reason,
+				ObservedGeneration: 0,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionTrue,
+				Reason:             altReason,
+				ObservedGeneration: 0,
+			},
+			want: true,
+		},
+		{
+			name: "conditions are not equal (different type)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				ObservedGeneration: 1,
+			},
+			desired: &metav1.Condition{
+				Type:               altConditionType,
+				Status:             metav1.ConditionUnknown,
+				ObservedGeneration: 1,
+			},
+			want: false,
+		},
+		{
+			name: "conditions are not equal (different status)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionFalse,
+				ObservedGeneration: 4,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionTrue,
+				ObservedGeneration: 4,
+			},
+			want: false,
+		},
+		{
+			name: "conditions are equal (current condition is newer)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				ObservedGeneration: 3,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionUnknown,
+				ObservedGeneration: 2,
+			},
+			want: true,
+		},
+		{
+			name: "conditions are not equal (current condition is older)",
+			current: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionFalse,
+				ObservedGeneration: 5,
+			},
+			desired: &metav1.Condition{
+				Type:               conditionType,
+				Status:             metav1.ConditionFalse,
+				ObservedGeneration: 6,
+			},
+			want: false,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			if got := EqualConditionIgnoreReason(tc.current, tc.desired); got != tc.want {
+				t.Fatalf("EqualConditionIgnoreReason(%+v, %+v) = %t, want %t",
+					tc.current, tc.desired, got, tc.want)
+			}
+		})
+	}
+}