File: test_toml_loader.py

package info (click to toggle)
python-dynaconf 3.2.12-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,900 kB
  • sloc: python: 21,464; sh: 9; makefile: 4
file content (268 lines) | stat: -rw-r--r-- 7,932 bytes parent folder | download
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
from __future__ import annotations

import pytest

from dynaconf import LazySettings
from dynaconf.loaders.toml_loader import encode_nulls
from dynaconf.loaders.toml_loader import load
from dynaconf.strategies.filtering import PrefixFilter

settings = LazySettings(environments=True, ENV_FOR_DYNACONF="PRODUCTION")


TOML = """
a = "a,b"
[default]
password = "@int 99999"
host = "server.com"
port = "@int 8080"
alist = [
  "item1",
  "item2",
  "@int 23"
]

  [default.service]
  url = "service.com"
  port = 80.0

    [default.service.auth]
    password = "qwerty"
    test = 1234.0

[development]
password = "@int 88888"
host = "devserver.com"

[production]
password = "@int 11111"
HOST = "prodserver.com"

[extra]
password = "@int 77777"

[GLOBAL]
global_value = "global"
"""

TOML2 = """
[global]
secret = "@float 42"
password = 123456.0
host = "othertoml.com"
"""

INVALID_TOML_TO_BE_REMOVED_ON_4_0_0 = """
[global]
secret = "@float 42"
password = 123456.0
host = "othertoml.com"
emojis = "😀😀😀😀"
encoded_variable="This has accents like � and � � � � just to test encoding �"
# The above is not allowed by TOML, but it is allowed by Dynaconf < 4.0.0
"""


TOMLS = [TOML, TOML2]


def test_load_from_toml_with_multiple_envs(tmpdir):
    """Asserts loader can read from TOML when multiple comma separated envs are provided"""
    _settings = LazySettings(environments=True)
    load(_settings, filename=TOML, env="DEVELOPMENT,EXTRA")
    assert _settings.HOST == "devserver.com"  # comes from [development]
    assert _settings.PASSWORD == 77777  # comes from [extra]
    assert _settings.GLOBAL_VALUE == "global"  # comes from [global]


def test_load_from_toml_with_invalid_unicode(tmpdir):
    # THIS TEST MUST FAIL AND BE REMOVED ON 4.0.0
    load(settings, filename=INVALID_TOML_TO_BE_REMOVED_ON_4_0_0)
    assert settings.ENCODED_VARIABLE == (
        "This has accents like � and � � � � just to test encoding �"
    )

    tmpfile = tmpdir.join("settings.toml")
    with open(tmpfile.strpath, "w", encoding="utf-8") as f:
        f.write(INVALID_TOML_TO_BE_REMOVED_ON_4_0_0)

    _settings = LazySettings(
        settings_files=[tmpfile.strpath], environments=True
    )
    assert _settings.ENCODED_VARIABLE == (
        "This has accents like � and � � � � just to test encoding �"
    )
    assert _settings.EMOJIS == "😀😀😀😀"


def test_load_from_toml():
    """Assert loads from TOML string"""
    load(settings, filename=TOML)
    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=TOML, env="DEVELOPMENT")
    assert settings.HOST == "devserver.com"
    load(settings, filename=TOML)
    assert settings.HOST == "prodserver.com"


def test_load_from_multiple_toml():
    """Assert loads from TOML string"""
    load(settings, filename=TOMLS)
    assert settings.HOST == "othertoml.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=TOMLS, env="DEVELOPMENT")
    assert settings.PORT == 8080
    assert settings.HOST == "othertoml.com"
    load(settings, filename=TOMLS)
    assert settings.HOST == "othertoml.com"
    assert settings.PASSWORD == 123456
    load(settings, filename=TOML, env="DEVELOPMENT")
    assert settings.PORT == 8080
    assert settings.HOST == "devserver.com"
    load(settings, filename=TOML)
    assert settings.HOST == "prodserver.com"
    assert settings.PASSWORD == 11111


def test_no_filename_is_none():
    """Assert if passed no filename return is None"""
    assert load(settings) is None


def test_key_error_on_invalid_env():
    """Assert error raised if env is not found in TOML"""
    with pytest.raises(KeyError):
        load(settings, filename=TOML, env="FOOBAR", silent=False)


def test_no_key_error_on_invalid_env():
    """Assert error raised if env is not found in TOML"""
    load(settings, filename=TOML, env="FOOBAR", silent=True)


def test_load_single_key():
    """Test loading a single key"""
    toml = """
    a = "a,b"
    [foo]
    bar = "blaz"
    ZAZ = "naz"
    lowerkey = 'hello'
    UPPERKEY = 'world'
    """
    load(settings, filename=toml, env="FOO", key="bar")
    assert settings.BAR == "blaz"
    assert settings.exists("BAR") is True
    assert settings.exists("ZAZ") is False
    load(settings, filename=toml, env="FOO", key="ZAZ")
    assert settings.ZAZ == "naz"
    load(settings, filename=toml, env="FOO", key="LOWERKEY")
    assert settings.LOWERKEY == "hello"
    load(settings, filename=toml, env="FOO", key="upperkey")
    assert settings.UPPERKEY == "world"


def test_empty_value():
    load(settings, filename="")


def test_multiple_filenames():
    load(settings, filename="a.toml,b.tml,c.toml,d.tml")


def test_cleaner():
    load(settings, filename=TOML)
    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=TOML, env="DEVELOPMENT")
    assert settings.HOST == "devserver.com"
    load(settings, filename=TOML)
    assert settings.HOST == "prodserver.com"

    settings.clean()
    with pytest.raises(AttributeError):
        assert settings.HOST == "prodserver.com"


def test_using_env(tmpdir):
    load(settings, filename=TOML)
    assert settings.HOST == "prodserver.com"

    tmpfile = tmpdir.mkdir("sub").join("test_using_env.toml")
    tmpfile.write(TOML)
    with settings.using_env("DEVELOPMENT", filename=str(tmpfile)):
        assert settings.HOST == "devserver.com"
    assert settings.HOST == "prodserver.com"


def test_load_dunder():
    """Test load with dunder settings"""
    toml = """
    a = "a,b"
    [foo]
    colors__gray__code = '#CCCCCC'
    COLORS__gray__name = 'Gray'
    """
    load(settings, filename=toml, env="FOO")
    assert settings.COLORS.gray.code == "#CCCCCC"
    assert settings.COLORS.gray.name == "Gray"


def test_encode_nulls():
    assert encode_nulls(None) == "@none "
    assert encode_nulls([None, None]) == ["@none ", "@none "]
    assert encode_nulls((None, None)) == ["@none ", "@none "]
    assert encode_nulls({"nullable": None}) == {"nullable": "@none "}
    assert encode_nulls(1) == 1
    assert encode_nulls(1.1) == 1.1
    assert encode_nulls(True) is True
    assert encode_nulls(False) is False
    assert encode_nulls("") == ""
    assert encode_nulls("text") == "text"


def test_envless():
    settings = LazySettings()
    ini = """
    a = "a,b"
    colors__white__code = '#FFFFFF'
    COLORS__white__name = 'white'
    """
    load(settings, filename=ini)
    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"))
    ini = """
    prefix_a = "a,b"
    prefix_colors__white__code = '#FFFFFF'
    COLORS__white__name = 'white'
    """
    load(settings, filename=ini)
    assert settings.a == "a,b"
    assert settings.COLORS.white.code == "#FFFFFF"
    with pytest.raises(AttributeError):
        settings.COLORS.white.name