[feat gw-api]handle noMatchingParent in route status

Author: shuqz

pkg/gateway/routeutils/route_attachment_helper.go

@@ -8,7 +8,7 @@ import (
 // routeAttachmentHelper is an internal utility that is responsible for providing functionality related to route filtering.
 type routeAttachmentHelper interface {
 	doesRouteAttachToGateway(gw gwv1.Gateway, route preLoadRouteDescriptor) bool
-	routeAllowsAttachmentToListener(listener gwv1.Listener, route preLoadRouteDescriptor) bool
+	routeAllowsAttachmentToListener(gw gwv1.Gateway, listener gwv1.Listener, route preLoadRouteDescriptor) (bool, []RouteData)
 }
 
 var _ routeAttachmentHelper = &routeAttachmentHelperImpl{}
@@ -56,19 +56,24 @@ func (rah *routeAttachmentHelperImpl) doesRouteAttachToGateway(gw gwv1.Gateway,
 // This function implements the Gateway API spec for route -> listener attachment.
 // This function assumes that the caller has already validated that the gateway that owns the listener allows for route
 // attachment.
-func (rah *routeAttachmentHelperImpl) routeAllowsAttachmentToListener(listener gwv1.Listener, route preLoadRouteDescriptor) bool {
+// Returns: (allowed, failedRouteDataList)
+func (rah *routeAttachmentHelperImpl) routeAllowsAttachmentToListener(gw gwv1.Gateway, listener gwv1.Listener, route preLoadRouteDescriptor) (bool, []RouteData) {
+	var failedRouteData []RouteData
 	for _, parentRef := range route.GetParentRefs() {
-
 		if parentRef.SectionName != nil && string(*parentRef.SectionName) != string(listener.Name) {
+			rd := GenerateRouteData(false, true, string(gwv1.RouteReasonNoMatchingParent), RouteStatusInfoRejectedMessageParentSectionNameNotMatch, route.GetRouteNamespacedName(), route.GetRouteKind(), route.GetRouteGeneration(), gw)
+			failedRouteData = append(failedRouteData, rd)
 			continue
 		}
 
 		if parentRef.Port != nil && *parentRef.Port != listener.Port {
+			rd := GenerateRouteData(false, true, string(gwv1.RouteReasonNoMatchingParent), RouteStatusInfoRejectedMessageParentPortNotMatch, route.GetRouteNamespacedName(), route.GetRouteKind(), route.GetRouteGeneration(), gw)
+			failedRouteData = append(failedRouteData, rd)
 			continue
 		}
 
-		return true
+		return true, failedRouteData
 	}
 
-	return false
+	return false, failedRouteData
 }

pkg/gateway/routeutils/route_attachment_helper_test.go

@@ -1,12 +1,13 @@
 package routeutils
 
 import (
+	"testing"
+
 	awssdk "github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/go-logr/logr"
 	"github.com/stretchr/testify/assert"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	gwv1 "sigs.k8s.io/gateway-api/apis/v1"
-	"testing"
 )
 
 func Test_doesRouteAttachToGateway(t *testing.T) {
@@ -231,11 +232,18 @@ func Test_doesRouteAttachToGateway(t *testing.T) {
 }
 
 func Test_routeAllowsAttachmentToListener(t *testing.T) {
+	gw := gwv1.Gateway{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "gw",
+			Namespace: "ns1",
+		},
+	}
 	testCases := []struct {
-		name     string
-		listener gwv1.Listener
-		route    preLoadRouteDescriptor
-		result   bool
+		name             string
+		listener         gwv1.Listener
+		route            preLoadRouteDescriptor
+		result           bool
+		failedRouteCount int
 	}{
 		{
 			name: "allows attachment section and port correct",
@@ -325,7 +333,8 @@ func Test_routeAllowsAttachmentToListener(t *testing.T) {
 				Name: "sectionname",
 				Port: 80,
 			},
-			result: true,
+			result:           true,
+			failedRouteCount: 3,
 		},
 		{
 			name: "multiple parent refs one ref none attachment",
@@ -357,6 +366,45 @@ func Test_routeAllowsAttachmentToListener(t *testing.T) {
 				Name: "sectionname",
 				Port: 80,
 			},
+			failedRouteCount: 4,
+		},
+		{
+			name: "section name mismatch",
+			route: convertHTTPRoute(gwv1.HTTPRoute{
+				Spec: gwv1.HTTPRouteSpec{
+					CommonRouteSpec: gwv1.CommonRouteSpec{
+						ParentRefs: []gwv1.ParentReference{
+							{
+								SectionName: (*gwv1.SectionName)(awssdk.String("wrongsection")),
+							},
+						},
+					},
+				},
+			}),
+			listener: gwv1.Listener{
+				Name: "sectionname",
+				Port: 80,
+			},
+			failedRouteCount: 1,
+		},
+		{
+			name: "port mismatch",
+			route: convertHTTPRoute(gwv1.HTTPRoute{
+				Spec: gwv1.HTTPRouteSpec{
+					CommonRouteSpec: gwv1.CommonRouteSpec{
+						ParentRefs: []gwv1.ParentReference{
+							{
+								Port: (*gwv1.PortNumber)(awssdk.Int32(443)),
+							},
+						},
+					},
+				},
+			}),
+			listener: gwv1.Listener{
+				Name: "sectionname",
+				Port: 80,
+			},
+			failedRouteCount: 1,
 		},
 	}
 
@@ -365,7 +413,9 @@ func Test_routeAllowsAttachmentToListener(t *testing.T) {
 			helper := &routeAttachmentHelperImpl{
 				logger: logr.Discard(),
 			}
-			assert.Equal(t, tc.result, helper.routeAllowsAttachmentToListener(tc.listener, tc.route))
+			allowed, failedRouteData := helper.routeAllowsAttachmentToListener(gw, tc.listener, tc.route)
+			assert.Equal(t, tc.result, allowed)
+			assert.Equal(t, tc.failedRouteCount, len(failedRouteData))
 		})
 	}
 }

pkg/gateway/routeutils/route_listener_mapper.go

@@ -59,7 +59,10 @@ func (ltr *listenerToRouteMapperImpl) mapGatewayAndRoutes(ctx context.Context, g
 		for _, route := range routesForGateway {
 			// We need to check both paths (route -> listener) and (listener -> route)
 			// for connection viability.
-			if !ltr.routeAttachmentHelper.routeAllowsAttachmentToListener(listener, route) {
+			allowed, failedRouteDataList := ltr.routeAttachmentHelper.routeAllowsAttachmentToListener(gw, listener, route)
+			// Collect any failed parentRefs no matter route is allowed to attach
+			failedRoutes = append(failedRoutes, failedRouteDataList...)
+			if !allowed {
 				ltr.logger.V(1).Info("Route doesnt allow attachment")
 				continue
 			}

pkg/gateway/routeutils/route_listener_mapper_test.go

@@ -41,9 +41,9 @@ func (m *mockRouteAttachmentHelper) doesRouteAttachToGateway(gw gwv1.Gateway, ro
 	return m.routeGatewayMap[k]
 }
 
-func (m *mockRouteAttachmentHelper) routeAllowsAttachmentToListener(listener gwv1.Listener, route preLoadRouteDescriptor) bool {
+func (m *mockRouteAttachmentHelper) routeAllowsAttachmentToListener(gw gwv1.Gateway, listener gwv1.Listener, route preLoadRouteDescriptor) (bool, []RouteData) {
 	k := makeListenerAttachmentMapKey(listener, route)
-	return m.routeListenerMap[k]
+	return m.routeListenerMap[k], nil
 }
 
 func Test_mapGatewayAndRoutes(t *testing.T) {

pkg/gateway/routeutils/route_reconciler_utils.go

@@ -48,11 +48,13 @@ type RouteReconcilerSubmitter interface {
 // constants
 
 const (
-	RouteStatusInfoAcceptedMessage                   = "Route is accepted by Gateway"
-	RouteStatusInfoRejectedMessageNoMatchingHostname = "Listener does not allow route attachment, no matching hostname"
-	RouteStatusInfoRejectedMessageNamespaceNotMatch  = "Listener does not allow route attachment, namespace does not match between listener and route"
-	RouteStatusInfoRejectedMessageKindNotMatch       = "Listener does not allow route attachment, kind does not match between listener and route"
-	RouteStatusInfoRejectedParentRefNotExist         = "ParentRefDoesNotExist"
+	RouteStatusInfoAcceptedMessage                          = "Route is accepted by Gateway"
+	RouteStatusInfoRejectedMessageNoMatchingHostname        = "Listener does not allow route attachment, no matching hostname"
+	RouteStatusInfoRejectedMessageNamespaceNotMatch         = "Listener does not allow route attachment, namespace does not match between listener and route"
+	RouteStatusInfoRejectedMessageKindNotMatch              = "Listener does not allow route attachment, kind does not match between listener and route"
+	RouteStatusInfoRejectedParentRefNotExist                = "ParentRefDoesNotExist"
+	RouteStatusInfoRejectedMessageParentSectionNameNotMatch = "Route parentRef sectionName does not match listener name"
+	RouteStatusInfoRejectedMessageParentPortNotMatch        = "Route parentRef port does not match listener port"
 )
 
 func GenerateRouteData(accepted bool, resolvedRefs bool, reason string, message string, routeNamespaceName types.NamespacedName, routeKind RouteKind, routeGeneration int64, gw gwv1.Gateway) RouteData {