Address issues with sort package and tests

Author: Kate Osborn

internal/mode/static/sort/sort.go

@@ -18,11 +18,11 @@ func LessObjectMeta(meta1 *metav1.ObjectMeta, meta2 *metav1.ObjectMeta) bool {
 	return meta1.CreationTimestamp.Before(&meta2.CreationTimestamp)
 }
 
-// ClientObject compares two client.Objects and returns true if:
+// LessClientObject compares two client.Objects and returns true if:
 // - the first object was created first,
 // - the objects were created at the same time, or
 // - the first object's name appears first in alphabetical order.
-func ClientObject(obj1 client.Object, obj2 client.Object) bool {
+func LessClientObject(obj1 client.Object, obj2 client.Object) bool {
 	create1 := obj1.GetCreationTimestamp()
 	create2 := obj2.GetCreationTimestamp()
 

internal/mode/static/sort/sort_test.go

@@ -29,7 +29,6 @@ func TestLessObjectMeta(t *testing.T) {
 			meta2: &metav1.ObjectMeta{
 				Namespace:         "ns1",
 				Name:              "meta2",
-				UID:               "b",
 				CreationTimestamp: later,
 			},
 			name:     "first is less by timestamp",
@@ -92,7 +91,7 @@ func TestLessObjectMeta(t *testing.T) {
 	}
 }
 
-func TestClientObject(t *testing.T) {
+func TestLessClientObject(t *testing.T) {
 	before := metav1.Now()
 	later := metav1.NewTime(before.Add(1 * time.Second))
 
@@ -115,7 +114,6 @@ func TestClientObject(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Namespace:         "ns1",
 					Name:              "obj2",
-					UID:               "b",
 					CreationTimestamp: later,
 				},
 			},
@@ -133,8 +131,7 @@ func TestClientObject(t *testing.T) {
 			obj2: &v1.Gateway{
 				ObjectMeta: metav1.ObjectMeta{
 					Namespace:         "ns2",
-					Name:              "obj2",
-					UID:               "b",
+					Name:              "obj1",
 					CreationTimestamp: before,
 				},
 			},
@@ -153,7 +150,6 @@ func TestClientObject(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Namespace:         "ns1",
 					Name:              "obj2",
-					UID:               "b",
 					CreationTimestamp: before,
 				},
 			},
@@ -172,7 +168,6 @@ func TestClientObject(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Namespace:         "ns1",
 					Name:              "obj1",
-					UID:               "b",
 					CreationTimestamp: before,
 				},
 			},
@@ -184,8 +179,8 @@ func TestClientObject(t *testing.T) {
 		t.Run(test.name, func(t *testing.T) {
 			g := NewWithT(t)
 
-			result := ClientObject(test.obj1, test.obj2)
-			invertedResult := ClientObject(test.obj2, test.obj1)
+			result := LessClientObject(test.obj1, test.obj2)
+			invertedResult := LessClientObject(test.obj2, test.obj1)
 
 			g.Expect(result).To(Equal(test.expected))
 			g.Expect(invertedResult).To(BeFalse())

internal/mode/static/state/graph/backend_refs.go

@@ -247,7 +247,7 @@ func findBackendTLSPolicyForService(
 		for _, targetRef := range btp.Source.Spec.TargetRefs {
 			if string(targetRef.Name) == refName && btpNs == refNs {
 				if beTLSPolicy != nil {
-					if sort.LessObjectMeta(&btp.Source.ObjectMeta, &beTLSPolicy.Source.ObjectMeta) {
+					if sort.LessClientObject(btp.Source, beTLSPolicy.Source) {
 						beTLSPolicy = btp
 					}
 				} else {

internal/mode/static/state/graph/gateway.go

@@ -77,7 +77,7 @@ func processGateways(
 	}
 
 	sort.Slice(referencedGws, func(i, j int) bool {
-		return ngfsort.LessObjectMeta(&referencedGws[i].ObjectMeta, &referencedGws[j].ObjectMeta)
+		return ngfsort.LessClientObject(referencedGws[i], referencedGws[j])
 	})
 
 	ignoredGws := make(map[types.NamespacedName]*v1.Gateway)

internal/mode/static/state/graph/policies.go

@@ -245,7 +245,7 @@ func markConflictedPolicies(policies map[PolicyKey]*Policy, validator validation
 		// This will put them in priority-order.
 		sort.Slice(
 			policyList, func(i, j int) bool {
-				return ngfsort.ClientObject(policyList[i].Source, policyList[j].Source)
+				return ngfsort.LessClientObject(policyList[i].Source, policyList[j].Source)
 			},
 		)