globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: pydantic-settings nested secret directories are not ready yet

Browse source 
https://github.com/pydantic/pydantic-settings/issues/154
This commit is contained in:
Éloi Rivard 2024-03-29 13:57:00 +01:00
parent 4cd3d51de5
commit bfae3fbe18
No known key found for this signature in database
GPG key ID: 7EDA204EA57DD184
2 changed files with 28 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/configuration.rst
View file

@ -27,12 +27,15 @@ The way environment variables are parsed can be read from the `pydantic-settings
Settings will also be read from a local ``.env`` file if present.
Secret parameters
=================
.. TODO: Uncomment this when pydantic-settings implements nested secrets directories
https://github.com/pydantic/pydantic-settings/issues/154
A ``SECRETS_DIR`` environment variable can be passed as an environment variable, being a path to a directory in which are stored files named after the configuration settings.
Secret parameters
=================
For instance, you can set ``SECRETS_DIR=/run/secrets`` and put your secret key in the file ``/run/secrets/SECRET_KEY``.
A ``SECRETS_DIR`` environment variable can be passed as an environment variable, being a path to a directory in which are stored files named after the configuration settings.
For instance, you can set ``SECRETS_DIR=/run/secrets`` and put your secret key in the file ``/run/secrets/SECRET_KEY``.
Parameters
==========

24
tests/app/test_configuration.py
View file

@ -9,10 +9,11 @@ from canaille.app.configuration import settings_factory
from canaille.app.configuration import validate
def test_configuration_file_suffix(tmp_path, backend, configuration):
def test_configuration_secrets_directory(tmp_path, backend, configuration):
os.environ["SECRETS_DIR"] = str(tmp_path)
file_path = os.path.join(tmp_path, "SECRET_KEY")
with open(file_path, "w") as fd:
secret_key_path = tmp_path / "SECRET_KEY"
with open(secret_key_path, "w") as fd:
fd.write("very-secret")
del configuration["SECRET_KEY"]
@ -22,6 +23,23 @@ def test_configuration_file_suffix(tmp_path, backend, configuration):
del os.environ["SECRETS_DIR"]
@pytest.skip
# Not fully implemented in pydantic-settings yet
# https://github.com/pydantic/pydantic-settings/issues/154
def test_configuration_nestedsecrets_directory(tmp_path, backend, configuration):
os.environ["SECRETS_DIR"] = str(tmp_path)
smtp_password_path = tmp_path / "CANAILLE__SMTP__PASSWORD"
with open(smtp_password_path, "w") as fd:
fd.write("very-very-secret")
del configuration["CANAILLE"]["SMTP"]["PASSWORD"]
app = create_app(configuration)
assert app.config["CANAILLE"]["SMTP"]["PASSWORD"] == "very-very-secret"
del os.environ["SECRETS_DIR"]
def test_configuration_from_environment_vars():
os.environ["SECRET_KEY"] = "very-very-secret"
os.environ["CANAILLE__SMTP__FROM_ADDR"] = "user@mydomain.tld"