forked from moriyoshi/envconfig
-
Notifications
You must be signed in to change notification settings - Fork 0
/
envconfig_test.go
806 lines (704 loc) · 22.3 KB
/
envconfig_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
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
// Copyright (c) 2013 Kelsey Hightower. All rights reserved.
// Use of this source code is governed by the MIT License that can be found in
// the LICENSE file.
package envconfig
import (
"flag"
"fmt"
"net/url"
"os"
"testing"
"time"
)
type HonorDecodeInStruct struct {
Value string
}
func (h *HonorDecodeInStruct) Decode(env string) error {
h.Value = "decoded"
return nil
}
type CustomURL struct {
Value *url.URL
}
func (cu *CustomURL) UnmarshalBinary(data []byte) error {
u, err := url.Parse(string(data))
cu.Value = u
return err
}
type Specification struct {
Embedded `envconfig_desc:"can we document a struct"`
EmbeddedButIgnored `envconfig_ignored:"true"`
Debug bool
Port int
Rate float32
User string
TTL uint32
Timeout time.Duration
AdminUsers []string
MagicNumbers []int
ColorCodes map[string]int
MultiWordVar string
MultiWordVarWithAutoSplit uint32 `envconfig_snake:"true"`
SomePointer *string
SomePointerWithDefault *string `envconfig_default:"foo2baz" envconfig_desc:"foorbar is the word"`
MultiWordVarWithAlt string `envconfig:"MULTI_WORD_VAR_WITH_ALT" envconfig_desc:"what alt"`
MultiWordVarWithLowerCaseAlt string `envconfig:"multi_word_var_with_lower_case_alt"`
NoPrefixWithAlt string `envconfig:"SERVICE_HOST"`
DefaultVar string `envconfig_default:"foobar"`
RequiredVar string `envconfig_required:"True"`
NoPrefixDefault string `envconfig:"BROKER" envconfig_default:"127.0.0.1"`
RequiredDefault string `envconfig_required:"true" envconfig_default:"foo2bar"`
Ignored string `envconfig_ignored:"true"`
NestedSpecification struct {
Property string `envconfig:"inner"`
PropertyWithDefault string `envconfig_default:"fuzzybydefault"`
} `envconfig:"outer"`
AfterNested string
DecodeStruct HonorDecodeInStruct `envconfig:"honor"`
Datetime time.Time
MapField map[string]string `envconfig_default:"one:two,three:four"`
UrlValue CustomURL
UrlPointer *CustomURL
CustomSetter string `envconfig_setter:"SetterForCustomSetter"`
}
func (*Specification) SetterForCustomSetter(s *string, value string) error {
*s = value + "???"
return nil
}
type Embedded struct {
Enabled bool `envconfig_desc:"some embedded value"`
EmbeddedPort int
MultiWordVar string
MultiWordVarWithAlt string `envconfig:"MULTI_WITH_DIFFERENT_ALT"`
EmbeddedAlt string `envconfig:"EMBEDDED_WITH_ALT"`
EmbeddedIgnored string `envconfig_ignored:"true"`
}
type EmbeddedButIgnored struct {
FirstEmbeddedButIgnored string
SecondEmbeddedButIgnored string
}
func TestProcess(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_DEBUG", "true")
os.Setenv("ENV_CONFIG_PORT", "8080")
os.Setenv("ENV_CONFIG_RATE", "0.5")
os.Setenv("ENV_CONFIG_USER", "Kelsey")
os.Setenv("ENV_CONFIG_TIMEOUT", "2m")
os.Setenv("ENV_CONFIG_ADMINUSERS", "John,Adam,Will")
os.Setenv("ENV_CONFIG_MAGICNUMBERS", "5,10,20")
os.Setenv("ENV_CONFIG_COLORCODES", "red:1,green:2,blue:3")
os.Setenv("SERVICE_HOST", "127.0.0.1")
os.Setenv("ENV_CONFIG_TTL", "30")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
os.Setenv("ENV_CONFIG_IGNORED", "was-not-ignored")
os.Setenv("ENV_CONFIG_OUTER_INNER", "iamnested")
os.Setenv("ENV_CONFIG_AFTERNESTED", "after")
os.Setenv("ENV_CONFIG_HONOR", "honor")
os.Setenv("ENV_CONFIG_DATETIME", "2016-08-16T18:57:05Z")
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "24")
os.Setenv("ENV_CONFIG_URLVALUE", "https://github.com/kelseyhightower/envconfig")
os.Setenv("ENV_CONFIG_URLPOINTER", "https://github.com/kelseyhightower/envconfig")
os.Setenv("ENV_CONFIG_CUSTOMSETTER", "CUSTOM")
err := Process([]string{"env_config_"}, &s, "_")
if err != nil {
t.Error(err.Error())
}
if s.NoPrefixWithAlt != "127.0.0.1" {
t.Errorf("expected %v, got %v", "127.0.0.1", s.NoPrefixWithAlt)
}
if !s.Debug {
t.Errorf("expected %v, got %v", true, s.Debug)
}
if s.Port != 8080 {
t.Errorf("expected %d, got %v", 8080, s.Port)
}
if s.Rate != 0.5 {
t.Errorf("expected %f, got %v", 0.5, s.Rate)
}
if s.TTL != 30 {
t.Errorf("expected %d, got %v", 30, s.TTL)
}
if s.User != "Kelsey" {
t.Errorf("expected %s, got %s", "Kelsey", s.User)
}
if s.Timeout != 2*time.Minute {
t.Errorf("expected %s, got %s", 2*time.Minute, s.Timeout)
}
if s.RequiredVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.RequiredVar)
}
if len(s.AdminUsers) != 3 ||
s.AdminUsers[0] != "John" ||
s.AdminUsers[1] != "Adam" ||
s.AdminUsers[2] != "Will" {
t.Errorf("expected %#v, got %#v", []string{"John", "Adam", "Will"}, s.AdminUsers)
}
if len(s.MagicNumbers) != 3 ||
s.MagicNumbers[0] != 5 ||
s.MagicNumbers[1] != 10 ||
s.MagicNumbers[2] != 20 {
t.Errorf("expected %#v, got %#v", []int{5, 10, 20}, s.MagicNumbers)
}
if s.Ignored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
if len(s.ColorCodes) != 3 ||
s.ColorCodes["red"] != 1 ||
s.ColorCodes["green"] != 2 ||
s.ColorCodes["blue"] != 3 {
t.Errorf(
"expected %#v, got %#v",
map[string]int{
"red": 1,
"green": 2,
"blue": 3,
},
s.ColorCodes,
)
}
if s.NestedSpecification.Property != "iamnested" {
t.Errorf("expected '%s' string, got %#v", "iamnested", s.NestedSpecification.Property)
}
if s.NestedSpecification.PropertyWithDefault != "fuzzybydefault" {
t.Errorf("expected default '%s' string, got %#v", "fuzzybydefault", s.NestedSpecification.PropertyWithDefault)
}
if s.AfterNested != "after" {
t.Errorf("expected default '%s' string, got %#v", "after", s.AfterNested)
}
if s.DecodeStruct.Value != "decoded" {
t.Errorf("expected default '%s' string, got %#v", "decoded", s.DecodeStruct.Value)
}
if expected := time.Date(2016, 8, 16, 18, 57, 05, 0, time.UTC); !s.Datetime.Equal(expected) {
t.Errorf("expected %s, got %s", expected.Format(time.RFC3339), s.Datetime.Format(time.RFC3339))
}
if s.MultiWordVarWithAutoSplit != 24 {
t.Errorf("expected %q, got %q", 24, s.MultiWordVarWithAutoSplit)
}
u, err := url.Parse("https://github.com/kelseyhightower/envconfig")
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if *s.UrlValue.Value != *u {
t.Errorf("expected %q, got %q", u, s.UrlValue.Value.String())
}
if *s.UrlPointer.Value != *u {
t.Errorf("expected %q, got %q", u, s.UrlPointer.Value.String())
}
if s.CustomSetter != "CUSTOM???" {
t.Errorf("expected %s, got %s", "CUSTOM???", s.CustomSetter)
}
}
func TestParseErrorBool(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_DEBUG", "string")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Debug" {
t.Errorf("expected %s, got %v", "Debug", v.FieldName)
}
if s.Debug != false {
t.Errorf("expected %v, got %v", false, s.Debug)
}
}
func TestParseErrorFloat32(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_RATE", "string")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Rate" {
t.Errorf("expected %s, got %v", "Rate", v.FieldName)
}
if s.Rate != 0 {
t.Errorf("expected %v, got %v", 0, s.Rate)
}
}
func TestParseErrorInt(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_PORT", "string")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Port" {
t.Errorf("expected %s, got %v", "Port", v.FieldName)
}
if s.Port != 0 {
t.Errorf("expected %v, got %v", 0, s.Port)
}
}
func TestParseErrorUint(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_TTL", "-30")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "TTL" {
t.Errorf("expected %s, got %v", "TTL", v.FieldName)
}
if s.TTL != 0 {
t.Errorf("expected %v, got %v", 0, s.TTL)
}
}
func TestParseErrorSplitWords(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "shakespeare")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "MultiWordVarWithAutoSplit" {
t.Errorf("expected %s, got %v", "", v.FieldName)
}
if s.MultiWordVarWithAutoSplit != 0 {
t.Errorf("expected %v, got %v", 0, s.MultiWordVarWithAutoSplit)
}
}
func TestErrInvalidSpecification(t *testing.T) {
m := make(map[string]string)
err := Process([]string{"env_config_"}, &m, "_")
if err != ErrInvalidSpecification {
t.Errorf("expected %v, got %v", ErrInvalidSpecification, err)
}
}
func TestUnsetVars(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("USER", "foo")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
// If the var is not defined the non-prefixed version should not be used
// unless the struct tag says so
if s.User != "" {
t.Errorf("expected %q, got %q", "", s.User)
}
}
func TestAlternateVarNames(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR", "foo")
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_ALT", "bar")
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_LOWER_CASE_ALT", "baz")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
// Setting the alt version of the var in the environment has no effect if
// the struct tag is not supplied
if s.MultiWordVar != "" {
t.Errorf("expected %q, got %q", "", s.MultiWordVar)
}
// Setting the alt version of the var in the environment correctly sets
// the value if the struct tag IS supplied
if s.MultiWordVarWithAlt != "bar" {
t.Errorf("expected %q, got %q", "bar", s.MultiWordVarWithAlt)
}
// Alt value is not case sensitive and is treated as all uppercase
if s.MultiWordVarWithLowerCaseAlt != "baz" {
t.Errorf("expected %q, got %q", "baz", s.MultiWordVarWithLowerCaseAlt)
}
}
func TestRequiredVar(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foobar")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.RequiredVar != "foobar" {
t.Errorf("expected %s, got %s", "foobar", s.RequiredVar)
}
}
func TestRequiredMissing(t *testing.T) {
var s Specification
os.Clearenv()
err := Process([]string{"env_config_"}, &s, "_")
if err == nil {
t.Error("no failure when missing required variable")
}
}
func TestBlankDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "requiredvalue")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.DefaultVar != "foobar" {
t.Errorf("expected %s, got %s", "foobar", s.DefaultVar)
}
if *s.SomePointerWithDefault != "foo2baz" {
t.Errorf("expected %s, got %s", "foo2baz", *s.SomePointerWithDefault)
}
}
func TestNonBlankDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_DEFAULTVAR", "nondefaultval")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "requiredvalue")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.DefaultVar != "nondefaultval" {
t.Errorf("expected %s, got %s", "nondefaultval", s.DefaultVar)
}
}
func TestExplicitBlankDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_DEFAULTVAR", "")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.DefaultVar != "" {
t.Errorf("expected %s, got %s", "\"\"", s.DefaultVar)
}
}
func TestAlternateNameDefaultVar(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("BROKER", "betterbroker")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.NoPrefixDefault != "betterbroker" {
t.Errorf("expected %q, got %q", "betterbroker", s.NoPrefixDefault)
}
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.NoPrefixDefault != "127.0.0.1" {
t.Errorf("expected %q, got %q", "127.0.0.1", s.NoPrefixDefault)
}
}
func TestRequiredDefault(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.RequiredDefault != "foo2bar" {
t.Errorf("expected %q, got %q", "foo2bar", s.RequiredDefault)
}
}
func TestPointerFieldBlank(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.SomePointer != nil {
t.Errorf("expected <nil>, got %q", *s.SomePointer)
}
}
func TestEmptyMapFieldOverride(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
os.Setenv("ENV_CONFIG_MAPFIELD", "")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.MapField == nil {
t.Error("expected empty map, got <nil>")
}
if len(s.MapField) != 0 {
t.Errorf("expected empty map, got map of size %d", len(s.MapField))
}
}
func TestMustProcess(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_DEBUG", "true")
os.Setenv("ENV_CONFIG_PORT", "8080")
os.Setenv("ENV_CONFIG_RATE", "0.5")
os.Setenv("ENV_CONFIG_USER", "Kelsey")
os.Setenv("SERVICE_HOST", "127.0.0.1")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
MustProcess([]string{"env_config_"}, &s, "_")
defer func() {
if err := recover(); err != nil {
return
}
t.Error("expected panic")
}()
m := make(map[string]string)
MustProcess([]string{"env_config_"}, &m, "_")
}
func TestEmbeddedStruct(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "required")
os.Setenv("ENV_CONFIG_ENABLED", "true")
os.Setenv("ENV_CONFIG_EMBEDDEDPORT", "1234")
os.Setenv("ENV_CONFIG_MULTIWORDVAR", "foo")
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_ALT", "bar")
os.Setenv("ENV_CONFIG_MULTI_WITH_DIFFERENT_ALT", "baz")
os.Setenv("ENV_CONFIG_EMBEDDED_WITH_ALT", "foobar")
os.Setenv("ENV_CONFIG_SOMEPOINTER", "foobaz")
os.Setenv("ENV_CONFIG_EMBEDDED_IGNORED", "was-not-ignored")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if !s.Enabled {
t.Errorf("expected %v, got %v", true, s.Enabled)
}
if s.EmbeddedPort != 1234 {
t.Errorf("expected %d, got %v", 1234, s.EmbeddedPort)
}
if s.MultiWordVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.MultiWordVar)
}
if s.Embedded.MultiWordVar != "foo" {
t.Errorf("expected %s, got %s", "foo", s.Embedded.MultiWordVar)
}
if s.MultiWordVarWithAlt != "bar" {
t.Errorf("expected %s, got %s", "bar", s.MultiWordVarWithAlt)
}
if s.Embedded.MultiWordVarWithAlt != "baz" {
t.Errorf("expected %s, got %s", "baz", s.Embedded.MultiWordVarWithAlt)
}
if s.EmbeddedAlt != "foobar" {
t.Errorf("expected %s, got %s", "foobar", s.EmbeddedAlt)
}
if *s.SomePointer != "foobaz" {
t.Errorf("expected %s, got %s", "foobaz", *s.SomePointer)
}
if s.EmbeddedIgnored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
}
func TestEmbeddedButIgnoredStruct(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "required")
os.Setenv("ENV_CONFIG_FIRSTEMBEDDEDBUTIGNORED", "was-not-ignored")
os.Setenv("ENV_CONFIG_SECONDEMBEDDEDBUTIGNORED", "was-not-ignored")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.FirstEmbeddedButIgnored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
if s.SecondEmbeddedButIgnored != "" {
t.Errorf("expected empty string, got %#v", s.Ignored)
}
}
func TestNonPointerFailsProperly(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "snap")
err := Process([]string{"env_config_"}, s, "_")
if err != ErrInvalidSpecification {
t.Errorf("non-pointer should fail with ErrInvalidSpecification, was instead %s", err)
}
}
func TestCustomValueFields(t *testing.T) {
var s struct {
Foo string
Bar bracketed
Baz quoted
Struct setterStruct
}
// Set would panic when the receiver is nil,
// so make sure it has an initial value to replace.
s.Baz = quoted{new(bracketed)}
os.Clearenv()
os.Setenv("ENV_CONFIG_FOO", "foo")
os.Setenv("ENV_CONFIG_BAR", "bar")
os.Setenv("ENV_CONFIG_BAZ", "baz")
os.Setenv("ENV_CONFIG_STRUCT", "inner")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if want := "foo"; s.Foo != want {
t.Errorf("foo: got %#q, want %#q", s.Foo, want)
}
if want := "[bar]"; s.Bar.String() != want {
t.Errorf("bar: got %#q, want %#q", s.Bar, want)
}
if want := `["baz"]`; s.Baz.String() != want {
t.Errorf(`baz: got %#q, want %#q`, s.Baz, want)
}
if want := `setterstruct{"inner"}`; s.Struct.Inner != want {
t.Errorf(`Struct.Inner: got %#q, want %#q`, s.Struct.Inner, want)
}
}
func TestCustomPointerFields(t *testing.T) {
var s struct {
Foo string
Bar *bracketed
Baz *quoted
Struct *setterStruct
}
// Set would panic when the receiver is nil,
// so make sure they have initial values to replace.
s.Bar = new(bracketed)
s.Baz = "ed{new(bracketed)}
os.Clearenv()
os.Setenv("ENV_CONFIG_FOO", "foo")
os.Setenv("ENV_CONFIG_BAR", "bar")
os.Setenv("ENV_CONFIG_BAZ", "baz")
os.Setenv("ENV_CONFIG_STRUCT", "inner")
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if want := "foo"; s.Foo != want {
t.Errorf("foo: got %#q, want %#q", s.Foo, want)
}
if want := "[bar]"; s.Bar.String() != want {
t.Errorf("bar: got %#q, want %#q", s.Bar, want)
}
if want := `["baz"]`; s.Baz.String() != want {
t.Errorf(`baz: got %#q, want %#q`, s.Baz, want)
}
if want := `setterstruct{"inner"}`; s.Struct.Inner != want {
t.Errorf(`Struct.Inner: got %#q, want %#q`, s.Struct.Inner, want)
}
}
func TestEmptyPrefixUsesFieldNames(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("REQUIREDVAR", "foo")
err := Process([]string{}, &s, "_")
if err != nil {
t.Errorf("Process failed: %s", err)
}
if s.RequiredVar != "foo" {
t.Errorf(
`RequiredVar not populated correctly: expected "foo", got %q`,
s.RequiredVar,
)
}
}
func TestNestedStructVarName(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "required")
val := "found with only short name"
os.Setenv("INNER", val)
if err := Process([]string{"env_config_"}, &s, "_"); err != nil {
t.Error(err.Error())
}
if s.NestedSpecification.Property != val {
t.Errorf("expected %s, got %s", val, s.NestedSpecification.Property)
}
}
func TestTextUnmarshalerError(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
os.Setenv("ENV_CONFIG_DATETIME", "I'M NOT A DATE")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Errorf("expected ParseError, got %v", v)
}
if v.FieldName != "Datetime" {
t.Errorf("expected %s, got %v", "Datetime", v.FieldName)
}
expectedLowLevelError := time.ParseError{
Layout: time.RFC3339,
Value: "I'M NOT A DATE",
LayoutElem: "2006",
ValueElem: "I'M NOT A DATE",
}
if v.Err.Error() != expectedLowLevelError.Error() {
t.Errorf("expected %s, got %s", expectedLowLevelError, v.Err)
}
}
func TestBinaryUnmarshalerError(t *testing.T) {
var s Specification
os.Clearenv()
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
os.Setenv("ENV_CONFIG_URLPOINTER", "http://%41:8080/")
err := Process([]string{"env_config_"}, &s, "_")
v, ok := err.(*ParseError)
if !ok {
t.Fatalf("expected ParseError, got %T %v", err, err)
}
if v.FieldName != "UrlPointer" {
t.Errorf("expected %s, got %v", "UrlPointer", v.FieldName)
}
// To be compatible with go 1.5 and lower we should do a very basic check,
// because underlying error message varies in go 1.5 and go 1.6+.
ue, ok := v.Err.(*url.Error)
if !ok {
t.Errorf("expected error type to be \"*url.Error\", got %T", v.Err)
}
if ue.Op != "parse" {
t.Errorf("expected error op to be \"parse\", got %q", ue.Op)
}
}
type bracketed string
func (b *bracketed) Set(value string) error {
*b = bracketed("[" + value + "]")
return nil
}
func (b bracketed) String() string {
return string(b)
}
// quoted is used to test the precedence of Decode over Set.
// The sole field is a flag.Value rather than a setter to validate that
// all flag.Value implementations are also Setter implementations.
type quoted struct{ flag.Value }
func (d quoted) Decode(value string) error {
return d.Set(`"` + value + `"`)
}
type setterStruct struct {
Inner string
}
func (ss *setterStruct) Set(value string) error {
ss.Inner = fmt.Sprintf("setterstruct{%q}", value)
return nil
}
func BenchmarkGatherInfo(b *testing.B) {
os.Clearenv()
os.Setenv("ENV_CONFIG_DEBUG", "true")
os.Setenv("ENV_CONFIG_PORT", "8080")
os.Setenv("ENV_CONFIG_RATE", "0.5")
os.Setenv("ENV_CONFIG_USER", "Kelsey")
os.Setenv("ENV_CONFIG_TIMEOUT", "2m")
os.Setenv("ENV_CONFIG_ADMINUSERS", "John,Adam,Will")
os.Setenv("ENV_CONFIG_MAGICNUMBERS", "5,10,20")
os.Setenv("ENV_CONFIG_COLORCODES", "red:1,green:2,blue:3")
os.Setenv("SERVICE_HOST", "127.0.0.1")
os.Setenv("ENV_CONFIG_TTL", "30")
os.Setenv("ENV_CONFIG_REQUIREDVAR", "foo")
os.Setenv("ENV_CONFIG_IGNORED", "was-not-ignored")
os.Setenv("ENV_CONFIG_OUTER_INNER", "iamnested")
os.Setenv("ENV_CONFIG_AFTERNESTED", "after")
os.Setenv("ENV_CONFIG_HONOR", "honor")
os.Setenv("ENV_CONFIG_DATETIME", "2016-08-16T18:57:05Z")
os.Setenv("ENV_CONFIG_MULTI_WORD_VAR_WITH_AUTO_SPLIT", "24")
for i := 0; i < b.N; i++ {
var s Specification
gatherInfo([]string{"env_config_"}, &s, "_") //nolint:errcheck
}
}