-
Notifications
You must be signed in to change notification settings - Fork 88
/
config.go
290 lines (251 loc) · 8.08 KB
/
config.go
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
package config
import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/mitchellh/mapstructure"
"github.com/spf13/viper"
"gopkg.in/yaml.v3"
"github.com/bacalhau-project/bacalhau/pkg/config/configenv"
"github.com/bacalhau-project/bacalhau/pkg/config/types"
"github.com/bacalhau-project/bacalhau/pkg/telemetry"
)
const (
environmentVariablePrefix = "BACALHAU"
inferConfigTypes = true
automaticEnvVar = true
)
var (
environmentVariableReplace = strings.NewReplacer(".", "_")
configDecoderHook = viper.DecodeHook(mapstructure.TextUnmarshallerHookFunc())
)
func WriteConfig(fileName string) error {
var cfg types.BacalhauConfig
if err := viper.Unmarshal(&cfg, configDecoderHook); err != nil {
return err
}
cfgBytes, err := yaml.Marshal(cfg)
if err != nil {
return err
}
flags := os.O_CREATE | os.O_TRUNC | os.O_WRONLY
f, err := os.OpenFile(fileName, flags, os.FileMode(0o644)) //nolint:gomnd
if err != nil {
return err
}
defer f.Close()
if _, err := f.Write(cfgBytes); err != nil {
return err
}
return nil
}
func ReadConfig(fileName string) error {
if _, err := os.Stat(fileName); os.IsNotExist(err) {
// if the config file doesn't exist that's fine, we will just use default configuration values
// dictated by the environment
return nil
} else if err != nil {
return err
}
// else we will read values set from the config, and accept those over the default values.
return viper.ReadInConfig()
}
func Init(defaultConfig types.BacalhauConfig, path string, fileName, fileType string) (types.BacalhauConfig, error) {
return initConfig(initParams{
filePath: path,
fileName: fileName,
fileType: fileType,
fileHandler: WriteConfig,
defaultConfig: defaultConfig,
})
}
func Load(path string, fileName, fileType string) (types.BacalhauConfig, error) {
return initConfig(initParams{
filePath: path,
fileName: fileName,
fileType: fileType,
fileHandler: ReadConfig,
defaultConfig: ForEnvironment(),
})
}
func Get[T any](key string) (T, error) {
raw := viper.Get(key)
if raw == nil {
return zeroValue[T](), fmt.Errorf("value not found for %s", key)
}
var val T
val, ok := raw.(T)
if !ok {
err := ForKey(key, &val)
if err != nil {
return zeroValue[T](), fmt.Errorf("value not of expected type, got: %T", raw)
}
}
return val, nil
}
func GetStringMapString(key string) map[string]string {
return viper.GetStringMapString(key)
}
func zeroValue[T any]() T {
var zero T
return zero
}
// Set sets the current configuration to `config`, useful for testing.
func Set(config types.BacalhauConfig) error {
types.SetDefaults(config)
return nil
}
// Reset clears all configuration, useful for testing.
func Reset() {
viper.Reset()
}
// Getenv wraps os.Getenv and retrieves the value of the environment variable named by the config key.
// It returns the value, which will be empty if the variable is not present.
func Getenv(key string) string {
return os.Getenv(KeyAsEnvVar(key))
}
// KeyAsEnvVar returns the environment variable corresponding to a config key
func KeyAsEnvVar(key string) string {
return strings.ToUpper(
fmt.Sprintf("%s_%s", environmentVariablePrefix, environmentVariableReplace.Replace(key)),
)
}
type initParams struct {
filePath string
fileName string
fileType string
fileHandler func(fileName string) error
defaultConfig types.BacalhauConfig
}
func ForEnvironment() types.BacalhauConfig {
env := GetConfigEnvironment()
switch env {
case EnvironmentProd:
return configenv.Production
case EnvironmentStaging:
return configenv.Staging
case EnvironmentDev:
return configenv.Development
case EnvironmentTest:
return configenv.Testing
case EnvironmentLocal:
return configenv.Local
default:
// this would indicate an error in the above logic of `GetEnvironment()`
return configenv.Local
}
}
func initConfig(params initParams) (types.BacalhauConfig, error) {
viper.AddConfigPath(params.filePath)
viper.SetConfigName(params.fileName)
viper.SetConfigType(params.fileType)
viper.SetEnvPrefix(environmentVariablePrefix)
viper.SetTypeByDefaultValue(inferConfigTypes)
viper.SetEnvKeyReplacer(environmentVariableReplace)
if err := Set(params.defaultConfig); err != nil {
return types.BacalhauConfig{}, nil
}
if err := params.fileHandler(filepath.Join(params.filePath, fmt.Sprintf("%s.%s", params.fileName, params.fileType))); err != nil {
return types.BacalhauConfig{}, err
}
if automaticEnvVar {
viper.AutomaticEnv()
}
var out types.BacalhauConfig
if err := viper.Unmarshal(&out, configDecoderHook); err != nil {
return types.BacalhauConfig{}, err
}
// TODO this should be a part of the config.
telemetry.SetupFromEnvs()
return out, nil
}
// ForKey unmarshals configuration values associated with a given key into the provided cfg structure.
// It uses unmarshalCompositeKey internally to handle composite keys, ensuring values spread across
// nested sub-keys are correctly populated into the cfg structure.
//
// Parameters:
// - key: The configuration key to retrieve values for.
// - cfg: The structure into which the configuration values will be unmarshaled.
//
// Returns:
// - An error if any occurred during unmarshaling; otherwise, nil.
func ForKey(key string, cfg interface{}) error {
return unmarshalCompositeKey(key, cfg)
}
// unmarshalCompositeKey takes a key and an output structure to unmarshal into. It gets the
// composite value associated with the given key and decodes it into the provided output structure.
// It's especially useful when the desired value is not directly associated with the key, but
// instead is spread across various nested sub-keys within the configuration.
func unmarshalCompositeKey(key string, output interface{}) error {
compositeValue, err := getCompositeValue(key)
if err != nil {
return err
}
decoderConfig := &mapstructure.DecoderConfig{
DecodeHook: mapstructure.TextUnmarshallerHookFunc(),
Result: output,
TagName: "mapstructure", // This is the default struct tag name used by Viper.
}
decoder, err := mapstructure.NewDecoder(decoderConfig)
if err != nil {
return err
}
return decoder.Decode(compositeValue)
}
// getCompositeValue constructs a composite value for a given key. If the key directly corresponds
// to a set value in Viper, it returns that. Otherwise, it collects all nested values under that
// key and returns them as a nested map.
func getCompositeValue(key string) (map[string]interface{}, error) {
var compositeValue map[string]interface{}
// Fetch directly if the exact key exists
if viper.IsSet(key) {
rawValue := viper.Get(key)
switch v := rawValue.(type) {
case map[string]interface{}:
compositeValue = v
default:
return map[string]interface{}{
key: rawValue,
}, nil
}
} else {
compositeValue = make(map[string]interface{})
}
lowerKey := strings.ToLower(key)
// Prepare a map for faster key lookup.
viperKeys := viper.AllKeys()
keyMap := make(map[string]string, len(viperKeys))
for _, k := range viperKeys {
keyMap[strings.ToLower(k)] = k
}
// Build a composite map of values for keys nested under the provided key.
for lowerK, originalK := range keyMap {
if strings.HasPrefix(lowerK, lowerKey+".") {
parts := strings.Split(lowerK[len(lowerKey)+1:], ".")
if err := setNested(compositeValue, parts, viper.Get(originalK)); err != nil {
return nil, err
}
}
}
return compositeValue, nil
}
// setNested is a recursive helper function that sets a value in a nested map based on a slice of keys.
// It goes through each key, creating maps for each level as needed, and ultimately sets the value
// in the innermost map.
func setNested(m map[string]interface{}, keys []string, value interface{}) error {
if len(keys) == 1 {
m[keys[0]] = value
return nil
}
// If the next map level doesn't exist, create it.
if m[keys[0]] == nil {
m[keys[0]] = make(map[string]interface{})
}
// Cast the nested level to a map and return an error if the type assertion fails.
nestedMap, ok := m[keys[0]].(map[string]interface{})
if !ok {
return fmt.Errorf("key %s is not of type map[string]interface{}", keys[0])
}
return setNested(nestedMap, keys[1:], value)
}