Refactor condition helpers for Mirror, Summary and Aggregate

Author: fabriziopandini

util/conditions/getter.go

@@ -114,9 +114,9 @@ func GetLastTransitionTime(from Getter, t clusterv1.ConditionType) *metav1.Time
 	return nil
 }
 
-// Summary returns a Ready condition with the summary of all the conditions existing
+// summary returns a Ready condition with the summary of all the conditions existing
 // on an object. If the object does not have other conditions, no summary condition is generated.
-func Summary(from Getter, options ...MergeOption) *clusterv1.Condition {
+func summary(from Getter, options ...MergeOption) *clusterv1.Condition {
 	conditions := from.GetConditions()
 
 	conditionsInScope := make([]localizedCondition, 0, len(conditions))
@@ -137,11 +137,47 @@ func Summary(from Getter, options ...MergeOption) *clusterv1.Condition {
 	return merge(conditionsInScope, clusterv1.ReadyCondition, mergeOpt)
 }
 
-// Mirror mirrors the Ready condition from a dependent object into the target condition;
+// mirrorOptions allows to set options for the mirror operation.
+type mirrorOptions struct {
+	fallbackTo       *bool
+	fallbackReason   string
+	fallbackSeverity clusterv1.ConditionSeverity
+	fallbackMessage  string
+}
+
+// MirrorOptions defines an option for mirroring conditions.
+type MirrorOptions func(*mirrorOptions)
+
+// WithFallbackValue specify a fallback value to use in case the mirrored condition does not exists;
+// in case the fallbackValue is false, given values for reason, severity and message will be used.
+func WithFallbackValue(fallbackValue bool, reason string, severity clusterv1.ConditionSeverity, message string) MirrorOptions {
+	return func(c *mirrorOptions) {
+		c.fallbackTo = &fallbackValue
+		c.fallbackReason = reason
+		c.fallbackSeverity = severity
+		c.fallbackMessage = message
+	}
+}
+
+// mirror mirrors the Ready condition from a dependent object into the target condition;
 // if the Ready condition does not exists in the source object, no target conditions is generated.
-func Mirror(from Getter, targetCondition clusterv1.ConditionType) *clusterv1.Condition {
+func mirror(from Getter, targetCondition clusterv1.ConditionType, options ...MirrorOptions) *clusterv1.Condition {
+	mirrorOpt := &mirrorOptions{}
+	for _, o := range options {
+		o(mirrorOpt)
+	}
+
 	condition := Get(from, clusterv1.ReadyCondition)
 
+	if mirrorOpt.fallbackTo != nil && condition == nil {
+		switch *mirrorOpt.fallbackTo {
+		case true:
+			condition = TrueCondition(targetCondition)
+		case false:
+			condition = FalseCondition(targetCondition, mirrorOpt.fallbackReason, mirrorOpt.fallbackSeverity, mirrorOpt.fallbackMessage)
+		}
+	}
+
 	if condition != nil {
 		condition.Type = targetCondition
 	}
@@ -152,7 +188,7 @@ func Mirror(from Getter, targetCondition clusterv1.ConditionType) *clusterv1.Con
 // Aggregates all the the Ready condition from a list of dependent objects into the target object;
 // if the Ready condition does not exists in one of the source object, the object is excluded from
 // the aggregation; if none of the source object have ready condition, no target conditions is generated.
-func Aggregate(from []Getter, targetCondition clusterv1.ConditionType, options ...MergeOption) *clusterv1.Condition {
+func aggregate(from []Getter, targetCondition clusterv1.ConditionType, options ...MergeOption) *clusterv1.Condition {
 	conditionsInScope := make([]localizedCondition, 0, len(from))
 	for i := range from {
 		condition := Get(from[i], clusterv1.ReadyCondition)

util/conditions/getter_test.go

@@ -120,7 +120,7 @@ func TestMirror(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			g := NewWithT(t)
 
-			got := Mirror(tt.from, tt.t)
+			got := mirror(tt.from, tt.t)
 			if tt.want == nil {
 				g.Expect(got).To(BeNil())
 				return
@@ -161,7 +161,7 @@ func TestSummary(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			g := NewWithT(t)
 
-			got := Summary(tt.from)
+			got := summary(tt.from)
 			if tt.want == nil {
 				g.Expect(got).To(BeNil())
 				return
@@ -205,7 +205,7 @@ func TestAggregate(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			g := NewWithT(t)
 
-			got := Aggregate(tt.from, tt.t)
+			got := aggregate(tt.from, tt.t)
 			if tt.want == nil {
 				g.Expect(got).To(BeNil())
 				return

util/conditions/merge_test.go

@@ -89,12 +89,12 @@ func TestMergeRespectPriority(t *testing.T) {
 		want       *clusterv1.Condition
 	}{
 		{
-			name:       "Aggregate nil list return nil",
+			name:       "aggregate nil list return nil",
 			conditions: nil,
 			want:       nil,
 		},
 		{
-			name:       "Aggregate empty list return nil",
+			name:       "aggregate empty list return nil",
 			conditions: []*clusterv1.Condition{},
 			want:       nil,
 		},

util/conditions/setter.go

@@ -116,21 +116,21 @@ func MarkFalse(to Setter, t clusterv1.ConditionType, reason string, severity clu
 // SetSummary sets a Ready condition with the summary of all the conditions existing
 // on an object. If the object does not have other conditions, no summary condition is generated.
 func SetSummary(to Setter, options ...MergeOption) {
-	Set(to, Summary(to, options...))
+	Set(to, summary(to, options...))
 }
 
-// SetMirrorCondition creates a new condition by mirroring the the Ready condition from a dependent object;
+// SetMirror creates a new condition by mirroring the the Ready condition from a dependent object;
 // if the Ready condition does not exists in the source object, no target conditions is generated.
-func SetMirrorCondition(to Setter, targetCondition clusterv1.ConditionType, from Getter) {
-	Set(to, Mirror(from, targetCondition))
+func SetMirror(to Setter, targetCondition clusterv1.ConditionType, from Getter, options ...MirrorOptions) {
+	Set(to, mirror(from, targetCondition, options...))
 }
 
-// SetAggregateCondition creates a new condition with the aggregation of all the the Ready condition
+// SetAggregate creates a new condition with the aggregation of all the the Ready condition
 // from a list of dependent objects; if the Ready condition does not exists in one of the source object,
 // the object is excluded from the aggregation; if none of the source object have ready condition,
 // no target conditions is generated.
-func SetAggregateCondition(to Setter, targetCondition clusterv1.ConditionType, from []Getter, options ...MergeOption) {
-	Set(to, Aggregate(from, targetCondition, options...))
+func SetAggregate(to Setter, targetCondition clusterv1.ConditionType, from []Getter, options ...MergeOption) {
+	Set(to, aggregate(from, targetCondition, options...))
 }
 
 // Delete deletes the condition with the given type.

util/conditions/setter_test.go

@@ -216,6 +216,36 @@ func TestMarkMethods(t *testing.T) {
 	}))
 }
 
+func TestSetSummary(t *testing.T) {
+	g := NewWithT(t)
+	target := setterWithConditions(TrueCondition("foo"))
+
+	SetSummary(target)
+
+	g.Expect(Has(target, clusterv1.ReadyCondition)).To(BeTrue())
+}
+
+func TestSetMirror(t *testing.T) {
+	g := NewWithT(t)
+	source := getterWithConditions(TrueCondition(clusterv1.ReadyCondition))
+	target := setterWithConditions()
+
+	SetMirror(target, "foo", source)
+
+	g.Expect(Has(target, "foo")).To(BeTrue())
+}
+
+func TestSetAggregate(t *testing.T) {
+	g := NewWithT(t)
+	source1 := getterWithConditions(TrueCondition(clusterv1.ReadyCondition))
+	source2 := getterWithConditions(TrueCondition(clusterv1.ReadyCondition))
+	target := setterWithConditions()
+
+	SetAggregate(target, "foo", []Getter{source1, source2})
+
+	g.Expect(Has(target, "foo")).To(BeTrue())
+}
+
 func setterWithConditions(conditions ...*clusterv1.Condition) Setter {
 	obj := &clusterv1.Cluster{}
 	obj.SetConditions(conditionList(conditions...))