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
|
from __future__ import annotations
import json
import os
import sys
from collections import namedtuple
from pathlib import Path
from textwrap import dedent
import pytest
from dynaconf import add_converter
from dynaconf import default_settings
from dynaconf import Dynaconf
from dynaconf import DynaconfFormatError
from dynaconf.loaders.json_loader import DynaconfEncoder
from dynaconf.utils import build_env_list
from dynaconf.utils import ensure_a_list
from dynaconf.utils import extract_json_objects
from dynaconf.utils import isnamedtupleinstance
from dynaconf.utils import Missing
from dynaconf.utils import missing
from dynaconf.utils import object_merge
from dynaconf.utils import prepare_json
from dynaconf.utils import trimmed_split
from dynaconf.utils import upperfy
from dynaconf.utils.files import find_file
from dynaconf.utils.files import get_local_filename
from dynaconf.utils.parse_conf import boolean_fix
from dynaconf.utils.parse_conf import evaluate_lazy_format
from dynaconf.utils.parse_conf import Formatters
from dynaconf.utils.parse_conf import Lazy
from dynaconf.utils.parse_conf import parse_conf_data
from dynaconf.utils.parse_conf import try_to_encode
from dynaconf.utils.parse_conf import unparse_conf_data
def test_isnamedtupleinstance():
"""Assert that isnamedtupleinstance works as expected"""
Db = namedtuple("Db", ["host", "port"])
assert isnamedtupleinstance(Db(host="localhost", port=3306))
assert not isnamedtupleinstance(dict(host="localhost", port=3306.0))
assert not isnamedtupleinstance(("localhost", "3306"))
class Foo(tuple):
def _fields(self):
return ["a", "b"]
assert not isnamedtupleinstance(Foo())
def test_unparse():
"""Assert bare types are reversed cast"""
assert unparse_conf_data("teste") == "teste"
assert unparse_conf_data(123) == "@int 123"
assert unparse_conf_data(123.4) == "@float 123.4"
assert unparse_conf_data(False) == "@bool False"
assert unparse_conf_data(True) == "@bool True"
assert unparse_conf_data(["a", "b"]) == '@json ["a", "b"]'
assert unparse_conf_data({"name": "Bruno"}) == '@json {"name": "Bruno"}'
assert unparse_conf_data(None) == "@none "
assert unparse_conf_data(Lazy("{foo}")) == "@format {foo}"
def test_cast_bool(settings):
"""Covers https://github.com/dynaconf/dynaconf/issues/14"""
assert parse_conf_data(False, box_settings=settings) is False
assert settings.get("SIMPLE_BOOL", cast="@bool") is False
def test_find_file(tmpdir):
"""
Create a temporary folder structure like the following:
tmpXiWxa5/
└── child1
└── child2
└── child3
└── child4
└── .env
└── app.py
1) Then try to automatically `find_dotenv` starting in `child4`
"""
curr_dir = tmpdir
dirs = []
for f in ["child1", "child2", "child3", "child4"]:
curr_dir = os.path.join(str(curr_dir), f)
dirs.append(curr_dir)
os.mkdir(curr_dir)
child4 = dirs[-1]
assert find_file("file-does-not-exist") == ""
assert find_file("/abs-file-does-not-exist") == ""
for _dir in dirs:
# search for abspath return the same path
assert os.path.isabs(_dir)
assert find_file(_dir) == _dir
# now place a .env file a few levels up and make sure it's found
filename = os.path.join(str(child4), ".env")
with open(
filename, "w", encoding=default_settings.ENCODING_FOR_DYNACONF
) as f:
f.write("TEST=test\n")
assert find_file(project_root=str(child4)) == filename
# skip the inner child4/.env and force the find of /tmp.../.env
assert find_file(
project_root=str(child4), skip_files=[filename]
) == os.path.join(str(tmpdir), ".env")
def test_casting_str(settings):
res = parse_conf_data("@str 7")
assert isinstance(res, str) and res == "7"
settings.set("value", 7)
res = parse_conf_data("@str @jinja {{ this.value }}")(settings)
assert isinstance(res, str) and res == "7"
res = parse_conf_data("@str @format {this.value}")(settings)
assert isinstance(res, str) and res == "7"
def test_casting_int(settings):
res = parse_conf_data("@int 2")
assert isinstance(res, int) and res == 2
settings.set("value", 2)
res = parse_conf_data("@int @jinja {{ this.value }}")(settings)
assert isinstance(res, int) and res == 2
res = parse_conf_data("@int @format {this.value}")(settings)
assert isinstance(res, int) and res == 2
def test_casting_float(settings):
res = parse_conf_data("@float 0.3")
assert isinstance(res, float) and abs(res - 0.3) < 1e-6
settings.set("value", 0.3)
res = parse_conf_data("@float @jinja {{ this.value }}")(settings)
assert isinstance(res, float) and abs(res - 0.3) < 1e-6
res = parse_conf_data("@float @format {this.value}")(settings)
assert isinstance(res, float) and abs(res - 0.3) < 1e-6
def test_casting_bool(settings):
res = parse_conf_data("@bool true")
assert isinstance(res, bool) and res is True
settings.set("value", "true")
res = parse_conf_data("@bool @jinja {{ this.value }}")(settings)
assert isinstance(res, bool) and res is True
settings.set("value", "false")
res = parse_conf_data("@bool @format {this.value}")(settings)
assert isinstance(res, bool) and res is False
def test_casting_json(settings):
res = parse_conf_data("""@json {"FOO": "bar"}""")
assert isinstance(res, dict)
assert "FOO" in res and "bar" in res.values()
# Test how single quotes cases are handled.
# When jinja uses `attr` to render a json string,
# it may convert double quotes to single quotes.
settings.set("value", "{'FOO': 'bar'}")
res = parse_conf_data("@json @jinja {{ this.value }}")(settings)
assert isinstance(res, dict)
assert "FOO" in res and "bar" in res.values()
res = parse_conf_data("@json @format {this.value}")(settings)
assert isinstance(res, dict)
assert "FOO" in res and "bar" in res.values()
# Test jinja rendering a dict
settings.set("value", "OPTION1")
settings.set("OPTION1", {"bar": 1})
settings.set("OPTION2", {"bar": 2})
res = parse_conf_data("@jinja {{ this|attr(this.value) }}")(settings)
assert isinstance(res, str)
res = parse_conf_data("@json @jinja {{ this|attr(this.value) }}")(settings)
assert isinstance(res, dict)
assert "bar" in res and res["bar"] == 1
def test_disable_cast(monkeypatch):
# this casts for int
assert parse_conf_data("@int 42", box_settings={}) == 42
# now gives pure string
with monkeypatch.context() as m:
m.setenv("AUTO_CAST_FOR_DYNACONF", "off")
assert parse_conf_data("@int 42", box_settings={}) == "@int 42"
def test_disable_cast_on_instance():
settings = Dynaconf(auto_cast=False, environments=True)
assert settings.auto_cast_for_dynaconf is False
settings.set("SIMPLE_INT", "@int 42")
assert settings.get("SIMPLE_INT") == "@int 42"
def test_tomlfy(settings):
assert parse_conf_data("1", tomlfy=True, box_settings=settings) == 1
assert parse_conf_data("true", tomlfy=True, box_settings=settings) is True
assert (
parse_conf_data("'true'", tomlfy=True, box_settings=settings) == "true"
)
assert parse_conf_data('"42"', tomlfy=True, box_settings=settings) == "42"
assert parse_conf_data(
"[1, 32, 3]", tomlfy=True, box_settings=settings
) == [1, 32, 3]
assert parse_conf_data(
"[1.1, 32.1, 3.3]", tomlfy=True, box_settings=settings
) == [1.1, 32.1, 3.3]
assert parse_conf_data(
"['a', 'b', 'c']", tomlfy=True, box_settings=settings
) == ["a", "b", "c"]
assert parse_conf_data(
"[true, false]", tomlfy=True, box_settings=settings
) == [True, False]
assert parse_conf_data(
"{key='value', v=1}", tomlfy=True, box_settings=settings
) == {"key": "value", "v": 1}
@pytest.mark.parametrize("test_input", ["something=42"])
def test_tomlfy_unparsable(test_input, settings):
assert (
parse_conf_data(test_input, tomlfy=True, box_settings=settings)
== test_input
)
def test_missing_sentinel():
# The missing singleton should always compare truthfully to itself
assert missing == missing
# new instances of Missing should be equal to each other due to
# explicit __eq__ implementation check for isinstance.
assert missing == Missing()
# The sentinel should not be equal to None, True, or False
assert missing is not None
assert missing is not True
assert missing is not False
# But the explicit typecasting of missing to a bool should evaluate to
# False
assert bool(missing) is False
assert str(missing) == "<dynaconf.missing>"
def test_meta_values(settings):
reset = parse_conf_data(
"@reset [1, 2]", tomlfy=True, box_settings=settings
)
assert reset.value == [1, 2]
assert reset._dynaconf_reset is True
assert "Reset([1, 2])" in repr(reset)
_del = parse_conf_data("@del", tomlfy=True, box_settings=settings)
assert _del.value == ""
assert _del._dynaconf_del is True
assert "Del()" in repr(_del)
def test_merge_existing_list():
existing = ["bruno", "karla"]
object_merge(existing, existing)
# calling twice the same object does not duplicate
assert existing == ["bruno", "karla"]
new = ["erik", "bruno"]
object_merge(existing, new)
assert new == ["bruno", "karla", "erik", "bruno"]
def test_merge_existing_list_unique():
existing = ["bruno", "karla"]
new = ["erik", "bruno"]
object_merge(existing, new, unique=True)
assert new == ["karla", "erik", "bruno"]
def test_merge_existing_dict():
existing = {"host": "localhost", "port": 666}
new = {"user": "admin"}
# calling with same data has no effect
object_merge(existing, existing)
assert existing == {"host": "localhost", "port": 666}
object_merge(existing, new)
assert new == {"host": "localhost", "port": 666, "user": "admin"}
def test_merge_dict_with_meta_values(settings):
existing = {"A": 1, "B": 2, "C": 3}
new = {
"B": parse_conf_data("@del", tomlfy=True, box_settings=settings),
"C": parse_conf_data("4", tomlfy=True, box_settings=settings),
}
object_merge(existing, new)
assert new == {"A": 1, "C": 4}
def test_trimmed_split():
# No sep
assert trimmed_split("hello") == ["hello"]
# a comma sep string
assert trimmed_split("ab.toml,cd.yaml") == ["ab.toml", "cd.yaml"]
# spaces are trimmed
assert trimmed_split(" ab.toml , cd.yaml ") == ["ab.toml", "cd.yaml"]
# a semicollon sep string
assert trimmed_split("ab.toml;cd.yaml") == ["ab.toml", "cd.yaml"]
# semicollon are trimmed
assert trimmed_split(" ab.toml ; cd.yaml ") == ["ab.toml", "cd.yaml"]
# has comma and also semicollon (semicollon has precedence)
assert trimmed_split("ab.toml,cd.yaml;ef.ini") == [
"ab.toml,cd.yaml",
"ef.ini",
]
# has comma and also semicollon (changing precedence)
assert trimmed_split("ab.toml,cd.yaml;ef.ini", seps=(",", ";")) == [
"ab.toml",
"cd.yaml;ef.ini",
]
# using different separator
assert trimmed_split("ab.toml|cd.yaml", seps=("|")) == [
"ab.toml",
"cd.yaml",
]
def test_ensure_a_list():
# No data is empty list
assert ensure_a_list(None) == []
# Sequence types is only converted
assert ensure_a_list([1, 2]) == [1, 2]
assert ensure_a_list((1, 2)) == [1, 2]
assert ensure_a_list({1, 2}) == [1, 2]
# A string is trimmed_split
assert ensure_a_list("ab.toml") == ["ab.toml"]
assert ensure_a_list("ab.toml,cd.toml") == ["ab.toml", "cd.toml"]
assert ensure_a_list("ab.toml;cd.toml") == ["ab.toml", "cd.toml"]
# other types get wrapped in a list
assert ensure_a_list(1) == [1]
def test_get_local_filename():
settings_path = os.path.join("foo", "b", "conf.toml")
local_path = os.path.join("foo", "b", "conf.local.toml")
assert get_local_filename(settings_path) == local_path
def test_upperfy():
assert upperfy("foo") == "FOO"
assert upperfy("foo__bar") == "FOO__bar"
assert upperfy("foo__bar__ZAZ") == "FOO__bar__ZAZ"
assert (
upperfy("foo__bar__ZAZ__naz__TAZ_ZAZ") == "FOO__bar__ZAZ__naz__TAZ_ZAZ"
)
assert upperfy("foo_bar") == "FOO_BAR"
assert upperfy("foo_BAR") == "FOO_BAR"
def test_lazy_format_class():
value = Lazy("{this[FOO]}/bar")
settings = {"FOO": "foo"}
assert value(settings) == "foo/bar"
assert str(value) == value.value
assert repr(value) == f"'@{value.formatter} {value.value}'"
def test_evaluate_lazy_format_decorator(settings):
class Settings:
FOO = "foo"
AUTO_CAST_FOR_DYNACONF = True
@evaluate_lazy_format
def get(self, key, default=None):
if key.endswith("_FOR_DYNACONF"):
return getattr(self, key)
return parse_conf_data("@format {this.FOO}/bar", box_settings=self)
settings = Settings()
assert settings.get("foo") == "foo/bar"
def test_lazy_format_on_settings(settings):
os.environ["ENV_THING"] = "LazyFormat"
settings.set("set_1", "really")
settings.set("lazy", "@format {env[ENV_THING]}/{this[set_1]}/{this.SET_2}")
settings.set("set_2", "works")
assert settings.LAZY == settings.get("lazy") == "LazyFormat/really/works"
def test_lazy_format_class_jinja():
value = Lazy("{{this['FOO']}}/bar", formatter=Formatters.jinja_formatter)
settings = {"FOO": "foo"}
assert value(settings) == "foo/bar"
def test_evaluate_lazy_format_decorator_jinja(settings):
class Settings:
FOO = "foo"
AUTO_CAST_FOR_DYNACONF = True
@evaluate_lazy_format
def get(self, key, default=None):
if key.endswith("_FOR_DYNACONF"):
return getattr(self, key)
return parse_conf_data(
"@jinja {{this.FOO}}/bar", box_settings=settings
)
settings = Settings()
assert settings.get("foo") == "foo/bar"
def test_lazy_format_on_settings_jinja(settings):
os.environ["ENV_THING"] = "LazyFormat"
settings.set("set_1", "really")
settings.set(
"lazy", "@jinja {{env.ENV_THING}}/{{this['set_1']}}/{{this.SET_2}}"
)
settings.set("set_2", "works")
assert settings.LAZY == settings.get("lazy") == "LazyFormat/really/works"
def test_lazy_format_is_json_serializable():
value = Lazy("{this[FOO]}/bar")
assert (
json.dumps({"val": value}, cls=DynaconfEncoder)
== '{"val": "@format {this[FOO]}/bar"}'
)
def test_try_to_encode():
value = Lazy("{this[FOO]}/bar")
assert try_to_encode(value) == "@format {this[FOO]}/bar"
def test_del_raises_on_unwrap(settings):
value = parse_conf_data("@del ", box_settings=settings)
with pytest.raises(ValueError):
value.unwrap()
def test_extract_json():
assert list(extract_json_objects("foo bar")) == []
assert list(extract_json_objects('foo bar {"a": 1}')) == [{"a": 1}]
assert list(extract_json_objects("foo bar {'a': 2{")) == []
assert list(extract_json_objects('{{{"x": {}}}}')) == [{"x": {}}]
def test_env_list():
class Obj(dict):
@property
def current_env(self):
return "other"
assert build_env_list(Obj(), env="OTHER") == [
"default",
"dynaconf",
"other",
"global",
]
def create_file(filename: str, data: str) -> str:
with open(filename, "w", encoding="utf-8") as f:
f.write(dedent(data))
return filename
@pytest.mark.skipif(
sys.platform.startswith("win"),
reason="Doesn't work on windows due to backslash decoding errors",
)
def test_add_converter_path_example(tmp_path):
"""Assert add_converter Path example works"""
add_converter("path", Path)
fn = create_file(
tmp_path / "settings.yaml",
f"""\
my_path: "@path {Path.home()}"
""",
)
settings = Dynaconf(settings_file=fn)
assert isinstance(settings.my_path, Path)
def test_boolean_fix():
"""Assert boolean fix works"""
assert boolean_fix("True") == "true"
assert boolean_fix("False") == "false"
assert boolean_fix("NotOnlyTrue") == "NotOnlyTrue"
assert boolean_fix("TrueNotOnly") == "TrueNotOnly"
assert boolean_fix("FalseNotOnly") == "FalseNotOnly"
assert boolean_fix("NotOnlyFalse") == "NotOnlyFalse"
def test_get_converter(settings):
"""Ensure the work of @get converter"""
settings.set("FOO", 12)
settings.set("BAR", "@get FOO")
assert settings.BAR == settings.FOO == 12
settings.set("ZAZ", "@get RAZ @float 42")
assert settings.ZAZ == 42.0
def test_get_converter_error_when_converting(settings):
"""Malformed declaration errors"""
settings.set("BLA", "@get")
with pytest.raises(DynaconfFormatError):
settings.BLA
@pytest.mark.parametrize(
"input_expected",
[
({"path": Path("foo")}, {"path": "foo"}),
({1: Path("foo")}, {"1": "foo"}),
({True: Path("foo")}, {"True": "foo"}),
([Path("one"), Path("two"), 1, True], ["one", "two", 1, True]),
(1, 1),
(True, True),
("test", "test"),
],
)
def test_prepare_json(input_expected):
data, expected = input_expected
assert prepare_json(data) == expected
|