mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-24 12:15:52 +00:00
Merge pull request #103852 from brianpursley/kubectl-1078
Changed flag name underscore warning to prevent duplicate warnings and avoid recommending invalid flag name
This commit is contained in:
commit
3945e35f1c
@ -24,6 +24,8 @@ import (
|
|||||||
"k8s.io/klog/v2"
|
"k8s.io/klog/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var underscoreWarnings = make(map[string]bool)
|
||||||
|
|
||||||
// WordSepNormalizeFunc changes all flags that contain "_" separators
|
// WordSepNormalizeFunc changes all flags that contain "_" separators
|
||||||
func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
||||||
if strings.Contains(name, "_") {
|
if strings.Contains(name, "_") {
|
||||||
@ -36,7 +38,10 @@ func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
|||||||
func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
||||||
if strings.Contains(name, "_") {
|
if strings.Contains(name, "_") {
|
||||||
nname := strings.Replace(name, "_", "-", -1)
|
nname := strings.Replace(name, "_", "-", -1)
|
||||||
klog.Warningf("%s is DEPRECATED and will be removed in a future version. Use %s instead.", name, nname)
|
if _, alreadyWarned := underscoreWarnings[name]; !alreadyWarned {
|
||||||
|
klog.Warningf("using an underscore in a flag name is not supported. %s has been converted to %s.", name, nname)
|
||||||
|
underscoreWarnings[name] = true
|
||||||
|
}
|
||||||
|
|
||||||
return pflag.NormalizedName(nname)
|
return pflag.NormalizedName(nname)
|
||||||
}
|
}
|
||||||
|
107
staging/src/k8s.io/component-base/cli/flag/flags_test.go
Normal file
107
staging/src/k8s.io/component-base/cli/flag/flags_test.go
Normal file
@ -0,0 +1,107 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2021 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 flag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"github.com/go-logr/logr"
|
||||||
|
"github.com/spf13/pflag"
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"k8s.io/klog/v2"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type FakeLogger struct {
|
||||||
|
logr.Logger
|
||||||
|
infoBuffer bytes.Buffer
|
||||||
|
errorBuffer bytes.Buffer
|
||||||
|
}
|
||||||
|
|
||||||
|
func (logger *FakeLogger) Enabled() bool { return true }
|
||||||
|
func (logger *FakeLogger) Info(msg string, keysAndValues ...interface{}) {
|
||||||
|
logger.infoBuffer.WriteString(msg)
|
||||||
|
}
|
||||||
|
func (logger *FakeLogger) Error(err error, msg string, keysAndValues ...interface{}) {
|
||||||
|
logger.errorBuffer.WriteString(msg)
|
||||||
|
}
|
||||||
|
func (logger *FakeLogger) V(level int) logr.Logger { return logger }
|
||||||
|
func (logger *FakeLogger) WithValues(keysAndValues ...interface{}) logr.Logger { return logger }
|
||||||
|
func (logger *FakeLogger) WithName(name string) logr.Logger { return logger }
|
||||||
|
|
||||||
|
func TestWordSepNormalizeFunc(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
flagName string
|
||||||
|
expectedFlagName string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
flagName: "foo",
|
||||||
|
expectedFlagName: "foo",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
flagName: "foo-bar",
|
||||||
|
expectedFlagName: "foo-bar",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
flagName: "foo_bar",
|
||||||
|
expectedFlagName: "foo-bar",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.flagName, func(t *testing.T) {
|
||||||
|
fakeLogger := &FakeLogger{}
|
||||||
|
klog.SetLogger(fakeLogger)
|
||||||
|
result := WordSepNormalizeFunc(nil, tc.flagName)
|
||||||
|
assert.Equal(t, pflag.NormalizedName(tc.expectedFlagName), result)
|
||||||
|
assert.Equal(t, "", fakeLogger.infoBuffer.String())
|
||||||
|
assert.Equal(t, "", fakeLogger.errorBuffer.String())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWarnWordSepNormalizeFunc(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
flagName string
|
||||||
|
expectedFlagName string
|
||||||
|
expectedWarning string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
flagName: "foo",
|
||||||
|
expectedFlagName: "foo",
|
||||||
|
expectedWarning: "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
flagName: "foo-bar",
|
||||||
|
expectedFlagName: "foo-bar",
|
||||||
|
expectedWarning: "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
flagName: "foo_bar",
|
||||||
|
expectedFlagName: "foo-bar",
|
||||||
|
expectedWarning: "using an underscore in a flag name is not supported. foo_bar has been converted to foo-bar.\n",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.flagName, func(t *testing.T) {
|
||||||
|
fakeLogger := &FakeLogger{}
|
||||||
|
klog.SetLogger(fakeLogger)
|
||||||
|
result := WarnWordSepNormalizeFunc(nil, tc.flagName)
|
||||||
|
assert.Equal(t, pflag.NormalizedName(tc.expectedFlagName), result)
|
||||||
|
assert.Equal(t, tc.expectedWarning, fakeLogger.infoBuffer.String())
|
||||||
|
assert.Equal(t, "", fakeLogger.errorBuffer.String())
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user