github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-19 09:52:49 +00:00
Code Issues Projects Releases Wiki Activity

Handle AllAlpha and AllBeta in SetFeatureGateDuringTest

Browse Source
This commit is contained in:
Jordan Liggitt 2023-02-28 16:59:19 -05:00
parent 3835c7aecd
commit d0a213aba2
No known key found for this signature in database
3 changed files with 145 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hack/verify-test-featuregates.sh
View File

@ -30,7 +30,7 @@ cd "${KUBE_ROOT}"
rc=0
# find test files accessing the mutable global feature gate or interface
direct_sets=$(find -L . -name '*_test.go' -exec grep -Hn 'MutableFeatureGate' {} \; 2>/dev/null) || true
direct_sets=$(git grep MutableFeatureGate -- '*_test.go') || true
if [[ -n "${direct_sets}" ]]; then
echo "Test files may not access mutable global feature gates directly:" >&2
echo "${direct_sets}" >&2
@ -42,7 +42,7 @@ if [[ -n "${direct_sets}" ]]; then
fi
# find test files calling SetFeatureGateDuringTest and not calling the result
missing_defers=$(find -L . -name '*_test.go' -exec grep -Hn 'SetFeatureGateDuringTest' {} \; 2>/dev/null | grep -E -v "defer .*\\)\\(\\)$") || true
missing_defers=$(git grep "\\.SetFeatureGateDuringTest" -- '*_test.go' | grep -E -v "defer .*\\)\\(\\)$") || true
if [[ -n "${missing_defers}" ]]; then
echo "Invalid invocations of featuregatetesting.SetFeatureGateDuringTest():" >&2
echo "${missing_defers}" >&2

17
staging/src/k8s.io/component-base/featuregate/testing/feature_gate.go
View File

@ -32,6 +32,20 @@ import (
func SetFeatureGateDuringTest(tb testing.TB, gate featuregate.FeatureGate, f featuregate.Feature, value bool) func() {
originalValue := gate.Enabled(f)
// Specially handle AllAlpha and AllBeta
var cleanups []func()
if f == "AllAlpha" || f == "AllBeta" {
// Iterate over individual gates so their individual values get restored
for k, v := range gate.(featuregate.MutableFeatureGate).GetAll() {
if k == "AllAlpha" || k == "AllBeta" {
continue
}
if (f == "AllAlpha" && v.PreRelease == featuregate.Alpha) || (f == "AllBeta" && v.PreRelease == featuregate.Beta) {
cleanups = append(cleanups, SetFeatureGateDuringTest(tb, gate, k, value))
}
}
}
if err := gate.(featuregate.MutableFeatureGate).Set(fmt.Sprintf("%s=%v", f, value)); err != nil {
tb.Errorf("error setting %s=%v: %v", f, value, err)
}
@ -40,5 +54,8 @@ func SetFeatureGateDuringTest(tb testing.TB, gate featuregate.FeatureGate, f fea
if err := gate.(featuregate.MutableFeatureGate).Set(fmt.Sprintf("%s=%v", f, originalValue)); err != nil {
tb.Errorf("error restoring %s=%v: %v", f, originalValue, err)
}
for _, cleanup := range cleanups {
cleanup()
}
}
}

126
staging/src/k8s.io/component-base/featuregate/testing/feature_gate_test.go Normal file
View File

@ -0,0 +1,126 @@
/*
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 testing
import (
gotest "testing"
"k8s.io/component-base/featuregate"
)
func TestSpecialGates(t *gotest.T) {
gate := featuregate.NewFeatureGate()
gate.Add(map[featuregate.Feature]featuregate.FeatureSpec{
"alpha_default_on": {PreRelease: featuregate.Alpha, Default: true},
"alpha_default_on_set_off": {PreRelease: featuregate.Alpha, Default: true},
"alpha_default_off": {PreRelease: featuregate.Alpha, Default: false},
"alpha_default_off_set_on": {PreRelease: featuregate.Alpha, Default: false},
"beta_default_on": {PreRelease: featuregate.Beta, Default: true},
"beta_default_on_set_off": {PreRelease: featuregate.Beta, Default: true},
"beta_default_off": {PreRelease: featuregate.Beta, Default: false},
"beta_default_off_set_on": {PreRelease: featuregate.Beta, Default: false},
"stable_default_on": {PreRelease: featuregate.GA, Default: true},
"stable_default_on_set_off": {PreRelease: featuregate.GA, Default: true},
"stable_default_off": {PreRelease: featuregate.GA, Default: false},
"stable_default_off_set_on": {PreRelease: featuregate.GA, Default: false},
})
gate.Set("alpha_default_on_set_off=false")
gate.Set("beta_default_on_set_off=false")
gate.Set("stable_default_on_set_off=false")
gate.Set("alpha_default_off_set_on=true")
gate.Set("beta_default_off_set_on=true")
gate.Set("stable_default_off_set_on=true")
before := map[featuregate.Feature]bool{
"AllAlpha": false,
"AllBeta": false,
"alpha_default_on": true,
"alpha_default_on_set_off": false,
"alpha_default_off": false,
"alpha_default_off_set_on": true,
"beta_default_on": true,
"beta_default_on_set_off": false,
"beta_default_off": false,
"beta_default_off_set_on": true,
"stable_default_on": true,
"stable_default_on_set_off": false,
"stable_default_off": false,
"stable_default_off_set_on": true,
}
expect(t, gate, before)
cleanupAlpha := SetFeatureGateDuringTest(t, gate, "AllAlpha", true)
expect(t, gate, map[featuregate.Feature]bool{
"AllAlpha": true,
"AllBeta": false,
"alpha_default_on": true,
"alpha_default_on_set_off": true,
"alpha_default_off": true,
"alpha_default_off_set_on": true,
"beta_default_on": true,
"beta_default_on_set_off": false,
"beta_default_off": false,
"beta_default_off_set_on": true,
"stable_default_on": true,
"stable_default_on_set_off": false,
"stable_default_off": false,
"stable_default_off_set_on": true,
})
cleanupBeta := SetFeatureGateDuringTest(t, gate, "AllBeta", true)
expect(t, gate, map[featuregate.Feature]bool{
"AllAlpha": true,
"AllBeta": true,
"alpha_default_on": true,
"alpha_default_on_set_off": true,
"alpha_default_off": true,
"alpha_default_off_set_on": true,
"beta_default_on": true,
"beta_default_on_set_off": true,
"beta_default_off": true,
"beta_default_off_set_on": true,
"stable_default_on": true,
"stable_default_on_set_off": false,
"stable_default_off": false,
"stable_default_off_set_on": true,
})
// run cleanups in reverse order like defer would
cleanupBeta()
cleanupAlpha()
expect(t, gate, before)
}
func expect(t *gotest.T, gate featuregate.FeatureGate, expect map[featuregate.Feature]bool) {
t.Helper()
for k, v := range expect {
if gate.Enabled(k) != v {
t.Errorf("Expected %v=%v, got %v", k, v, gate.Enabled(k))
}
}
}