Update environment variable names

- Changed the variable names to match Platta configuration
- Define all default values in the same place in settings.py
- Define testpaths and remove unnecessary test commands

.github/workflows/test-deviceregistry.yml

@@ -66,11 +66,8 @@ jobs:
           ruff check --output-format=github .
       - name: Test with pytest
         env:
-          DATABASE_HOST: localhost
-          DATABASE_PORT: 5432
+          DJANGO_DB_HOST: localhost
+          DJANGO_DB_PORT: 5432
           MEDIA_ROOT: /tmp
-          PYTEST_ADDOPTS: "--color=yes"
         run: |
-          python manage.py test devices/tests
-          pytest devices/tests/test_api_device.py
-          pytest devices/tests/test_api_devicetype.py
+          pytest

Dockerfile

@@ -6,12 +6,15 @@ ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONUNBUFFERED 1
 
 # Override these in the docker-compose.yml file or elsewhere
-ENV DATABASE_NAME=postgres
-ENV DATABASE_USER=postgres
-ENV DATABASE_PASSWORD=postgres
-ENV DATABASE_HOST=db
-ENV DATABASE_PORT=5432
 
+# PostgreSQL config
+ENV DJANGO_DB_NAME=postgres
+ENV DJANGO_DB_USER=postgres
+ENV DJANGO_DB_PASSWORD=postgres
+ENV DJANGO_DB_HOST=db
+ENV DJANGO_DB_PORT=5432
+
+# Device registry config
 ENV MEDIA_HOME=/media
 ENV DJANGO_SETTINGS_MODULE=deviceregistry.settings
 

deploy/templates/configmap.yaml

@@ -16,9 +16,9 @@ data:
   KAFKA_RAW_DATA_TOPIC_NAME: "{{ .Values.kafka.kafkaRawDataTopicName }}"
   DEVICE_REGISTRY_URL: "{{ .Values.parser.deviceRegistryUrl }}"
   DEVICE_REGISTRY_TOKEN: "{{ .Values.parser.deviceRegistryToken }}"
-  DATABASE_HOST: "{{ .Release.Name }}-{{ .Values.deviceregistry.databaseHost }}"
-  DATABASE_USER: "{{ .Values.deviceregistry.databaseUser }}"
-  DATABASE_PASSWORD: "{{ .Values.deviceregistry.databasePassword }}"
-  DATABASE_PORT: "{{ .Values.deviceregistry.databasePort }}"
+  DJANGO_DB_HOST: "{{ .Release.Name }}-{{ .Values.deviceregistry.databaseHost }}"
+  DJANGO_DB_USER: "{{ .Values.deviceregistry.databaseUser }}"
+  DJANGO_DB_PASSWORD: "{{ .Values.deviceregistry.databasePassword }}"
+  DJANGO_DB_PORT: "{{ .Values.deviceregistry.databasePort }}"
   ALLOWED_HOSTS: "{{ .Values.deviceregistry.allowedHosts | toStrings }}"
   SECRET_KEY: "{{ .Values.deviceregistry.secretKey }}"

deviceregistry/settings.py

@@ -16,7 +16,16 @@
 
 env = environ.Env(
     # set casting, default value
-    DEBUG=(bool, False)
+    DEBUG=(bool, False),
+    SECRET_KEY=(str, "django-insecure-vz&7byj9esv1ncrv(7805g7w%h+-(-k_q82q(woh%1pcxr)^jf"),
+    # Platta uses mSECRET_KEY as the name for the variable.
+    mSECRET_KEY=(str, ""),
+    ALLOWED_HOSTS=(list, ["devreg", "localhost", "127.0.0.1", "[::1]"]),
+    DJANGO_DB_NAME=(str, "postgres"),
+    DJANGO_DB_USER=(str, "postgres"),
+    DJANGO_DB_PASSWORD=(str, "postgres"),
+    DJANGO_DB_HOST=(str, "db"),
+    DJANGO_DB_PORT=(str, 5432)
 )
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
@@ -26,12 +35,13 @@
 # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = env("SECRET_KEY", default="django-insecure-vz&7byj9esv1ncrv(7805g7w%h+-(-k_q82q(woh%1pcxr)^jf")
+# Use mSECRET_KEY if it is defined.
+SECRET_KEY = env("mSECRET_KEY") or env("SECRET_KEY")
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = env("DEBUG")
 
-ALLOWED_HOSTS = env("ALLOWED_HOSTS", default=["devreg", "localhost", "127.0.0.1", "[::1]"])
+ALLOWED_HOSTS = env("ALLOWED_HOSTS")
 
 # Application definition
 
@@ -83,16 +93,26 @@
 # Database https://docs.djangoproject.com/en/4.2/ref/settings/#databases
 DATABASES = {
     "default": {
-        # "ENGINE": "django.db.backends.postgresql",
         "ENGINE": "django.contrib.gis.db.backends.postgis",
-        "NAME": env("DATABASE_NAME", default="postgres"),
-        "USER": env("DATABASE_USER", default="postgres"),
-        "PASSWORD": env("DATABASE_PASSWORD", default="postgres"),
-        "HOST": env("DATABASE_HOST", default="db"),
-        "PORT": env("DATABASE_PORT", default=5432),
+        "NAME": env("DJANGO_DB_NAME"),
+        "USER": env("DJANGO_DB_USER"),
+        "PASSWORD": env("DJANGO_DB_PASSWORD"),
+        "HOST": env("DJANGO_DB_HOST"),
+        "PORT": env("DJANGO_DB_PORT"),
     }
 }
-
+# if env("DATABASE_LOCAL", default=False):
+#     # Temp database for development
+#     DATABASES = {
+#         "default": {
+#             "ENGINE": "django.contrib.gis.db.backends.postgis",
+#             "NAME": "deviceregistry",
+#             # "USER": env("DJANGO_DB_USER", default="postgres"),
+#             # "PASSWORD": env("DJANGO_DB_PASSWORD", default="postgres"),
+#             # "HOST": env("DJANGO_DB_HOST", default="db"),
+#             # "PORT": env("DJANGO_DB_PORT", default=5432),
+#         }
+#     }
 
 # Password validation
 # https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators

docker-compose.yml

@@ -115,10 +115,10 @@ services:
       ALLOWED_HOSTS:
       SECRET_KEY:
       # PostgreSQL config
-      DATABASE_HOST:
-      DATABASE_USER:
-      DATABASE_PASSWORD:
-      DATABASE_PORT:
+      DJANGO_DB_HOST:
+      DJANGO_DB_USER:
+      DJANGO_DB_PASSWORD:
+      DJANGO_DB_PORT:
       # Debug config
       DEBUG: 1
     depends_on:

pyproject.toml

@@ -75,3 +75,5 @@ exclude = ["migrations", "venv"]
 DJANGO_SETTINGS_MODULE = "deviceregistry.settings"
 log_cli = 1
 log_cli_level = 20
+testpaths = ["devices/tests"]
+addopts = ["--color=yes"]