1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
|
package config
import (
"fmt"
"path/filepath"
"reflect"
"github.com/crc-org/crc/v2/pkg/crc/preset"
"github.com/spf13/cast"
)
const (
configPropDoesntExistMsg = "Configuration property '%s' does not exist"
invalidProp = "Value '%v' for configuration property '%s' is invalid, reason: %s"
invalidType = "Type %T for configuration property '%s' is invalid"
)
type ValueChangedFunc func(config *Config, key string, value interface{})
type Config struct {
storage RawStorage
secretStorage RawStorage
settingsByName map[string]Setting
valueChangeNotifiers map[string]ValueChangedFunc
}
func New(storage, secretStorage RawStorage) *Config {
return &Config{
storage: storage,
secretStorage: secretStorage,
settingsByName: make(map[string]Setting),
valueChangeNotifiers: map[string]ValueChangedFunc{},
}
}
// AllConfigs returns all the known configs
// A known config is one which was registered through AddSetting
// - config with a default value
// - config with a value set
// - config with no value set
func (c *Config) AllConfigs() map[string]SettingValue {
var allConfigs = make(map[string]SettingValue)
for key := range c.settingsByName {
allConfigs[key] = c.Get(key)
}
return allConfigs
}
func (c *Config) AllSettings() []Setting {
var settings []Setting
for _, setting := range c.settingsByName {
settings = append(settings, setting)
}
return settings
}
// AddSetting returns a filled struct of ConfigSetting
// takes the config name and default value as arguments
func (c *Config) AddSetting(name string, defValue interface{}, validationFn ValidationFnType, callbackFn SetFn, help string) {
c.settingsByName[name] = Setting{
Name: name,
defaultValue: defValue,
validationFn: validationFn,
callbackFn: callbackFn,
isSecret: isUnderlyingTypeSecret(defValue),
Help: help,
}
}
func (c *Config) validate(key string, value interface{}) error {
ok, expectedValue := c.settingsByName[key].validationFn(value)
if !ok {
return fmt.Errorf(invalidProp, value, key, expectedValue)
}
return nil
}
// Set sets the value for a given config key
func (c *Config) Set(key string, value interface{}) (string, error) {
setting, ok := c.settingsByName[key]
if !ok {
return "", fmt.Errorf(configPropDoesntExistMsg, key)
}
if err := c.validate(key, value); err != nil {
return "", err
}
var castValue interface{}
var err error
switch setting.defaultValue.(type) {
case int:
castValue, err = cast.ToIntE(value)
if err != nil {
return "", fmt.Errorf(invalidProp, value, key, err)
}
case string, Secret:
castValue = cast.ToString(value)
case bool:
castValue, err = cast.ToBoolE(value)
if err != nil {
return "", fmt.Errorf(invalidProp, value, key, err)
}
case Path:
path := cast.ToString(value)
path, err := filepath.Abs(path)
if err != nil {
return "", fmt.Errorf(invalidProp, value, key, err)
}
castValue = path
case preset.Preset:
castValue = cast.ToString(value)
default:
return "", fmt.Errorf(invalidType, value, key)
}
// Make sure if user try to set same value which
// is default then just unset the value which
// anyway make it default and don't update it
// ~/.crc/crc.json (viper config) file.
if setting.defaultValue == castValue {
if _, err := c.Unset(key); err != nil {
return "", err
}
return c.settingsByName[key].callbackFn(key, castValue), nil
}
if setting.isSecret {
if err := c.secretStorage.Set(key, castValue); err != nil {
return "", err
}
} else {
if err := c.storage.Set(key, castValue); err != nil {
return "", err
}
}
c.valueChangeNotify(key, value)
return c.settingsByName[key].callbackFn(key, castValue), nil
}
// Unset unsets a given config key
func (c *Config) Unset(key string) (string, error) {
setting, ok := c.settingsByName[key]
if !ok {
return "", fmt.Errorf(configPropDoesntExistMsg, key)
}
if setting.isSecret {
if err := c.secretStorage.Unset(key); err != nil {
return "", err
}
} else {
if err := c.storage.Unset(key); err != nil {
return "", err
}
}
c.valueChangeNotify(key, nil)
return fmt.Sprintf("Successfully unset configuration property '%s'", key), nil
}
func (c *Config) RegisterNotifier(key string, changeNotifier ValueChangedFunc) error {
if _, hasKey := c.valueChangeNotifiers[key]; hasKey {
return fmt.Errorf("Config change notifier already registered for %s", key)
}
c.valueChangeNotifiers[key] = changeNotifier
return nil
}
func (c *Config) valueChangeNotify(key string, value interface{}) {
changeNotifier, hasKey := c.valueChangeNotifiers[key]
if !hasKey {
return
}
changeNotifier(c, key, value)
}
func (c *Config) Get(key string) SettingValue {
setting, ok := c.settingsByName[key]
if !ok {
return SettingValue{
Invalid: true,
}
}
var value interface{}
if setting.isSecret {
value = c.secretStorage.Get(key)
} else {
value = c.storage.Get(key)
}
if value == nil {
value = setting.defaultValue
}
var err error
switch setting.defaultValue.(type) {
case int:
value, err = cast.ToIntE(value)
if err != nil {
return SettingValue{
Invalid: true,
}
}
case string:
value = cast.ToString(value)
case Path:
value = Path(cast.ToString(value))
case bool:
value, err = cast.ToBoolE(value)
if err != nil {
return SettingValue{
Invalid: true,
}
}
case preset.Preset:
value, err = preset.ParsePresetE(cast.ToString(value))
if err != nil {
return SettingValue{
Invalid: true,
}
}
case Secret:
value, err = toSecret(value)
if err != nil {
return SettingValue{
Invalid: true,
}
}
default:
return SettingValue{
Invalid: true,
}
}
return SettingValue{
Value: value,
IsDefault: reflect.DeepEqual(setting.defaultValue, value),
IsSecret: isUnderlyingTypeSecret(value),
}
}
func toSecret(value interface{}) (Secret, error) {
if isUnderlyingTypeSecret(value) {
return value.(Secret), nil
}
v, err := cast.ToStringE(value)
if err != nil {
return Secret(""), err
}
return Secret(v), nil
}
func isUnderlyingTypeSecret(value interface{}) bool {
if _, ok := value.(Secret); ok {
return true
}
return false
}
|