✨(configuration) add configuration Value to support file path in environment

Author: soyouzpanda

pyproject.toml

@@ -24,6 +24,7 @@ classifiers = [
 ]
 dependencies = [
     "django>=5.0",
+    "django-configurations>=2.5.1",
     "djangorestframework>=3.15.2",
     "mozilla-django-oidc>=4.0.1",
     "joserfc>=1.0.4",

src/lasuite/configuration/values.py

@@ -0,0 +1,47 @@
+import os
+from configurations import values
+
+
+class SecretFileValue(values.Value):
+    """
+    Class used to interpret value from environment variables with reading file support.
+
+    The value set is either (in order of priority):
+    * The content of the file referenced by the environment variable
+      `{name}_{file_suffix}` if set.
+    * The value of the environment variable `{name}` if set.
+    * The default value
+    """
+
+    file_suffix = 'FILE'
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if 'file_suffix' in kwargs:
+            self.file_suffix = kwargs['file_suffix']
+
+    def setup(self, name):
+        value = self.default
+        if self.environ:
+            full_environ_name = self.full_environ_name(name)
+            full_environ_name_file = f'{full_environ_name}_{self.file_suffix}'
+            if full_environ_name_file in os.environ:
+                filename = os.environ[full_environ_name_file]
+                if not os.path.exists(filename):
+                    raise ValueError(
+                        'Path {0!r} does not exist.'.format(filename))
+                try:
+                    file = open(filename, 'r')
+                    value = self.to_python(file.read().removesuffix("\n"))
+                    file.close()
+                except:
+                    raise ValueError(
+                        'Path {0!r} cannot be read.'.format(filename))
+            elif full_environ_name in os.environ:
+                value = self.to_python(os.environ[full_environ_name])
+            elif self.environ_required:
+                raise ValueError('Value {0!r} is required to be set as the '
+                                 'environment variable {1!r} or {2!r}'
+                                 .format(name, full_environ_name_file, full_environ_name))
+        self.value = value
+        return value

tests/configuration/__init__.py

@@ -0,0 +1 @@
+"""Configuration tests"""

tests/configuration/test_secret

@@ -0,0 +1 @@
+TestSecretInFile

tests/configuration/test_secret_file.py

@@ -0,0 +1,52 @@
+"""Tests for SecretFileValue"""
+
+import os
+
+from unittest import mock
+from lasuite.configuration.values import SecretFileValue
+
+
+@mock.patch.dict(os.environ, clear=True)
+def test_secret_default():
+    value = SecretFileValue("DefaultTestSecret")
+    assert value.setup('TEST_SECRET_KEY') == "DefaultTestSecret"
+
+
+@mock.patch.dict(os.environ, clear=True,
+                 DJANGO_TEST_SECRET_KEY='TestSecretInEnv')
+def test_secret_in_env():
+    value = SecretFileValue("DefaultTestSecret")
+    assert os.environ["DJANGO_TEST_SECRET_KEY"] == 'TestSecretInEnv'
+    assert value.setup('TEST_SECRET_KEY') == "TestSecretInEnv"
+
+
+@mock.patch.dict(os.environ, clear=True,
+                 DJANGO_TEST_SECRET_KEY_FILE=os.path.join(os.path.dirname(os.path.realpath(__file__)), 'test_secret'))
+def test_secret_in_file():
+    value = SecretFileValue("DefaultTestSecret")
+    assert os.environ["DJANGO_TEST_SECRET_KEY_FILE"] == os.path.join(
+        os.path.dirname(os.path.realpath(__file__)), 'test_secret')
+    assert value.setup('TEST_SECRET_KEY') == "TestSecretInFile"
+
+
+@mock.patch.dict(os.environ, clear=True)
+def test_secret_default_suffix():
+    value = SecretFileValue("DefaultTestSecret", file_suffix='PATH')
+    assert value.setup('TEST_SECRET_KEY') == "DefaultTestSecret"
+
+
+@mock.patch.dict(os.environ, clear=True,
+                 DJANGO_TEST_SECRET_KEY='TestSecretInEnv')
+def test_secret_in_env_suffix():
+    value = SecretFileValue("DefaultTestSecret", file_suffix='PATH')
+    assert os.environ["DJANGO_TEST_SECRET_KEY"] == 'TestSecretInEnv'
+    assert value.setup('TEST_SECRET_KEY') == "TestSecretInEnv"
+
+
+@mock.patch.dict(os.environ, clear=True,
+                 DJANGO_TEST_SECRET_KEY_PATH=os.path.join(os.path.dirname(os.path.realpath(__file__)), 'test_secret'))
+def test_secret_in_file_suffix():
+    value = SecretFileValue("DefaultTestSecret", file_suffix='PATH')
+    assert os.environ["DJANGO_TEST_SECRET_KEY_PATH"] == os.path.join(
+        os.path.dirname(os.path.realpath(__file__)), 'test_secret')
+    assert value.setup('TEST_SECRET_KEY') == "TestSecretInFile"