v1alpha2 validation fix/update

apis/v1alpha2/validation/validation_test.go → apis/util/utils.go

@@ -14,18 +14,27 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package validation
+package utils
 
 import (
 	gatewayv1a2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
 )
 
-func pathMatchTypePtr(s string) *gatewayv1a2.PathMatchType {
+// PathMatchTypePtr generate path match type
+func PathMatchTypePtr(s string) *gatewayv1a2.PathMatchType {
+	if s != string(gatewayv1a2.PathMatchExact) && s != string(gatewayv1a2.PathMatchPrefix) && s != string(gatewayv1a2.PathMatchRegularExpression) &&
+		s != string(gatewayv1a2.PathMatchImplementationSpecific) {
+		return nil
+	}
 	result := gatewayv1a2.PathMatchType(s)
 	return &result
 }
 
-func portNumberPtr(p int) *gatewayv1a2.PortNumber {
+// PortNumberPtr generate port number
+func PortNumberPtr(p int) *gatewayv1a2.PortNumber {
+	if p < 1 || p > 65535 {
+		return nil
+	}
 	result := gatewayv1a2.PortNumber(p)
 	return &result
 }

apis/util/utils_test.go

@@ -0,0 +1,96 @@
+package utils
+
+import (
+	"fmt"
+	"testing"
+
+	gatewayv1a2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
+)
+
+func Test_Utils(t *testing.T) {
+
+	var exportedPort1 gatewayv1a2.PortNumber = 65535
+	var exportedPort3 gatewayv1a2.PortNumber = 1
+
+	var expectedPathMatch1 = gatewayv1a2.PathMatchExact
+	var expectedPathMatch2 = gatewayv1a2.PathMatchPrefix
+	var expectedPathMatch3 = gatewayv1a2.PathMatchRegularExpression
+	var expectedPathMatch4 = gatewayv1a2.PathMatchImplementationSpecific
+
+	table := []struct {
+		pathType     string
+		expectedPath *gatewayv1a2.PathMatchType
+		port         int
+		expectedPort *gatewayv1a2.PortNumber
+	}{
+		{
+			pathType:     "Exact",
+			expectedPath: &expectedPathMatch1,
+			port:         0,
+			expectedPort: nil,
+		},
+		{
+			pathType:     "Exact",
+			expectedPath: &expectedPathMatch1,
+			port:         65535,
+			expectedPort: &exportedPort1,
+		},
+		{
+			pathType:     "Exact",
+			expectedPath: &expectedPathMatch1,
+			port:         65536,
+			expectedPort: nil,
+		},
+		{
+			pathType:     "Prefix",
+			expectedPath: &expectedPathMatch2,
+			port:         0,
+			expectedPort: nil,
+		},
+		{
+			pathType:     "RegularExpression",
+			expectedPath: &expectedPathMatch3,
+			port:         65536,
+			expectedPort: nil,
+		},
+		{
+			pathType:     "ImplementationSpecific",
+			expectedPath: &expectedPathMatch4,
+			port:         1,
+			expectedPort: &exportedPort3,
+		},
+		{
+			pathType:     "APrefix",
+			expectedPath: nil,
+			port:         1,
+			expectedPort: &exportedPort3,
+		},
+	}
+
+	for _, entry := range table {
+		path := PathMatchTypePtr(entry.pathType)
+		if path == nil && entry.expectedPath != nil {
+			t.Error("failed in path match type pointer. not expecting nil, but get nil.")
+		}
+
+		if path != nil && entry.expectedPath == nil {
+			t.Error("failed in path match type pointer. expecting nil but get non-nil")
+		}
+
+		if path != nil && entry.expectedPath != nil && *path != *entry.expectedPath {
+			t.Error("failed in path match type pointer. go unexpected.")
+		}
+
+		port := PortNumberPtr(entry.port)
+		if port == nil && entry.expectedPort != nil {
+			t.Error("failed in port number pointer. not expected nil, but got nil.")
+		}
+		if port != nil && entry.expectedPort == nil {
+			t.Error("failed in port number port. expecting nil, but got non-nil.")
+		}
+		if port != nil && entry.expectedPort != nil && *port != *entry.expectedPort {
+			fmt.Printf("failed in port number expecting  %d got port %d", entry.expectedPort, *port)
+		}
+
+	}
+}

apis/v1alpha2/validation/httproute.go

@@ -40,7 +40,11 @@ func ValidateHTTPRoute(route *gatewayv1a2.HTTPRoute) field.ErrorList {
 // validateHTTPRouteSpec validates that required fields of spec are set according to the
 // HTTPRoute specification.
 func validateHTTPRouteSpec(spec *gatewayv1a2.HTTPRouteSpec, path *field.Path) field.ErrorList {
-	return validateHTTPRouteUniqueFilters(spec.Rules, path.Child("rules"))
+	if errList := validateHTTPRouteUniqueFilters(spec.Rules, path.Child("rules")); len(errList) > 0 {
+		return errList
+	}
+
+	return nil
 }
 
 // validateHTTPRouteUniqueFilters validates whether each core and extended filter
@@ -55,7 +59,7 @@ func validateHTTPRouteUniqueFilters(rules []gatewayv1a2.HTTPRouteRule, path *fie
 		}
 		// custom filters don't have any validation
 		for _, key := range repeatableHTTPRouteFilters {
-			counts[key] = 0
+			delete(counts, key)
 		}
 
 		for filterType, count := range counts {
@@ -64,7 +68,32 @@ func validateHTTPRouteUniqueFilters(rules []gatewayv1a2.HTTPRouteRule, path *fie
 			}
 		}
 
+		if errList := validateHttpRouteBackendRefs(rule.BackendRefs, path, i); len(errList) > 0 {
+			errs = append(errs, errList...)
+		}
 	}
 
 	return errs
 }
+
+func validateHttpRouteBackendRefs(ref []gatewayv1a2.HTTPBackendRef, path *field.Path, i int) field.ErrorList {
+	var errs field.ErrorList
+
+	for _, bkr := range ref {
+		counts := map[gatewayv1a2.HTTPRouteFilterType]int{}
+		for _, filter := range bkr.Filters {
+			counts[filter.Type]++
+		}
+
+		for _, key := range repeatableHTTPRouteFilters {
+			delete(counts, key)
+		}
+
+		for filterType, count := range counts {
+			if count > 1 {
+				errs = append(errs, field.Invalid(path.Index(i).Child("BackendRefs"), filterType, "cannot be used multiple times in the same rule"))
+			}
+		}
+	}
+	return errs
+}

apis/v1alpha2/validation/httproute_test.go

@@ -19,8 +19,10 @@ package validation
 import (
 	"testing"
 
+	"k8s.io/apimachinery/pkg/util/validation/field"
 	utilpointer "k8s.io/utils/pointer"
 
+	apiutils "sigs.k8s.io/gateway-api/apis/util"
 	gatewayv1a2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
 )
 
@@ -41,7 +43,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 							Matches: []gatewayv1a2.HTTPRouteMatch{
 								{
 									Path: &gatewayv1a2.HTTPPathMatch{
-										Type:  pathMatchTypePtr("Prefix"),
+										Type:  apiutils.PathMatchTypePtr("Prefix"),
 										Value: utilpointer.String("/"),
 									},
 								},
@@ -51,7 +53,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									BackendRef: gatewayv1a2.BackendRef{
 										BackendObjectReference: gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 										Weight: utilpointer.Int32(100),
 									},
@@ -72,7 +74,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 							Matches: []gatewayv1a2.HTTPRouteMatch{
 								{
 									Path: &gatewayv1a2.HTTPPathMatch{
-										Type:  pathMatchTypePtr("Prefix"),
+										Type:  apiutils.PathMatchTypePtr("Prefix"),
 										Value: utilpointer.String("/"),
 									},
 								},
@@ -83,7 +85,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8081),
+											Port: apiutils.PortNumberPtr(8081),
 										},
 									},
 								},
@@ -103,7 +105,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 							Matches: []gatewayv1a2.HTTPRouteMatch{
 								{
 									Path: &gatewayv1a2.HTTPPathMatch{
-										Type:  pathMatchTypePtr("Prefix"),
+										Type:  apiutils.PathMatchTypePtr("Prefix"),
 										Value: utilpointer.String("/"),
 									},
 								},
@@ -114,7 +116,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -123,7 +125,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: specialService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -143,7 +145,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 							Matches: []gatewayv1a2.HTTPRouteMatch{
 								{
 									Path: &gatewayv1a2.HTTPPathMatch{
-										Type:  pathMatchTypePtr("Prefix"),
+										Type:  apiutils.PathMatchTypePtr("Prefix"),
 										Value: utilpointer.String("/"),
 									},
 								},
@@ -165,7 +167,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -196,7 +198,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 							Matches: []gatewayv1a2.HTTPRouteMatch{
 								{
 									Path: &gatewayv1a2.HTTPPathMatch{
-										Type:  pathMatchTypePtr("Prefix"),
+										Type:  apiutils.PathMatchTypePtr("Prefix"),
 										Value: utilpointer.String("/"),
 									},
 								},
@@ -207,7 +209,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -227,7 +229,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -247,7 +249,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: specialService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -267,7 +269,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 							Matches: []gatewayv1a2.HTTPRouteMatch{
 								{
 									Path: &gatewayv1a2.HTTPPathMatch{
-										Type:  pathMatchTypePtr("Prefix"),
+										Type:  apiutils.PathMatchTypePtr("Prefix"),
 										Value: utilpointer.String("/"),
 									},
 								},
@@ -289,7 +291,7 @@ func TestValidateHTTPRoute(t *testing.T) {
 									RequestMirror: &gatewayv1a2.HTTPRequestMirrorFilter{
 										BackendRef: &gatewayv1a2.BackendObjectReference{
 											Name: testService,
-											Port: portNumberPtr(8080),
+											Port: apiutils.PortNumberPtr(8080),
 										},
 									},
 								},
@@ -312,12 +314,10 @@ func TestValidateHTTPRoute(t *testing.T) {
 	}
 	for _, tt := range tests {
 		// copy variable to avoid scope problems with ranges
-		tt := tt
-		t.Run(tt.name, func(t *testing.T) {
-			errs := ValidateHTTPRoute(&tt.hRoute)
-			if len(errs) != tt.errCount {
-				t.Errorf("ValidateHTTPRoute() got %v errors, want %v errors", len(errs), tt.errCount)
-			}
-		})
+		t.Logf("running test case [%s]", tt.name)
+		errs := validateHTTPRouteUniqueFilters(tt.hRoute.Spec.Rules, field.NewPath("spec").Child("rules"))
+		if len(errs) != tt.errCount {
+			t.Errorf("ValidateHTTPRoute() got %v errors, want %v errors", len(errs), tt.errCount)
+		}
 	}
 }