-
-
Notifications
You must be signed in to change notification settings - Fork 288
/
test_yaml_loader.py
536 lines (463 loc) · 14.4 KB
/
test_yaml_loader.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
from __future__ import annotations
import os
import pytest
from dynaconf import LazySettings
from dynaconf.loaders.yaml_loader import load
from dynaconf.strategies.filtering import PrefixFilter
@pytest.fixture(scope="module")
def settings():
return LazySettings(
environments=True,
ENV_FOR_DYNACONF="PRODUCTION",
# ROOT_PATH_FOR_DYNACONF=os.path.dirname(os.path.abspath(__file__)),
)
YAML = """
# the bellow is just to ensure `,` will not break string YAML
a: 'a,b'
default:
password: 99999
host: server.com
port: 8080
alist:
- item1
- item2
- 23
service:
url: service.com
port: 80
auth:
password: qwerty
test: 1234
development:
password: 88888
host: devserver.com
production:
password: 11111
host: prodserver.com
global:
global_value: global
"""
YAML2 = """
global:
# @float casting not needed, used only for testing
secret: '@float 42'
password: 123456
host: otheryaml.com
"""
YAMLS = [YAML, YAML2]
def test_load_from_yaml(settings):
"""Assert loads from YAML string"""
load(settings, filename=YAML)
assert settings.HOST == "prodserver.com"
assert settings.PORT == 8080
assert settings.ALIST == ["item1", "item2", 23]
assert settings.SERVICE["url"] == "service.com"
assert settings.SERVICE.url == "service.com"
assert settings.SERVICE.port == 80
assert settings.SERVICE.auth.password == "qwerty"
assert settings.SERVICE.auth.test == 1234
load(settings, filename=YAML, env="DEVELOPMENT")
assert settings.HOST == "devserver.com"
load(settings, filename=YAML)
assert settings.HOST == "prodserver.com"
def test_load_from_multiple_yaml(settings):
"""Assert loads from YAML string"""
load(settings, filename=YAMLS)
assert settings.HOST == "otheryaml.com"
assert settings.PASSWORD == 123456
assert settings.SECRET == 42.0
assert settings.PORT == 8080
assert settings.SERVICE["url"] == "service.com"
assert settings.SERVICE.url == "service.com"
assert settings.SERVICE.port == 80
assert settings.SERVICE.auth.password == "qwerty"
assert settings.SERVICE.auth.test == 1234
load(settings, filename=YAMLS, env="DEVELOPMENT")
assert settings.PORT == 8080
assert settings.HOST == "otheryaml.com"
load(settings, filename=YAMLS)
assert settings.HOST == "otheryaml.com"
assert settings.PASSWORD == 123456
load(settings, filename=YAML, env="DEVELOPMENT")
assert settings.PORT == 8080
assert settings.HOST == "devserver.com"
load(settings, filename=YAML)
assert settings.HOST == "prodserver.com"
assert settings.PASSWORD == 11111
def test_no_filename_is_none(settings):
"""Assert if passed no filename return is None"""
assert load(settings) is None
def test_key_error_on_invalid_env(settings):
"""Assert error raised if env is not found in YAML"""
with pytest.raises(KeyError):
load(settings, filename=YAML, env="FOOBAR", silent=False)
def test_no_key_error_on_invalid_env(settings):
"""Assert error raised if env is not found in YAML"""
load(settings, filename=YAML, env="FOOBAR", silent=True)
def test_load_single_key(settings):
"""Test loading a single key"""
yaml = """
foo:
bar: blaz
zaz: naz
"""
load(settings, filename=yaml, env="FOO", key="bar")
assert settings.BAR == "blaz"
assert settings.exists("BAR") is True
assert settings.exists("ZAZ") is False
def test_extra_yaml(settings):
"""Test loading extra yaml file"""
load(settings, filename=YAML)
yaml = """
example:
helloexample: world
"""
settings.set("YAML", yaml)
settings.execute_loaders(env="EXAMPLE")
assert settings.HELLOEXAMPLE == "world"
def test_empty_value(settings):
load(settings, filename="")
def test_multiple_filenames(settings):
load(settings, filename="a.yaml,b.yml,c.yaml,d.yml")
def test_cleaner(settings):
load(settings, filename=YAML)
assert settings.HOST == "prodserver.com"
assert settings.PORT == 8080
assert settings.ALIST == ["item1", "item2", 23]
assert settings.SERVICE["url"] == "service.com"
assert settings.SERVICE.url == "service.com"
assert settings.SERVICE.port == 80
assert settings.SERVICE.auth.password == "qwerty"
assert settings.SERVICE.auth.test == 1234
load(settings, filename=YAML, env="DEVELOPMENT")
assert settings.HOST == "devserver.com"
load(settings, filename=YAML)
assert settings.HOST == "prodserver.com"
settings.clean()
with pytest.raises(AttributeError):
assert settings.HOST == "prodserver.com"
def test_using_env(tmpdir, settings):
load(settings, filename=YAML)
assert settings.HOST == "prodserver.com"
tmpfile = tmpdir.mkdir("sub").join("test_using_env.yaml")
tmpfile.write(YAML)
with settings.using_env("DEVELOPMENT", filename=str(tmpfile)):
assert settings.HOST == "devserver.com"
assert settings.HOST == "prodserver.com"
def test_load_dunder(settings):
"""Test load with dunder settings"""
yaml = """
foo:
bar: blaz
zaz: naz
colors__black__code: '#000000'
COLORS__black__name: Black
"""
load(settings, filename=yaml, env="FOO")
assert settings.COLORS.black.code == "#000000"
assert settings.COLORS.black.name == "Black"
def test_local_files(tmpdir):
settings_file_yaml = """
default:
name: Bruno
colors:
- green
- blue
data:
link: brunorocha.org
other:
foo: bar
music:
current:
volume: 10
title: The Beatles - Strawberry Fields
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
local_file_yaml = """
default:
name: Bruno Rocha
colors:
- red
- dynaconf_merge
data:
city: Guarulhos
dynaconf_merge: true
other:
baz: zaz
music__current__volume: 100
music__current__title: Led Zeppelin - Immigrant Song
"""
tmpdir.join("settings.local.yaml").write(local_file_yaml)
conf = LazySettings(environments=True, settings_file="settings.yaml")
assert conf.NAME == "Bruno Rocha"
assert set(conf.COLORS) == {"red", "green", "blue"}
assert conf.DATA.link == "brunorocha.org"
assert conf.DATA.city == "Guarulhos"
assert conf.OTHER == {"baz": "zaz"}
assert conf.MUSIC.current.volume == 100
assert conf.MUSIC.current.title == "Led Zeppelin - Immigrant Song"
def test_explicit_local_files(tmpdir):
settings_file_yaml = """
default:
name: Bruno
colors:
- green
- blue
data:
link: brunorocha.org
other:
foo: bar
music:
current:
volume: 10
title: The Beatles - Strawberry Fields
"""
tmpdir.join("foo.yaml").write(settings_file_yaml)
local_file_yaml = """
default:
name: Bruno Rocha
colors:
- red
- dynaconf_merge
data:
city: Guarulhos
dynaconf_merge: true
other:
baz: zaz
music__current__volume: 100
music__current__title: Led Zeppelin - Immigrant Song
music__current__even__inner__element: true
"""
tmpdir.join("foo.local.yaml").write(local_file_yaml)
conf = LazySettings(
environments=True,
SETTINGS_FILE_FOR_DYNACONF=["foo.yaml", "foo.local.yaml"],
)
assert conf.NAME == "Bruno Rocha"
assert set(conf.COLORS) == {"red", "green", "blue"}
assert conf.DATA.link == "brunorocha.org"
assert conf.DATA.city == "Guarulhos"
assert conf.OTHER == {"baz": "zaz"}
assert conf.MUSIC.current.volume == 100
assert conf.MUSIC.current.title == "Led Zeppelin - Immigrant Song"
assert conf.get("music.current.even.inner.element") is True
def test_envless():
settings = LazySettings()
_yaml = """
a: a,b
colors__white__code: "#FFFFFF"
COLORS__white__name: "white"
"""
load(settings, filename=_yaml)
assert settings.a == "a,b"
assert settings.COLORS.white.code == "#FFFFFF"
assert settings.COLORS.white.name == "white"
def test_prefix():
settings = LazySettings(filter_strategy=PrefixFilter("prefix"))
_yaml = """
prefix_a: a,b
prefix_colors__white__code: "#FFFFFF"
COLORS__white__name: "white"
"""
load(settings, filename=_yaml)
assert settings.a == "a,b"
assert settings.COLORS.white.code == "#FFFFFF"
with pytest.raises(AttributeError):
settings.COLORS.white.name
def test_empty_env():
settings = LazySettings(environments=True)
_yaml = """
default:
foo: bar
development:
"""
load(settings, filename=_yaml)
assert settings.FOO == "bar"
def test_empty_env_from_file(tmpdir):
"""Assert empty env is not crashing on load."""
settings_file_yaml = """
default:
foo: bar
development: ~
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
settings = LazySettings(environments=True, settings_file="settings.yaml")
settings.reload()
assert settings.FOO == "bar"
def test_merge_unique_in_a_first_level(tmpdir):
"""Assert merge unique in a first level."""
settings_file_yaml = """
default:
colors: "@merge_unique green,blue"
non_exist: "@merge_unique item1,item2"
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
settings = LazySettings(
environments=True,
settings_file="settings.yaml",
COLORS=["red", "green"],
)
settings.reload()
assert settings.COLORS == ["red", "green", "blue"]
assert settings.NON_EXIST == ["item1", "item2"]
def test_should_not_merge_if_merge_is_not_explicit_set(tmpdir):
"""Should not merge if merge is not explicit set."""
settings_file_yaml = """
default:
SOME_KEY: "value"
SOME_LIST:
- "item_1"
- "item_2"
- "item_3"
other:
SOME_KEY: "new_value"
SOME_LIST:
- "item_4"
- "item_5"
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
settings = LazySettings(
environments=True,
settings_files=["settings.yaml"],
)
settings.reload()
assert settings.SOME_KEY == "value"
assert settings.SOME_LIST == ["item_1", "item_2", "item_3"]
other_settings = settings.from_env("other")
assert other_settings.SOME_KEY == "new_value"
assert other_settings.SOME_LIST == ["item_4", "item_5"]
def test_should_not_duplicate_with_global_merge(tmpdir):
"""Assert merge unique in a first level. Issue #653"""
settings_file_yaml = """
default:
SOME_KEY: "value"
SOME_LIST:
- "item_1"
- "item_2"
- "item_3"
other:
SOME_KEY: "new_value"
SOME_LIST:
- "item_4"
- "item_5"
even_other:
SOME_KEY: "new_value_2"
SOME_LIST:
- "item_6"
- "item_7"
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
settings = LazySettings(
environments=True, settings_files=["settings.yaml"], merge_enabled=True
)
# settings.reload()
assert settings.SOME_KEY == "value"
assert settings.SOME_LIST == ["item_1", "item_2", "item_3"]
other_settings = settings.from_env("other")
assert other_settings.SOME_KEY == "new_value"
assert other_settings.SOME_LIST == [
"item_1",
"item_2",
"item_3",
"item_4",
"item_5",
]
def test_should_duplicate_when_explicit_set(tmpdir):
"""Issue #653"""
settings_file_yaml = """
default:
SCRIPTS:
- "script1.sh"
- "script2.sh"
- "script3.sh"
other:
SCRIPTS:
- "script4.sh"
- "script1.sh"
- "dynaconf_merge"
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
settings = LazySettings(
environments=True, settings_files=["settings.yaml"]
)
assert settings.SCRIPTS == [
"script1.sh",
"script2.sh",
"script3.sh",
]
other_settings = settings.from_env("other")
assert other_settings.SCRIPTS == [
"script1.sh",
"script2.sh",
"script3.sh",
"script4.sh",
"script1.sh", # explicit wants to duplicate
]
def test_should_NOT_duplicate_when_explicit_set(tmpdir):
"""Issue #653"""
settings_file_yaml = """
default:
SCRIPTS:
- "script1.sh"
- "script2.sh"
- "script3.sh"
other:
SCRIPTS:
- "script4.sh"
- "script1.sh"
- "dynaconf_merge_unique" # NO DUPLICATE
"""
tmpdir.join("settings.yaml").write(settings_file_yaml)
settings = LazySettings(
environments=True, settings_files=["settings.yaml"]
)
assert settings.SCRIPTS == [
"script1.sh",
"script2.sh",
"script3.sh",
]
other_settings = settings.from_env("other")
assert other_settings.SCRIPTS == [
"script2.sh",
"script3.sh",
"script4.sh",
"script1.sh",
# merge_unique does not duplicate, but overrides the order
]
def test_empty_yaml_key_overriding(tmpdir):
new_key_value = "new_key_value"
os.environ["DYNACONF_LEVEL1__KEY"] = new_key_value
os.environ["DYNACONF_LEVEL1__KEY2"] = new_key_value
os.environ["DYNACONF_LEVEL1__key3"] = new_key_value
os.environ["DYNACONF_LEVEL1__KEY4"] = new_key_value
os.environ["DYNACONF_LEVEL1__KEY5"] = new_key_value
tmpdir.join("test.yml").write(
"""
level1:
key: key_value
KEY2:
key3:
keY4:
"""
)
for merge_state in (True, False):
_settings = LazySettings(
settings_files=["test.yml"], merge_enabled=merge_state
)
assert _settings.level1.key == new_key_value
assert _settings.level1.key2 == new_key_value
assert _settings.level1.key3 == new_key_value
assert _settings.level1.get("KEY4") == new_key_value
assert _settings.level1.get("key4") == new_key_value
assert _settings.level1.get("keY4") == new_key_value
assert _settings.level1.get("keY6", "foo") == "foo"
assert _settings.level1.get("KEY6", "bar") == "bar"
assert _settings.level1["Key4"] == new_key_value
assert _settings.level1.Key4 == new_key_value
assert _settings.level1.KEy4 == new_key_value
assert _settings.level1.KEY4 == new_key_value
assert _settings.level1.key4 == new_key_value
with pytest.raises(AttributeError):
_settings.level1.key6
_settings.level1.key7
_settings.level1.KEY8