-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathschema_validation_test.go
More file actions
248 lines (200 loc) · 6.65 KB
/
schema_validation_test.go
File metadata and controls
248 lines (200 loc) · 6.65 KB
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
package rigging
import (
"context"
"errors"
"reflect"
"testing"
)
func requireValidationError(t *testing.T, err error) *ValidationError {
t.Helper()
valErr, ok := err.(*ValidationError)
if !ok {
t.Fatalf("expected *ValidationError, got %T", err)
}
return valErr
}
func requireSingleFieldError(t *testing.T, err error) FieldError {
t.Helper()
valErr := requireValidationError(t, err)
if len(valErr.FieldErrors) != 1 {
t.Fatalf("expected 1 field error, got %d: %#v", len(valErr.FieldErrors), valErr.FieldErrors)
}
return valErr.FieldErrors[0]
}
func TestLoad_InvalidTag_UnknownDirective(t *testing.T) {
type Config struct {
Host string `conf:"unknown:value"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.FieldPath != "Host" {
t.Fatalf("expected FieldPath=Host, got %s", fieldErr.FieldPath)
}
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
if fieldErr.Message != `unknown directive "unknown"` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
}
func TestLoad_InvalidTag_InvalidRequiredValue(t *testing.T) {
type Config struct {
Host string `conf:"required:maybe"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
if fieldErr.Message != `invalid required value "maybe": use true or false` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
}
func TestLoad_InvalidTag_InvalidSecretValue(t *testing.T) {
type Config struct {
Host string `conf:"secret:maybe"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
if fieldErr.Message != `invalid secret value "maybe": use true or false` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
}
func TestLoad_InvalidTag_MinMaxConstraints(t *testing.T) {
t.Run("int min", func(t *testing.T) {
type Config struct {
Port int `conf:"min:abc"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Message != `invalid min constraint "abc": must be a valid integer` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
})
t.Run("uint max", func(t *testing.T) {
type Config struct {
Port uint `conf:"max:abc"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Message != `invalid max constraint "abc": must be a valid unsigned integer` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
})
t.Run("float min", func(t *testing.T) {
type Config struct {
Port float64 `conf:"min:abc"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Message != `invalid min constraint "abc": must be a valid number` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
})
t.Run("string max", func(t *testing.T) {
type Config struct {
Name string `conf:"max:abc"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Message != `invalid max constraint "abc": must be a valid integer` {
t.Fatalf("unexpected message: %s", fieldErr.Message)
}
})
}
func TestLoad_InvalidTag_NestedStructField(t *testing.T) {
type Database struct {
Host string
}
type Config struct {
Database Database `conf:"secret:maybe"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.FieldPath != "Database" {
t.Fatalf("expected FieldPath=Database, got %s", fieldErr.FieldPath)
}
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
}
func TestLoad_InvalidTag_UnsetOptionalField(t *testing.T) {
type Config struct {
Timeout Optional[int] `conf:"required:maybe"`
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.FieldPath != "Timeout" {
t.Fatalf("expected FieldPath=Timeout, got %s", fieldErr.FieldPath)
}
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
}
func TestLoad_InvalidTag_OptionalNestedStructField(t *testing.T) {
type TLSConfig struct {
Cert string `conf:"secret:maybe"`
}
type Config struct {
TLS Optional[TLSConfig]
}
_, err := NewLoader[Config]().Load(context.Background())
fieldErr := requireSingleFieldError(t, err)
if fieldErr.FieldPath != "TLS.Cert" {
t.Fatalf("expected FieldPath=TLS.Cert, got %s", fieldErr.FieldPath)
}
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
}
func TestLoad_InvalidTag_PrecedesSourceErrors(t *testing.T) {
type Config struct {
Host string `conf:"required:maybe"`
}
loader := NewLoader[Config]().WithSource(&mockSource{err: context.DeadlineExceeded})
cfg, err := loader.Load(context.Background())
if cfg != nil {
t.Fatal("expected cfg to be nil")
}
fieldErr := requireSingleFieldError(t, err)
if fieldErr.Code != ErrCodeInvalidTag {
t.Fatalf("expected Code=%s, got %s", ErrCodeInvalidTag, fieldErr.Code)
}
if errors.Is(err, context.DeadlineExceeded) {
t.Fatal("schema validation error should take precedence over source errors")
}
}
func TestLoad_InvalidTag_RepeatedLoadsStable(t *testing.T) {
type Config struct {
Host string `conf:"required:maybe"`
}
loader := NewLoader[Config]()
_, err := loader.Load(context.Background())
first := requireSingleFieldError(t, err)
_, err = loader.Load(context.Background())
second := requireSingleFieldError(t, err)
if !reflect.DeepEqual(first, second) {
t.Fatalf("expected repeated loads to return stable errors:\nfirst: %#v\nsecond: %#v", first, second)
}
}
func TestGetSchemaValidationErrors_ReturnsDefensiveCopy(t *testing.T) {
type Config struct {
Host string `conf:"required:maybe"`
}
rootType := reflect.TypeOf(Config{})
first := getSchemaValidationErrors(rootType)
if len(first) != 1 {
t.Fatalf("expected 1 cached error, got %d: %#v", len(first), first)
}
first[0].Message = "mutated"
second := getSchemaValidationErrors(rootType)
if len(second) != 1 {
t.Fatalf("expected 1 cached error, got %d: %#v", len(second), second)
}
if second[0].Message != `invalid required value "maybe": use true or false` {
t.Fatalf("expected defensive copy, got message %q", second[0].Message)
}
}