fix: aggregate xRoute/xPolicy statuses across GWCs in gateway-api runner

Signed-off-by: y-rabie <[email protected]>

Author: y-rabie

internal/gatewayapi/extensionserverpolicy.go

@@ -81,7 +81,7 @@ func (t *Translator) ProcessExtensionServerPolicies(policies []unstructured.Unst
 		}
 		if accepted {
 			res = append(res, *policy)
-			policy.Object["status"] = policyStatusToUnstructured(policyStatus)
+			policy.Object["status"] = PolicyStatusToUnstructured(policyStatus)
 		}
 	}
 
@@ -108,14 +108,6 @@ func extractTargetRefs(policy *unstructured.Unstructured, gateways []*GatewayCon
 	return ret, nil
 }
 
-func policyStatusToUnstructured(policyStatus gwapiv1.PolicyStatus) map[string]any {
-	ret := map[string]any{}
-	// No need to check the marshal/unmarshal error here
-	d, _ := json.Marshal(policyStatus)
-	_ = json.Unmarshal(d, &ret)
-	return ret
-}
-
 func resolveExtServerPolicyGatewayTargetRef(policy *unstructured.Unstructured, target gwapiv1.LocalPolicyTargetReferenceWithSectionName, gateways map[types.NamespacedName]*policyGatewayTargetContext) *GatewayContext {
 	// Check if the gateway exists
 	key := types.NamespacedName{
@@ -132,6 +124,29 @@ func resolveExtServerPolicyGatewayTargetRef(policy *unstructured.Unstructured, t
 	return gateway.GatewayContext
 }
 
+func PolicyStatusToUnstructured(policyStatus gwapiv1.PolicyStatus) map[string]any {
+	ret := map[string]any{}
+	// No need to check the marshal/unmarshal error here
+	d, _ := json.Marshal(policyStatus)
+	_ = json.Unmarshal(d, &ret)
+	return ret
+}
+
+func ExtServerPolicyStatusAsPolicyStatus(policy *unstructured.Unstructured) gwapiv1.PolicyStatus {
+	statusObj := policy.Object["status"]
+	status := gwapiv1.PolicyStatus{}
+	if _, ok := statusObj.(map[string]any); ok {
+		// No need to check the json marshal/unmarshal error, the policyStatus was
+		// created via a typed object so the marshalling/unmarshalling will always
+		// work
+		d, _ := json.Marshal(statusObj)
+		_ = json.Unmarshal(d, &status)
+	} else if _, ok := statusObj.(gwapiv1.PolicyStatus); ok {
+		status = statusObj.(gwapiv1.PolicyStatus)
+	}
+	return status
+}
+
 func (t *Translator) translateExtServerPolicyForGateway(
 	policy *unstructured.Unstructured,
 	gateway *GatewayContext,
@@ -173,3 +188,11 @@ func (t *Translator) translateExtServerPolicyForGateway(
 	}
 	return found
 }
+
+// Appends status ancestors from newPolicy into aggregatedPolicy's list of ancestors.
+func MergeAncestorsForExtensionServerPolicies(aggregatedPolicy, newPolicy *unstructured.Unstructured) {
+	aggStatus := ExtServerPolicyStatusAsPolicyStatus(aggregatedPolicy)
+	newStatus := ExtServerPolicyStatusAsPolicyStatus(newPolicy)
+	aggStatus.Ancestors = append(aggStatus.Ancestors, newStatus.Ancestors...)
+	aggregatedPolicy.Object["status"] = PolicyStatusToUnstructured(aggStatus)
+}

internal/gatewayapi/extensionserverpolicy_test.go

@@ -123,3 +123,115 @@ func TestExtractTargetRefs(t *testing.T) {
 		})
 	}
 }
+
+func TestMergeAncestorsForExtensionServerPolicies(t *testing.T) {
+	tests := []struct {
+		aggStatus *gwapiv1.PolicyStatus
+		newStatus *gwapiv1.PolicyStatus
+		noStatus  bool
+	}{
+		{
+			aggStatus: &gwapiv1.PolicyStatus{
+				Ancestors: []gwapiv1.PolicyAncestorStatus{
+					{
+						AncestorRef: gwapiv1.ParentReference{
+							Name: "gateway-1",
+						},
+					},
+				},
+			},
+			newStatus: &gwapiv1.PolicyStatus{
+				Ancestors: []gwapiv1.PolicyAncestorStatus{
+					{
+						AncestorRef: gwapiv1.ParentReference{
+							Name: "gateway-2",
+						},
+					},
+				},
+			},
+		},
+		{
+			aggStatus: &gwapiv1.PolicyStatus{},
+			newStatus: &gwapiv1.PolicyStatus{
+				Ancestors: []gwapiv1.PolicyAncestorStatus{
+					{
+						AncestorRef: gwapiv1.ParentReference{
+							Name: "gateway-2",
+						},
+					},
+				},
+			},
+		},
+		{
+			aggStatus: &gwapiv1.PolicyStatus{
+				Ancestors: []gwapiv1.PolicyAncestorStatus{
+					{
+						AncestorRef: gwapiv1.ParentReference{
+							Name: "gateway-1",
+						},
+					},
+				},
+			},
+			newStatus: &gwapiv1.PolicyStatus{},
+		},
+		{
+			aggStatus: &gwapiv1.PolicyStatus{},
+			newStatus: &gwapiv1.PolicyStatus{},
+		},
+		{
+			aggStatus: nil,
+			newStatus: &gwapiv1.PolicyStatus{
+				Ancestors: []gwapiv1.PolicyAncestorStatus{
+					{
+						AncestorRef: gwapiv1.ParentReference{
+							Name: "gateway-1",
+						},
+					},
+				},
+			},
+		},
+		{
+			aggStatus: &gwapiv1.PolicyStatus{
+				Ancestors: []gwapiv1.PolicyAncestorStatus{
+					{
+						AncestorRef: gwapiv1.ParentReference{
+							Name: "gateway-1",
+						},
+					},
+				},
+			},
+			newStatus: nil,
+		},
+		{
+			aggStatus: nil,
+			newStatus: nil,
+		},
+	}
+
+	for _, test := range tests {
+		aggPolicy := unstructured.Unstructured{Object: make(map[string]interface{})}
+		newPolicy := unstructured.Unstructured{Object: make(map[string]interface{})}
+		desiredMergedStatus := gwapiv1.PolicyStatus{}
+
+		// aggStatus == nil, means simulate not setting status at all within the policy.
+		if test.aggStatus != nil {
+			aggPolicy.Object["status"] = PolicyStatusToUnstructured(*test.aggStatus)
+			desiredMergedStatus.Ancestors = append(desiredMergedStatus.Ancestors, test.aggStatus.Ancestors...)
+		}
+
+		// newStatus == nil, means simulate not setting status at all within the policy.
+		if test.newStatus != nil {
+			newPolicy.Object["status"] = PolicyStatusToUnstructured(*test.newStatus)
+			desiredMergedStatus.Ancestors = append(desiredMergedStatus.Ancestors, test.newStatus.Ancestors...)
+		}
+
+		MergeAncestorsForExtensionServerPolicies(&aggPolicy, &newPolicy)
+
+		// The product object will always have an existing `status`, even if with 0 ancestors.
+		newAggPolicy := ExtServerPolicyStatusAsPolicyStatus(&aggPolicy)
+		require.Len(t, newAggPolicy.Ancestors, len(desiredMergedStatus.Ancestors))
+		for i := range newAggPolicy.Ancestors {
+			require.Equal(t, desiredMergedStatus.Ancestors[i].AncestorRef.Name, newAggPolicy.Ancestors[i].AncestorRef.Name)
+		}
+	}
+}