-
Notifications
You must be signed in to change notification settings - Fork 0
/
loader_flagset_test.go
168 lines (136 loc) · 3.78 KB
/
loader_flagset_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
// 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 (
"flag"
"fmt"
"io"
"testing"
"github.com/actforgood/xconf"
)
var flagSetConfigMap = map[string]any{
"flag_foo": "bar",
"flag_year": "2022",
"flag_temperature": "37.5",
"flag_shopping_list": "bread,milk,eggs",
}
func TestFlagSetLoader(t *testing.T) {
t.Parallel()
t.Run("success - visit all", testFlagSetLoaderVisitAll)
t.Run("success - visit only set", testFlagSetLoaderVisitOnlySet)
t.Run("success - safe-mutable config map", testFlagSetLoaderReturnsSafeMutableConfigMap)
}
func testFlagSetLoaderVisitAll(t *testing.T) {
t.Parallel()
// arrange
flgSet, err := setUpFlagSet()
requireNil(t, err)
subject := xconf.FlagSetLoader(flgSet)
// act
config, err := subject.Load()
// assert
assertNil(t, err)
assertEqual(t, flagSetConfigMap, config)
}
func testFlagSetLoaderVisitOnlySet(t *testing.T) {
t.Parallel()
// arrange
flgSet, err := setUpFlagSet()
requireNil(t, err)
subject := xconf.FlagSetLoader(flgSet, false)
// act
config, err := subject.Load()
// assert
assertNil(t, err)
assertEqual(
t,
map[string]any{
"flag_foo": "bar",
"flag_temperature": "37.5",
},
config,
)
}
func testFlagSetLoaderReturnsSafeMutableConfigMap(t *testing.T) {
t.Parallel()
// arrange
flgSet, err := setUpFlagSet()
requireNil(t, err)
subject := xconf.FlagSetLoader(flgSet)
// act
config1, err1 := subject.Load()
// assert
assertNil(t, err1)
assertEqual(t, flagSetConfigMap, config1)
// modify first returned value, expect second returned value to be initial one.
config1["flag_foo"] = "test flag string modified"
config1["flag_year"] = "2099"
// act
config2, err2 := subject.Load()
// assert
assertNil(t, err2)
assertEqual(t, flagSetConfigMap, config2)
assertEqual(
t,
map[string]any{
"flag_foo": "bar",
"flag_year": "2022",
"flag_temperature": "37.5",
"flag_shopping_list": "bread,milk,eggs",
},
flagSetConfigMap,
)
}
// setUpFlagSet sets up the flag set used in tests.
func setUpFlagSet() (*flag.FlagSet, error) {
flgSet := flag.NewFlagSet("test-flag-set", flag.ContinueOnError)
flgSet.SetOutput(io.Discard)
_ = flgSet.String("flag_foo", "baz", "foo...")
_ = flgSet.Int("flag_year", 2022, "year...")
_ = flgSet.Float64("flag_temperature", 37.5, "temperature...")
_ = flgSet.String("flag_shopping_list", "bread,milk,eggs", "shopping list...")
args := []string{"-flag_foo=bar", "-flag_temperature=37.5"}
return flgSet, flgSet.Parse(args)
}
func BenchmarkFlagSetLoader(b *testing.B) {
flgSet, err := setUpFlagSet()
if err != nil {
b.Fatal(err)
}
subject := xconf.FlagSetLoader(flgSet)
b.ReportAllocs()
b.ResetTimer()
for n := 0; n < b.N; n++ {
_, err := subject.Load()
if err != nil {
b.Error(err)
}
}
}
func ExampleFlagSetLoader() {
// setup a test flag set
flgSet := flag.NewFlagSet("example-flag-set", flag.ContinueOnError)
_ = flgSet.String("flag_foo", "baz", "foo description")
_ = flgSet.Int("flag_year", 2022, "year description")
_ = flgSet.Float64("flag_temperature", 37.5, "temperature description")
_ = flgSet.String("flag_shopping_list", "bread,milk,eggs", "shopping list description")
args := []string{"-flag_foo=bar", "-flag_temperature=37.5"} // you will usually pass os.Args[1:] here
if err := flgSet.Parse(args); err != nil {
panic(err)
}
loader := xconf.FlagSetLoader(flgSet)
configMap, err := loader.Load()
if err != nil {
panic(err)
}
for key, value := range configMap {
fmt.Println(key+":", value)
}
// Unordered output:
// flag_foo: bar
// flag_year: 2022
// flag_temperature: 37.5
// flag_shopping_list: bread,milk,eggs
}