-
Notifications
You must be signed in to change notification settings - Fork 5
/
tests.py
1213 lines (970 loc) · 34.4 KB
/
tests.py
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
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import configparser
import errno
import imp
import io
import json
import os
import textwrap
import unittest
import warnings
import toml # requires "pip install toml"
import yaml # requires "pip install pyyaml"
import confix
from confix import AlreadyParsedError
from confix import AlreadyRegisteredError
from confix import Error
from confix import NotParsedError
from confix import RequiredSettingKeyError
from confix import TypesMismatchError
from confix import UnrecognizedSettingKeyError
from confix import ValidationError
from confix import discard
from confix import get_parsed_conf
from confix import isemail
from confix import isin
from confix import isip4
from confix import isip6
from confix import isip46
from confix import isnotin
from confix import istrue
from confix import isurl
from confix import parse
from confix import parse_with_envvars
from confix import register
from confix import schema
THIS_MODULE = os.path.splitext(os.path.basename(__file__))[0]
TESTFN = "$testfile"
def safe_remove(path):
try:
os.remove(path)
except OSError as err:
if err.errno != errno.ENOENT:
raise
# ===================================================================
# base test case and mixin class
# ===================================================================
class BaseTestCase(unittest.TestCase):
def setUp(self):
discard()
self.original_environ = os.environ.copy()
if getattr(self, "TESTFN", None) is not None:
safe_remove(self.TESTFN)
def tearDown(self):
discard()
os.environ.clear()
os.environ.update(self.original_environ)
if getattr(self, "TESTFN", None) is not None:
safe_remove(self.TESTFN)
@classmethod
def write_to_file(cls, content, fname=None):
with open(fname or cls.TESTFN, "w") as f:
f.write(content)
def parse(self, *args, **kwargs):
parse(*args, **kwargs)
def parse_with_envvars(self, *args, **kwargs):
parse_with_envvars(*args, **kwargs)
class BaseMixin:
"""Base class from which mixin classes are derived."""
TESTFN = None
section = None
def setUp(self):
super().setUp()
self.original_section = self.section
def tearDown(self):
super().tearDown()
self.section = self.original_section
def dict_to_file(self, dct):
raise NotImplementedError("must be implemented in subclass")
# --- base tests
def test_empty_conf_file(self):
@register(self.section)
class config:
foo = 1
bar = 2
self.write_to_file(" ")
self.parse(self.TESTFN)
assert config.foo == 1
assert config.bar == 2
def test_conf_file_overrides_key(self):
# Conf file overrides one key, other one should be default.
@register(self.section)
class config:
foo = 1
bar = 2
self.dict_to_file(dict(foo=5))
self.parse(self.TESTFN)
assert config.foo == 5
assert config.bar == 2
def test_conf_file_overrides_all_keys(self):
# Conf file overrides both keys.
@register(self.section)
class config:
foo = 1
bar = 2
self.dict_to_file(dict(foo=5, bar=6))
self.parse(self.TESTFN)
assert config.foo == 5
assert config.bar == 6
def test_unrecognized_key(self):
# Conf file has a key which is not specified in the config class.
@register(self.section)
class config:
foo = 1
bar = 2
self.dict_to_file(dict(foo=5, apple=6))
with self.assertRaises(UnrecognizedSettingKeyError) as cm:
self.parse(self.TESTFN)
assert cm.exception.section == self.section
assert cm.exception.key, "apple"
def test_types_mismatch(self):
# Conf file provides a key with a value whose type is != than
# conf class default type.
@register(self.section)
class config:
foo = 1
bar = 2
self.dict_to_file(dict(foo=5, bar="foo"))
with self.assertRaises(TypesMismatchError) as cm:
self.parse(self.TESTFN)
assert cm.exception.section == self.section
assert cm.exception.key == "bar"
assert cm.exception.default_value == 2
assert cm.exception.new_value == "foo"
# ...Unless we explicitly tell parse() to ignore type mismatch.
self.parse(self.TESTFN, type_check=False)
assert config.foo == 5
assert config.bar == "foo"
def test_types_mismatch_schema_override(self):
# Same as above but schema(type_check=False) should override
# parse(type_check=True).
@register(self.section)
class config:
foo = schema(default=21, type_check=False)
self.dict_to_file(dict(foo="aaa"))
self.parse(self.TESTFN)
discard()
#
@register(self.section)
class config2:
foo = schema(default=21, type_check=True)
self.dict_to_file(dict(foo="aaa"))
with self.assertRaises(TypesMismatchError):
self.parse(self.TESTFN)
def test_base_types(self):
# str, int, float, bool are supposed to be supported by all
# file formats.
@register(self.section)
class config:
some_true_bool = True
some_false_bool = False
some_int = 0
some_str = "foo"
self.dict_to_file(
dict(
some_true_bool=False,
some_false_bool=True,
some_int=1,
some_str="bar",
)
)
self.parse(self.TESTFN)
assert config.some_true_bool is False
assert config.some_false_bool is True
assert config.some_int == 1
assert config.some_str == "bar"
# def test_invalid_yaml_file(self):
# self.dict_to_file('?!?')
# with self.assertRaises(Error) as cm:
# self.parse(self.TESTFN)
# --- test schemas
def test_schema_base(self):
# A schema with no constraints is supposed to be converted into
# its default value after parse().
@register(self.section)
class config:
foo = schema(10)
self.dict_to_file({})
self.parse(self.TESTFN)
assert config.foo == 10
def test_schema_required(self):
# If a schema is required and it's not specified in the config
# file expect an error.
@register(self.section)
class config:
foo = schema(10, required=True)
bar = 2
self.dict_to_file(dict(bar=2))
with self.assertRaises(RequiredSettingKeyError) as cm:
self.parse(self.TESTFN)
assert cm.exception.section == self.section
assert cm.exception.key == "foo"
def test_schema_required_provided(self):
# If a schema is required and it's provided in the conf file
# eveything is cool.
@register(self.section)
class config:
foo = schema(10, required=True)
self.dict_to_file(dict(foo=5))
self.parse(self.TESTFN)
assert config.foo == 5
def test_schemas_w_multi_validators(self):
def fun1(x):
flags.append(1)
return True
def fun2(x):
flags.append(2)
return True
def fun3(x):
flags.append(3)
return True
def fun4(x):
flags.append(4)
return True
@register(self.section)
class config:
overridden = schema(10, validator=[fun1, fun2])
not_overridden = schema(10, validator=[fun3, fun4])
flags = []
self.dict_to_file(dict(overridden=5))
self.parse(self.TESTFN)
assert sorted(flags) == [1, 2, 3, 4]
assert config.overridden == 5
assert config.not_overridden == 10
# --- test validators
def test_validator_ok(self):
@register(self.section)
class config:
foo = schema(10, validator=lambda x: isinstance(x, int))
self.dict_to_file(dict(foo=5))
self.parse(self.TESTFN)
def test_validator_ko(self):
@register(self.section)
class config:
foo = schema(10, validator=lambda x: isinstance(x, str))
self.dict_to_file(dict(foo=5))
with self.assertRaises(ValidationError) as cm:
self.parse(self.TESTFN)
assert cm.exception.section == self.section
assert cm.exception.key == "foo"
assert cm.exception.value == 5
def test_validator_ko_custom_exc_w_message(self):
def validator(value):
raise ValidationError("message")
@register(self.section)
class config:
foo = schema(10, validator=validator)
self.dict_to_file(dict(foo=5))
with self.assertRaises(ValidationError) as cm:
self.parse(self.TESTFN)
# assert cm.exception.section == 'name' # TOD)
assert cm.exception.key == "foo"
assert cm.exception.value == 5
assert cm.exception.msg == "message"
def test_validator_ko_custom_exc_w_no_message(self):
def validator(value):
raise ValidationError
@register(self.section)
class config:
foo = schema(10, validator=validator)
self.dict_to_file(dict(foo=5))
with self.assertRaises(ValidationError) as cm:
self.parse(self.TESTFN)
assert cm.exception.section == self.section
assert cm.exception.key == "foo"
assert cm.exception.value == 5
assert cm.exception.msg is None
assert "with value 5" in str(cm.exception)
# --- test parse_with_envvars
def test_envvars_w_file(self):
# Test both config file and env vars are taken into account.
@register(self.section)
class config:
foo = 1
bar = 2
apple = 3
self.dict_to_file(dict(foo=5))
os.environ["APPLE"] = "10"
self.parse_with_envvars(self.TESTFN)
assert config.foo == 5
assert config.bar == 2
assert config.apple == 10
def test_envvars_precendence_order(self):
# Test env var takes precedence over config file.
@register(self.section)
class config:
foo = 1
self.dict_to_file(dict(foo=5))
os.environ["FOO"] = "6"
self.parse_with_envvars(self.TESTFN)
assert config.foo == 6
def test_envvars_case_sensitive(self):
@register(self.section)
class config:
foo = 1
bar = 2
APPLE = 3
# non-uppercase env vars are supposed to be ignored
os.environ["FoO"] = "10" # noqa
os.environ["BAR"] = "20"
os.environ["APPLE"] = "30"
parse_with_envvars(case_sensitive=True)
assert config.foo == 1
assert config.bar == 2
assert config.APPLE == 30
def test_envvars_case_insensitive(self):
@register(self.section)
class config:
foo = 1
bar = 2
APPLE = 3
PeAr = 4
# non-uppercase env vars are supposed to be ignored
os.environ["FoO"] = "10" # noqa
os.environ["BAR"] = "20"
os.environ["APPLE"] = "30"
os.environ["PEAR"] = "40"
parse_with_envvars(case_sensitive=False)
assert config.foo == 1
assert config.bar == 20
assert config.APPLE == 30
assert config.PeAr == 40
def test_envvars_type_mismatch(self):
@register(self.section)
class config:
some_int = 1
some_float = 0.1
some_bool = True
# int
os.environ["SOME_INT"] = "foo"
with self.assertRaises(TypesMismatchError) as cm:
parse_with_envvars()
assert cm.exception.section == self.section
assert cm.exception.key == "some_int"
assert cm.exception.default_value == 1
assert cm.exception.new_value == "foo"
del os.environ["SOME_INT"]
# float
os.environ["SOME_FLOAT"] = "foo"
with self.assertRaises(TypesMismatchError) as cm:
parse_with_envvars()
assert cm.exception.section == self.section
assert cm.exception.key == "some_float"
assert cm.exception.default_value == 0.1
assert cm.exception.new_value == "foo"
del os.environ["SOME_FLOAT"]
# bool
os.environ["SOME_BOOL"] = "foo"
with self.assertRaises(TypesMismatchError) as cm:
parse_with_envvars()
assert cm.exception.section == self.section
assert cm.exception.key == "some_bool"
assert cm.exception.default_value is True
assert cm.exception.new_value == "foo"
# --- test multiple sections
def test_multisection_multiple(self):
# Define two configuration classes, control them via a single
# conf file defining separate sections.
self.section = None
@register("ftp")
class ftp_config:
port = 21
username = "ftp"
@register("http")
class http_config:
port = 80
username = "www"
self.dict_to_file(
{
"ftp": dict(username="foo"),
"http": dict(username="bar"),
}
)
self.parse(self.TESTFN)
assert ftp_config.port == 21
assert ftp_config.username == "foo"
assert http_config.port == 80
assert http_config.username == "bar"
def test_multisection_invalid_section(self):
# Config file define a section which is not defined in config
# class.
self.section = None
@register("ftp")
class config:
port = 21
username = "ftp"
self.dict_to_file(
{
"http": dict(username="bar"),
}
)
with self.assertRaises(UnrecognizedSettingKeyError) as cm:
self.parse(self.TESTFN)
assert cm.exception.key == "http"
assert cm.exception.new_value == dict(username="bar")
assert cm.exception.section is None
def test_multisection_unrecognized_key(self):
# Config file define a section key which is not defined in config
# class.
self.section = None
@register("ftp")
class config:
port = 21
username = "ftp"
self.dict_to_file(
{
"ftp": dict(password="bar"),
}
)
with self.assertRaises(UnrecognizedSettingKeyError) as cm:
self.parse(self.TESTFN)
assert cm.exception.key == "password"
assert cm.exception.new_value == "bar"
assert cm.exception.section == "ftp"
# ===================================================================
# mixin tests
# ===================================================================
# yaml
class TestYamlMixin(BaseMixin, BaseTestCase):
TESTFN = TESTFN + ".yaml"
def dict_to_file(self, dct):
if self.section:
dct = {self.section: dct}
s = yaml.dump(dct, default_flow_style=False)
self.write_to_file(s)
class TestYamlWithSectionMixin(TestYamlMixin):
section = "name"
# json
class TestJsonMixin(BaseMixin, BaseTestCase):
TESTFN = TESTFN + ".json"
def dict_to_file(self, dct):
if self.section:
dct = {self.section: dct}
self.write_to_file(json.dumps(dct))
class TestJsonWithSectionMixin(TestJsonMixin):
section = "name"
# toml
class TestTomlMixin(BaseMixin, BaseTestCase):
TESTFN = TESTFN + ".toml"
def dict_to_file(self, dct):
if self.section:
dct = {self.section: dct}
s = toml.dumps(dct)
self.write_to_file(s)
class TestTomWithSectionlMixin(TestTomlMixin):
section = "name"
# ini
class TestIniMixin(BaseMixin, BaseTestCase):
TESTFN = TESTFN + "testfile.ini"
section = "name"
def dict_to_file(self, dct):
if not self._testMethodName.startswith("test_multisection"):
dct = {self.section: dct}
config = configparser.RawConfigParser()
for section, values in dct.items():
assert isinstance(section, str)
config.add_section(section)
for key, value in values.items():
config.set(section, key, value)
fl = io.StringIO()
config.write(fl)
fl.seek(0)
content = fl.read()
self.write_to_file(content)
# env vars
class TestEnvVarsMixin(BaseMixin, BaseTestCase):
TESTFN = TESTFN + "testfile.ini"
def setUp(self):
super().setUp()
if self._testMethodName.startswith("test_multisection"):
raise unittest.SkipTest
def parse(self, *args, **kwargs):
parse_with_envvars(**kwargs)
def parse_with_envvars(self, *args, **kwargs):
parse_with_envvars(**kwargs)
def dict_to_file(self, dct):
for k, v in dct.items():
os.environ[k.upper()] = str(v)
@unittest.skip("")
def test_unrecognized_key(self):
# Will fail because var names not matching the default conf
# keys are skipped.
pass
# ===================================================================
# tests for a specific format
# ===================================================================
class TestIni(BaseTestCase):
TESTFN = TESTFN + ".ini"
def test_sectionless_conf(self):
@register()
class config:
foo = 1
self.write_to_file("")
self.assertRaisesRegex(
Error,
"can't parse ini files if a sectionless configuration class",
parse,
self.TESTFN,
)
def test_true_type(self):
for value in ("1", "yes", "true", "on", "YES", "TRUE", "ON"):
@register("name")
class config:
foo = False
self.write_to_file(
textwrap.dedent(
"""
[name]
foo = %s
"""
% (value)
)
)
self.parse(self.TESTFN)
assert config.foo is True
discard()
def test_false_type(self):
for value in ("0", "no", "false", "off", "NO", "FALSE", "OFF"):
@register("name")
class config:
foo = True
self.write_to_file(
textwrap.dedent(
"""
[name]
foo = %s
"""
% (value)
)
)
self.parse(self.TESTFN)
assert config.foo is False
discard()
class TestEnvVars(BaseTestCase):
def test_true_type(self):
for value in ("1", "yes", "true", "on", "YES", "TRUE", "ON"):
@register()
class config:
foo = False
os.environ["FOO"] = value
self.parse_with_envvars()
assert config.foo is True
discard()
def test_false_type(self):
for value in ("0", "no", "false", "off", "NO", "FALSE", "OFF"):
@register("name")
class config:
foo = True
os.environ["FOO"] = value
self.parse_with_envvars()
assert config.foo is False
discard()
# ===================================================================
# test validators
# ===================================================================
class TestValidators(BaseTestCase):
def test_istrue(self):
assert istrue("foo")
self.assertRaises(ValidationError, istrue, "")
def test_isin(self):
self.assertRaises(TypeError, isin, 1)
fun = isin(("1", "2"))
assert fun("1")
assert fun("2")
self.assertRaises(ValidationError, fun, "3")
self.assertRaises(ValueError, isin, [])
def test_isnotin(self):
self.assertRaises(TypeError, isin, 1)
fun = isnotin(("1", "2"))
assert fun("3")
assert fun("4")
self.assertRaises(ValidationError, fun, "2")
self.assertRaisesRegex(TypeError, "is not iterable", isnotin, None)
self.assertRaisesRegex(
ValueError, "sequence can't be empty", isnotin, []
)
def test_isemail(self):
assert isemail("[email protected]")
assert isemail("[email protected]")
self.assertRaises(ValidationError, isemail, "@bar.com")
self.assertRaises(ValidationError, isemail, "foo@bar")
self.assertRaises(ValidationError, isemail, "foo@bar.")
self.assertRaisesRegex(
ValidationError, "expected a string", isemail, None
)
assert isemail("[email protected]")
assert isemail('"email"@domain.com')
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("email@[123.123.123.123]")
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("[email protected]")
assert isemail("[email protected]")
def test_isurl(self):
assert isurl("http://google.com")
assert isurl("http://www.google.com")
assert isurl("http://www.google.com/foo/bar")
assert isurl("https://google.com")
assert isurl("https://www.google.com")
assert isurl("https://www.google.com:80")
assert isurl("https://www.google.com:80")
assert isurl("http://www.2google.com")
assert isurl("http://127.0.0.1")
assert isurl("http://127.0.0.1:8000")
self.assertRaises(ValidationError, isurl, "htt://google.com")
self.assertRaises(ValidationError, isurl, "http://google.com:foo")
self.assertRaises(ValidationError, isurl, "ftp://google.com")
self.assertRaises(ValidationError, isurl, "google.com")
self.assertRaises(ValidationError, isurl, None)
def test_isip4(self, fun=isip4):
assert fun("127.0.0.1")
assert fun("10.0.0.1")
assert fun("255.255.255.255")
self.assertRaises(ValidationError, fun, "10.0.0.1/24")
self.assertRaises(ValidationError, fun, "10.0.0")
self.assertRaises(ValidationError, fun, "256.333.333.333")
self.assertRaisesRegex(ValidationError, "expected a string", fun, None)
self.assertRaises(ValidationError, isip4, "::1")
def test_isip6(self, fun=isip6):
assert fun("::")
assert fun("::1")
assert fun("FE80:0000:0000:0000:0202:B3FF:FE1E:8329")
# http://www.ronnutter.com/ipv6-cheatsheet-on-identifying-valid-
# ipv6-addresses/
self.assertRaises(
ValidationError, fun, "1200::AB00:1234::2552:7777:1313"
)
self.assertRaises(
ValidationError, fun, "1200:0000:AB00:1234:O000:2552:7777:1313"
)
self.assertRaisesRegex(ValidationError, "expected a string", fun, None)
self.assertRaises(ValidationError, isip6, "127.0.0.1")
def test_isip46(self):
self.test_isip4(fun=isip46)
self.test_isip6(fun=isip46)
self.assertRaisesRegex(
ValidationError, "expected a string", isip46, None
)
# ===================================================================
# parse() tests
# ===================================================================
class TestParse(BaseTestCase):
def test_no_conf_file(self):
# parse() is supposed to parse also if no conf file is passed
@register()
class config:
foo = 1
bar = schema(10)
parse()
assert config.foo == 1
assert config.bar == 10
def test_conf_file_w_unknown_ext(self):
# Conf file with unsupported extension.
with open(TESTFN, "w") as f:
f.write("foo")
self.addCleanup(safe_remove, TESTFN)
with self.assertRaises(ValueError) as cm:
parse(TESTFN)
assert "don't know how to parse" in str(cm.exception)
assert "extension not supported" in str(cm.exception)
def test_parser_with_no_file(self):
self.assertRaises(ValueError, parse, file_parser=lambda x: {}) # noqa
def test_no_registered_class(self):
self.assertRaises(Error, parse)
def test_file_like(self):
@register()
class foo:
foo = 1
file = io.StringIO()
with self.assertRaises(Error) as cm:
parse(file)
assert (
str(cm.exception)
== "can't determine file format from a file object with no 'name' "
"attribute"
)
assert (
str(cm.exception)
== "can't determine file format from a file object with no 'name' "
"attribute"
)
file = io.StringIO()
parse(file, file_parser=lambda x: {}) # noqa
def test_parse_called_twice(self):
@register()
class config:
foo = 1
bar = 2
parse()
self.assertRaises(AlreadyParsedError, parse)
self.assertRaises(AlreadyParsedError, parse_with_envvars)
# ===================================================================
# schema() tests
# ===================================================================
class TestSchema(BaseTestCase):
def test_errors(self):
# no default nor required=True
self.assertRaisesRegex(
ValueError, "specify a default value or set required", schema
)
# not callable validator
self.assertRaisesRegex(
TypeError, "not callable", schema, default=10, validator=1
)
self.assertRaisesRegex(
TypeError, "not callable", schema, default=10, validator=["foo"]
)
# ===================================================================
# exception classes tests
# ===================================================================
class TestExceptions(BaseTestCase):
def test_error(self):
exc = Error("foo")
assert str(exc) == "foo"
assert repr(exc) == "foo"
def test_already_parsed_error(self):
exc = AlreadyParsedError()
assert "already parsed" in str(exc)
def test_already_registered_error(self):
exc = AlreadyRegisteredError("foo")
assert "already registered" in str(exc)
assert "foo" in str(exc)
def test_not_parsed_error(self):
exc = NotParsedError()
assert "not parsed" in str(exc)
def test_unrecognized_key_error(self):
exc = UnrecognizedSettingKeyError(
section=None, key="foo", new_value="bar"
)
assert (
str(exc)
== "config file provides setting key 'foo' with value 'bar' but "
"setting key 'foo' is not defined in any of the config classes"
)
@register()
class config:
pass
exc = UnrecognizedSettingKeyError(
section=None, key="foo", new_value="bar"
)
assert (
str(exc)
== "config file provides setting key 'foo' with value 'bar' but "
"setting key 'foo' is not defined in config class %s.%s"
% (config.__module__, config.__name__)
)
def test_required_key_error(self):
exc = RequiredSettingKeyError(None, key="foo")
assert (
str(exc)
== "configuration class requires 'foo' setting key to be specified "
"via config file or environment variable"
)
def test_types_mismatch_error(self):
exc = TypesMismatchError(
section=None, key="foo", default_value=1, new_value="bar"
)
assert (
str(exc)
== "type mismatch for setting key 'foo' (default_value=1, %s) got "
"'bar' (%s)" % (int, str)
)
# ===================================================================
# get_parsed_conf() tests
# ===================================================================
class TestGetParsedConf(BaseTestCase):
def test_root_only(self):
@register()
class root_conf:
root_value = 1
self.assertRaises(NotParsedError, get_parsed_conf)
parse()
assert get_parsed_conf() == {"root_value": 1}
def test_root_plus_sub(self):
@register()
class root_conf:
root_value = 1
@register("sub")
class sub_conf:
sub_value = 1
parse()
assert get_parsed_conf() == {"root_value": 1, "sub": {"sub_value": 1}}
def test_sub_plus_root(self):
@register("sub")
class sub_conf:
sub_value = 1
@register()
class root_conf:
root_value = 1
parse()
assert get_parsed_conf() == {"root_value": 1, "sub": {"sub_value": 1}}