httproute: use lists insteads of maps for HTTPRequestHeaderFilter

kubernetes-sigs · May 25, 2021 · 210b8b5 · 210b8b5
1 parent 53e7802
commit 210b8b5
Show file tree

Hide file tree

Showing 4 changed files with 158 additions and 27 deletions.
diff --git a/apis/v1alpha2/httproute_types.go b/apis/v1alpha2/httproute_types.go
@@ -530,6 +530,23 @@ const (
 	HTTPRouteFilterExtensionRef HTTPRouteFilterType = "ExtensionRef"
 )
 
+// HTTPHeader represents an HTTP Header name and value as defined by RFC 7230.
+type HTTPHeader struct {
+	// Name is the name of the HTTP query param to be matched. This must be an
+	// exact string match. (See
+	// https://tools.ietf.org/html/rfc7230#section-2.7.3).
+	//
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=256
+	Name string `json:"name"`
+
+	// Value is the value of HTTP query param to be matched.
+	//
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=1024
+	Value string `json:"value"`
+}
+
 // HTTPRequestHeaderFilter defines configuration for the RequestHeaderModifier
 // filter.
 type HTTPRequestHeaderFilter struct {
@@ -550,7 +567,7 @@ type HTTPRequestHeaderFilter struct {
 	// Support: Extended
 	//
 	// +optional
-	Set map[string]string `json:"set,omitempty"`
+	Set []HTTPHeader `json:"set,omitempty"`
 
 	// Add adds the given header (name, value) to the request
 	// before the action. It appends to any existing values associated
@@ -571,7 +588,7 @@ type HTTPRequestHeaderFilter struct {
 	// Support: Extended
 	//
 	// +optional
-	Add map[string]string `json:"add,omitempty"`
+	Add []HTTPHeader `json:"add,omitempty"`
 
 	// Remove the given header(s) from the HTTP request before the
 	// action. The value of RemoveHeader is a list of HTTP header

diff --git a/apis/v1alpha2/validation/httproute_test.go b/apis/v1alpha2/validation/httproute_test.go
@@ -142,7 +142,12 @@ func TestValidateHTTPRoute(t *testing.T) {
 								{
 									Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
 									RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
-										Set: map[string]string{"special-header": "foo"},
+										Set: []gatewayv1a2.HTTPHeader{
+											{
+												Name:  "special-header",
+												Value: "foo",
+											},
+										},
 									},
 								},
 								{
@@ -155,7 +160,12 @@ func TestValidateHTTPRoute(t *testing.T) {
 								{
 									Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
 									RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
-										Add: map[string]string{"my-header": "bar"},
+										Add: []gatewayv1a2.HTTPHeader{
+											{
+												Name:  "my-header",
+												Value: "bar",
+											},
+										},
 									},
 								},
 							},
@@ -190,7 +200,12 @@ func TestValidateHTTPRoute(t *testing.T) {
 								{
 									Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
 									RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
-										Set: map[string]string{"special-header": "foo"},
+										Set: []gatewayv1a2.HTTPHeader{
+											{
+												Name:  "special-header",
+												Value: "foo",
+											},
+										},
 									},
 								},
 								{
@@ -203,7 +218,12 @@ func TestValidateHTTPRoute(t *testing.T) {
 								{
 									Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
 									RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
-										Add: map[string]string{"my-header": "bar"},
+										Add: []gatewayv1a2.HTTPHeader{
+											{
+												Name:  "my-header",
+												Value: "bar",
+											},
+										},
 									},
 								},
 								{
@@ -238,7 +258,12 @@ func TestValidateHTTPRoute(t *testing.T) {
 								{
 									Type: gatewayv1a2.HTTPRouteFilterRequestHeaderModifier,
 									RequestHeaderModifier: &gatewayv1a2.HTTPRequestHeaderFilter{
-										Set: map[string]string{"special-header": "foo"},
+										Set: []gatewayv1a2.HTTPHeader{
+											{
+												Name:  "special-header",
+												Value: "foo",
+											},
+										},
 									},
 								},
 								{

diff --git a/apis/v1alpha2/zz_generated.deepcopy.go b/apis/v1alpha2/zz_generated.deepcopy.go
diff --git a/config/crd/bases/networking.x-k8s.io_httproutes.yaml b/config/crd/bases/networking.x-k8s.io_httproutes.yaml