-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cmd: Fix issue reading string map type via config map
As mentioned in below upstream issue, there is a discrepancy in viper
while reading string map string data type i.e. kv pair format was not
supported, only `{"k":"v"}` format is allowed. This commit is to wrap
GetStringMapString implementation to handle such case.
Also, during the bootstrap, if there is any flag having invalid value,
fatal log will be printed for early detection and awareness.
Relates spf13/viper#911
Fixes #18328
Signed-off-by: Tam Mach <tam.mach@isovalent.com>- Loading branch information
Showing
7 changed files
with
414 additions
and
8 deletions.
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
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,22 @@ | ||
| #!/bin/bash | ||
| # | ||
| # Copyright 2022 Authors of Cilium | ||
| # | ||
| # 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. | ||
|
|
||
| # Simple script to make sure viper.GetStringMapString should not be used. | ||
| # Related upstream issue https://github.com/spf13/viper/issues/911 | ||
| if grep -r --exclude-dir={.git,_build,vendor,contrib} -i --include \*.go "viper.GetStringMapString" .; then | ||
| echo "Found viper.GetStringMapString(key) usage. Please use command.GetStringMapString(viper.GetViper(), key) instead"; | ||
| exit 1 | ||
| fi |
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
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,80 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // Copyright 2022 Authors of Cilium | ||
|
|
||
| package command | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "regexp" | ||
| "strings" | ||
| "unicode" | ||
|
|
||
| "github.com/spf13/cast" | ||
| "github.com/spf13/viper" | ||
| ) | ||
|
|
||
| var keyValueRegex = regexp.MustCompile(`([\w-:./]+=[\w-:./]+,)*([\w-:./]+=[\w-:./]+)$`) | ||
|
|
||
| // GetStringMapString contains one enhancement to support k1=v2,k2=v2 compared to original | ||
| // implementation of GetStringMapString function | ||
| // Related upstream issue https://github.com/spf13/viper/issues/911 | ||
| func GetStringMapString(vp *viper.Viper, key string) map[string]string { | ||
| v, _ := GetStringMapStringE(vp, key) | ||
| return v | ||
| } | ||
|
|
||
| // GetStringMapStringE is same as GetStringMapString, but with error | ||
| func GetStringMapStringE(vp *viper.Viper, key string) (map[string]string, error) { | ||
| data := vp.Get(key) | ||
| if data == nil { | ||
| return map[string]string{}, nil | ||
| } | ||
| v, err := cast.ToStringMapStringE(data) | ||
| if err != nil { | ||
| var syntaxErr *json.SyntaxError | ||
| if !errors.As(err, &syntaxErr) { | ||
| return v, err | ||
| } | ||
|
|
||
| switch s := data.(type) { | ||
| case string: | ||
| if len(s) == 0 { | ||
| return map[string]string{}, nil | ||
| } | ||
|
|
||
| // if the input is starting with either '{' or '[', just preserve original json parsing error. | ||
| firstIndex := strings.IndexFunc(s, func(r rune) bool { | ||
| return !unicode.IsSpace(r) | ||
| }) | ||
| if firstIndex != -1 && (s[firstIndex] == '{' || s[firstIndex] == '[') { | ||
| return v, err | ||
| } | ||
|
|
||
| if !isValidKeyValuePair(s) { | ||
| return map[string]string{}, fmt.Errorf("'%s' is not formatted as key=value,key1=value1", s) | ||
| } | ||
|
|
||
| var v = map[string]string{} | ||
| kvs := strings.Split(s, ",") | ||
| for _, kv := range kvs { | ||
| temp := strings.Split(kv, "=") | ||
| if len(temp) != 2 { | ||
| return map[string]string{}, fmt.Errorf("'%s' is not formatted as key=value,key1=value1", s) | ||
| } | ||
| v[temp[0]] = temp[1] | ||
| } | ||
| return v, nil | ||
| } | ||
| } | ||
| return v, nil | ||
| } | ||
|
|
||
| // isValidKeyValuePair returns true if the input is following key1=value1,key2=value2,...,keyN=valueN format. | ||
| func isValidKeyValuePair(str string) bool { | ||
| if len(str) == 0 { | ||
| return true | ||
| } | ||
| return len(keyValueRegex.ReplaceAllString(str, "")) == 0 | ||
| } |
Oops, something went wrong.