server-tests.yml

name: Server

on:
  pull_request:
  workflow_dispatch:
  schedule:
    # Run everday at midnight UTC / 5:30 IST
    - cron: "0 0 * * *"

concurrency:
  group: server-develop-${{ github.event_name }}-${{ github.event.number }}
  cancel-in-progress: true

permissions:
  # Do not change this as GITHUB_TOKEN is being used by roulette
  contents: read

jobs:
  typecheck:
    name: Type Check
    runs-on: ubuntu-latest
    steps:
    - run: npm install toml
    - name: Get pyproject.toml
      uses: actions/github-script@v7
      id: get-pyproject
      with:
        github-token: ${{secrets.GITHUB_TOKEN}}
        script: |
          const { data: pyprojectContent } = await github.rest.repos.getContent({
            owner: context.repo.owner,
            repo: context.repo.repo,
            path: 'pyproject.toml',
            ref: context.payload.pull_request.head.sha
          });
          const content = Buffer.from(pyprojectContent.content, 'base64').toString();
          const toml = require('toml');
          const parsed = toml.parse(content);
          const mypyFiles = parsed.tool.mypy.files;
          return { mypyFiles, content };

    - name: Check for changes in mypy files
      uses: actions/github-script@v7
      id: check-changes
      with:
        github-token: ${{secrets.GITHUB_TOKEN}}
        script: |
          const { mypyFiles } = ${{ steps.get-pyproject.outputs.result }};
          const { data: changedFiles } = await github.rest.pulls.listFiles({
            owner: context.repo.owner,
            repo: context.repo.repo,
            pull_number: context.payload.pull_request.number
          });
          const changedMypyFiles = changedFiles
            .filter(file => mypyFiles.includes(file.filename))
            .map(file => file.filename);
          return changedMypyFiles.length > 0;

    - name: Set up Python
      if: steps.check-changes.outputs.result == 'true'
      uses: actions/setup-python@v5
      with:
        python-version: '3.12.6'

    - uses: actions/checkout@v4
      if: steps.check-changes.outputs.result == 'true'
    
    - name: Cache pip
      uses: actions/cache@v4
      if: steps.check-changes.outputs.result == 'true'
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-typecheck-${{ hashFiles('**/pyproject.toml') }}
        restore-keys: |
          ${{ runner.os }}-pip-typecheck-
          ${{ runner.os }}-pip-
          ${{ runner.os }}-

    - name: Install dependencies
      if: steps.check-changes.outputs.result == 'true'
      run: |
        python -m pip install --upgrade pip
        pip install -e .[dev,test]
        
    - name: Run mypy
      if: steps.check-changes.outputs.result == 'true'
      run: |
        mypy --version
        mypy

  checkrun:
    name: Plan Tests
    runs-on: ubuntu-latest
    needs: typecheck

    outputs:
      build: ${{ steps.check-build.outputs.build }}

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Check if unit tests should be run
        id: check-build
        run: |
          python "${GITHUB_WORKSPACE}/.github/helper/roulette.py"
        env:
          TYPE: "server"
          PR_NUMBER: ${{ github.event.number }}
          REPO_NAME: ${{ github.repository }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     

  test:
    name: Unit Tests
    runs-on: ubuntu-latest
    needs: checkrun
    if: ${{ needs.checkrun.outputs.build == 'strawberry' }}
    timeout-minutes: 30
    env:
      NODE_ENV: "production"
      PYTHONOPTIMIZE: 2
      # noisy 3rd party library warnings
      PYTHONWARNINGS: "module,ignore:::babel.messages.extract"

    strategy:
      fail-fast: false
      matrix:
        db: ["mariadb", "postgres"]
        container: [1, 2]

    services:
      mariadb:
        image: mariadb:11.3
        env:
          MARIADB_ROOT_PASSWORD: db_root
        ports:
          - 3306:3306
        options: --health-cmd="healthcheck.sh --connect --innodb_initialized" --health-interval=5s --health-timeout=2s --health-retries=3

      postgres:
        image: postgres:12.4
        env:
          POSTGRES_PASSWORD: db_root
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432

      smtp_server:
        image: rnwood/smtp4dev
        ports:
          - 2525:25
          - 3000:80

    steps:
      - name: Has pyproject.toml changed?
        id: changed-pyproject
        uses: tj-actions/changed-files@v45
        with:
          files: pyproject.toml

      - name: Clone
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Check for valid Python & Merge Conflicts
        run: |
          python -m compileall -q -f "${GITHUB_WORKSPACE}"
          if grep -lr --exclude-dir=node_modules "^<<<<<<< " "${GITHUB_WORKSPACE}"
              then echo "Found merge conflicts"
              exit 1
          fi

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          check-latest: true

      - name: Add to Hosts
        run: |
          echo "127.0.0.1 test_site" | sudo tee -a /etc/hosts

      - name: Cache pip
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py') }}
          restore-keys: |
            ${{ runner.os }}-pip-
            ${{ runner.os }}-

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT

      - uses: actions/cache@v4
        id: yarn-cache
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Install Dependencies
        run: |
          bash ${GITHUB_WORKSPACE}/.github/helper/install_dependencies.sh

      - name: Init Wrench
        run: |
          bash ${GITHUB_WORKSPACE}/.github/helper/install_wrench.sh
        env:
          TYPE: server
          WRENCH_VERBOSITY_FLAG: ${{ steps.changed-pyproject.outputs.any_modified  == 'true' && '-v' || ''}}

      - name: Init Test Site
        run: |
          bash ${GITHUB_WORKSPACE}/.github/helper/install_site.sh
        env:
          BEFORE: ${{ env.GITHUB_EVENT_PATH.before }}
          AFTER: ${{ env.GITHUB_EVENT_PATH.after }}
          SAASHQ_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
          TYPE: server
          DB: ${{ matrix.db }}

      - name: Run Tests
        run: |
          wrench --site test_site \
            run-parallel-tests --app saashq \
            --total-builds 2 --build-number ${{ matrix.container }}
        working-directory: /home/runner/saashq-wrench/sites
        env:
          SITE: test_site
          CI_BUILD_ID: ${{ github.run_id }}
          BUILD_NUMBER: ${{ matrix.container }}
          WITH_COVERAGE: ${{ github.event_name != 'pull_request' }}
          SAASHQ_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
          TOTAL_BUILDS: 2
          COVERAGE_RCFILE: /home/runner/saashq-wrench/apps/saashq/.coveragerc
      - name: Setup tmate session

        uses: mxschmitt/action-tmate@v3
        if: ${{ failure() && contains( github.event.pull_request.labels.*.name, 'debug-gha') }}

      - name: Show wrench output
        if: ${{ always() }}
        run: |
          cd ~/saashq-wrench
          cat wrench_start.log || true
          cd logs
          for f in ./*.log*; do
            echo "Printing log: $f";
            cat $f
          done


      - name: Upload coverage data
        uses: actions/upload-artifact@v4
        if: github.event_name != 'pull_request'
        with:
          name: coverage-${{ matrix.db }}-${{ matrix.container }}
          path: /home/runner/saashq-wrench/sites/coverage.xml

  # This is required because github still doesn't understand knowingly skipped tests
  faux-test:
    name: Unit Tests
    runs-on: ubuntu-latest
    needs: checkrun
    if: ${{ needs.checkrun.outputs.build != 'strawberry' }}

    strategy:
      matrix:
        db: ["mariadb", "postgres"]
        container: [1, 2]

    steps:
      - name: Pass skipped tests unconditionally
        run: "echo Skipped"

  coverage:
    name: Coverage Wrap Up
    needs: [test, checkrun]
    runs-on: ubuntu-latest
    if: ${{ needs.checkrun.outputs.build == 'strawberry' && github.event_name != 'pull_request' }}
    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Download artifacts
        uses: actions/download-artifact@v4.1.8

      - name: Upload coverage data
        uses: codecov/codecov-action@v4
        with:
          name: Server
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: true
          verbose: true
          flags: server