conformance test: CORS #3739
+464
−46
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,305 @@ | ||
| /* | ||
| Copyright 2025 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/suite" | ||
| "sigs.k8s.io/gateway-api/pkg/features" | ||
| ) | ||
|
|
||
| func init() { | ||
| ConformanceTests = append(ConformanceTests, HTTPRouteCORS) | ||
| } | ||
|
|
||
| var HTTPRouteCORS = suite.ConformanceTest{ | ||
| ShortName: "HTTPRouteCORS", | ||
| Description: "An HTTPRoute with CORS filter should allow CORS requests from specified origins", | ||
| Manifests: []string{"tests/httproute-cors.yaml"}, | ||
| Features: []features.FeatureName{ | ||
| features.SupportGateway, | ||
| features.SupportHTTPRoute, | ||
| features.SupportHTTPRouteCORS, | ||
| }, | ||
| Test: func(t *testing.T, suite *suite.ConformanceTestSuite) { | ||
| ns := "gateway-conformance-infra" | ||
| routeNN1 := types.NamespacedName{Name: "cors-1", Namespace: ns} | ||
| routeNN2 := types.NamespacedName{Name: "cors-2", Namespace: ns} | ||
| gwNN := types.NamespacedName{Name: "same-namespace", Namespace: ns} | ||
| gwAddr := kubernetes.GatewayAndHTTPRoutesMustBeAccepted(t, suite.Client, suite.TimeoutConfig, suite.ControllerName, kubernetes.NewGatewayRef(gwNN), routeNN1, routeNN2) | ||
| kubernetes.HTTPRouteMustHaveResolvedRefsConditionsTrue(t, suite.Client, suite.TimeoutConfig, routeNN1, gwNN) | ||
| kubernetes.HTTPRouteMustHaveResolvedRefsConditionsTrue(t, suite.Client, suite.TimeoutConfig, routeNN2, gwNN) | ||
|
|
||
| testCases := []http.ExpectedResponse{ | ||
| { | ||
| TestCaseName: "CORS preflight request from an exact matching origin should be allowed", | ||
| Request: http.Request{ | ||
| Path: "/cors-1", | ||
| Method: "OPTIONS", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://www.foo.com", | ||
| "access-control-request-method": "GET", | ||
| "access-control-request-headers": "x-header-1, x-header-2", | ||
| }, | ||
| }, | ||
| // Set the expected request properties and namespace to empty strings. | ||
| // This is a workaround to avoid the test failure. | ||
| // The response body is empty because the request is a preflight request, | ||
| // so we can't get the request properties from the echoserver. | ||
| ExpectedRequest: &http.ExpectedRequest{ | ||
| Request: http.Request{ | ||
| Host: "", | ||
| Method: "OPTIONS", | ||
| Path: "", | ||
| Headers: nil, | ||
| }, | ||
| }, | ||
| Namespace: "", | ||
| Response: http.Response{ | ||
| StatusCodes: []int{200, 204}, | ||
| HeadersWithMultipleValues: map[string][]string{ | ||
| "access-control-allow-origin": {"https://www.foo.com"}, | ||
| "access-control-allow-methods": { | ||
| "GET, OPTIONS", | ||
| "OPTIONS, GET", | ||
| }, | ||
| "access-control-allow-headers": { | ||
| "x-header-1, x-header-2", | ||
| "x-header-2, x-header-1", | ||
| }, | ||
| "access-control-expose-headers": { | ||
| "x-header-3, x-header-4", | ||
| "x-header-4, x-header-3", | ||
| }, | ||
| "access-control-max-age": {"3600"}, | ||
| "access-control-allow-credentials": {"true"}, | ||
| }, | ||
| // Ignore whitespace when comparing the response headers. This is because some | ||
| // implementations add a space after each comma, and some don't. Both are valid. | ||
| IgnoreWhitespace: true, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "CORS preflight request from a wildcard matching origin should be allowed", | ||
| Request: http.Request{ | ||
| Path: "/cors-1", | ||
| Method: "OPTIONS", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://www.bar.com", | ||
| "access-control-request-method": "GET", | ||
| "access-control-request-headers": "x-header-1, x-header-2", | ||
| }, | ||
| }, | ||
| // Set the expected request properties and namespace to empty strings. | ||
| // This is a workaround to avoid the test failure. | ||
| // The response body is empty because the request is a preflight request, | ||
| // so we can't get the request properties from the echoserver. | ||
| ExpectedRequest: &http.ExpectedRequest{ | ||
| Request: http.Request{ | ||
| Host: "", | ||
| Method: "OPTIONS", | ||
| Path: "", | ||
| Headers: nil, | ||
| }, | ||
| }, | ||
| Namespace: "", | ||
| Response: http.Response{ | ||
| StatusCode: 200, | ||
| HeadersWithMultipleValues: map[string][]string{ | ||
| "access-control-allow-origin": {"https://www.bar.com"}, | ||
| "access-control-allow-methods": { | ||
| "GET, OPTIONS", | ||
|
There was a problem hiding this comment. is the order relevant here or is it because the assertion is not able to check if the array contains an item? If this is the second, I would prefer that we have single entries here, and that we fix the http library to check if the array contains both items |
||
| "OPTIONS, GET", | ||
| }, | ||
| "access-control-allow-headers": { | ||
| "x-header-1, x-header-2", | ||
| "x-header-2, x-header-1", | ||
| }, | ||
| "access-control-expose-headers": { | ||
| "x-header-3, x-header-4", | ||
| "x-header-4, x-header-3", | ||
| }, | ||
| "access-control-max-age": {"3600"}, | ||
| "access-control-allow-credentials": {"true"}, | ||
| }, | ||
| // Ignore whitespace when comparing the response headers. This is because some | ||
| // implementations add a space after each comma, and some don't. Both are valid. | ||
| IgnoreWhitespace: true, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "CORS preflight request from a non-matching origin should not be allowed", | ||
zhaohuabing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Request: http.Request{ | ||
| Path: "/cors-1", | ||
| Method: "OPTIONS", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://foobar.com", | ||
| "access-control-request-method": "GET", | ||
| }, | ||
| }, | ||
| // Set the expected request properties and namespace to empty strings. | ||
| // This is a workaround to avoid the test failure. | ||
| // The response body is empty because the request is a preflight request, | ||
| // so we can't get the request properties from the echoserver. | ||
| ExpectedRequest: &http.ExpectedRequest{ | ||
| Request: http.Request{ | ||
| Host: "", | ||
| Method: "OPTIONS", | ||
| Path: "", | ||
| Headers: nil, | ||
| }, | ||
| }, | ||
| Namespace: "", | ||
| Response: http.Response{ | ||
| StatusCodes: []int{200, 204, 403}, | ||
| AbsentHeaders: []string{ | ||
| "access-control-allow-origin", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "Simple request from an exact matching origin should be allowed", | ||
| Namespace: ns, | ||
| Request: http.Request{ | ||
| Path: "/cors-1", | ||
| Method: "GET", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://www.foo.com", | ||
| "access-control-request-method": "GET", | ||
| "access-control-request-headers": "x-header-1, x-header-2", | ||
| }, | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCodes: []int{200, 204}, | ||
| Headers: map[string]string{ | ||
| "access-control-allow-origin": "https://www.foo.com", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "Simple request from a wildcard matching origin should be allowed", | ||
| Namespace: ns, | ||
| Request: http.Request{ | ||
| Path: "/cors-1", | ||
| Method: "GET", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://www.bar.com", | ||
| "access-control-request-method": "GET", | ||
| "access-control-request-headers": "x-header-1, x-header-2", | ||
zhaohuabing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| }, | ||
| Response: http.Response{ | ||
| StatusCodes: []int{200, 204}, | ||
| Headers: map[string]string{ | ||
| "access-control-allow-origin": "https://www.bar.com", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "Simple request from a non-matching origin should not be allowed", | ||
| Namespace: ns, | ||
| Request: http.Request{ | ||
| Path: "/cors-1", | ||
| Method: "GET", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://foobar.com", | ||
| "access-control-request-method": "GET", | ||
| }, | ||
| }, | ||
| Response: http.Response{ | ||
| AbsentHeaders: []string{ | ||
| "access-control-allow-origin", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "CORS preflight request with POST method should be allowed by allowMethods with wildcard", | ||
| Request: http.Request{ | ||
| Path: "/cors-2", | ||
| Method: "OPTIONS", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://www.foo.com", | ||
| "access-control-request-method": "POST", | ||
| }, | ||
| }, | ||
| // Set the expected request properties and namespace to empty strings. | ||
| // This is a workaround to avoid the test failure. | ||
| // The response body is empty because the request is a preflight request, | ||
| // so we can't get the request properties from the echoserver. | ||
| ExpectedRequest: &http.ExpectedRequest{ | ||
| Request: http.Request{ | ||
| Host: "", | ||
| Method: "OPTIONS", | ||
| Path: "", | ||
| Headers: nil, | ||
| }, | ||
| }, | ||
| Namespace: "", | ||
| Response: http.Response{ | ||
| StatusCodes: []int{200, 204}, | ||
| Headers: map[string]string{ | ||
| "access-control-allow-origin": "https://www.foo.com", | ||
| "access-control-allow-methods": "POST", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| TestCaseName: "CORS preflight request should not receive access-control-allow-credentials header without access-control-allow-credentials set to true", | ||
| Request: http.Request{ | ||
| Path: "/cors-2", | ||
| Method: "OPTIONS", | ||
| Headers: map[string]string{ | ||
| "Origin": "https://www.foo.com", | ||
| "access-control-request-method": "POST", | ||
| }, | ||
| }, | ||
| // Set the expected request properties and namespace to empty strings. | ||
| // This is a workaround to avoid the test failure. | ||
| // The response body is empty because the request is a preflight request, | ||
| // so we can't get the request properties from the echoserver. | ||
| ExpectedRequest: &http.ExpectedRequest{ | ||
| Request: http.Request{ | ||
| Host: "", | ||
| Method: "OPTIONS", | ||
| Path: "", | ||
| Headers: nil, | ||
| }, | ||
| }, | ||
| Namespace: "", | ||
| Response: http.Response{ | ||
| AbsentHeaders: []string{ | ||
| "access-control-allow-credentials", | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| 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) | ||
| }) | ||
| } | ||
| }, | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: cors-1 | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| parentRefs: | ||
| - name: same-namespace | ||
| rules: | ||
| - filters: | ||
| - type: CORS | ||
| cors: | ||
| allowOrigins: | ||
| - "https://www.foo.com" | ||
| - "https://*.bar.com" | ||
shaneutt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| allowMethods: | ||
| - GET | ||
| - OPTIONS | ||
| allowHeaders: | ||
| - "x-header-1" | ||
| - "x-header-2" | ||
| exposeHeaders: | ||
| - "x-header-3" | ||
| - "x-header-4" | ||
| allowCredentials: true | ||
| maxAge: 3600 | ||
| matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /cors-1 | ||
| backendRefs: | ||
| - name: infra-backend-v1 | ||
| port: 8080 | ||
| --- | ||
| apiVersion: gateway.networking.k8s.io/v1 | ||
| kind: HTTPRoute | ||
| metadata: | ||
| name: cors-2 # test CORS with allowMethods: ["*"] and without allowCredentials=true | ||
| namespace: gateway-conformance-infra | ||
| spec: | ||
| parentRefs: | ||
| - name: same-namespace | ||
| rules: | ||
| - filters: | ||
| - type: CORS | ||
| cors: | ||
| allowOrigins: | ||
| - "https://www.foo.com" | ||
| allowMethods: ["*"] | ||
| matches: | ||
| - path: | ||
| type: PathPrefix | ||
| value: /cors-2 | ||
| backendRefs: | ||
zhaohuabing marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - name: infra-backend-v1 | ||
| port: 8080 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.