Merge pull request #122 from SADiLaR/develop

Merge existing work into main branch

Author: friedelwolff

.env.example

@@ -0,0 +1,22 @@
+SECRET_KEY=''
+DEBUG=True
+DB_HOST=db
+DB_PORT=5432
+DB_NAME=term_db
+DB_USER=sadilar
+DB_PASSWORD=sadilar
+LOGGING_FILE=debug.log
+LOGGING_HANDLERS_LEVEL=INFO
+LOGGING_LOGGERS_LEVEL=INFO
+LOGGING_LOGGERS_DJANGO_LEVEL=INFO
+TESTING_DIR=/app/general/tests/files/
+EMAIL_HOST=''
+EMAIL_PORT=587
+EMAIL_USE_TLS=True
+EMAIL_HOST_USER=''
+EMAIL_HOST_PASSWORD=''
+DEFAULT_FROM_EMAIL=''
+SERVER_EMAIL=''
+EMAIL_SUBJECT_PREFIX=''
+EMAIL_BACKEND_CONSOLE='True/False'
+SECRET_KEY=''

.env.testing

@@ -0,0 +1,12 @@
+SECRET_KEY='django-insecure-w!h85bp^$$e8gm%c23r!0%9i7yzd=6w$$s&ic+6!%306&kj8@k*5'
+DEBUG=True
+DB_HOST=localhost
+DB_PORT=5432
+DB_NAME=term_db
+DB_USER=sadilar
+DB_PASSWORD=sadilar
+LOGGING_FILE=debug.log
+LOGGING_HANDLERS_LEVEL=INFO
+LOGGING_LOGGERS_LEVEL=INFO
+LOGGING_LOGGERS_DJANGO_LEVEL=INFO
+TESTING_DIR=/home/runner/work/term_platform/term_platform/app/general/tests/files/

.github/workflows/main.yml renamed to .github/workflows/develop.yml

@@ -1,5 +1,5 @@
 # https://docs.docker.com/build/ci/github-actions/push-multi-registries/
-name: docker_push
+name: docker_push_deploy_test
 
 on:
   workflow_dispatch:
@@ -8,7 +8,7 @@ on:
       - "develop"
 
 jobs:
-  docker:
+  deploy_test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -34,4 +34,4 @@ jobs:
         with:
           url: https://api.bitbucket.org/2.0/repositories/team_sadilar/ansible/pipelines/
           headers: '{"Authorization": "Bearer ${{ secrets.BITBUCKET_PIPELINE_SECRET }}"}'
-          body: '{"target": {"ref_type": "branch", "type": "pipeline_ref_target", "ref_name": "master", "selector": {"type": "custom", "pattern": "deploy_term_platform" }   }}'
+          body: '{"target": {"ref_type": "branch", "type": "pipeline_ref_target", "ref_name": "master", "selector": {"type": "custom", "pattern": "deploy_term_platform_test" }   }}'

.github/workflows/production.yml

@@ -0,0 +1,30 @@
+# https://docs.docker.com/build/ci/github-actions/push-multi-registries/
+name: docker_push_prod
+
+on:
+  push:
+    tags:
+      - v**
+
+jobs:
+  docker_push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to SADiLaR Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: docker.sadilar.org
+          username: ${{ vars.SADILAR_DOCKER_REPOSITORY_USER }}
+          password: ${{ secrets.SADILAR_DOCKER_REPOSITORY_SECRET }}
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          platforms: linux/amd64
+          push: true
+          tags: |
+            docker.sadilar.org/term_platform:prod

.github/workflows/testing.yml

@@ -0,0 +1,57 @@
+name: Testing Django
+on: [ pull_request, push ] # activates the workflow when there is a push or pull request in the repo
+jobs:
+  test_project:
+    runs-on: ubuntu-latest # operating system your code will run on
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: sadilar
+          POSTGRES_PASSWORD: sadilar
+          POSTGRES_DB: test_db_1
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-test.txt
+          sudo apt-get install -y gettext
+      - name: Run linting tools
+        run: |
+          cd app/
+          ruff format .
+      - name: Create logging folder
+        run: |
+          sudo  mkdir -p /logging
+          sudo chown runner:runner /logging
+      - name: Compile Translation Messages
+        run: |
+          cp .env.testing app/.env
+          cd app/
+          python manage.py makemessages --all
+          python manage.py compilemessages
+      - name: Run validate_templates
+        run: |
+          export DJANGO_TEST_PROCESSES=1
+          cp .env.testing app/.env
+          cd app/
+          mkdir -p static_files
+          python manage.py validate_templates --ignore-app django_filters
+      - name: Run Tests
+        run: |
+          cp .env.testing app/.env
+          cd app/
+          mkdir -p static_files
+          python manage.py test
+        env:
+          DJANGO_SETTINGS_MODULE: app.settings
+          DATABASE_URL: postgres://sadilar:sadilar@localhost:5432/test_db
+      - name: Manager Check
+        run: |
+          cd app/
+          python manage.py check

.gitignore

@@ -1,50 +1,41 @@
-# These are some examples of commonly ignored file patterns.
-# You should customize this list as applicable to your project.
-# Learn more about .gitignore:
-#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
-
-# Node artifact files
-node_modules/
-dist/
-
-# Compiled Java class files
-*.class
-
-# Compiled Python bytecode
-*.py[cod]
-
 # Log files
 *.log
 
-# Package files
-*.jar
-
-# Maven
-target/
-dist/
-
 # JetBrains IDE
 .idea/
 
-# Unit test reports
-TEST*.xml
-
-# Generated by MacOS
-.DS_Store
-
 # Generated by Windows
 Thumbs.db
 
-# Applications
-*.app
-*.exe
-*.war
-
-# Large media files
-*.mp4
-*.tiff
-*.avi
-*.flv
-*.mov
-*.wmv
-
+# Django template
+*.pot
+*.mo
+*.pyc
+__pycache__/
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+media
+
+# General Files
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+#folders
+app/static_files/
+/app/documents/
+app/media/
+/app/logging/
+/logging/
+/pdf_uploads/
+/pdf_upload_completed/

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  # Linting and formatting for Python.
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.2.2
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --diff ]
+      # Run the formatter.
+      - id: ruff-format
+        args: [ --diff ]
+
+  # Automatically sort python imports
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: [ --profile, black ]
+
+  # Lint: YAML
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: ["-d {extends: relaxed, rules: {line-length: disable}}", "-s"]
+        files: \.(yaml|yml)$

Dockerfile

@@ -0,0 +1,30 @@
+# A minimalist image usable as a base for a production deployment.
+FROM python:3.12
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+SHELL ["/bin/bash", "-c"]
+
+# Set work directory
+WORKDIR /app
+
+# Install dependencies
+COPY requirements.txt /app/
+
+RUN <<EOF
+  set -exo pipefail
+  apt-get update
+  apt-get -y upgrade
+  apt-get install -y --no-install-recommends libmagic1 gettext
+  pip install --upgrade pip
+  pip install -r requirements.txt
+EOF
+
+# Copy project
+COPY ./app /app/
+COPY ./entrypoint.sh /
+
+# Run the application
+ENTRYPOINT ["bash", "/entrypoint.sh"]

Dockerfile-dev

@@ -0,0 +1,30 @@
+# A development image with extras for development.
+# Don't use in production.
+FROM python:3.12
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+SHELL ["/bin/bash", "-c"]
+
+# Set work directory
+WORKDIR /app
+
+# Install dependencies
+COPY requirements.txt requirements-dev.txt /app/
+
+RUN <<EOF
+  set -exo pipefail
+  apt-get update
+  apt-get -y upgrade
+  apt-get install -y --no-install-recommends libmagic1 gettext graphviz graphviz-dev
+  pip install --upgrade pip
+  pip install -r requirements-dev.txt
+EOF
+
+# Copy project
+COPY ./app /app/
+
+# Run the application
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]