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
|
from __future__ import annotations
import os
import sys
from collections import OrderedDict
from os import environ
import pytest
from dynaconf import settings # noqa
from dynaconf.loaders.env_loader import load
from dynaconf.loaders.env_loader import load_from_env
from dynaconf.loaders.env_loader import write
# GLOBAL ENV VARS
environ["DYNACONF_HOSTNAME"] = "host.com"
environ["DYNACONF_PORT"] = "@int 5000"
environ["DYNACONF_ALIST"] = '@json ["item1", "item2", "item3", 123]'
environ["DYNACONF_ADICT"] = '@json {"key": "value", "int": 42}'
environ["DYNACONF_DEBUG"] = "@bool true"
environ["DYNACONF_MUSTBEFRESH"] = "first"
environ["DYNACONF_MUSTBEALWAYSFRESH"] = "first"
environ["DYNACONF_SHOULDBEFRESHINCONTEXT"] = "first"
environ["DYNACONF_VALUE"] = "@float 42.1"
# environ['FRESH_VARS_FOR_DYNACONF'] = '@json ["MUSTBEALWAYSFRESH"]'
# settings.configure(IGNORE_UNKNOWN_ENVVARS_FOR_DYNACONF=True)
settings.configure(
FRESH_VARS_FOR_DYNACONF=["MUSTBEALWAYSFRESH"],
ROOT_PATH_FOR_DYNACONF=os.path.dirname(os.path.abspath(__file__)),
)
SETTINGS_DATA = OrderedDict()
# Numbers
SETTINGS_DATA["DYNACONF_INTEGER"] = 42
SETTINGS_DATA["DYNACONF_FLOAT"] = 3.14
# Text
# 'DYNACONF_STRING': Hello,
SETTINGS_DATA["DYNACONF_STRING2"] = "Hello"
SETTINGS_DATA["DYNACONF_STRING2_LONG"] = "Hello World!"
SETTINGS_DATA["DYNACONF_BOOL"] = True
SETTINGS_DATA["DYNACONF_BOOL2"] = False
# Use extra quotes to force a string from other type
SETTINGS_DATA["DYNACONF_STRING21"] = '"42"'
SETTINGS_DATA["DYNACONF_STRING22"] = "'true'"
# Arrays must be homogeneous in toml syntax
SETTINGS_DATA["DYNACONF_ARRAY"] = [1, 2, 3]
SETTINGS_DATA["DYNACONF_ARRAY2"] = [1.1, 2.2, 3.3]
SETTINGS_DATA["DYNACONF_ARRAY3"] = ["a", "b", "c"]
# Dictionaries
SETTINGS_DATA["DYNACONF_DICT"] = {"val": 123}
SETTINGS_DATA_GROUND_TRUTH = """DYNACONF_TESTING=true
DYNACONF_INTEGER=42
DYNACONF_FLOAT=3.14
DYNACONF_STRING2=Hello
DYNACONF_STRING2_LONG="Hello World!"
DYNACONF_BOOL=True
DYNACONF_BOOL2=False
DYNACONF_STRING21="42"
DYNACONF_STRING22="true"
DYNACONF_ARRAY="[1, 2, 3]"
DYNACONF_ARRAY2="[1.1, 2.2, 3.3]"
DYNACONF_ARRAY3="[\'a\', \'b\', \'c\']"
DYNACONF_DICT="{\'val\': 123}"
"""
def test_write(tmpdir):
settings_path = tmpdir.join(".env")
write(settings_path, SETTINGS_DATA)
ground_truth = SETTINGS_DATA_GROUND_TRUTH.split("\n")
with open(str(settings_path)) as fp:
lines = fp.readlines()
for idx, line in enumerate(lines):
line = line.strip()
if line.split("=")[0] == "DYNACONF_TESTING":
continue # this key is written by the test itself; skip.
assert line == ground_truth[idx].strip()
def test_env_loader():
assert settings.HOSTNAME == "host.com"
assert settings.PORT == 5000
assert settings.ALIST == ["item1", "item2", "item3", 123]
assert settings.ADICT == {"key": "value", "int": 42}
def test_single_key():
environ["DYNACONF_HOSTNAME"] = "changedhost.com"
load(settings, key="HOSTNAME")
# hostname is reloaded
assert settings.HOSTNAME == "changedhost.com"
def test_dotenv_loader():
assert settings.DOTENV_INT == 1
assert settings.DOTENV_STR == "hello"
assert settings.DOTENV_FLOAT == 4.2
assert settings.DOTENV_BOOL is False
assert settings.DOTENV_JSON == ["1", "2"]
assert settings.DOTENV_NOTE is None
def test_get_fresh():
assert settings.MUSTBEFRESH == "first"
environ["DYNACONF_MUSTBEFRESH"] = "second"
with pytest.raises(AssertionError):
# fresh should now be second
assert settings.exists("MUSTBEFRESH")
assert settings.get_fresh("MUSTBEFRESH") == "first"
assert settings.get_fresh("MUSTBEFRESH") == "second"
environ["DYNACONF_THISMUSTEXIST"] = "@int 1"
# must tnot exist yet (not loaded)
assert settings.exists("THISMUSTEXIST") is False
# must exist because fresh will call loaders
assert settings.exists("THISMUSTEXIST", fresh=True) is True
# loaders run only once
assert settings.get("THISMUSTEXIST") == 1
environ["DYNACONF_THISMUSTEXIST"] = "@int 23"
del environ["DYNACONF_THISMUSTEXIST"]
# this should error because envvar got cleaned
# but it is not, so cleaners should be fixed
assert settings.get_fresh("THISMUSTEXIST") is None
with pytest.raises(AttributeError):
settings.THISMUSTEXIST
with pytest.raises(KeyError):
settings["THISMUSTEXIST"]
environ["DYNACONF_THISMUSTEXIST"] = "@int 23"
load(settings)
assert settings.get("THISMUSTEXIST") == 23
def test_always_fresh():
# assert environ['FRESH_VARS_FOR_DYNACONF'] == '@json ["MUSTBEALWAYSFRESH"]' # noqa
assert settings.FRESH_VARS_FOR_DYNACONF == ["MUSTBEALWAYSFRESH"]
assert settings.MUSTBEALWAYSFRESH == "first"
environ["DYNACONF_MUSTBEALWAYSFRESH"] = "second"
assert settings.MUSTBEALWAYSFRESH == "second"
environ["DYNACONF_MUSTBEALWAYSFRESH"] = "third"
assert settings.MUSTBEALWAYSFRESH == "third"
def test_fresh_context():
assert settings.SHOULDBEFRESHINCONTEXT == "first"
environ["DYNACONF_SHOULDBEFRESHINCONTEXT"] = "second"
assert settings.SHOULDBEFRESHINCONTEXT == "first"
with settings.fresh():
assert settings.get("DOTENV_INT") == 1
assert settings.SHOULDBEFRESHINCONTEXT == "second"
def test_cleaner():
settings.clean()
with pytest.raises(AttributeError):
assert settings.HOSTNAME == "host.com"
def test_empty_string_prefix():
environ["_VALUE"] = "underscored"
load_from_env(
identifier="env_global", key=None, prefix="", obj=settings, silent=True
)
assert settings.VALUE == "underscored"
def test_no_prefix():
environ["VALUE"] = "no_prefix"
load_from_env(
identifier="env_global",
key=None,
prefix=False,
obj=settings,
silent=True,
)
assert settings.VALUE == "no_prefix"
def test_none_as_string_prefix():
environ["NONE_VALUE"] = "none as prefix"
load_from_env(
identifier="env_global",
key=None,
prefix="none",
obj=settings,
silent=True,
)
assert settings.VALUE == "none as prefix"
def test_backwards_compat_using_env_argument():
environ["BLARG_VALUE"] = "BLARG as prefix"
load_from_env(
identifier="env_global",
key=None,
env="BLARG", # renamed to `prefix` on 3.0.0
obj=settings,
silent=True,
)
assert settings.VALUE == "BLARG as prefix"
def test_load_signed_integer():
environ["799_SIGNED_NEG_INT"] = "-1"
environ["799_SIGNED_POS_INT"] = "+1"
load_from_env(
identifier="env_global",
key=None,
prefix="799",
obj=settings,
silent=True,
)
assert settings.SIGNED_NEG_INT == -1
assert settings.SIGNED_POS_INT == 1
def test_env_is_not_str_raises():
with pytest.raises(TypeError):
load_from_env(settings, prefix=int)
with pytest.raises(TypeError):
load_from_env(settings, prefix=True)
def test_can_load_in_to_dict():
os.environ["LOADTODICT"] = "true"
sets = {}
load_from_env(sets, prefix=False, key="LOADTODICT")
assert sets["LOADTODICT"] is True
def clean_environ(prefix):
keys = [k for k in environ if k.startswith(prefix)]
for key in keys:
environ.pop(key)
@pytest.mark.skipif(
sys.platform.startswith("win"),
reason="Windows env vars are case insensitive",
)
def test_load_dunder(clean_env):
"""Test load and merge with dunder settings"""
clean_environ("DYNACONF_DATABASES")
settings.set(
"DATABASES",
{
"default": {
"NAME": "db",
"ENGINE": "module.foo.engine",
"ARGS": {"timeout": 30},
"PORTS": [123, 456],
}
},
)
# change engine
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__ENGINE"] = "other.module"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES.default.ENGINE == "other.module"
# change timeout directly
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__ARGS__timeout"] = "99"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES.default.ARGS.timeout == 99
# add to ARGS
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__ARGS"] = "@merge {retries=10}"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES.default.ARGS.retries == 10
assert settings.DATABASES.default.ARGS.timeout == 99
# Ensure dictionary keeps its format
assert settings.DATABASES == {
"default": {
"NAME": "db",
"ENGINE": "other.module",
"ARGS": {"timeout": 99, "retries": 10},
"PORTS": [123, 456],
}
}
assert "default" in settings["DATABASES"].keys()
assert "DEFAULT" not in settings["DATABASES"].keys()
assert "NAME" in settings["DATABASES"]["default"].keys()
assert "name" not in settings["DATABASES"]["default"].keys()
# Clean args
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__ARGS"] = "{timeout=8}"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES.default.ARGS == {"timeout": 8}
# Make args empty
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__ARGS"] = "{}"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES.default.ARGS == {}
# Remove ARGS key
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__ARGS"] = "@del"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert "ARGS" not in settings.DATABASES.default.keys()
# add to existing PORTS
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__PORTS"] = "@merge [789, 101112]"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert "ARGS" not in settings.DATABASES.default.keys()
assert settings.DATABASES.default.PORTS == [123, 456, 789, 101112]
# reset PORTS
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__PORTS"] = "[789, 101112]"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert "ARGS" not in settings.DATABASES.default.keys()
assert settings.DATABASES.default.PORTS == [789, 101112]
# delete PORTS
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default__PORTS"] = "@del"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert "ARGS" not in settings.DATABASES.default.keys()
assert "PORTS" not in settings.DATABASES.default.keys()
# reset default key
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default"] = "{}"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES.default == {}
# remove default
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__default"] = "@del"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES == {}
# set value to databases
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES__foo"] = "bar"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES == {"foo": "bar"}
# reset databases
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES"] = "{hello='world'}"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES == {"hello": "world"}
# also reset databases
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES"] = "{yes='no'}"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert settings.DATABASES == {"yes": "no"}
# remove databases
clean_environ("DYNACONF_DATABASES")
environ["DYNACONF_DATABASES"] = "@del"
load_from_env(
identifier="env_global",
key=None,
prefix="dynaconf",
obj=settings,
silent=True,
)
assert "DATABASES" not in settings
def test_filtering_unknown_variables():
# Predefine some known variable.
settings.MYCONFIG = "bar"
# Enable environment filtering.
settings.IGNORE_UNKNOWN_ENVVARS_FOR_DYNACONF = True
# Pollute the environment.
environ["IGNOREME"] = "foo"
load_from_env(
obj=settings,
prefix=False,
key=None,
silent=True,
identifier="env_global",
env=False,
)
# Verify the filter works.
assert not settings.get("IGNOREME")
# Smoke test.
assert settings.get("MYCONFIG") == "bar"
def test_filtering_unknown_variables_with_prefix():
# Predefine some known variable.
settings.MYCONFIG = "bar"
# Enable environment filtering.
settings.IGNORE_UNKNOWN_ENVVARS_FOR_DYNACONF = True
# Pollute the environment.
environ["APP_IGNOREME"] = "foo"
# Also change legitimate variable.
environ["APP_MYCONFIG"] = "ham"
load_from_env(
obj=settings,
prefix="APP",
key=None,
silent=True,
identifier="env_global",
env=False,
)
# Verify the filter works.
assert not settings.get("IGNOREME")
# Smoke test.
assert settings.get("MYCONFIG") == "ham"
def test_boolean_fix():
environ["BOOLFIX_CAPITALTRUE"] = "True"
environ["BOOLFIX_CAPITALFALSE"] = "False"
settings.IGNORE_UNKNOWN_ENVVARS_FOR_DYNACONF = False
load_from_env(
obj=settings,
prefix="BOOLFIX",
key=None,
silent=True,
identifier="env_global",
env=False,
)
assert settings.CAPITALTRUE is True
assert settings.CAPITALFALSE is False
|