Add coverage result in workflow and Readme.md, separate environtment …

…for development and non-development

.github/workflows/django-build-test.yml

@@ -50,8 +50,9 @@ jobs:
       - name: Run tests and generate coverage
         run: |
           coverage run --source='.' manage.py test
-          coverage report
+          coverage report > coverage-out.txt
           coverage xml -o ./coverage.xml
+          echo "Test coverage result: $(cat output.txt)" >> Readme.md
 
       - name: SonarCloud Scan
         uses: sonarsource/sonarcloud-github-action@master

Readme.md

@@ -0,0 +1,3 @@
+### Backend for Revelio App
+
+#### Note: For development, please add 'dev' on every command that runs manage.py so it will use the Development environment. For example: python manage.py dev runserver, python manage.py dev makemigrations, python manage.py dev migrate.

manage.py

@@ -6,7 +6,12 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'revelio.settings')
+    if 'dev' in sys.argv:
+        sys.argv.remove('dev')
+        os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'revelio.settings_dev')
+    else:
+        os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'revelio.settings')
+
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

revelio/settings.py

@@ -11,7 +11,6 @@
 """
 
 from pathlib import Path
-import os
 import sys
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.

revelio/settings_dev.py

@@ -0,0 +1,126 @@
+"""
+Django settings for revelio project.
+
+Generated by 'django-admin startproject' using Django 5.0.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.0/ref/settings/
+"""
+
+from pathlib import Path
+import sys
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-o^$o854ewkumms=p^%lmvupmlp&0-5!d*ltjp%3gn8w@z3jccz'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ['*']
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'authentication',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'revelio.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'revelio.wsgi.application'
+
+
+# Database
+# Adapted from: https://medium.com/intelligentmachines/github-actions-end-to-end-ci-cd-pipeline-for-django-5d48d6f00abf
+
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+        }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.0/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.0/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.0/howto/static-files/
+
+STATIC_URL = 'static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'