Merge pull request #151 from Xpirix/local_settings_override

Local settings override

Author: Xpirix

.gitignore

@@ -122,9 +122,10 @@ package-lock.json
 webpack-stats.json
 qgisfeedproject/static/bundles
 !qgisfeedproject/qgisfeedproject/settings_local.py.templ
+qgisfeedproject/qgisfeedproject/settings_local_override.py
 
 # Sustaining members template
 qgisfeedproject/templates/layouts/sustaining_members.html
 
 .vscode
-.vscode-extensions
+.vscode-extensions

CONTRIBUTING.md

@@ -71,6 +71,7 @@ TODO: Install all dependecies when running nix-shell.
 $ make dev-build
 ```
 
+#### Environment setup
 - Create `settings_local.py` int the `qgisfeedproject` directory, configure the media folder as in the example below:
 
 ```python
@@ -105,6 +106,21 @@ See https://docs.djangoproject.com/en/2.2/topics/email/#module-django.core.mail
 QGISFEED_MAX_RECORDS=40  # default value is 20
 ```
 
+**IMPORTANT NOTE**: For new Django variables, please use the `settings_local_override.py` as the `.env` file is not supported by the new production infrastructure.
+
+#### Django Local Settings Override (`settings_local_override.py`)
+
+- Create settings_local_override.py file
+```bash
+$ cp settings_local_override.py.templ settings_local_override.py
+```
+
+- Edit settings_local_override.py file and set your environment variables
+
+**IMPORTANT NOTE**: As we are migrating to a declarative based infrastructure, it is preferable to use the `settings_local_override.py` file for all new Django variables. This file is ignored when commiting so please make sure you define your new variables with an example value (**NOT THE REAL ONE FOR SECRETS AND PASSWORDS**) inside the `settings_local_override.py.templ` file.
+
+#### Spin up the development environment
+
 - Start the docker the container
 ```bash
 $ make dev-start

docker-compose-production-ssl.yml

@@ -57,6 +57,7 @@ services:
       QGISFEED_DOCKER_DBUSER: ${QGISFEED_DOCKER_DBUSER}
       QGISFEED_DOCKER_DBPASSWORD: ${QGISFEED_DOCKER_DBPASSWORD}
       QGIS_FEED_PROD_URL: ${QGIS_FEED_PROD_URL}
+      DJANGO_LOCAL_SETTINGS: ${DJANGO_LOCAL_SETTINGS:-settings_local_override.py}
       DEFAULT_FROM_EMAIL: ${DEFAULT_FROM_EMAIL:-automation}
       EMAIL_BACKEND: ${EMAIL_BACKEND}
       EMAIL_HOST: ${EMAIL_HOST}

docker-compose-production.yml

@@ -57,6 +57,7 @@ services:
       QGISFEED_DOCKER_DBUSER: ${QGISFEED_DOCKER_DBUSER}
       QGISFEED_DOCKER_DBPASSWORD: ${QGISFEED_DOCKER_DBPASSWORD}
       QGIS_FEED_PROD_URL: ${QGIS_FEED_PROD_URL}
+      DJANGO_LOCAL_SETTINGS: ${DJANGO_LOCAL_SETTINGS:-settings_local_override.py}
       DEFAULT_FROM_EMAIL: ${DEFAULT_FROM_EMAIL:-automation}
       EMAIL_BACKEND: ${EMAIL_BACKEND}
       EMAIL_HOST: ${EMAIL_HOST}

docker-compose.dev.yml

@@ -26,6 +26,7 @@ services:
       QGISFEED_DOCKER_DBUSER: ${QGISFEED_DOCKER_DBUSER}
       QGISFEED_DOCKER_DBPASSWORD: ${QGISFEED_DOCKER_DBPASSWORD}
       QGIS_FEED_PROD_URL: ${QGIS_FEED_PROD_URL}
+      DJANGO_LOCAL_SETTINGS: ${DJANGO_LOCAL_SETTINGS:-settings_local_override.py}
       DEFAULT_FROM_EMAIL: ${DEFAULT_FROM_EMAIL:-automation}
       EMAIL_BACKEND: ${EMAIL_BACKEND}
       EMAIL_HOST: ${EMAIL_HOST}

env.template

@@ -22,6 +22,15 @@ QGISFEED_DOCKER_DBUSER=docker
 # Database password
 QGISFEED_DOCKER_DBPASSWORD=docker
 
+# (Optional) Full path of the Django local settings override.
+# Any values defined in this file will override values
+# from the existing settings. New variables can also be
+# defined. We can't use settings_local.py because it will be
+# automaticaly replaced by settings_docker_production.py in
+# Production.
+# This variable is mainly usefull for the new infrastructure
+DJANGO_LOCAL_SETTINGS='/path/to/settings_local_override.py'
+
 # Email variables
 EMAIL_BACKEND='django.core.mail.backends.smtp.EmailBackend'
 EMAIL_HOST='smtp.resend.com'

qgisfeedproject/qgisfeedproject/settings.py

@@ -221,3 +221,31 @@
 # Telegram
 TELEGRAM_BOT_TOKEN = os.environ.get("TELEGRAM_BOT_TOKEN", "")
 TELEGRAM_CHAT_ID = os.environ.get("TELEGRAM_CHAT_ID", "")
+
+# Local settings overrides
+# Must be the last!
+DJANGO_LOCAL_SETTINGS = os.environ.get(
+    "DJANGO_LOCAL_SETTINGS", "settings_local_override.py"
+)
+
+try:
+    from pathlib import Path
+
+    local_settings_path = Path(__file__).parent / DJANGO_LOCAL_SETTINGS
+    if local_settings_path.exists():
+        import importlib.util
+
+        spec = importlib.util.spec_from_file_location(
+            "settings_local_override", local_settings_path
+        )
+        settings_local_override = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(settings_local_override)
+        for setting in dir(settings_local_override):
+            if setting.isupper():
+                globals()[setting] = getattr(settings_local_override, setting)
+    else:
+        raise ImportError(
+            f"Local settings file {DJANGO_LOCAL_SETTINGS} does not exist."
+        )
+except ImportError:
+    pass

qgisfeedproject/qgisfeedproject/settings_local_override.py.templ

@@ -0,0 +1,9 @@
+# Host for sending e-mail.
+EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+EMAIL_HOST = 'smtp.resend.com'
+EMAIL_PORT = 587
+EMAIL_USE_TLS = True
+EMAIL_HOST_USER = "resend"
+EMAIL_HOST_PASSWORD = ""
+EMAIL_SUBJECT_PREFIX = '[QGIS Feed] '
+DEFAULT_FROM_EMAIL = 'no-reply-feed@qgis.org'