reusable-python-testing-linting-with-db.yml

name: reusable-testing-linting-pipeline-with-db

on:
  workflow_call:
    inputs:
      DJANGO_SETTINGS_MODULE:
          required: true
          type: string
      directories_to_test:
          description: "Directories to test"
          type: string
          required: false
          default: "tests/"
      directories_for_coverage:
          description: "Directories to test"
          type: string
          required: false
          default: "app/"

env:
  JEST_JUNIT_OUTPUT_FILE: "/home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/unit-test-results.xml"
  DJANGO_SETTINGS_MODULE: ${{ inputs.DJANGO_SETTINGS_MODULE }}
  DATABASE_HOST: ${{ vars.DATABASE_HOST }}
  DATABASE_NAME: ${{ vars.DATABASE_NAME }}
  DATABASE_PASSWORD: ${{ vars.DATABASE_PASSWORD }}
  DATABASE_USER: ${{ vars.DATABASE_USER }}

permissions:
  id-token: write # This is required for requesting the JWT
  contents: read # This is required for actions/checkout
  pull-requests: write

jobs:
  Unit-Tests:
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 4
      matrix:
        db: [postgres]
        postgresql-version: [14]
        python-version: [3.11]
        include:
          - db: postgres
            db_port: 5432
    permissions:
      contents: read
      issues: read
      checks: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Start PostgreSQL
        run: |
          sudo systemctl start postgresql.service
          sudo -u postgres createuser -s runner
      - name: Git clone the repository
        uses: actions/checkout@v3
      - name: Install Dependencies
        run: pip install -r requirements.txt
      - name: Run Tests
        run: pytest ${{ inputs.directories_to_test }} --cov=${{ inputs.directories_for_coverage }} --cov-report=xml --junitxml=unit-test-results.xml
      - name: Publish Test Results
        uses: EnricoMi/publish-unit-test-result-action@v2
        if: always()
        with:
          check_name: Unit-Tests-Report
          junit_files: ${{ env.JEST_JUNIT_OUTPUT_FILE }}
      - name: Code Coverage Report
        uses: irongut/CodeCoverageSummary@v1.3.0
        with:
          filename: coverage.xml
          badge: true
          fail_below_min: true
          format: markdown
          hide_branch_rate: false
          hide_complexity: true
          indicators: true
          output: both
          thresholds: '60 80'
      - name: Finder
        uses: jwalton/gh-find-current-pr@v1
        id: finder
      - name: Add Coverage PR Comment
        uses: marocchino/sticky-pull-request-comment@v2
        if: github.event_name == 'push'
        with:
          number: ${{ steps.finder.outputs.pr }}
          message: |
            Test ${{ github.sha }} ended successfully.
            This message is from a push.
          recreate: false
          path: code-coverage-results.md

  Linting:
    name: Linting with ruff
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - name: Lint with Ruff
        run: |
          pip install ruff
          ruff check --output-format=github .
        continue-on-error: false