Merge pull request #122738 from benluddy/client-go-feature-gate-adapter

Inject feature gate instance into client-go for kube components.

pkg/features/client_adapter.go

@@ -0,0 +1,69 @@
+/*
+Copyright 2024 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 features
+
+import (
+	"fmt"
+
+	clientfeatures "k8s.io/client-go/features"
+	"k8s.io/component-base/featuregate"
+)
+
+// clientAdapter adapts a k8s.io/component-base/featuregate.MutableFeatureGate to client-go's
+// feature Gate and Registry interfaces. The component-base types Feature, FeatureSpec, and
+// prerelease, and the component-base prerelease constants, are duplicated by parallel types and
+// constants in client-go. The parallel types exist to allow the feature gate mechanism to be used
+// for client-go features without introducing a circular dependency between component-base and
+// client-go.
+type clientAdapter struct {
+	mfg featuregate.MutableFeatureGate
+}
+
+var _ clientfeatures.Gates = &clientAdapter{}
+
+func (a *clientAdapter) Enabled(name clientfeatures.Feature) bool {
+	return a.mfg.Enabled(featuregate.Feature(name))
+}
+
+var _ clientfeatures.Registry = &clientAdapter{}
+
+func (a *clientAdapter) Add(in map[clientfeatures.Feature]clientfeatures.FeatureSpec) error {
+	out := map[featuregate.Feature]featuregate.FeatureSpec{}
+	for name, spec := range in {
+		converted := featuregate.FeatureSpec{
+			Default:       spec.Default,
+			LockToDefault: spec.LockToDefault,
+		}
+		switch spec.PreRelease {
+		case clientfeatures.Alpha:
+			converted.PreRelease = featuregate.Alpha
+		case clientfeatures.Beta:
+			converted.PreRelease = featuregate.Beta
+		case clientfeatures.GA:
+			converted.PreRelease = featuregate.GA
+		case clientfeatures.Deprecated:
+			converted.PreRelease = featuregate.Deprecated
+		default:
+			// The default case implies programmer error.  The same set of prerelease
+			// constants must exist in both component-base and client-go, and each one
+			// must have a case here.
+			panic(fmt.Sprintf("unrecognized prerelease %q of feature %q", spec.PreRelease, name))
+		}
+		out[featuregate.Feature(name)] = converted
+	}
+	return a.mfg.Add(out)
+}

pkg/features/client_adapter_test.go

@@ -0,0 +1,99 @@
+/*
+Copyright 2024 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 features
+
+import (
+	"testing"
+
+	clientfeatures "k8s.io/client-go/features"
+	"k8s.io/component-base/featuregate"
+)
+
+func TestClientAdapterEnabled(t *testing.T) {
+	fg := featuregate.NewFeatureGate()
+	if err := fg.Add(map[featuregate.Feature]featuregate.FeatureSpec{
+		"Foo": {Default: true},
+	}); err != nil {
+		t.Fatal(err)
+	}
+
+	a := &clientAdapter{fg}
+	if !a.Enabled("Foo") {
+		t.Error("expected Enabled(\"Foo\") to return true")
+	}
+	var r interface{}
+	func() {
+		defer func() {
+			r = recover()
+		}()
+		a.Enabled("Bar")
+	}()
+	if r == nil {
+		t.Error("expected Enabled(\"Bar\") to panic due to unknown feature name")
+	}
+}
+
+func TestClientAdapterAdd(t *testing.T) {
+	fg := featuregate.NewFeatureGate()
+	a := &clientAdapter{fg}
+	defaults := fg.GetAll()
+	if err := a.Add(map[clientfeatures.Feature]clientfeatures.FeatureSpec{
+		"FeatureAlpha":      {PreRelease: clientfeatures.Alpha, Default: true},
+		"FeatureBeta":       {PreRelease: clientfeatures.Beta, Default: false},
+		"FeatureGA":         {PreRelease: clientfeatures.GA, Default: true, LockToDefault: true},
+		"FeatureDeprecated": {PreRelease: clientfeatures.Deprecated, Default: false, LockToDefault: true},
+	}); err != nil {
+		t.Fatal(err)
+	}
+	all := fg.GetAll()
+	allexpected := map[featuregate.Feature]featuregate.FeatureSpec{
+		"FeatureAlpha":      {PreRelease: featuregate.Alpha, Default: true},
+		"FeatureBeta":       {PreRelease: featuregate.Beta, Default: false},
+		"FeatureGA":         {PreRelease: featuregate.GA, Default: true, LockToDefault: true},
+		"FeatureDeprecated": {PreRelease: featuregate.Deprecated, Default: false, LockToDefault: true},
+	}
+	for name, spec := range defaults {
+		allexpected[name] = spec
+	}
+	if len(all) != len(allexpected) {
+		t.Errorf("expected %d registered features, got %d", len(allexpected), len(all))
+	}
+	for name, expected := range allexpected {
+		actual, ok := all[name]
+		if !ok {
+			t.Errorf("expected feature %q not found", name)
+			continue
+		}
+
+		if actual != expected {
+			t.Errorf("expected feature %q spec %#v, got spec %#v", name, expected, actual)
+		}
+	}
+
+	var r interface{}
+	func() {
+		defer func() {
+			r = recover()
+		}()
+		_ = a.Add(map[clientfeatures.Feature]clientfeatures.FeatureSpec{
+			"FeatureAlpha": {PreRelease: "foobar"},
+		})
+	}()
+	if r == nil {
+		t.Error("expected panic when adding feature with unknown prerelease")
+	}
+}

pkg/features/kube_features.go

@@ -21,6 +21,7 @@ import (
 	"k8s.io/apimachinery/pkg/util/runtime"
 	genericfeatures "k8s.io/apiserver/pkg/features"
 	utilfeature "k8s.io/apiserver/pkg/util/feature"
+	clientfeatures "k8s.io/client-go/features"
 	"k8s.io/component-base/featuregate"
 )
 
@@ -904,6 +905,15 @@ const (
 
 func init() {
 	runtime.Must(utilfeature.DefaultMutableFeatureGate.Add(defaultKubernetesFeatureGates))
+
+	// Register all client-go features with kube's feature gate instance and make all client-go
+	// feature checks use kube's instance. The effect is that for kube binaries, client-go
+	// features are wired to the existing --feature-gates flag just as all other features
+	// are. Further, client-go features automatically support the existing mechanisms for
+	// feature enablement metrics and test overrides.
+	ca := &clientAdapter{utilfeature.DefaultMutableFeatureGate}
+	runtime.Must(clientfeatures.AddFeaturesToExistingFeatureGates(ca))
+	clientfeatures.ReplaceFeatureGates(ca)
 }
 
 // defaultKubernetesFeatureGates consists of all known Kubernetes-specific feature keys.

pkg/features/kube_features_test.go

@@ -17,22 +17,56 @@ limitations under the License.
 package features
 
 import (
-	utilfeature "k8s.io/apiserver/pkg/util/feature"
 	"testing"
+
+	utilfeature "k8s.io/apiserver/pkg/util/feature"
+	clientfeatures "k8s.io/client-go/features"
+	"k8s.io/component-base/featuregate"
 )
 
-func TestKubeFeatures(t *testing.T) {
-	features := utilfeature.DefaultFeatureGate.DeepCopy().GetAll()
+// TestKubeFeaturesRegistered tests that all kube features are registered.
+func TestKubeFeaturesRegistered(t *testing.T) {
+	registeredFeatures := utilfeature.DefaultFeatureGate.DeepCopy().GetAll()
 
-	for i := range features {
-		featureName := string(i)
-
-		if featureName == "AllAlpha" || featureName == "AllBeta" {
-			continue
-		}
-
-		if _, ok := defaultKubernetesFeatureGates[i]; !ok {
-			t.Errorf("The feature gate %q is not registered", featureName)
+	for featureName := range defaultKubernetesFeatureGates {
+		if _, ok := registeredFeatures[featureName]; !ok {
+			t.Errorf("The feature gate %q is not registered in the DefaultFeatureGate", featureName)
+		}
+	}
+}
+
+// TestClientFeaturesRegistered tests that all client features are registered.
+func TestClientFeaturesRegistered(t *testing.T) {
+	onlyClientFg := featuregate.NewFeatureGate()
+	if err := clientfeatures.AddFeaturesToExistingFeatureGates(&clientAdapter{onlyClientFg}); err != nil {
+		t.Fatal(err)
+	}
+	registeredFeatures := utilfeature.DefaultFeatureGate.DeepCopy().GetAll()
+
+	for featureName := range onlyClientFg.GetAll() {
+		if _, ok := registeredFeatures[featureName]; !ok {
+			t.Errorf("The client-go's feature gate %q is not registered in the DefaultFeatureGate", featureName)
+		}
+	}
+}
+
+// TestAllRegisteredFeaturesExpected tests that the set of features actually registered does not
+// include any features other than those on the list in this package or in client-go's feature
+// package.
+func TestAllRegisteredFeaturesExpected(t *testing.T) {
+	registeredFeatures := utilfeature.DefaultFeatureGate.DeepCopy().GetAll()
+	knownFeatureGates := featuregate.NewFeatureGate()
+	if err := clientfeatures.AddFeaturesToExistingFeatureGates(&clientAdapter{knownFeatureGates}); err != nil {
+		t.Fatal(err)
+	}
+	if err := knownFeatureGates.Add(defaultKubernetesFeatureGates); err != nil {
+		t.Fatal(err)
+	}
+	knownFeatures := knownFeatureGates.GetAll()
+
+	for registeredFeature := range registeredFeatures {
+		if _, ok := knownFeatures[registeredFeature]; !ok {
+			t.Errorf("The feature gate %q is not from known feature gates", registeredFeature)
 		}
 	}
 }

vendor/modules.txt

@@ -1688,6 +1688,7 @@ k8s.io/client-go/dynamic
 k8s.io/client-go/dynamic/dynamicinformer
 k8s.io/client-go/dynamic/dynamiclister
 k8s.io/client-go/dynamic/fake
+k8s.io/client-go/features
 k8s.io/client-go/informers
 k8s.io/client-go/informers/admissionregistration
 k8s.io/client-go/informers/admissionregistration/v1