feat[django]: Split settings for differents enviroments

.env

@@ -1,3 +1,7 @@
 DJANGO_SECRET_KEY='django-insecure-wc2i2*6^17$9!u+(u66@q_rg)++n1x-^(0-$3yz2f(n=_-o*7='
 DATABASE_NAME='db.sqlite3'
-DJANGO_ALLOWED_HOSTS="127.0.0.1"
+DJANGO_ALLOWED_HOSTS="127.0.0.1"
+AWS_STORAGE_BUCKET_NAME=your_bucket_name
+AWS_ACCESS_KEY_ID=your_access_key_id
+AWS_SECRET_ACCESS_KEY=your_secret_access_key
+AWS_DEFAULT_REGION=us-east-1

.github/workflows/deploy-api.yml

@@ -3,7 +3,7 @@ name: Deploy API
 on:
   push:
     branches:
-      - main
+      - master
 
 jobs:
   build:
@@ -50,6 +50,11 @@ jobs:
             --set secrets.DJANGO_ALLOWED_HOSTS="${{ secrets.DJANGO_ALLOWED_HOSTS }}" \
             --set secrets.CERTIFICATE_ID="${{ secrets.CERTIFICATE_ID }}" \
             --set secrets.DOCKER_REGISTRY="${{ secrets.DOCKER_REGISTRY }}" \
+            --set secrets.DJANGO_SETTINGS_MODULE= "${{ secrets.DJANGO_SETTINGS_MODULE }}" \
+            --set secrets.AWS_STORAGE_BUCKET_NAME="${{ secrets.AWS_STORAGE_BUCKET_NAME }}" \
+            --set secrets.AWS_ACCESS_KEY_ID="${{ secrets.AWS_ACCESS_KEY_ID }}" \
+            --set secrets.AWS_SECRET_ACCESS_KEY="${{ secrets.AWS_SECRET_ACCESS_KEY }}" \
+            --set secrets.AWS_DEFAULT_REGION="${{ secrets.AWS_DEFAULT_REGION }}" \
             --create-namespace --namespace=default ./devops-deemo
           kubectl set image deployment/algova-django-api algova-django-api=${{ secrets.DOCKER_REGISTRY }}/algova-django-api:${GITHUB_SHA::7} --namespace=default
           kubectl rollout status deployment/algova-django-api --namespace=default

.github/workflows/deploy-pr.yml

@@ -2,7 +2,7 @@ name: Test PR
 
 on:
   pull_request:
-    types: [synchronize]
+    types: [opened, synchronize]
 
 jobs:
   build:
@@ -23,7 +23,7 @@ jobs:
 
       - name: Code Coverage
         run: |
-          pytest --ds=demo.settings --cov=. --cov-fail-under=80
+          pytest --ds=demo.settings.dev --cov=. --cov-fail-under=80
 
       - name: Login to Docker Hub
         run: echo ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }} | docker login -u ${{ secrets.DOCKER_HUB_USERNAME }} --password-stdin

.pylintrc

@@ -2,7 +2,7 @@
 load-plugins=pylint_django
 
 [TYPECHECK]
-django-settings-module=demo.settings
+django-settings-module=demo.settings.dev
 
 [MESSAGES CONTROL]
 disable=

api/tests/test_asgi.py

@@ -0,0 +1,9 @@
+from django.test import SimpleTestCase
+
+class TestASGIApplication(SimpleTestCase):
+    def test_asgi_application_import(self):
+        try:
+            from demo.asgi import application
+            self.assertIsNotNone(application)
+        except Exception as e:
+            self.fail(f"ASGI application import failed: {e}")

api/tests.py → api/tests/test_user_view.py

@@ -1,7 +1,7 @@
 import json
 from django.urls import reverse
 from rest_framework.test import APITestCase
-from .models import User
+from api.models import User
 
 
 class TestUserView(APITestCase):

api/tests/test_wsgi.py

@@ -0,0 +1,9 @@
+from django.test import SimpleTestCase
+
+class TestWSGIApplication(SimpleTestCase):
+    def test_wsgi_application_import(self):
+        try:
+            from demo.wsgi import application
+            self.assertIsNotNone(application)
+        except Exception as e:
+            self.fail(f"WSGI application import failed: {e}")

demo/asgi.py

@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings.base")
 
 application = get_asgi_application()

demo/settings.py → demo/settings/base.py

@@ -3,7 +3,7 @@
 
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
-BASE_DIR = Path(__file__).resolve().parent.parent
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
 
 env = environ.Env()
 env.read_env(BASE_DIR / ".env")
@@ -118,6 +118,7 @@
 # https://docs.djangoproject.com/en/4.2/howto/static-files/
 
 STATIC_URL = "static/"
+STATIC_ROOT = "/static/"
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field

demo/settings/dev.py

@@ -0,0 +1,3 @@
+from demo.settings.base import *  # noqa: F401,F403,F405
+
+DEBUG = True

demo/settings/prod.py

@@ -0,0 +1,26 @@
+from demo.settings.base import *  # noqa: F401,F403,F405
+
+DEBUG = False
+
+INSTALLED_APPS += [
+    'storages',
+]
+
+# AWS configurations
+AWS_ACCESS_KEY_ID = env("AWS_ACCESS_KEY_ID")
+AWS_SECRET_ACCESS_KEY = env("AWS_SECRET_ACCESS_KEY")
+AWS_DEFAULT_REGION = env("AWS_DEFAULT_REGION")
+
+# S3 STATIC SETTINGS
+STATICFILES_LOCATION = "static"
+MEDIAFILES_LOCATION = "media"
+
+AWS_STORAGE_BUCKET_NAME = env("AWS_STORAGE_BUCKET_NAME")
+AWS_DEFAULT_ACL = "public-read"
+AWS_S3_CUSTOM_DOMAIN = "{}.s3.amazonaws.com".format(AWS_STORAGE_BUCKET_NAME)
+AWS_S3_OBJECT_PARAMETERS = {"CacheControl": "max-age=86400"}
+
+STATICFILES_STORAGE = "demo.storage_backends.StaticStorage"
+DEFAULT_FILE_STORAGE = "demo.storage_backends.MediaStorage"
+STATIC_URL = "https://{}/{}/".format(AWS_S3_CUSTOM_DOMAIN, STATICFILES_LOCATION)
+MEDIA_URL = "https://{}/{}/".format(AWS_S3_CUSTOM_DOMAIN, MEDIAFILES_LOCATION)

demo/storage_backends.py

@@ -0,0 +1,12 @@
+from storages.backends.s3boto3 import S3Boto3Storage
+
+from demo.settings import prod
+
+
+class MediaStorage(S3Boto3Storage):
+    location = prod.MEDIAFILES_LOCATION
+    file_overwrite = False
+
+
+class StaticStorage(S3Boto3Storage):
+    location = prod.STATICFILES_LOCATION

demo/urls.py

@@ -1,4 +1,4 @@
 from django.contrib import admin
 from django.urls import path, include
 
-urlpatterns = [path("admin/", admin.site.urls), path("api/", include("api.urls"))]
+urlpatterns = [path("admin/", admin.site.urls), path("api/", include("api.urls")), path("", admin.site.urls)]

demo/wsgi.py

@@ -11,6 +11,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings.base")
 
 application = get_wsgi_application()

devops-deemo/templates/api/api-secrets.yaml

@@ -6,4 +6,9 @@ metadata:
 type: Opaque
 data:
   DJANGO_ALLOWED_HOSTS: {{ .Values.secrets.DJANGO_ALLOWED_HOSTS | b64enc }}
-  SECRET_KEY: {{ .Values.secrets.DJANGO_SECRET_KEY | b64enc }}
+  SECRET_KEY: {{ .Values.secrets.DJANGO_SECRET_KEY | b64enc }}
+  DJANGO_SETTINGS_MODULE: {{ .Values.secrets.DJANGO_SETTINGS_MODULE | b64enc }}
+  AWS_STORAGE_BUCKET_NAME: {{ .Values.secrets.AWS_STORAGE_BUCKET_NAME | b64enc }}
+  AWS_ACCESS_KEY_ID: {{ .Values.secrets.AWS_ACCESS_KEY_ID | b64enc }}
+  AWS_SECRET_ACCESS_KEY: {{ .Values.secrets.AWS_SECRET_ACCESS_KEY | b64enc }}
+  AWS_DEFAULT_REGION: {{ .Values.secrets.AWS_DEFAULT_REGION | b64enc }}

devops-deemo/values.yaml

@@ -6,3 +6,8 @@ secrets:
   DJANGO_ALLOWED_HOSTS: ""
   CERTIFICATE_ID: ""
   DOCKER_REGISTRY: ""
+  DJANGO_SETTINGS_MODULE: ""
+  AWS_STORAGE_BUCKET_NAME: ""
+  AWS_ACCESS_KEY_ID: ""
+  AWS_SECRET_ACCESS_KEY: ""
+  AWS_DEFAULT_REGION: ""

manage.py

@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings.base")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

pytest.ini

@@ -1,3 +1,3 @@
 [pytest]
-DJANGO_SETTINGS_MODULE = demo.settings
-python_files = tests.py
+DJANGO_SETTINGS_MODULE = demo.settings.dev
+python_files = tests.py test_*.py

requirements/base.in

@@ -1,3 +1,5 @@
 django==4.2
 django-environ==0.10.0
-djangorestframework==3.14.0
+djangorestframework==3.14.0
+django-storages
+boto3

requirements/base.txt

@@ -6,17 +6,38 @@
 #
 asgiref==3.8.1
     # via django
+boto3==1.34.144
+    # via -r requirements/base.in
+botocore==1.34.144
+    # via
+    #   boto3
+    #   s3transfer
 django==4.2
     # via
     #   -r requirements/base.in
+    #   django-storages
     #   djangorestframework
 django-environ==0.10.0
     # via -r requirements/base.in
+django-storages==1.14.4
+    # via -r requirements/base.in
 djangorestframework==3.14.0
     # via -r requirements/base.in
+jmespath==1.0.1
+    # via
+    #   boto3
+    #   botocore
+python-dateutil==2.9.0.post0
+    # via botocore
 pytz==2024.1
     # via djangorestframework
+s3transfer==0.10.2
+    # via boto3
+six==1.16.0
+    # via python-dateutil
 sqlparse==0.5.1
     # via django
 typing-extensions==4.12.2
     # via asgiref
+urllib3==1.26.19
+    # via botocore

requirements/dev.txt

@@ -14,6 +14,13 @@ astroid==3.2.3
     #   pylint
 black==24.4.2
     # via -r requirements/dev.in
+boto3==1.34.144
+    # via -r requirements/test.txt
+botocore==1.34.144
+    # via
+    #   -r requirements/test.txt
+    #   boto3
+    #   s3transfer
 build==1.2.1
     # via pip-tools
 click==8.1.7
@@ -31,9 +38,12 @@ dill==0.3.8
 django==4.2
     # via
     #   -r requirements/test.txt
+    #   django-storages
     #   djangorestframework
 django-environ==0.10.0
     # via -r requirements/test.txt
+django-storages==1.14.4
+    # via -r requirements/test.txt
 djangorestframework==3.14.0
     # via -r requirements/test.txt
 exceptiongroup==1.2.2
@@ -50,6 +60,11 @@ isort==5.13.2
     # via
     #   -r requirements/test.txt
     #   pylint
+jmespath==1.0.1
+    # via
+    #   -r requirements/test.txt
+    #   boto3
+    #   botocore
 mccabe==0.7.0
     # via
     #   -r requirements/test.txt
@@ -99,10 +114,22 @@ pytest-cov==5.0.0
     # via -r requirements/test.txt
 pytest-django==4.8.0
     # via -r requirements/test.txt
+python-dateutil==2.9.0.post0
+    # via
+    #   -r requirements/test.txt
+    #   botocore
 pytz==2024.1
     # via
     #   -r requirements/test.txt
     #   djangorestframework
+s3transfer==0.10.2
+    # via
+    #   -r requirements/test.txt
+    #   boto3
+six==1.16.0
+    # via
+    #   -r requirements/test.txt
+    #   python-dateutil
 sqlparse==0.5.1
     # via
     #   -r requirements/test.txt
@@ -127,6 +154,10 @@ typing-extensions==4.12.2
     #   astroid
     #   black
     #   pylint
+urllib3==1.26.19
+    # via
+    #   -r requirements/test.txt
+    #   botocore
 wheel==0.43.0
     # via pip-tools
 zipp==3.19.2

requirements/prod.txt

@@ -8,22 +8,49 @@ asgiref==3.8.1
     # via
     #   -r requirements/base.txt
     #   django
+boto3==1.34.144
+    # via -r requirements/base.txt
+botocore==1.34.144
+    # via
+    #   -r requirements/base.txt
+    #   boto3
+    #   s3transfer
 django==4.2
     # via
     #   -r requirements/base.txt
+    #   django-storages
     #   djangorestframework
 django-environ==0.10.0
     # via -r requirements/base.txt
+django-storages==1.14.4
+    # via -r requirements/base.txt
 djangorestframework==3.14.0
     # via -r requirements/base.txt
 gunicorn==22.0.0
     # via -r requirements/prod.in
+jmespath==1.0.1
+    # via
+    #   -r requirements/base.txt
+    #   boto3
+    #   botocore
 packaging==24.1
     # via gunicorn
+python-dateutil==2.9.0.post0
+    # via
+    #   -r requirements/base.txt
+    #   botocore
 pytz==2024.1
     # via
     #   -r requirements/base.txt
     #   djangorestframework
+s3transfer==0.10.2
+    # via
+    #   -r requirements/base.txt
+    #   boto3
+six==1.16.0
+    # via
+    #   -r requirements/base.txt
+    #   python-dateutil
 sqlparse==0.5.1
     # via
     #   -r requirements/base.txt
@@ -32,3 +59,7 @@ typing-extensions==4.12.2
     # via
     #   -r requirements/base.txt
     #   asgiref
+urllib3==1.26.19
+    # via
+    #   -r requirements/base.txt
+    #   botocore