-
Notifications
You must be signed in to change notification settings - Fork 0
/
loader_multi_test.go
245 lines (212 loc) · 6.05 KB
/
loader_multi_test.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
// Copyright The ActForGood Authors.
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file or at
// https://github.com/actforgood/xconf/blob/main/LICENSE.
package xconf_test
import (
"errors"
"fmt"
"testing"
"github.com/actforgood/xconf"
)
func TestMultiLoader(t *testing.T) {
t.Parallel()
t.Run("success - merged config from multiple loaders", testMultiLoaderSuccess)
t.Run("error - from loaders", testMultiLoaderReturnsLoadErr)
t.Run("error - key conflict", testMultiLoaderReturnsKeyConflictErr)
t.Run("success - safe-mutable config map", testMultiLoaderReturnsSafeMutableConfigMap)
}
func testMultiLoaderSuccess(t *testing.T) {
t.Parallel()
// arrange
var (
loader1 = xconf.PlainLoader(map[string]any{
"loader_1_foo": "foo - from Loader 1",
"loader_1_bar": "bar - from Loader 1",
"key": "value - from Loader 1",
})
loader2 = xconf.PlainLoader(map[string]any{
"loader_2_foo": "foo - from Loader 2",
"loader_2_bar": "bar - from Loader 2",
"loader_1_bar": "bar - from Loader 2 - overwrite Loader 1",
"key": "value - from Loader 2",
})
loader3 = xconf.PlainLoader(map[string]any{
"loader_3_foo": "foo - from Loader 3",
"loader_3_bar": "bar - from Loader 3",
"loader_2_bar": "bar - from Loader 3 - overwrite Loader 2",
"key": "value - from Loader 3",
})
subject = xconf.NewMultiLoader(true, loader1, loader2, loader3)
)
// act
config, err := subject.Load()
// assert
assertNil(t, err)
assertEqual(
t,
map[string]any{
"loader_1_foo": "foo - from Loader 1",
"loader_2_foo": "foo - from Loader 2",
"loader_3_foo": "foo - from Loader 3",
"loader_1_bar": "bar - from Loader 2 - overwrite Loader 1",
"loader_2_bar": "bar - from Loader 3 - overwrite Loader 2",
"loader_3_bar": "bar - from Loader 3",
"key": "value - from Loader 3",
},
config,
)
}
func testMultiLoaderReturnsLoadErr(t *testing.T) {
t.Parallel()
// arrange
var (
expectedLoader1Err = errors.New("loader 1 intentionally triggered error")
expectedLoader3Err = errors.New("loader 3 intentionally triggered error")
loader1 = xconf.LoaderFunc(func() (map[string]any, error) {
return nil, expectedLoader1Err
})
loader2 = xconf.PlainLoader(map[string]any{
"foo": "bar",
})
loader3 = xconf.LoaderFunc(func() (map[string]any, error) {
return nil, expectedLoader3Err
})
subject = xconf.NewMultiLoader(false, loader1, loader2, loader3)
)
// act
config, err := subject.Load()
// assert
assertTrue(t, errors.Is(err, expectedLoader1Err))
assertTrue(t, errors.Is(err, expectedLoader3Err))
assertNil(t, config)
}
func testMultiLoaderReturnsKeyConflictErr(t *testing.T) {
t.Parallel()
// arrange
var (
loader1 = xconf.PlainLoader(map[string]any{
"foo": "bar",
"x": "y",
})
loader2 = xconf.PlainLoader(map[string]any{
"foo": "same key as for Loader 1",
})
loader3 = xconf.PlainLoader(map[string]any{
"abc": "xyz",
})
subject = xconf.NewMultiLoader(false, loader1, loader2, loader3)
)
// act
config, err := subject.Load()
// assert
assertNil(t, config)
if assertNotNil(t, err) {
var conflictErr xconf.KeyConflictError
assertTrue(t, errors.As(err, &conflictErr))
assertEqual(t, `key "foo" already exists`, conflictErr.Error())
}
}
func testMultiLoaderReturnsSafeMutableConfigMap(t *testing.T) {
t.Parallel()
// arrange
var (
loader1 = xconf.PlainLoader(map[string]any{
"multi_string": "some string",
"multi_slice": []any{"foo", "bar", "baz"},
})
loader2 = xconf.PlainLoader(map[string]any{
"multi_map": map[string]any{
"foo": "bar",
},
})
subject = xconf.NewMultiLoader(true, loader1, loader2)
expectedConfig = map[string]any{
"multi_string": "some string",
"multi_slice": []any{"foo", "bar", "baz"},
"multi_map": map[string]any{"foo": "bar"},
}
)
// act
config1, err1 := subject.Load()
// assert
assertNil(t, err1)
assertEqual(t, expectedConfig, config1)
// modify first returned value, expect second returned value to be initial one.
config1["multi_int"] = 3333
config1["multi_string"] = "test multi string"
config1["multi_slice"].([]any)[0] = "test multi slice"
config1["multi_map"].(map[string]any)["foo"] = "test multi map"
// act
config2, err2 := subject.Load()
// assert
assertNil(t, err2)
assertEqual(t, expectedConfig, config2)
assertEqual(
t,
map[string]any{
"multi_string": "some string",
"multi_slice": []any{"foo", "bar", "baz"},
"multi_map": map[string]any{"foo": "bar"},
},
expectedConfig,
)
}
func benchmarkMultiLoader(allowKeyOverwrite bool) func(b *testing.B) {
return func(b *testing.B) {
b.Helper()
loader1 := xconf.PlainLoader(map[string]any{
"loader_1": "Loader 1",
})
loader2 := xconf.PlainLoader(map[string]any{
"loader_2": "Loader 2",
})
loader3 := xconf.PlainLoader(map[string]any{
"loader_3": "Loader 3",
})
subject := xconf.NewMultiLoader(allowKeyOverwrite, loader1, loader2, loader3)
b.ReportAllocs()
b.ResetTimer()
for n := 0; n < b.N; n++ {
_, err := subject.Load()
if err != nil {
b.Error(err)
}
}
}
}
func BenchmarkMultiLoader_withAllowingKeyOverwrite(b *testing.B) {
benchmarkMultiLoader(true)(b)
}
func BenchmarkMultiLoader_withoutAllowingKeyOverwrite(b *testing.B) {
benchmarkMultiLoader(false)(b)
}
func ExampleMultiLoader() {
loader := xconf.NewMultiLoader(
true, // allow key overwrite
xconf.PlainLoader(map[string]any{
"json_foo": "bar from plain, will get overwritten",
"yaml_foo": "bar from plain, will get overwritten",
"plain_key": "plain value",
}),
xconf.JSONFileLoader("testdata/config.json"),
xconf.YAMLFileLoader("testdata/config.yaml"),
)
configMap, err := loader.Load()
if err != nil {
panic(err)
}
for key, value := range configMap {
fmt.Println(key+":", value)
}
// Unordered output:
// json_foo: bar
// json_year: 2022
// json_temperature: 37.5
// json_shopping_list: [bread milk eggs]
// yaml_foo: bar
// yaml_year: 2022
// yaml_temperature: 37.5
// yaml_shopping_list: [bread milk eggs]
// plain_key: plain value
}