ci-cd.yml

name: CI/CD Workflow

on:
    push:
        branches: [main]
    pull_request:
        branches: [main]

jobs:
    test-backend:
        defaults:
          run:
            working-directory: ./backend
        runs-on: ubuntu-latest

        env:
          DATABASE_URL: postgresql://test_user:test_password@localhost:5432/test_db
          DATABASE_ENGINE: django.db.backends.postgresql
          DATABASE_NAME: test_db 
          DATABASE_USER: test_user   
          DATABASE_PASSWORD: test_pw
          DATABASE_HOST: test_host
          DATABASE_PORT: test_port
          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
          EMAIL_HOST: localhost
          EMAIL_PORT: 1025
          EMAIL_HOST_USER: ''
          EMAIL_HOST_PASSWORD: ''

        services:
          redis: 
            image: redis
            ports: 
              - 6379:6379
            options: >-   #verify the service is up and running properly before your tests begin.
              --health-cmd "redis-cli ping" 
              --health-interval 10s
              --health-timeout 5s
              --health-retries 5
          
          postgres:
            image: postgres
            env:
              POSTGRES_DB: test_db
              POSTGRES_USER: test_user
              POSTGRES_PASSWORD: test_password
            ports:
              - 5432:5432
            options: >-
              --health-cmd pg_isready
              --health-interval 10s
              --health-timeout 5s
              --health-retries 5
          
          mailhog:
            image: mailhog/mailhog
            ports:
              - 1025:1025
              - 8025:8025

            
        steps:
            - uses: actions/checkout@v4  #Clones repo into the GitHub Actions runner => without it => cannot access code
            
            - name: Set Up Python
              uses: actions/setup-python@v5 
              with: 
                python-version: "3.11"
            
            - name: Cache Dependencies
              uses: actions/cache@v4
              with: 
                path: ~/.cache/pip #~ is home directory of virtual environment (runner) where this code is executed => path by default
                key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} #hashFiles: Changes if dependencies change
                restore-keys: |  #Fallback keys to use if exact match isn't found
                  ${{ runner.os }}-pip-
                  ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}-

            
            - name: Install Python Dependencies
              run: pip install -r requirements.txt

            - name: Check Migration
              run: python manage.py makemigrations --check --dry-run  #Prevents forgetting to create or commit migration files => especially when Supabase require consistent schema
              #checking if you have any pending model changes that require migrations, but not actually applying those migrations to any database => can use with test database
            
            - name: Run Django Unit Test
              run: python manage.py test toast_tutor.tests.units

            - name: Verify Django Build
              run: python manage.py collectstatic --noinput --dry-run
            
      
    test-frontend:
        defaults:
          run:
            working-directory: ./frontend
        runs-on: ubuntu-latest
        
        steps:
          - uses: actions/checkout@v4
          - name: Set Up Node.js
            uses: actions/setup-node@v4
            with:
              node-version: '20'
              cache: 'npm'  #caching is already integrated directly into the actions/setup-node action => dont need separate cache step like Django
              cache-dependency-path: package-lock.json
          
          - name: Install dependencies
            run: npm ci    #clean unecessary dependencies, look at package-locj.json and install exactly what we need
          
          # - name: Run React test
          #   run: npm test -- --watchAll=false  #allow Jest (React testing framework run once, not need to wait until file change/ CI hang indefinitely (may leads to timeout))
          
          - name: Check Linting
            run: npm run lint

          - name: Build Vite
            run: npm run build  #verifies Vite code can be compiled for production
          
    integration-tests:
        needs: [test-backend, test-frontend]
        runs-on: ubuntu-latest
        defaults:
          run:
            working-directory: ./backend
        
        env:
            DATABASE_URL: postgresql://test_user:test_password@localhost:5432/test_db
            DATABASE_ENGINE: django.db.backends.postgresql
            DATABASE_NAME: test_db 
            DATABASE_USER: test_user   
            DATABASE_PASSWORD: test_pw
            DATABASE_HOST: test_host
            DATABASE_PORT: test_port
            SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
            SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
            EMAIL_HOST: localhost
            EMAIL_PORT: 1025
            EMAIL_HOST_USER: ''
            EMAIL_HOST_PASSWORD: ''

        services:
          redis: 
            image: redis
            ports: 
              - 6379:6379
            options: >-   
              --health-cmd "redis-cli ping" 
              --health-interval 10s
              --health-timeout 5s
              --health-retries 5
          
          postgres:
            image: postgres
            env:
              POSTGRES_DB: test_db
              POSTGRES_USER: test_user
              POSTGRES_PASSWORD: test_password
            ports:
              - 5432:5432
            options: >-
              --health-cmd pg_isready
              --health-interval 10s
              --health-timeout 5s
              --health-retries 5
          
          mailhog:
            image: mailhog/mailhog
            ports:
              - 1025:1025
              - 8025:8025

            
        steps:
            - uses: actions/checkout@v4  
            
            - name: Set Up Python
              uses: actions/setup-python@v5 
              with: 
                python-version: "3.11"
            
            - name: Cache Dependencies
              uses: actions/cache@v4
              with: 
                path: ~/.cache/pip 
                key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} 
                restore-keys: |  
                  ${{ runner.os }}-pip-
                  ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}-

            - name: Install Python Dependencies
              run: pip install -r requirements.txt

            - name: Run API/Integration Tests
              run: python manage.py test toast_tutor.tests.apis