Merge pull request #12 from newfatto/feature/hw_34_2

Настроена конфигурация CI/CD

Author: newfatto

.dockerignore

@@ -0,0 +1,13 @@
+.git
+.github
+.env
+.venv
+venv
+__pycache__
+*.pyc
+.pytest_cache
+htmlcov
+media
+staticfiles
+.idea
+.vscode

.env.example

@@ -1,23 +1,30 @@
-SECRET_KEY=yoursecretkey
-DEBUG=True|False
-DATABASE_NAME=yourdbname
-DATABASE_USER=yourdbuser
-DATABASE_PASSWORD=yourdbpassword
-DATABASE_HOST=yourlhost
-DATABASE_PORT=yourport
+SECRET_KEY=
+DEBUG=False
 
-POSTGRES_DB=yourdbname
-POSTGRES_USER=yourdbuser
-POSTGRES_PASSWORD=yourdbpassword
+DATABASE_NAME=
+DATABASE_USER=
+DATABASE_PASSWORD=
+DATABASE_HOST=db
+DATABASE_PORT=5432
 
-STRIPE_API_KEY=yourstripeapikey
+ALLOWED_HOSTS=
+CSRF_TRUSTED_ORIGINS=
 
-CELERY_BROKER_URL=yourbrockerurl
-CELERY_RESULT_BACKEND=yourresultbackend
+POSTGRES_DB=
+POSTGRES_USER=
+POSTGRES_PASSWORD=
 
-EMAIL_HOST=smtp.gmail.com
-EMAIL_PORT=yourport
-EMAIL_HOST_USER=your_email@gmail.com
-EMAIL_HOST_PASSWORD=your_password
-EMAIL_USE_TLS=True
-DEFAULT_FROM_EMAIL=your_email@gmail.com
+STRIPE_API_KEY=
+
+CELERY_BROKER_URL=redis://redis:6379/0
+CELERY_RESULT_BACKEND=redis://redis:6379/0
+CELERY_TASK_ALWAYS_EAGER=False
+CELERY_TASK_EAGER_PROPAGATES=False
+
+EMAIL_HOST=
+EMAIL_PORT=465
+EMAIL_HOST_USER=
+EMAIL_HOST_PASSWORD=
+EMAIL_USE_TLS=False
+EMAIL_USE_SSL=True
+DEFAULT_FROM_EMAIL=

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 120
+ignore = E203, W503
+exclude = .git, __pycache__, venv, .venv, migrations

.github/workflows/ci-cd.yml

@@ -0,0 +1,177 @@
+name: DRF CI/CD
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_DB: learning_machine
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd="pg_isready -U postgres -d learning_machine"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+
+    env:
+      SECRET_KEY: test-secret-key
+      DEBUG: "True"
+      ALLOWED_HOSTS: localhost,127.0.0.1
+
+      DATABASE_NAME: learning_machine
+      DATABASE_USER: postgres
+      DATABASE_PASSWORD: postgres
+      DATABASE_HOST: localhost
+      DATABASE_PORT: 5432
+
+      STRIPE_API_KEY: test-stripe-key
+
+      CELERY_BROKER_URL: redis://localhost:6379/0
+      CELERY_RESULT_BACKEND: redis://localhost:6379/0
+      CELERY_TASK_ALWAYS_EAGER: "False"
+      CELERY_TASK_EAGER_PROPAGATES: "False"
+
+      EMAIL_HOST: smtp.example.com
+      EMAIL_PORT: 465
+      EMAIL_HOST_USER: test@example.com
+      EMAIL_HOST_PASSWORD: test-password
+      EMAIL_USE_TLS: "False"
+      EMAIL_USE_SSL: "True"
+      DEFAULT_FROM_EMAIL: test@example.com
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Install Poetry
+        run: pipx install poetry
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "poetry"
+
+      - name: Install dependencies
+        run: poetry install --no-interaction --no-root
+
+      - name: Run migrations
+        run: poetry run python manage.py migrate
+
+      - name: Run tests
+        run: poetry run python manage.py test
+
+  lint:
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Install Poetry
+        run: pipx install poetry
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "poetry"
+
+      - name: Install dependencies
+        run: poetry install --no-interaction --no-root
+
+      - name: Run flake8
+        run: poetry run flake8 . --exclude=.venv,venv,migrations,htmlcov --max-line-length=119
+
+  build:
+    runs-on: ubuntu-latest
+    needs: lint
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Build Docker image
+        run: docker build -t learning-machine:test .
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up SSH
+        uses: webfactory/ssh-agent@v0.9.0
+        with:
+          ssh-private-key: ${{ secrets.SSH_KEY }}
+
+      - name: Add server to known hosts
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan ${{ secrets.SERVER_IP }} >> ~/.ssh/known_hosts
+
+      - name: Create deploy directory on server
+        run: |
+          ssh ${{ secrets.SSH_USER }}@${{ secrets.SERVER_IP }} "mkdir -p ${{ secrets.DEPLOY_DIR }}"
+
+      - name: Copy project files to server
+        run: |
+          rsync -az --delete \
+            --exclude '.git' \
+            --exclude '.github' \
+            --exclude '.env' \
+            --exclude '.venv' \
+            --exclude 'venv' \
+            --exclude '__pycache__' \
+            --exclude '.pytest_cache' \
+            --exclude 'htmlcov' \
+            --exclude 'media' \
+            --exclude 'staticfiles' \
+            ./ ${{ secrets.SSH_USER }}@${{ secrets.SERVER_IP }}:${{ secrets.DEPLOY_DIR }}/
+
+      - name: Create .env on server
+        run: |
+          ssh ${{ secrets.SSH_USER }}@${{ secrets.SERVER_IP }} << EOF
+            cd ${{ secrets.DEPLOY_DIR }}
+
+            cat > .env << 'ENVEOF'
+          ${{ secrets.ENV_FILE }}
+          ENVEOF
+          EOF
+
+      - name: Deploy with Docker Compose
+        run: |
+          ssh ${{ secrets.SSH_USER }}@${{ secrets.SERVER_IP }} << 'EOF'
+            cd ${{ secrets.DEPLOY_DIR }}
+
+            docker compose -f docker-compose.prod.yml up -d db redis
+            docker compose -f docker-compose.prod.yml build
+
+            docker compose -f docker-compose.prod.yml run --rm web python manage.py migrate
+            docker compose -f docker-compose.prod.yml run --rm web python manage.py collectstatic --noinput
+
+            docker compose -f docker-compose.prod.yml up -d
+
+            docker image prune -f
+          EOF

.gitignore

@@ -37,7 +37,7 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
-#htmlcov/
+htmlcov/
 .tox/
 .nox/
 .coverage

Dockerfile

@@ -1,8 +1,11 @@
-FROM python:3.10
+FROM python:3.10-slim
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
 
 WORKDIR /app
 
-RUN apt-get update && apt-get install -y \
+RUN apt-get update && apt-get install -y --no-install-recommends \
     gcc \
     libpq-dev \
     && apt-get clean \
@@ -19,4 +22,4 @@ COPY . .
 
 EXPOSE 8000
 
-CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+CMD ["gunicorn", "config.wsgi:application", "--bind", "0.0.0.0:8000"]

config/settings.py

@@ -12,7 +12,17 @@
 
 DEBUG = True if os.getenv("DEBUG") == "True" else False
 
-ALLOWED_HOSTS = []
+ALLOWED_HOSTS = [
+    host.strip()
+    for host in os.getenv("ALLOWED_HOSTS", "localhost,127.0.0.1").split(",")
+    if host.strip()
+]
+
+CSRF_TRUSTED_ORIGINS = [
+    origin.strip()
+    for origin in os.getenv("CSRF_TRUSTED_ORIGINS", "").split(",")
+    if origin.strip()
+]
 
 INSTALLED_APPS = [
     "django.contrib.admin",
@@ -65,7 +75,7 @@
         "NAME": os.getenv("DATABASE_NAME"),
         "USER": os.getenv("DATABASE_USER"),
         "PASSWORD": os.getenv("DATABASE_PASSWORD"),
-        "HOST": os.getenv("DATABASE_HOST"),
+        "HOST": os.getenv("DATABASE_HOST", "db"),
         "PORT": os.getenv("DATABASE_PORT", default="5432"),
     }
 }
@@ -89,10 +99,10 @@
 
 TIME_ZONE = "Europe/Moscow"
 USE_TZ = True
-
 USE_I18N = True
 
 STATIC_URL = "static/"
+STATIC_ROOT = BASE_DIR / "staticfiles"
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"