This repository has been archived by the owner on Jan 10, 2021. It is now read-only.
/
utils.go
324 lines (280 loc) · 8.97 KB
/
utils.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
package configor
import (
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"path"
"reflect"
"strings"
"github.com/creasty/defaults"
"github.com/go-playground/validator/v10"
"github.com/markbates/pkger"
"github.com/markbates/pkger/pkging"
// "github.com/kelseyhightower/envconfig"
"github.com/stoewer/go-strcase"
"gopkg.in/yaml.v2"
)
func (configor *Configor) getENVPrefix(config interface{}) string {
if configor.Config.ENVPrefix == "" {
if prefix := os.Getenv("CONFIGOR_ENV_PREFIX"); prefix != "" {
return prefix
}
return "Configor"
}
return configor.Config.ENVPrefix
}
func getConfigurationFileWithENVPrefix(file, env string, usePkger bool) (string, error) {
var (
envFile string
extname = path.Ext(file)
)
if extname == "" {
envFile = fmt.Sprintf("%v.%v", file, env)
} else {
envFile = fmt.Sprintf("%v.%v%v", strings.TrimSuffix(file, extname), env, extname)
}
if fileInfo, err := stat(envFile, usePkger); err == nil && fileInfo.Mode().IsRegular() {
return envFile, nil
}
return "", fmt.Errorf("failed to find file %v", file)
}
func (configor *Configor) getConfigurationFiles(files ...string) []string {
var resultKeys []string
if configor.Config.Debug || configor.Config.Verbose {
fmt.Printf("Current environment: '%v'\n", configor.GetEnvironment())
}
for _, file := range files {
foundFile := false
// check configuration
if fileInfo, err := stat(file, configor.UsePkger); err == nil && fileInfo.Mode().IsRegular() {
foundFile = true
resultKeys = append(resultKeys, file)
}
// check configuration with env
if file, err := getConfigurationFileWithENVPrefix(file, configor.GetEnvironment(), configor.UsePkger); err == nil {
foundFile = true
resultKeys = append(resultKeys, file)
}
// check example configuration
if !foundFile {
if example, err := getConfigurationFileWithENVPrefix(file, "example", configor.UsePkger); err == nil {
if !configor.Silent {
fmt.Printf("Failed to find configuration %v, using example file %v\n", file, example)
}
resultKeys = append(resultKeys, example)
} else if !configor.Silent {
fmt.Printf("Failed to find configuration %v\n", file)
}
}
}
return resultKeys
}
func (configor *Configor) processFile(config interface{}, file string) (err error) {
var data []byte
if configor.UsePkger {
var fh pkging.File
if fh, err = pkger.Open(file); err != nil {
return err
}
defer fh.Close()
if data, err = ioutil.ReadAll(fh); err != nil {
return err
}
} else {
if data, err = ioutil.ReadFile(file); err != nil {
return err
}
}
switch {
case strings.HasSuffix(file, ".yaml") || strings.HasSuffix(file, ".yml"):
if configor.GetErrorOnUnmatchedKeys() {
return yaml.UnmarshalStrict(data, config)
}
return yaml.Unmarshal(data, config)
case strings.HasSuffix(file, ".json"):
return unmarshalJSON(data, config, configor.GetErrorOnUnmatchedKeys())
default:
if err := unmarshalJSON(data, config, configor.GetErrorOnUnmatchedKeys()); err == nil {
return nil
} else if strings.Contains(err.Error(), "json: unknown field") {
return err
}
var yamlError error
if configor.GetErrorOnUnmatchedKeys() {
yamlError = yaml.UnmarshalStrict(data, config)
} else {
yamlError = yaml.Unmarshal(data, config)
}
if yamlError == nil {
return nil
} else if yErr, ok := yamlError.(*yaml.TypeError); ok {
return yErr
}
return errors.New("failed to decode config")
}
}
// unmarshalJSON unmarshals the given data into the config interface.
// If the errorOnUnmatchedKeys boolean is true, an error will be returned if there
// are keys in the data that do not match fields in the config interface.
func unmarshalJSON(data []byte, config interface{}, errorOnUnmatchedKeys bool) error {
reader := strings.NewReader(string(data))
decoder := json.NewDecoder(reader)
if errorOnUnmatchedKeys {
decoder.DisallowUnknownFields()
}
err := decoder.Decode(config)
if err != nil && err != io.EOF {
return err
}
return nil
}
func getPrefixForStruct(prefixes []string, fieldStruct *reflect.StructField) []string {
if fieldStruct.Anonymous && fieldStruct.Tag.Get("anonymous") == "true" {
return prefixes
}
return append(prefixes, fieldStruct.Name)
}
func (configor *Configor) processTags(config interface{}, prefixes ...string) error {
configValue := reflect.Indirect(reflect.ValueOf(config))
if configValue.Kind() != reflect.Struct {
return errors.New("invalid config, should be struct")
}
configType := configValue.Type()
for i := 0; i < configType.NumField(); i++ {
var (
envNames []string
fieldStruct = configType.Field(i)
field = configValue.Field(i)
envName = fieldStruct.Tag.Get("env") // read configuration from shell env
)
if !field.CanAddr() || !field.CanInterface() {
continue
}
if envName == "" {
envNames = append(envNames, strcase.UpperSnakeCase(strings.Join(append(prefixes, fieldStruct.Name), "_"))) // CONFIGOR_DB_NAME
// envNames = append(envNames, strings.Join(append(prefixes, fieldStruct.Name), "_")) // Configor_DB_Name
// envNames = append(envNames, strings.ToUpper(strings.Join(append(prefixes, fieldStruct.Name), "_"))) // CONFIGOR_DB_NAME
} else {
envNames = []string{envName}
}
if configor.Config.Verbose {
fmt.Printf("Trying to load struct `%v`'s field `%v` from env %v\n", configType.Name(), fieldStruct.Name, strings.Join(envNames, ", "))
}
// Load From Shell ENV
for _, env := range envNames {
if value := os.Getenv(env); value != "" {
if configor.Config.Debug || configor.Config.Verbose {
fmt.Printf("Loading configuration for struct `%v`'s field `%v` from env %v...\n", configType.Name(), fieldStruct.Name, env)
}
switch reflect.Indirect(field).Kind() {
case reflect.Bool:
switch strings.ToLower(value) {
case "", "0", "f", "false":
field.Set(reflect.ValueOf(false))
default:
field.Set(reflect.ValueOf(true))
}
case reflect.String:
field.Set(reflect.ValueOf(value))
default:
if err := yaml.Unmarshal([]byte(value), field.Addr().Interface()); err != nil {
return err
}
}
break
}
}
if isBlank := reflect.DeepEqual(field.Interface(), reflect.Zero(field.Type()).Interface()); isBlank && fieldStruct.Tag.Get("required") == "true" {
// return error if it is required but blank
return errors.New(fieldStruct.Name + " is required, but blank")
}
for field.Kind() == reflect.Ptr {
field = field.Elem()
}
if field.Kind() == reflect.Struct {
if err := configor.processTags(field.Addr().Interface(), getPrefixForStruct(prefixes, &fieldStruct)...); err != nil {
return err
}
}
if field.Kind() == reflect.Slice {
if arrLen := field.Len(); arrLen > 0 {
for i := 0; i < arrLen; i++ {
if reflect.Indirect(field.Index(i)).Kind() == reflect.Struct {
if err := configor.processTags(field.Index(i).Addr().Interface(), append(getPrefixForStruct(prefixes, &fieldStruct), fmt.Sprint(i))...); err != nil {
return err
}
}
}
} else {
// load slice from env
newVal := reflect.New(field.Type().Elem()).Elem()
if newVal.Kind() == reflect.Struct {
idx := 0
for {
newVal = reflect.New(field.Type().Elem()).Elem()
if err := configor.processTags(newVal.Addr().Interface(), append(getPrefixForStruct(prefixes, &fieldStruct), fmt.Sprint(idx))...); err != nil {
return err
} else if reflect.DeepEqual(newVal.Interface(), reflect.New(field.Type().Elem()).Elem().Interface()) {
break
} else {
idx++
field.Set(reflect.Append(field, newVal))
}
}
}
}
}
}
return nil
}
func (configor *Configor) load(config interface{}, files ...string) (err error) {
defer func() {
if configor.Config.Debug || configor.Config.Verbose {
if err != nil {
fmt.Printf("Failed to load configuration from %v, got %v\n", files, err)
}
fmt.Printf("Configuration:\n %#v\n", config)
}
}()
configFiles := configor.getConfigurationFiles(files...)
for _, file := range configFiles {
if configor.Config.Debug || configor.Config.Verbose {
fmt.Printf("Loading configurations from file '%v'...\n", file)
}
if err = configor.processFile(config, file); err != nil {
return err
}
}
if configor.Config.Verbose {
fmt.Printf("Configuration after loading, and before setting Defaults :\n %#+v\n", config)
}
// process defaults
if err = defaults.Set(config); err != nil {
return err
}
if configor.Config.Verbose {
fmt.Printf("Configuration after loading files and setting Defaults, before processing ENV:\n %#v\n", config)
}
if prefix := configor.getENVPrefix(config); prefix == "-" {
err = configor.processTags(config)
} else {
err = configor.processTags(config, prefix)
}
// validate config only if no parsing errors
if err == nil {
validate := validator.New()
// validate.SetTagName("valid")
err = validate.Struct(config)
}
return err
}
func stat(name string, usePkger bool) (os.FileInfo, error) {
if usePkger {
return pkger.Stat(name)
} else {
return os.Stat(name)
}
}