mirror of https://github.com/helm/helm
This adds a new `gates` package used for interacting with feature gates. It also marks the OCI registry work as experimental, signalling to users that it is not a stable feature of Helm. Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>pull/6185/head
Matthew Fisher
5 years ago
parent
affd77558f
commit
fe952445bd
@ -0,0 +1,20 @@
|
||||
/*
|
||||
Copyright The Helm 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 gates provides a general tool for working with experimental feature gates.
|
||||
|
||||
This provides convenience methods where the user can determine if certain experimental features are enabled.
|
||||
*/
|
||||
package gates
|
||||
@ -0,0 +1,38 @@
|
||||
/*
|
||||
Copyright The Helm 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 gates
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// Gate is the name of the feature gate.
|
||||
type Gate string
|
||||
|
||||
// String returns the string representation of this feature gate.
|
||||
func (g Gate) String() string {
|
||||
return string(g)
|
||||
}
|
||||
|
||||
// IsEnabled determines whether a certain feature gate is enabled.
|
||||
func (g Gate) IsEnabled() bool {
|
||||
return os.Getenv(string(g)) != ""
|
||||
}
|
||||
|
||||
func (g Gate) Error() error {
|
||||
return fmt.Errorf("this feature has been marked as experimental and is not enabled by default. Please set $%s in your environment to use this feature", g.String())
|
||||
}
|
||||
@ -0,0 +1,47 @@
|
||||
/*
|
||||
Copyright The Helm 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 gates
|
||||
|
||||
import (
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const name string = "HELM_EXPERIMENTAL_FEATURE"
|
||||
|
||||
func TestIsEnabled(t *testing.T) {
|
||||
os.Unsetenv(name)
|
||||
g := Gate(name)
|
||||
|
||||
if g.IsEnabled() {
|
||||
t.Errorf("feature gate shows as available, but the environment variable $%s was not set", name)
|
||||
}
|
||||
|
||||
os.Setenv(name, "1")
|
||||
|
||||
if !g.IsEnabled() {
|
||||
t.Errorf("feature gate shows as disabled, but the environment variable $%s was set", name)
|
||||
}
|
||||
}
|
||||
|
||||
func TestError(t *testing.T) {
|
||||
os.Unsetenv(name)
|
||||
g := Gate(name)
|
||||
|
||||
if g.Error().Error() != "this feature has been marked as experimental and is not enabled by default. Please set $HELM_EXPERIMENTAL_FEATURE in your environment to use this feature" {
|
||||
t.Errorf("incorrect error message. Received %s", g.Error().Error())
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue