-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #271 from pjbgf/features
runtime: Add Feature Gates
- Loading branch information
Showing
4 changed files
with
246 additions
and
1 deletion.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| Copyright 2022 The Flux 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" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| "github.com/spf13/pflag" | ||
| cliflag "k8s.io/component-base/cli/flag" | ||
| ) | ||
|
|
||
| const ( | ||
| flagFeatureGates = "feature-gates" | ||
| ) | ||
|
|
||
| var featureGates map[string]bool | ||
| var loaded bool | ||
|
|
||
| // FeatureGates is a helper to manage feature switches. | ||
| // | ||
| // Controllers can set their supported features and then at runtime | ||
| // verify which ones are enabled/disabled. | ||
| // | ||
| // Callers have to call BindFlags, and then call SupportedFeatures to | ||
| // set the supported features and their default values. | ||
| type FeatureGates struct { | ||
| log *logr.Logger | ||
| cliFeatures map[string]bool | ||
| } | ||
|
|
||
| // WithLogger sets the logger to be used when loading supported features. | ||
| func (o *FeatureGates) WithLogger(l logr.Logger) *FeatureGates { | ||
| o.log = &l | ||
| return o | ||
| } | ||
|
|
||
| // SupportedFeatures sets the supported features and their default values. | ||
| func (o *FeatureGates) SupportedFeatures(features map[string]bool) error { | ||
| loaded = true | ||
| featureGates = features | ||
|
|
||
| for k, v := range o.cliFeatures { | ||
| if _, ok := featureGates[k]; ok { | ||
| featureGates[k] = v | ||
| } else { | ||
| return fmt.Errorf("feature-gate '%s' not supported", k) | ||
| } | ||
| if o.log != nil { | ||
| o.log.Info("loading feature gate", k, v) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // Enabled verifies whether the feature is enabled or not. | ||
| func Enabled(feature string) (bool, error) { | ||
| if !loaded { | ||
| return false, fmt.Errorf("supported features not set") | ||
| } | ||
| if enabled, ok := featureGates[feature]; ok { | ||
| return enabled, nil | ||
| } | ||
| return false, fmt.Errorf("feature-gate '%s' not supported", feature) | ||
| } | ||
|
|
||
| // BindFlags will parse the given pflag.FlagSet and load feature gates accordingly. | ||
| func (o *FeatureGates) BindFlags(fs *pflag.FlagSet) { | ||
| fs.Var(cliflag.NewMapStringBool(&o.cliFeatures), flagFeatureGates, | ||
| "A comma separated list of key=value pairs defining the state of experimental features.") | ||
| } |
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,153 @@ | ||
| /* | ||
| Copyright 2022 The Flux 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" | ||
|
|
||
| . "github.com/onsi/gomega" | ||
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| func TestSupportedFeatures(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| supportedFeatures map[string]bool | ||
| commandLine []string | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "opt-in when default value is false", | ||
| commandLine: []string{"--feature-gates=invisible-messages=true"}, | ||
| supportedFeatures: map[string]bool{"invisible-messages": false}, | ||
| }, | ||
| { | ||
| name: "opt-out when default value is true", | ||
| commandLine: []string{"--feature-gates=invisible-messages=false"}, | ||
| supportedFeatures: map[string]bool{"invisible-messages": true}, | ||
| }, | ||
| { | ||
| name: "multiple feature gates", | ||
| commandLine: []string{"--feature-gates=invisible-messages=false,time-travel=true"}, | ||
| supportedFeatures: map[string]bool{"invisible-messages": true, "time-travel": false}, | ||
| }, | ||
| { | ||
| name: "try set feature gate that is not supported", | ||
| commandLine: []string{"--feature-gates=time-travel=true"}, | ||
| supportedFeatures: map[string]bool{}, | ||
| wantErr: "feature-gate 'time-travel' not supported", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| fs := pflag.NewFlagSet("", pflag.ContinueOnError) | ||
|
|
||
| features := FeatureGates{} | ||
| features.BindFlags(fs) | ||
| fs.Parse(tt.commandLine) | ||
|
|
||
| err := features.SupportedFeatures(tt.supportedFeatures) | ||
| if tt.wantErr == "" { | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| } else { | ||
| g.Expect(err).To(HaveOccurred()) | ||
| g.Expect(err.Error()).Should(ContainSubstring(tt.wantErr)) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestEnabled(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| supportedFeatures map[string]bool | ||
| setSupportedFeatures bool | ||
| commandLine []string | ||
| featureGate string | ||
| enabled bool | ||
| wantErr string | ||
| }{ | ||
| { | ||
| name: "opt-in when default value is false", | ||
| commandLine: []string{"--feature-gates=invisible-messages=true"}, | ||
| featureGate: "invisible-messages", | ||
| supportedFeatures: map[string]bool{"invisible-messages": false}, | ||
| setSupportedFeatures: true, | ||
| enabled: true, | ||
| }, | ||
| { | ||
| name: "opt-out when default value is true", | ||
| commandLine: []string{"--feature-gates=invisible-messages=false"}, | ||
| featureGate: "invisible-messages", | ||
| supportedFeatures: map[string]bool{"invisible-messages": true}, | ||
| setSupportedFeatures: true, | ||
| enabled: false, | ||
| }, | ||
| { | ||
| name: "multiple feature gates", | ||
| commandLine: []string{"--feature-gates=invisible-messages=false,time-travel=true"}, | ||
| featureGate: "time-travel", | ||
| supportedFeatures: map[string]bool{"invisible-messages": true, "time-travel": false}, | ||
| setSupportedFeatures: true, | ||
| enabled: true, | ||
| }, | ||
| { | ||
| name: "try feature gate that is not supported", | ||
| featureGate: "time-travel", | ||
| supportedFeatures: map[string]bool{}, | ||
| setSupportedFeatures: true, | ||
| wantErr: "feature-gate 'time-travel' not supported", | ||
| }, | ||
| { | ||
| name: "supported features not set", | ||
| featureGate: "time-travel", | ||
| setSupportedFeatures: false, | ||
| wantErr: "supported features not set", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| g := NewWithT(t) | ||
|
|
||
| loaded = false | ||
| fs := pflag.NewFlagSet("", pflag.ContinueOnError) | ||
|
|
||
| features := FeatureGates{} | ||
| features.BindFlags(fs) | ||
| fs.Parse(tt.commandLine) | ||
|
|
||
| if tt.setSupportedFeatures { | ||
| err := features.SupportedFeatures(tt.supportedFeatures) | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| } | ||
|
|
||
| enabled, err := Enabled(tt.featureGate) | ||
| if tt.wantErr == "" { | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
| } else { | ||
| g.Expect(err).To(HaveOccurred()) | ||
| g.Expect(err.Error()).Should(ContainSubstring(tt.wantErr)) | ||
| } | ||
|
|
||
| g.Expect(enabled).To(Equal(tt.enabled)) | ||
| }) | ||
| } | ||
| } |
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