mirror of
https://github.com/spf13/viper
synced 2024-12-22 19:47:01 +00:00
21336ce35f
When reading configuration from sources with case-sensitive keys, such as YAML, TOML, and JSON, a user may wish to preserve the case of keys that appear in maps. For example, consider when the value of a setting is a map with string keys that are case-sensitive. Ideally, if the value is not going to be indexed by a Viper lookup key, then the map value should be treated as an opaque value by Viper, and its keys should not be modified. See #1014 Viper's default behaviour is that keys are case-sensitive, and this behavior is implemented by converting all keys to lower-case. For users that wish to preserve the case of keys, this commit introduces an Option `CaseSensitiveKeys()` that can be used to configure Viper to use case-sensitive keys. When CaseSensitiveKeys is enabled, all keys retain the original case, and lookups become case-sensitive (except for lookups of values bound to environment variables). The behavior of Viper could become hard to understand if a user could change the CaseSensitiveKeys setting after values have been stored. For this reason, the setting may only be set when creating a Viper instance, and it cannot be set on the "global" Viper.
121 lines
2.6 KiB
Go
121 lines
2.6 KiB
Go
// Copyright © 2016 Steve Francia <spf@spf13.com>.
|
|
//
|
|
// Use of this source code is governed by an MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Viper is a application configuration system.
|
|
// It believes that applications can be configured a variety of ways
|
|
// via flags, ENVIRONMENT variables, configuration files retrieved
|
|
// from the file system, or a remote key/value store.
|
|
|
|
package viper
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
slog "github.com/sagikazarmark/slog-shim"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestCopyMap(t *testing.T) {
|
|
var (
|
|
given = map[string]any{
|
|
"Foo": 32,
|
|
"Bar": map[any]any{
|
|
"ABc": "A",
|
|
"cDE": "B",
|
|
},
|
|
}
|
|
expected = map[string]any{
|
|
"foo": 32,
|
|
"bar": map[string]any{
|
|
"abc": "A",
|
|
"cde": "B",
|
|
},
|
|
}
|
|
expectedPreserveCase = map[string]any{
|
|
"Foo": 32,
|
|
"Bar": map[string]any{
|
|
"ABc": "A",
|
|
"cDE": "B",
|
|
},
|
|
}
|
|
)
|
|
|
|
t.Run("convert to lower-case", func(t *testing.T) {
|
|
got := CopyMap(given, false)
|
|
|
|
assert.Equal(t, expected, got)
|
|
_, ok := given["foo"]
|
|
assert.False(t, ok)
|
|
_, ok = given["bar"]
|
|
assert.False(t, ok)
|
|
|
|
m := given["Bar"].(map[any]any)
|
|
_, ok = m["ABc"]
|
|
assert.True(t, ok)
|
|
})
|
|
|
|
t.Run("preserve case", func(t *testing.T) {
|
|
got := CopyMap(given, true)
|
|
|
|
assert.Equal(t, expectedPreserveCase, got)
|
|
_, ok := given["foo"]
|
|
assert.False(t, ok)
|
|
_, ok = given["bar"]
|
|
assert.False(t, ok)
|
|
|
|
m := given["Bar"].(map[any]any)
|
|
_, ok = m["ABc"]
|
|
assert.True(t, ok)
|
|
})
|
|
|
|
t.Run("not a map", func(t *testing.T) {
|
|
var (
|
|
given = []any{42, "xyz"}
|
|
expected = []any{42, "xyz"}
|
|
)
|
|
got := CopyMap(given, false)
|
|
assert.Equal(t, expected, got)
|
|
|
|
got = CopyMap(given, true)
|
|
assert.Equal(t, expected, got)
|
|
})
|
|
}
|
|
|
|
func TestAbsPathify(t *testing.T) {
|
|
skipWindows(t)
|
|
|
|
home := userHomeDir()
|
|
homer := filepath.Join(home, "homer")
|
|
wd, _ := os.Getwd()
|
|
|
|
t.Setenv("HOMER_ABSOLUTE_PATH", homer)
|
|
t.Setenv("VAR_WITH_RELATIVE_PATH", "relative")
|
|
|
|
tests := []struct {
|
|
input string
|
|
output string
|
|
}{
|
|
{"", wd},
|
|
{"sub", filepath.Join(wd, "sub")},
|
|
{"./", wd},
|
|
{"./sub", filepath.Join(wd, "sub")},
|
|
{"$HOME", home},
|
|
{"$HOME/", home},
|
|
{"$HOME/sub", filepath.Join(home, "sub")},
|
|
{"$HOMER_ABSOLUTE_PATH", homer},
|
|
{"$HOMER_ABSOLUTE_PATH/", homer},
|
|
{"$HOMER_ABSOLUTE_PATH/sub", filepath.Join(homer, "sub")},
|
|
{"$VAR_WITH_RELATIVE_PATH", filepath.Join(wd, "relative")},
|
|
{"$VAR_WITH_RELATIVE_PATH/", filepath.Join(wd, "relative")},
|
|
{"$VAR_WITH_RELATIVE_PATH/sub", filepath.Join(wd, "relative", "sub")},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
got := absPathify(slog.Default(), test.input)
|
|
assert.Equal(t, test.output, got)
|
|
}
|
|
}
|