feat: add supported features to gateway class (envoyproxy#2491)

* feat: add supported features to gateway class Signed-off-by: Kobi Levi <kobilevi503@gmail.com> * remove skipped test features from supported features list Signed-off-by: Kobi Levi <kobilevi503@gmail.com> --------- Signed-off-by: Kobi Levi <kobilevi503@gmail.com>
guydc · May 15, 2024 · 02e9367 · 02e9367
1 parent a2fbbad
commit 02e9367
Show file tree

Hide file tree

Showing 13 changed files with 272 additions and 16 deletions.
diff --git a/internal/cmd/egctl/testdata/translate/out/default-resources.all.yaml b/internal/cmd/egctl/testdata/translate/out/default-resources.all.yaml
@@ -158,6 +158,27 @@ gatewayClass:
       reason: Accepted
       status: "True"
       type: Accepted
+    supportedFeatures:
+    - GRPCRoute
+    - GatewayPort8080
+    - HTTPRouteBackendProtocolH2C
+    - HTTPRouteBackendProtocolWebSocket
+    - HTTPRouteBackendTimeout
+    - HTTPRouteDestinationPortMatching
+    - HTTPRouteHostRewrite
+    - HTTPRouteMethodMatching
+    - HTTPRouteParentRefPort
+    - HTTPRoutePathRedirect
+    - HTTPRoutePathRewrite
+    - HTTPRoutePortRedirect
+    - HTTPRouteQueryParamMatching
+    - HTTPRouteRequestMirror
+    - HTTPRouteRequestMultipleMirrors
+    - HTTPRouteRequestTimeout
+    - HTTPRouteResponseHeaderModification
+    - HTTPRouteSchemeRedirect
+    - ReferenceGrant
+    - TLSRoute
 gateways:
 - metadata:
     creationTimestamp: null

diff --git a/internal/cmd/egctl/testdata/translate/out/echo-gateway-api.cluster.yaml b/internal/cmd/egctl/testdata/translate/out/echo-gateway-api.cluster.yaml
@@ -12,6 +12,27 @@ gatewayClass:
       reason: Accepted
       status: "True"
       type: Accepted
+    supportedFeatures:
+    - GRPCRoute
+    - GatewayPort8080
+    - HTTPRouteBackendProtocolH2C
+    - HTTPRouteBackendProtocolWebSocket
+    - HTTPRouteBackendTimeout
+    - HTTPRouteDestinationPortMatching
+    - HTTPRouteHostRewrite
+    - HTTPRouteMethodMatching
+    - HTTPRouteParentRefPort
+    - HTTPRoutePathRedirect
+    - HTTPRoutePathRewrite
+    - HTTPRoutePortRedirect
+    - HTTPRouteQueryParamMatching
+    - HTTPRouteRequestMirror
+    - HTTPRouteRequestMultipleMirrors
+    - HTTPRouteRequestTimeout
+    - HTTPRouteResponseHeaderModification
+    - HTTPRouteSchemeRedirect
+    - ReferenceGrant
+    - TLSRoute
 gateways:
 - metadata:
     creationTimestamp: null

diff --git a/internal/cmd/egctl/testdata/translate/out/echo-gateway-api.route.json b/internal/cmd/egctl/testdata/translate/out/echo-gateway-api.route.json
@@ -17,6 +17,28 @@
           "reason": "Accepted",
           "message": "Valid GatewayClass"
         }
+      ],
+      "supportedFeatures": [
+        "GRPCRoute",
+        "GatewayPort8080",
+        "HTTPRouteBackendProtocolH2C",
+        "HTTPRouteBackendProtocolWebSocket",
+        "HTTPRouteBackendTimeout",
+        "HTTPRouteDestinationPortMatching",
+        "HTTPRouteHostRewrite",
+        "HTTPRouteMethodMatching",
+        "HTTPRouteParentRefPort",
+        "HTTPRoutePathRedirect",
+        "HTTPRoutePathRewrite",
+        "HTTPRoutePortRedirect",
+        "HTTPRouteQueryParamMatching",
+        "HTTPRouteRequestMirror",
+        "HTTPRouteRequestMultipleMirrors",
+        "HTTPRouteRequestTimeout",
+        "HTTPRouteResponseHeaderModification",
+        "HTTPRouteSchemeRedirect",
+        "ReferenceGrant",
+        "TLSRoute"
       ]
     }
   },

diff --git a/internal/cmd/egctl/testdata/translate/out/invalid-envoyproxy.all.yaml b/internal/cmd/egctl/testdata/translate/out/invalid-envoyproxy.all.yaml
@@ -38,6 +38,27 @@ gatewayClass:
       reason: InvalidParameters
       status: "False"
       type: Accepted
+    supportedFeatures:
+    - GRPCRoute
+    - GatewayPort8080
+    - HTTPRouteBackendProtocolH2C
+    - HTTPRouteBackendProtocolWebSocket
+    - HTTPRouteBackendTimeout
+    - HTTPRouteDestinationPortMatching
+    - HTTPRouteHostRewrite
+    - HTTPRouteMethodMatching
+    - HTTPRouteParentRefPort
+    - HTTPRoutePathRedirect
+    - HTTPRoutePathRewrite
+    - HTTPRoutePortRedirect
+    - HTTPRouteQueryParamMatching
+    - HTTPRouteRequestMirror
+    - HTTPRouteRequestMultipleMirrors
+    - HTTPRouteRequestTimeout
+    - HTTPRouteResponseHeaderModification
+    - HTTPRouteSchemeRedirect
+    - ReferenceGrant
+    - TLSRoute
 gateways:
 - metadata:
     creationTimestamp: null

diff --git a/internal/cmd/egctl/testdata/translate/out/rejected-http-route.route.yaml b/internal/cmd/egctl/testdata/translate/out/rejected-http-route.route.yaml
@@ -12,6 +12,27 @@ gatewayClass:
       reason: Accepted
       status: "True"
       type: Accepted
+    supportedFeatures:
+    - GRPCRoute
+    - GatewayPort8080
+    - HTTPRouteBackendProtocolH2C
+    - HTTPRouteBackendProtocolWebSocket
+    - HTTPRouteBackendTimeout
+    - HTTPRouteDestinationPortMatching
+    - HTTPRouteHostRewrite
+    - HTTPRouteMethodMatching
+    - HTTPRouteParentRefPort
+    - HTTPRoutePathRedirect
+    - HTTPRoutePathRewrite
+    - HTTPRoutePortRedirect
+    - HTTPRouteQueryParamMatching
+    - HTTPRouteRequestMirror
+    - HTTPRouteRequestMultipleMirrors
+    - HTTPRouteRequestTimeout
+    - HTTPRouteResponseHeaderModification
+    - HTTPRouteSchemeRedirect
+    - ReferenceGrant
+    - TLSRoute
 gateways:
 - metadata:
     creationTimestamp: null

diff --git a/internal/cmd/egctl/testdata/translate/out/valid-envoyproxy.all.yaml b/internal/cmd/egctl/testdata/translate/out/valid-envoyproxy.all.yaml
@@ -31,6 +31,27 @@ gatewayClass:
       reason: Accepted
       status: "True"
       type: Accepted
+    supportedFeatures:
+    - GRPCRoute
+    - GatewayPort8080
+    - HTTPRouteBackendProtocolH2C
+    - HTTPRouteBackendProtocolWebSocket
+    - HTTPRouteBackendTimeout
+    - HTTPRouteDestinationPortMatching
+    - HTTPRouteHostRewrite
+    - HTTPRouteMethodMatching
+    - HTTPRouteParentRefPort
+    - HTTPRoutePathRedirect
+    - HTTPRoutePathRewrite
+    - HTTPRoutePortRedirect
+    - HTTPRouteQueryParamMatching
+    - HTTPRouteRequestMirror
+    - HTTPRouteRequestMultipleMirrors
+    - HTTPRouteRequestTimeout
+    - HTTPRouteResponseHeaderModification
+    - HTTPRouteSchemeRedirect
+    - ReferenceGrant
+    - TLSRoute
 gateways:
 - metadata:
     creationTimestamp: null

diff --git a/internal/cmd/egctl/translate_test.go b/internal/cmd/egctl/translate_test.go
@@ -22,6 +22,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/yaml"
 
+	"github.com/envoyproxy/gateway/internal/gatewayapi/status"
 	"github.com/envoyproxy/gateway/internal/utils/field"
 	"github.com/envoyproxy/gateway/internal/utils/file"
 )
@@ -349,6 +350,13 @@ func TestTranslate(t *testing.T) {
 			}
 			want := &TranslationResult{}
 			mustUnmarshal(t, requireTestDataOutFile(t, fn), want)
+
+			// Supported features are dynamic, instead of hard-coding them in the output files
+			// we define them here.
+			if want.GatewayClass != nil {
+				want.GatewayClass.Status.SupportedFeatures = status.GatewaySupportedFeatures
+			}
+
 			opts := cmpopts.IgnoreFields(metav1.Condition{}, "LastTransitionTime")
 			require.Empty(t, cmp.Diff(want, got, opts))
 		})

diff --git a/internal/gatewayapi/conformance/features.go b/internal/gatewayapi/conformance/features.go
@@ -0,0 +1,37 @@
+// Copyright Envoy Gateway Authors
+// SPDX-License-Identifier: Apache-2.0
+// The full text of the Apache license is available in the LICENSE file at
+// the root of the repo.
+
+package conformance
+
+import (
+	"k8s.io/apimachinery/pkg/util/sets"
+	"sigs.k8s.io/gateway-api/conformance/tests"
+	"sigs.k8s.io/gateway-api/conformance/utils/suite"
+	"sigs.k8s.io/gateway-api/pkg/features"
+)
+
+// SkipTests is a list of tests that are skipped in the conformance suite.
+var SkipTests = []suite.ConformanceTest{
+	tests.GatewayStaticAddresses,
+	tests.GatewayHTTPListenerIsolation,          // https://github.com/kubernetes-sigs/gateway-api/issues/3049
+	tests.HTTPRouteBackendRequestHeaderModifier, // https://github.com/envoyproxy/gateway/issues/3338
+}
+
+func skipTestsShortNames(skipTests []suite.ConformanceTest) []string {
+	shortNames := make([]string, len(skipTests))
+	for i, test := range skipTests {
+		shortNames[i] = test.ShortName
+	}
+	return shortNames
+}
+
+// EnvoyGatewaySuite is the conformance suite configuration for the Gateway API.
+var EnvoyGatewaySuite = suite.ConformanceOptions{
+	SupportedFeatures: features.AllFeatures,
+	ExemptFeatures: sets.New[features.SupportedFeature]().
+		Insert(features.MeshCoreFeatures.UnsortedList()...).
+		Insert(features.MeshExtendedFeatures.UnsortedList()...),
+	SkipTests: skipTestsShortNames(SkipTests),
+}
diff --git a/internal/gatewayapi/status/gatewayclass.go b/internal/gatewayapi/status/gatewayclass.go
@@ -17,7 +17,11 @@ import (
 	"time"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/sets"
 	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
+	"sigs.k8s.io/gateway-api/conformance/utils/suite"
+
+	"github.com/envoyproxy/gateway/internal/gatewayapi/conformance"
 )
 
 const (
@@ -32,6 +36,7 @@ const (
 // for the provided GatewayClass.
 func SetGatewayClassAccepted(gc *gwapiv1.GatewayClass, accepted bool, reason, msg string) *gwapiv1.GatewayClass {
 	gc.Status.Conditions = MergeConditions(gc.Status.Conditions, computeGatewayClassAcceptedCondition(gc, accepted, reason, msg))
+	gc.Status.SupportedFeatures = GatewaySupportedFeatures
 	return gc
 }
 
@@ -61,3 +66,24 @@ func computeGatewayClassAcceptedCondition(gatewayClass *gwapiv1.GatewayClass,
 		}
 	}
 }
+
+// GatewaySupportedFeatures is a list of supported Gateway-API features,
+// based on the running conformance tests suite.
+var GatewaySupportedFeatures = getSupportedFeatures(conformance.EnvoyGatewaySuite, conformance.SkipTests)
+
+func getSupportedFeatures(gatewaySuite suite.ConformanceOptions, skippedTests []suite.ConformanceTest) []gwapiv1.SupportedFeature {
+	supportedFeatures := gatewaySuite.SupportedFeatures.Clone()
+	supportedFeatures.Delete(gatewaySuite.ExemptFeatures.UnsortedList()...)
+
+	for _, skippedTest := range skippedTests {
+		for _, feature := range skippedTest.Features {
+			supportedFeatures.Delete(feature)
+		}
+	}
+
+	ret := sets.New[gwapiv1.SupportedFeature]()
+	for _, feature := range supportedFeatures.UnsortedList() {
+		ret.Insert(gwapiv1.SupportedFeature(feature))
+	}
+	return sets.List(ret)
+}
diff --git a/internal/gatewayapi/status/gatewayclass_test.go b/internal/gatewayapi/status/gatewayclass_test.go
@@ -10,7 +10,11 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/sets"
+
 	gwapiv1 "sigs.k8s.io/gateway-api/apis/v1"
+	"sigs.k8s.io/gateway-api/conformance/utils/suite"
+	"sigs.k8s.io/gateway-api/pkg/features"
 )
 
 func TestComputeGatewayClassAcceptedCondition(t *testing.T) {
@@ -66,3 +70,58 @@ func TestComputeGatewayClassAcceptedCondition(t *testing.T) {
 		assert.Equal(t, gc.Generation, got.ObservedGeneration)
 	}
 }
+
+func TestGetSupportedFeatures(t *testing.T) {
+	testCases := []struct {
+		name           string
+		gatewaySuite   suite.ConformanceOptions
+		skippedTests   []suite.ConformanceTest
+		expectedResult []gwapiv1.SupportedFeature
+	}{
+		{
+			name: "No exempt features",
+			gatewaySuite: suite.ConformanceOptions{
+				SupportedFeatures: sets.New[features.SupportedFeature]("Gateway", "HTTPRoute"),
+				ExemptFeatures:    sets.New[features.SupportedFeature](),
+			},
+			expectedResult: []gwapiv1.SupportedFeature{"Gateway", "HTTPRoute"},
+		},
+		{
+			name: "All features exempt",
+			gatewaySuite: suite.ConformanceOptions{
+				SupportedFeatures: sets.New[features.SupportedFeature]("Gateway", "HTTPRoute"),
+				ExemptFeatures:    sets.New[features.SupportedFeature]("Gateway", "HTTPRoute"),
+			},
+			expectedResult: []gwapiv1.SupportedFeature{},
+		},
+		{
+			name: "Some features exempt",
+			gatewaySuite: suite.ConformanceOptions{
+				SupportedFeatures: sets.New[features.SupportedFeature]("Gateway", "HTTPRoute", "GRPCRoute"),
+				ExemptFeatures:    sets.New[features.SupportedFeature]("GRPCRoute"),
+			},
+			expectedResult: []gwapiv1.SupportedFeature{"Gateway", "HTTPRoute"},
+		},
+		{
+			name: "Some features exempt with skipped tests",
+			gatewaySuite: suite.ConformanceOptions{
+				SupportedFeatures: sets.New[features.SupportedFeature]("Gateway", "HTTPRoute", "GRPCRoute"),
+				ExemptFeatures:    sets.New[features.SupportedFeature]("GRPCRoute"),
+			},
+			skippedTests: []suite.ConformanceTest{
+				{
+					Features: []features.SupportedFeature{"HTTPRoute"},
+				},
+			},
+			expectedResult: []gwapiv1.SupportedFeature{"Gateway"},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			result := getSupportedFeatures(tc.gatewaySuite, tc.skippedTests)
+
+			assert.ElementsMatch(t, tc.expectedResult, result, "The result should match the expected output for the test case.")
+		})
+	}
+}
diff --git a/internal/provider/kubernetes/controller_test.go b/internal/provider/kubernetes/controller_test.go
@@ -20,6 +20,7 @@ import (
 	"github.com/envoyproxy/gateway/internal/envoygateway"
 	"github.com/envoyproxy/gateway/internal/envoygateway/config"
 	"github.com/envoyproxy/gateway/internal/gatewayapi"
+	"github.com/envoyproxy/gateway/internal/gatewayapi/status"
 	"github.com/envoyproxy/gateway/internal/logging"
 )
 
@@ -189,6 +190,7 @@ func TestHasManagedClass(t *testing.T) {
 								Status: metav1.ConditionTrue,
 							},
 						},
+						SupportedFeatures: status.GatewaySupportedFeatures,
 					},
 				},
 			},
@@ -223,6 +225,7 @@ func TestHasManagedClass(t *testing.T) {
 								Status: metav1.ConditionTrue,
 							},
 						},
+						SupportedFeatures: status.GatewaySupportedFeatures,
 					},
 				},
 			},
@@ -275,6 +278,7 @@ func TestHasManagedClass(t *testing.T) {
 								Status: metav1.ConditionTrue,
 							},
 						},
+						SupportedFeatures: status.GatewaySupportedFeatures,
 					},
 				},
 				{
@@ -297,6 +301,7 @@ func TestHasManagedClass(t *testing.T) {
 								Status: metav1.ConditionFalse,
 							},
 						},
+						SupportedFeatures: status.GatewaySupportedFeatures,
 					},
 				},
 			},