generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 480
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Conformance tests for static Gateway addresses (#2412)
* docs: add specificity to GatewayStatusAddress docs Signed-off-by: Shane Utt <[email protected]> * docs: add specificity to address list in gw status Signed-off-by: Shane Utt <[email protected]> * docs: update GatewayReasonAddressNotAssigned to be about dynamic assignment Signed-off-by: Shane Utt <[email protected]> * docs: make GatewayReasonUnsupportedAddress only about supporting the address type Signed-off-by: Shane Utt <[email protected]> * feat: add GatewayReasonAddressNotUsable to indicate problems with static gw addrs Signed-off-by: Shane Utt <[email protected]> * feat: add test suite support for providing gw addr pools Signed-off-by: Shane Utt <[email protected]> * tests: add SupportGatewayStaticAddresses feature for conformance test suite Signed-off-by: Shane Utt <[email protected]> * tests: add conformance test for static gw addresses Signed-off-by: Shane Utt <[email protected]> * fix: skip some gws in suite setup * fix: prefer different net addr order in apply * chore: run codegen * docs: update CHANGELOG.md for gw addr changes Signed-off-by: Shane Utt <[email protected]> --------- Signed-off-by: Shane Utt <[email protected]>
- Loading branch information
Showing
12 changed files
with
500 additions
and
64 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
28 changes: 16 additions & 12 deletions
28
config/crd/experimental/gateway.networking.k8s.io_gateways.yaml
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
28 changes: 16 additions & 12 deletions
28
config/crd/standard/gateway.networking.k8s.io_gateways.yaml
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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,177 @@ | ||
| /* | ||
| Copyright 2023 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 ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| "sigs.k8s.io/gateway-api/apis/v1beta1" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/kubernetes" | ||
| "sigs.k8s.io/gateway-api/conformance/utils/suite" | ||
| ) | ||
|
|
||
| func init() { | ||
| ConformanceTests = append(ConformanceTests, GatewayStaticAddresses) | ||
| } | ||
|
|
||
| // GatewayStaticAddresses tests the implementation's support of deploying | ||
| // Gateway resources with static addresses, or in other words addresses | ||
| // provided via the specification rather than relying on the underlying | ||
| // implementation/network to dynamically assign the Gateway an address. | ||
| // | ||
| // Running this test against your own implementation is currently a little bit | ||
| // messy, as at the time of writing we didn't have great ways to provide the | ||
| // test suite with things like known good, or known bad addresses to run the | ||
| // test with (as we obviously can't determine that for the implementation). | ||
| // | ||
| // As such, if you're trying to enable this test for yourself and you're getting | ||
| // confused about how to provide addresses, you'll actually do that in the | ||
| // conformance test suite BEFORE you even set up and run your tests. Make sure | ||
| // you populate the following test suite fields: | ||
| // | ||
| // - suite.UsableNetworkAddresses | ||
| // - suite.UnusableNetworkAddresses | ||
| // | ||
| // With appropriate network addresses for your network environment. | ||
| var GatewayStaticAddresses = suite.ConformanceTest{ | ||
| ShortName: "GatewayStaticAddresses", | ||
| Description: "A Gateway in the gateway-conformance-infra namespace should be able to use previously determined addresses.", | ||
| Features: []suite.SupportedFeature{ | ||
| suite.SupportGateway, | ||
| suite.SupportGatewayStaticAddresses, | ||
| }, | ||
| Manifests: []string{ | ||
| "tests/gateway-static-addresses.yaml", | ||
| }, | ||
| Test: func(t *testing.T, s *suite.ConformanceTestSuite) { | ||
| gwNN := types.NamespacedName{ | ||
| Name: "gateway-static-addresses", | ||
| Namespace: "gateway-conformance-infra", | ||
| } | ||
| ctx, cancel := context.WithTimeout(context.Background(), time.Minute) | ||
| defer cancel() | ||
|
|
||
| t.Logf("waiting for namespace %s and Gateway %s to be ready for testing", gwNN.Namespace, gwNN.Name) | ||
| kubernetes.GatewayMustHaveLatestConditions(t, s.Client, s.TimeoutConfig, gwNN) | ||
|
|
||
| t.Logf("retrieving Gateway %s/%s and noting the provided addresses", gwNN.Namespace, gwNN.Name) | ||
| currentGW := &v1beta1.Gateway{} | ||
| err := s.Client.Get(ctx, gwNN, currentGW) | ||
| require.NoError(t, err, "error getting Gateway: %v", err) | ||
| require.Len(t, currentGW.Spec.Addresses, 3, "expected 3 addresses on the Gateway, one invalid, one usable and one unusable. somehow got %d", len(currentGW.Spec.Addresses)) | ||
| invalidAddress := currentGW.Spec.Addresses[0] | ||
| unusableAddress := currentGW.Spec.Addresses[1] | ||
| usableAddress := currentGW.Spec.Addresses[2] | ||
|
|
||
| t.Logf("verifying that the Gateway %s/%s is NOT accepted due to an address type that the implementation doesn't support", gwNN.Namespace, gwNN.Name) | ||
| kubernetes.GatewayMustHaveCondition(t, s.Client, s.TimeoutConfig, gwNN, metav1.Condition{ | ||
| Type: string(v1beta1.GatewayConditionAccepted), | ||
| Status: metav1.ConditionFalse, | ||
| Reason: string(v1beta1.GatewayReasonUnsupportedAddress), | ||
| }) | ||
|
|
||
| t.Logf("patching Gateway %s/%s to remove the invalid address %s", gwNN.Namespace, gwNN.Name, invalidAddress.Value) | ||
| updatedGW := currentGW.DeepCopy() | ||
| updatedGW.Spec.Addresses = filterAddr(currentGW.Spec.Addresses, invalidAddress) | ||
| err = s.Client.Patch(ctx, updatedGW, client.MergeFrom(currentGW)) | ||
| require.NoError(t, err, "failed to patch Gateway: %v", err) | ||
| kubernetes.GatewayMustHaveLatestConditions(t, s.Client, s.TimeoutConfig, gwNN) | ||
|
|
||
| t.Logf("verifying that the Gateway %s/%s is now accepted, but is not programmed due to an address that can't be used", gwNN.Namespace, gwNN.Name) | ||
| err = s.Client.Get(ctx, gwNN, currentGW) | ||
| require.NoError(t, err, "error getting Gateway: %v", err) | ||
| kubernetes.GatewayMustHaveCondition(t, s.Client, s.TimeoutConfig, gwNN, metav1.Condition{ | ||
| Type: string(v1beta1.GatewayConditionAccepted), | ||
| Status: metav1.ConditionTrue, | ||
| Reason: string(v1beta1.GatewayReasonAccepted), | ||
| }) | ||
| kubernetes.GatewayMustHaveCondition(t, s.Client, s.TimeoutConfig, gwNN, metav1.Condition{ | ||
| Type: string(v1beta1.GatewayConditionProgrammed), | ||
| Status: metav1.ConditionFalse, | ||
| Reason: string(v1beta1.GatewayReasonAddressNotUsable), | ||
| }) | ||
|
|
||
| t.Logf("patching Gateway %s/%s to remove the unusable address %s", gwNN.Namespace, gwNN.Name, unusableAddress.Value) | ||
| updatedGW = currentGW.DeepCopy() | ||
| updatedGW.Spec.Addresses = filterAddr(currentGW.Spec.Addresses, unusableAddress) | ||
| err = s.Client.Patch(ctx, updatedGW, client.MergeFrom(currentGW)) | ||
| require.NoError(t, err, "failed to patch Gateway: %v", err) | ||
| kubernetes.GatewayMustHaveLatestConditions(t, s.Client, s.TimeoutConfig, gwNN) | ||
|
|
||
| t.Logf("verifying that the Gateway %s/%s is accepted and programmed with the usable static address %s assigned", gwNN.Namespace, gwNN.Name, usableAddress.Value) | ||
| err = s.Client.Get(ctx, gwNN, currentGW) | ||
| require.NoError(t, err, "error getting Gateway: %v", err) | ||
| kubernetes.GatewayMustHaveCondition(t, s.Client, s.TimeoutConfig, gwNN, metav1.Condition{ | ||
| Type: string(v1beta1.GatewayConditionAccepted), | ||
| Status: metav1.ConditionTrue, | ||
| Reason: string(v1beta1.GatewayReasonAccepted), | ||
| }) | ||
| kubernetes.GatewayMustHaveCondition(t, s.Client, s.TimeoutConfig, gwNN, metav1.Condition{ | ||
| Type: string(v1beta1.GatewayConditionProgrammed), | ||
| Status: metav1.ConditionTrue, | ||
| Reason: string(v1beta1.GatewayReasonProgrammed), | ||
| }) | ||
| kubernetes.GatewayStatusMustHaveListeners(t, s.Client, s.TimeoutConfig, gwNN, finalExpectedListenerState) | ||
| require.Len(t, currentGW.Spec.Addresses, 1, "expected only 1 address left specified on Gateway") | ||
| require.Len(t, currentGW.Status.Addresses, 1, "one usable address was provided, so it should be the one reflected in status") | ||
| require.Equal(t, usableAddress.Type, currentGW.Status.Addresses[0].Type, "expected address type to match the usable address") | ||
| require.Equal(t, usableAddress.Value, currentGW.Status.Addresses[0].Value, "expected usable address to be assigned") | ||
| }, | ||
| } | ||
|
|
||
| // ----------------------------------------------------------------------------- | ||
| // Private Helper Functions | ||
| // ----------------------------------------------------------------------------- | ||
|
|
||
| func filterAddr(addrs []v1beta1.GatewayAddress, filter v1beta1.GatewayAddress) (newAddrs []v1beta1.GatewayAddress) { | ||
| for _, addr := range addrs { | ||
| if addr.Value != filter.Value { | ||
| newAddrs = append(newAddrs, addr) | ||
| } | ||
| } | ||
| return | ||
| } | ||
|
|
||
| var finalExpectedListenerState = []v1beta1.ListenerStatus{ | ||
| { | ||
| Name: v1beta1.SectionName("http"), | ||
| SupportedKinds: []v1beta1.RouteGroupKind{{ | ||
| Group: (*v1beta1.Group)(&v1beta1.GroupVersion.Group), | ||
| Kind: v1beta1.Kind("HTTPRoute"), | ||
| }}, | ||
| Conditions: []metav1.Condition{ | ||
| { | ||
| Type: string(v1beta1.ListenerConditionAccepted), | ||
| Status: metav1.ConditionTrue, | ||
| Reason: "", // any reason | ||
| }, | ||
| { | ||
| Type: string(v1beta1.ListenerConditionResolvedRefs), | ||
| Status: metav1.ConditionTrue, | ||
| Reason: "", // any reason | ||
| }, | ||
| }, | ||
| AttachedRoutes: 0, | ||
| }, | ||
| } |
Oops, something went wrong.