From cf86108a66a89fb272b8649b643097c4d0a1478d Mon Sep 17 00:00:00 2001 From: JohannesSetiawan Date: Mon, 5 Feb 2024 19:18:09 +0700 Subject: [PATCH 1/6] Add coverage report and remove some steps --- .github/workflows/django-build-test.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/django-build-test.yml b/.github/workflows/django-build-test.yml index ce7fb36..75f4d4d 100644 --- a/.github/workflows/django-build-test.yml +++ b/.github/workflows/django-build-test.yml @@ -50,11 +50,8 @@ jobs: - name: Run tests and generate coverage run: | coverage run --source='.' manage.py test + coverage report coverage xml -o ./coverage.xml - - name: List Directories - run: | - echo "Directories in GitHub workflow:" - find "$GITHUB_WORKSPACE" -type d -print - name: SonarCloud Scan uses: sonarsource/sonarcloud-github-action@master From 4e96b6f6b2ddde7ead188f44636fe569d7a8d52c Mon Sep 17 00:00:00 2001 From: JohannesSetiawan Date: Mon, 5 Feb 2024 19:36:38 +0700 Subject: [PATCH 2/6] Add Readme.md --- Readme.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..e69de29 From 7d766a46022e371ca86b045380142add4c68183c Mon Sep 17 00:00:00 2001 From: JohannesSetiawan Date: Mon, 5 Feb 2024 20:22:53 +0700 Subject: [PATCH 3/6] Add coverage result in workflow and Readme.md, separate environtment for development and non-development --- .github/workflows/django-build-test.yml | 3 +- Readme.md | 3 + manage.py | 7 +- revelio/settings.py | 1 - revelio/settings_dev.py | 126 ++++++++++++++++++++++++ 5 files changed, 137 insertions(+), 3 deletions(-) create mode 100644 revelio/settings_dev.py diff --git a/.github/workflows/django-build-test.yml b/.github/workflows/django-build-test.yml index 75f4d4d..1242d58 100644 --- a/.github/workflows/django-build-test.yml +++ b/.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 diff --git a/Readme.md b/Readme.md index e69de29..9019efb 100644 --- a/Readme.md +++ b/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. \ No newline at end of file diff --git a/manage.py b/manage.py index ee7acd9..ec01f96 100644 --- a/manage.py +++ b/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: diff --git a/revelio/settings.py b/revelio/settings.py index 4b8362e..ad3a2b5 100644 --- a/revelio/settings.py +++ b/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'. diff --git a/revelio/settings_dev.py b/revelio/settings_dev.py new file mode 100644 index 0000000..fcf94ce --- /dev/null +++ b/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' From 475c747d2d2364c1d1b6b18a4a80974a43a7af3e Mon Sep 17 00:00:00 2001 From: JohannesSetiawan Date: Mon, 5 Feb 2024 20:34:24 +0700 Subject: [PATCH 4/6] Fix workflows, Readme, and add dummy/sample data (data seed) --- .github/workflows/django-build-test.yml | 2 +- Readme.md | 5 ++++- authentication/fixtures/data_seed_authentication.json | 10 ++++++++++ 3 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 authentication/fixtures/data_seed_authentication.json diff --git a/.github/workflows/django-build-test.yml b/.github/workflows/django-build-test.yml index 1242d58..f6559fe 100644 --- a/.github/workflows/django-build-test.yml +++ b/.github/workflows/django-build-test.yml @@ -52,7 +52,7 @@ jobs: coverage run --source='.' manage.py test coverage report > coverage-out.txt coverage xml -o ./coverage.xml - echo "Test coverage result: $(cat output.txt)" >> Readme.md + echo "Test coverage result: $(cat coverage-out.txt)" >> Readme.md - name: SonarCloud Scan uses: sonarsource/sonarcloud-github-action@master diff --git a/Readme.md b/Readme.md index 9019efb..395d877 100644 --- a/Readme.md +++ b/Readme.md @@ -1,3 +1,6 @@ ### 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. \ No newline at end of file +#### Note for developers: +- 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`. +- While developing, use `python manage.py dev loaddata data_seed_authentication.json` (for example) to load a data seed to development environment database. +- Currently available backend URL: `/try` \ No newline at end of file diff --git a/authentication/fixtures/data_seed_authentication.json b/authentication/fixtures/data_seed_authentication.json new file mode 100644 index 0000000..1251093 --- /dev/null +++ b/authentication/fixtures/data_seed_authentication.json @@ -0,0 +1,10 @@ +[ + { + "model":"authentication.todo", + "pk":1, + "fields":{ + "label":"hello world", + "description":"hanya percobaan untuk melakukan deployment :V" + } +} +] \ No newline at end of file From c838c7de392dab44411cb03d4fa950815df81833 Mon Sep 17 00:00:00 2001 From: JohannesSetiawan Date: Mon, 5 Feb 2024 20:39:50 +0700 Subject: [PATCH 5/6] Add note in Readme --- .github/workflows/django-build-test.yml | 2 -- Readme.md | 3 +++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/django-build-test.yml b/.github/workflows/django-build-test.yml index f6559fe..931b445 100644 --- a/.github/workflows/django-build-test.yml +++ b/.github/workflows/django-build-test.yml @@ -50,9 +50,7 @@ jobs: - name: Run tests and generate coverage run: | coverage run --source='.' manage.py test - coverage report > coverage-out.txt coverage xml -o ./coverage.xml - echo "Test coverage result: $(cat coverage-out.txt)" >> Readme.md - name: SonarCloud Scan uses: sonarsource/sonarcloud-github-action@master diff --git a/Readme.md b/Readme.md index 395d877..dcf383b 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,8 @@ ### Backend for Revelio App +#### Note: +- Test coverage for now can be seen at Action --> select the **latest** workflow runs --> select `sonarcloud` Jobs --> open section `Run tests and generate coverage` + #### Note for developers: - 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`. - While developing, use `python manage.py dev loaddata data_seed_authentication.json` (for example) to load a data seed to development environment database. From e76ac8808b1aa1d75678e15782812fa61457d1fc Mon Sep 17 00:00:00 2001 From: JohannesSetiawan Date: Mon, 5 Feb 2024 20:46:14 +0700 Subject: [PATCH 6/6] Add workflow badges to readme.md --- .github/workflows/django-build-test.yml | 2 +- Readme.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/django-build-test.yml b/.github/workflows/django-build-test.yml index 931b445..d480fb6 100644 --- a/.github/workflows/django-build-test.yml +++ b/.github/workflows/django-build-test.yml @@ -1,4 +1,4 @@ -name: Django CI +name: Build and Test on: push: diff --git a/Readme.md b/Readme.md index dcf383b..4855e8f 100644 --- a/Readme.md +++ b/Readme.md @@ -1,3 +1,5 @@ +[![Build and Test](https://github.com/RevelioStartup/revelio-be/actions/workflows/django-build-test.yml/badge.svg)](https://github.com/RevelioStartup/revelio-be/actions/workflows/django-build-test.yml) + ### Backend for Revelio App #### Note: