Skip to content

add mesh conformance for request header modifier #3812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
name: mesh-request-header-modifier
namespace: gateway-conformance-mesh
spec:
parentRefs:
- group: ""
kind: Service
name: echo
port: 80
rules:
- matches:
- path:
type: PathPrefix
value: /set
backendRefs:
- name: echo-v1
port: 8080
filters:
- type: RequestHeaderModifier
requestHeaderModifier:
set:
- name: X-Header-Set
value: set-overwrites-values
- matches:
- path:
type: PathPrefix
value: /add
backendRefs:
- name: echo-v1
port: 8080
filters:
- type: RequestHeaderModifier
requestHeaderModifier:
add:
- name: X-Header-Add
value: add-appends-values
- matches:
- path:
type: PathPrefix
value: /remove
backendRefs:
- name: echo-v1
port: 8080
filters:
- type: RequestHeaderModifier
requestHeaderModifier:
remove:
- X-Header-Remove
- matches:
- path:
type: PathPrefix
value: /multiple
backendRefs:
- name: echo-v1
port: 8080
filters:
- type: RequestHeaderModifier
requestHeaderModifier:
set:
- name: X-Header-Set-1
value: header-set-1
- name: X-Header-Set-2
value: header-set-2
add:
- name: X-Header-Add-1
value: header-add-1
- name: X-Header-Add-2
value: header-add-2
- name: X-Header-Add-3
value: header-add-3
remove:
- X-Header-Remove-1
- X-Header-Remove-2
- matches:
- path:
type: PathPrefix
value: /case-insensitivity
backendRefs:
- name: echo-v1
port: 8080
filters:
- type: RequestHeaderModifier
requestHeaderModifier:
set:
- name: X-Header-Set
value: header-set
add:
- name: X-Header-Add
value: header-add
remove:
- X-Header-Remove
213 changes: 213 additions & 0 deletions conformance/tests/mesh/httproute-request-header-modifier.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
/*
Copyright 2022 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package meshtests

import (
"testing"

"sigs.k8s.io/gateway-api/conformance/utils/echo"
"sigs.k8s.io/gateway-api/conformance/utils/http"
"sigs.k8s.io/gateway-api/conformance/utils/suite"
"sigs.k8s.io/gateway-api/pkg/features"
)

func init() {
MeshConformanceTests = append(MeshConformanceTests,
MeshHHTTPRouteRequestHeaderModifier,
MeshHHTTPRouteBackendRequestHeaderModifier,
)
}

var MeshHHTTPRouteBackendRequestHeaderModifier = suite.ConformanceTest{
ShortName: "MeshHHTTPRouteBackendRequestHeaderModifier",
Description: "An HTTPRoute backend has request header modifier filters applied correctly",
Features: []features.FeatureName{
features.SupportMesh,
features.SupportHTTPRoute,
features.SupportMeshHTTPRouteBackendRequestHeaderModification,
},
Manifests: []string{"tests/mesh/httproute-request-header-modifier-backend.yaml"},
Test: MeshHHTTPRouteRequestHeaderModifier.Test,
}

var MeshHHTTPRouteRequestHeaderModifier = suite.ConformanceTest{
ShortName: "MeshHHTTPRouteRequestHeaderModifier",
Description: "An HTTPRoute has request header modifier filters applied correctly",
Features: []features.FeatureName{
features.SupportMesh,
features.SupportHTTPRoute,
},
Manifests: []string{"tests/mesh/httproute-request-header-modifier.yaml"},
Test: func(t *testing.T, s *suite.ConformanceTestSuite) {
ns := "gateway-conformance-mesh"
client := echo.ConnectToApp(t, s, echo.MeshAppEchoV1)

testCases := []http.ExpectedResponse{
{
Request: http.Request{
Path: "/set",
Headers: map[string]string{
"Some-Other-Header": "val",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/set",
Headers: map[string]string{
"Some-Other-Header": "val",
"X-Header-Set": "set-overwrites-values",
},
},
},
Backend: "echo-v1",
Namespace: ns,
}, {
Request: http.Request{
Path: "/set",
Headers: map[string]string{
"Some-Other-Header": "val",
"X-Header-Set": "some-other-value",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/set",
Headers: map[string]string{
"Some-Other-Header": "val",
"X-Header-Set": "set-overwrites-values",
},
},
},
Backend: "echo-v1",
Namespace: ns,
}, {
Request: http.Request{
Path: "/add",
Headers: map[string]string{
"Some-Other-Header": "val",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/add",
Headers: map[string]string{
"Some-Other-Header": "val",
"X-Header-Add": "add-appends-values",
},
},
},
Backend: "echo-v1",
Namespace: ns,
}, {
Request: http.Request{
Path: "/add",
Headers: map[string]string{
"Some-Other-Header": "val",
"X-Header-Add": "some-other-value",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/add",
Headers: map[string]string{
"Some-Other-Header": "val",
"X-Header-Add": "some-other-value,add-appends-values",
},
},
},
Backend: "echo-v1",
Namespace: ns,
}, {
Request: http.Request{
Path: "/remove",
Headers: map[string]string{
"X-Header-Remove": "val",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/remove",
},
AbsentHeaders: []string{"X-Header-Remove"},
},
Backend: "echo-v1",
Namespace: ns,
}, {
Request: http.Request{
Path: "/multiple",
Headers: map[string]string{
"X-Header-Set-2": "set-val-2",
"X-Header-Add-2": "add-val-2",
"X-Header-Remove-2": "remove-val-2",
"Another-Header": "another-header-val",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/multiple",
Headers: map[string]string{
"X-Header-Set-1": "header-set-1",
"X-Header-Set-2": "header-set-2",
"X-Header-Add-1": "header-add-1",
"X-Header-Add-2": "add-val-2,header-add-2",
"X-Header-Add-3": "header-add-3",
"Another-Header": "another-header-val",
},
},
AbsentHeaders: []string{"X-Header-Remove-1", "X-Header-Remove-2"},
},
Backend: "echo-v1",
Namespace: ns,
}, {
Request: http.Request{
Path: "/case-insensitivity",
// The filter uses canonicalized header names,
// the request uses lowercase names.
Headers: map[string]string{
"x-header-set": "original-val-set",
"x-header-add": "original-val-add",
"x-header-remove": "original-val-remove",
"Another-Header": "another-header-val",
},
},
ExpectedRequest: &http.ExpectedRequest{
Request: http.Request{
Path: "/case-insensitivity",
Headers: map[string]string{
"X-Header-Set": "header-set",
"X-Header-Add": "original-val-add,header-add",
"Another-Header": "another-header-val",
},
},
AbsentHeaders: []string{"x-header-remove", "X-Header-Remove"},
},
Backend: "echo-v1",
Namespace: ns,
},
}

for i := range testCases {
// Declare tc here to avoid loop variable
// reuse issues across parallel tests.
tc := testCases[i]
t.Run(tc.GetTestCaseName(i), func(t *testing.T) {
t.Parallel()
client.MakeRequestAndExpectEventuallyConsistentResponse(t, tc, s.TimeoutConfig)
})
}
},
}
Loading