-
Notifications
You must be signed in to change notification settings - Fork 617
added redirect tests for core redirect features #1556
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
Changes from 2 commits
d0b27d9
0ccda9d
c1c4952
be24a2a
cf34a2f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| 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 tests | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "k8s.io/apimachinery/pkg/types" | ||
|
|
||
| "sigs.k8s.io/gateway-api/conformance/utils/http" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/kubernetes" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/roundtripper" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/suite" | ||
| ) | ||
|
|
||
| func init() { | ||
| ConformanceTests = append(ConformanceTests, HTTPRouteRequestRedirect) | ||
| } | ||
|
|
||
| var HTTPRouteRequestRedirect = suite.ConformanceTest{ | ||
| ShortName: "HTTPRouteRequestRedirect", | ||
| Description: "An HTTPRoute with hostname and statusCode redirect filters", | ||
| Manifests: []string{"tests/httproute-request-redirect.yaml"}, | ||
| Test: func(t *testing.T, suite *suite.ConformanceTestSuite) { | ||
| ns := "gateway-conformance-infra" | ||
| routeNN := types.NamespacedName{Name: "request-redirect", Namespace: ns} | ||
| gwNN := types.NamespacedName{Name: "same-namespace", Namespace: ns} | ||
| gwAddr := kubernetes.GatewayAndHTTPRoutesMustBeAccepted(t, suite.Client, suite.TimeoutConfig, suite.ControllerName, kubernetes.NewGatewayRef(gwNN), routeNN) | ||
|
|
||
| testCases := []http.ExpectedResponse{{ | ||
| Request: http.Request{ | ||
| Path: "/hostname", | ||
| UnFollowRedirect: true, | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCode: 302, | ||
| }, | ||
| RedirectRequest: &roundtripper.RedirectRequest{ | ||
| Hostname: "example.org", | ||
| }, | ||
| Backend: "infra-backend-v1", | ||
| Namespace: ns, | ||
| }, { | ||
| Request: http.Request{ | ||
| Path: "/status-code-301", | ||
| UnFollowRedirect: true, | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCode: 301, | ||
| }, | ||
| Backend: "infra-backend-v1", | ||
| Namespace: ns, | ||
| }, { | ||
| Request: http.Request{ | ||
| Path: "/host-and-status", | ||
| UnFollowRedirect: true, | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCode: 301, | ||
| }, | ||
| RedirectRequest: &roundtripper.RedirectRequest{ | ||
| Hostname: "example.org", | ||
| }, | ||
| Backend: "infra-backend-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() | ||
| http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, suite.TimeoutConfig, gwAddr, tc) | ||
| }) | ||
| } | ||
| }, | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| apiVersion: gateway.networking.k8s.io/v1beta1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: request-redirect | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| parentRefs: | ||
| - name: same-namespace | ||
| rules: | ||
| - matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /hostname | ||
LiorLieberman marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| filters: | ||
| - type: RequestRedirect | ||
| requestRedirect: | ||
| hostname: example.org | ||
| backendRefs: | ||
| - name: infra-backend-v1 | ||
| port: 8080 | ||
| - matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /status-code-301 | ||
| filters: | ||
| - type: RequestRedirect | ||
| requestRedirect: | ||
| statusCode: 301 | ||
| - matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /host-and-status | ||
| filters: | ||
| - type: RequestRedirect | ||
| requestRedirect: | ||
| statusCode: 301 | ||
| hostname: example.org | ||
| backendRefs: | ||
| - name: infra-backend-v1 | ||
| port: 8080 | ||
LiorLieberman marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -37,11 +37,12 @@ type RoundTripper interface { | |||||||
|
|
||||||||
| // Request is the primary input for making a request. | ||||||||
| type Request struct { | ||||||||
| URL url.URL | ||||||||
| Host string | ||||||||
| Protocol string | ||||||||
| Method string | ||||||||
| Headers map[string][]string | ||||||||
| URL url.URL | ||||||||
| Host string | ||||||||
| Protocol string | ||||||||
| Method string | ||||||||
| Headers map[string][]string | ||||||||
| UnFollowRedirect bool | ||||||||
| } | ||||||||
|
|
||||||||
| // CapturedRequest contains request metadata captured from an echoserver | ||||||||
|
|
@@ -57,12 +58,19 @@ type CapturedRequest struct { | |||||||
| Pod string `json:"pod"` | ||||||||
| } | ||||||||
|
|
||||||||
| type RedirectRequest struct { | ||||||||
LiorLieberman marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
| Scheme string | ||||||||
| Hostname string | ||||||||
| Port string | ||||||||
| } | ||||||||
|
|
||||||||
| // CapturedResponse contains response metadata. | ||||||||
| type CapturedResponse struct { | ||||||||
| StatusCode int | ||||||||
| ContentLength int64 | ||||||||
| Protocol string | ||||||||
| Headers map[string][]string | ||||||||
| StatusCode int | ||||||||
| ContentLength int64 | ||||||||
| Protocol string | ||||||||
| Headers map[string][]string | ||||||||
| RedirectRequest *RedirectRequest | ||||||||
| } | ||||||||
|
|
||||||||
| // DefaultRoundTripper is the default implementation of a RoundTripper. It will | ||||||||
|
|
@@ -80,6 +88,12 @@ func (d *DefaultRoundTripper) CaptureRoundTrip(request Request) (*CapturedReques | |||||||
| cReq := &CapturedRequest{} | ||||||||
| client := http.DefaultClient | ||||||||
|
|
||||||||
| if request.UnFollowRedirect { | ||||||||
| client.CheckRedirect = func(req *http.Request, via []*http.Request) error { | ||||||||
| return http.ErrUseLastResponse | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| method := "GET" | ||||||||
| if request.Method != "" { | ||||||||
| method = request.Method | ||||||||
|
|
@@ -144,6 +158,18 @@ func (d *DefaultRoundTripper) CaptureRoundTrip(request Request) (*CapturedReques | |||||||
| Headers: resp.Header, | ||||||||
| } | ||||||||
|
|
||||||||
| if IsRedirect(resp.StatusCode) { | ||||||||
| redirectURL, err := resp.Location() | ||||||||
| if err != nil { | ||||||||
| return nil, nil, err | ||||||||
| } | ||||||||
| cRes.RedirectRequest = &RedirectRequest{ | ||||||||
| Scheme: redirectURL.Scheme, | ||||||||
| Hostname: redirectURL.Hostname(), | ||||||||
| Port: redirectURL.Port(), | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| return cReq, cRes, nil | ||||||||
| } | ||||||||
|
|
||||||||
|
|
@@ -153,3 +179,14 @@ func formatDump(data []byte, prefix string) string { | |||||||
| data = startLineRegex.ReplaceAllLiteral(data, []byte(prefix)) | ||||||||
| return string(data) | ||||||||
| } | ||||||||
|
|
||||||||
| func IsRedirect(statusCode int) bool { | ||||||||
LiorLieberman marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
| // Gateway allows only 301, and 302 | ||||||||
|
||||||||
| if expected.Response.StatusCode != cRes.StatusCode { | |
| return fmt.Errorf("expected status code to be %d, got %d", expected.Response.StatusCode, cRes.StatusCode) | |
| } |
I agree the roundtripper should not care about conformance, would you prefer to construct the redirect struct always? Whats the value you think it'll give us? it wont change the behavior of the above lines - we will have a failure with a wrong status code still.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should always construct the redirect struct for any 3xx status code. Although the test will still fail, it will likely provide more useful information to the person debugging the test. Instead of simply knowing the code is wrong, they'll also be able to see if the location they are redirecting to has any issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, I have added all the codes but if you prefer I will do something like this instead let me know
func IsRedirect(statusCode int) bool {
switch {
case statusCode >= 300 && statusCode < 400:
return true
}
return false
}
Uh oh!
There was an error while loading. Please reload this page.