Merge pull request #1 from junior92jr/test-ci

Add GitHub Actions workflow for Django tests with PostgreSQL

Author: junior92jr

.devcontainer/docker-compose.yml

@@ -9,7 +9,7 @@ services:
       - ..:/workspace:cached
     working_dir: /workspace/src
     env_file:
-      - ../.env
+      - ../.env_files/.env
 
     command: sleep infinity
     depends_on:
@@ -22,7 +22,7 @@ services:
       - ..:/workspace:cached
     working_dir: /workspace/src
     env_file:
-      - ../.env
+      - ../.env_files/.env
 
     command: celery -A backend worker --loglevel=info
     depends_on:
@@ -37,7 +37,7 @@ services:
       - ..:/workspace:cached
     working_dir: /workspace/src
     env_file:
-      - ../.env
+      - ../.env_files/.env
     command: celery -A backend beat --loglevel=info --scheduler django_celery_beat.schedulers:DatabaseScheduler
     depends_on:
       - redis
@@ -57,7 +57,7 @@ services:
     ports:
       - "5432:5432"
     env_file:
-      - ../.env
+      - ../.env_files/.env
 
 volumes:
   postgres-data:

.env_files/.env.ci

@@ -0,0 +1,18 @@
+# Database
+DATABASE_URI=postgresql://postgres:postgres@localhost:5432/web_test
+DATABASE_URI_TEST=postgresql://postgres:postgres@localhost:5432/web_test
+
+# Django
+SECRET_KEY=ci-secret-key
+DEBUG=False
+ALLOWED_HOSTS=localhost,127.0.0.1
+CORS_ALLOWED_ORIGINS=http://localhost:3000,http://127.0.0.1:3000
+
+# Celery / Redis
+CELERY_BROKER_URL=redis://localhost:6379/0
+CELERY_RESULT_BACKEND=redis://localhost:6379/1
+
+# Postgres
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_DB=postgres

.sample_env renamed to .env_files/.env.sample

@@ -0,0 +1,54 @@
+name: Django CI (Postgres)
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: web_test
+        ports: ["5432:5432"]
+        options: >-
+          --health-cmd="pg_isready -U postgres"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+      redis:
+        image: redis:7
+        ports: ["6379:6379"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Run migrations
+        working-directory: src
+        run: |
+          set -o allexport
+          source ../.env_files/.env.ci
+          python manage.py migrate
+          set +o allexport
+
+      - name: Run tests
+        working-directory: src
+        run: |
+          set -o allexport
+          source ../.env_files/.env.ci
+          pytest
+          set +o allexport

.github/workflows/django-ci.yml

@@ -0,0 +1,25 @@
+name: Lint & Format
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Run Black
+        run: black --check .
+      - name: Run isort
+        run: isort --check-only .
+      - name: Run flake8
+        run: flake8 .

.github/workflows/lint.yml

@@ -22,7 +22,8 @@
   "python.testing.pytestEnabled": true,
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
-    "source.organizeImports": "always"
+    "source.organizeImports": "always",
+    "source.fixAll": "always"
   },
   "editor.rulers": [
     88

.vscode/settings.json

@@ -7,7 +7,7 @@ services:
     volumes:
       - ./:/workspace:cached
     env_file:
-      - .env
+      - .env_files/.env
     command: ["/bin/sh", "/workspace/scripts/django/start.sh"]
     ports:
       - "8000:8000"
@@ -25,7 +25,7 @@ services:
     volumes:
       - ./:/workspace:cached
     env_file:
-      - .env
+      - .env_files/.env
     command: ["/bin/sh", "/workspace/scripts/celery/worker.sh"]
     depends_on:
       db:
@@ -43,7 +43,7 @@ services:
       - ./:/workspace:cached
     working_dir: /workspace/src
     env_file:
-      - .env
+      - .env_files/.env
     command: ["/bin/sh", "/workspace/scripts/celery/beat.sh"]
     depends_on:
       db:
@@ -74,7 +74,7 @@ services:
     ports:
       - "5432:5432"
     env_file:
-      - .env
+      - .env_files/.env
     networks:
       - backend
     healthcheck:

docker-compose.yml

@@ -1,18 +1,33 @@
 [black]
-line-length = 88  # Set line length to 88
+line-length = 88
 
-[pylint]
-disable = C0114  # Disable missing module docstring warning
+[isort]
+profile = black
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+line_length = 88
+remove_redundant_aliases = true
 
 [flake8]
-max-line-length = 88  # Set line length to 88
-extend-ignore = E203, W503  # Ignore specific warnings
+max-line-length = 88
+extend-ignore = E203, W503
+exclude = .git,__pycache__,migrations,venv
+per-file-ignores = 
+    src/backend/settings_test.py: F405
 
-[isort]
-multi_line_output = 3  # Vertical hanging indent for imports
-include_trailing_comma = true  # Add trailing comma
-force_grid_wrap = 0  # Disable wrapping
-use_parentheses = true  # Use parentheses for wrapping
-ensure_newline_before_comments = true  # Newline before comments in imports
-line_length = 88  # Set line length to 88
-remove_redundant_aliases = true  # Remove redundant aliases
+[pylint]
+disable = C0114
+
+[mypy]
+plugins = mypy_django_plugin.main
+ignore_missing_imports = True
+
+[mypy-tests.*]
+ignore_errors = True
+
+[mypy.plugins.django-stubs]
+django_settings_module = "backend.settings"
+strict_settings = True

setup.cfg

@@ -44,7 +44,7 @@
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.common.CommonMiddleware",
-    "corsheaders.middleware.CorsMiddleware",  # CORS middleware should be high in the order
+    "corsheaders.middleware.CorsMiddleware",
     "django.middleware.csrf.CsrfViewMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
@@ -80,11 +80,13 @@
 # Password validation
 AUTH_PASSWORD_VALIDATORS = [
     {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
+        "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"},
+    {"NAME": ("django.contrib.auth.password_validation.MinimumLengthValidator")},
+    {"NAME": ("django.contrib.auth.password_validation.CommonPasswordValidator")},
+    {"NAME": ("django.contrib.auth.password_validation.NumericPasswordValidator")},
 ]
 
 # Internationalization settings

src/backend/settings.py

@@ -1,3 +1,3 @@
-from backend.settings import *  # noqa: F401,F403
+from backend.settings import *  # noqa: F401,F403,F405
 
 DATABASES = {"default": env.db("DATABASE_URI")}