Update sorting conditions to order root last and sort by transition time (#83)

Author: jonathan-innis

status/condition_set.go

@@ -120,7 +120,13 @@ func (c ConditionSet) Set(condition Condition) (modified bool) {
 	}
 	conditions = append(conditions, condition)
 	// Sorted for convenience of the consumer, i.e. kubectl.
-	sort.Slice(conditions, func(i, j int) bool { return conditions[i].Type < conditions[j].Type })
+	sort.SliceStable(conditions, func(i, j int) bool {
+		// Order the root status condition at the end
+		if conditions[i].Type == c.root || conditions[j].Type == c.root {
+			return conditions[j].Type == c.root
+		}
+		return conditions[i].LastTransitionTime.Time.Before(conditions[j].LastTransitionTime.Time)
+	})
 	c.object.SetConditions(conditions)
 
 	// Recompute the root condition after setting any other condition

status/condition_set_test.go

@@ -3,6 +3,7 @@ package status_test
 import (
 	"time"
 
+	"github.com/awslabs/operatorpkg/status"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
@@ -140,4 +141,27 @@ var _ = Describe("Conditions", func() {
 		Expect(testObject.StatusConditions().IsTrue(ConditionTypeFoo, ConditionTypeBaz)).To(BeTrue())
 		Expect(testObject.StatusConditions().IsTrue(ConditionTypeFoo, ConditionTypeBar, ConditionTypeBaz)).To(BeTrue())
 	})
+	It("should sort status conditions", func() {
+		testObject := TestObject{}
+		// Ready condition should be at the end
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-1].Type).To(Equal(status.ConditionReady))
+
+		testObject.StatusConditions().SetTrue(ConditionTypeFoo)
+		// Ready condition should be last with Foo condition second to last since it was recently updated
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-1].Type).To(Equal(status.ConditionReady))
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-2].Type).To(Equal(ConditionTypeFoo))
+
+		testObject.StatusConditions().SetTrue(ConditionTypeBar)
+		// Ready condition should be last with Bar condition second to last since it was recently updated and Foo condition third to last
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-1].Type).To(Equal(status.ConditionReady))
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-2].Type).To(Equal(ConditionTypeBar))
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-3].Type).To(Equal(ConditionTypeFoo))
+
+		testObject.StatusConditions().SetTrue(ConditionTypeBaz)
+		// Ready condition should be last with Bar condition second to last since it was recently updated, Bar condition third to last, and Foo condition at the top
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-1].Type).To(Equal(status.ConditionReady))
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-2].Type).To(Equal(ConditionTypeBaz))
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-3].Type).To(Equal(ConditionTypeBar))
+		Expect(testObject.StatusConditions().List()[len(testObject.StatusConditions().List())-4].Type).To(Equal(ConditionTypeFoo))
+	})
 })