test.yml

name: Tests
on:
  push:
    branches:
      - develop
  pull_request:
    branches-ignore:
      - master
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

env:
  DEFAULT_PYTHON: '3.14'
  MIN_COVERAGE: 92

permissions:
  contents: write
  checks: write
  pull-requests: write

jobs:
  tests:
    name: Run tests (Python ${{ matrix.python-version }}, Pydantic v${{ matrix.pydantic-version }} on ${{ matrix.os }})
    runs-on: ${{ matrix.os }}

    strategy:
      fail-fast: false
      matrix:
        include:
          - python-version: '3.7'
            pydantic-version: '1'
            os: ubuntu-22.04

          - python-version: '3.14'
            pydantic-version: '2'
            os: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v4

      - name: Start container dependencies
        run: |
          docker compose -f docker-compose.test.yml down -v --remove-orphans
          docker compose -f docker-compose.test.yml up -d db ldap

      # https://docs.docker.com/build/ci/github-actions/cache/#local-cache
      - name: Cache Docker layers
        uses: actions/cache@v5
        with:
          path: ${{ runner.temp }}/.buildx-cache
          key: ${{ runner.os }}-buildx-${{ hashFiles('docker/Dockerfile.backend', 'pyproject.toml', 'uv.lock') }}
          restore-keys: |
            ${{ runner.os }}-buildx-

      - name: Build Backend Container
        uses: docker/build-push-action@v7
        with:
          context: .
          file: docker/Dockerfile.backend
          tags: mtsrus/horizon-backend:develop
          target: test
          build-args: |
            PYTHON_VERSION=${{ matrix.python-version }}
          push: false
          load: true
          cache-from: type=local,src=${{ runner.temp }}/.buildx-cache

      - name: Creare reports dir
        run: |
          mkdir -p reports/
          sudo chmod 777 -R reports/

      - name: Start Backend
        run: |
          docker compose -f docker-compose.test.yml up -d --wait --wait-timeout 60

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}

      - name: Install system dependencies
      # this step is needed for successful installation of "bonsai" library in python dependencies
        run: sudo apt-get update && sudo apt-get install -y libldap2-dev libsasl2-dev

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: 'false'

      # astral-sh/setup-uv cannot restore multiple keys
      - name: Cache uv
        uses: actions/cache@v5
        with:
          path: ~/.cache/uv
          key: ${{ runner.os }}-python${{ env.DEFAULT_PYTHON }}-pydantic${{ matrix.pydantic-version }}-${{ hashFiles('uv.lock') }}
          restore-keys: |
            ${{ runner.os }}-python${{ env.DEFAULT_PYTHON }}-pydantic${{ matrix.pydantic-version }}-${{ hashFiles('uv.lock') }}
            ${{ runner.os }}-python${{ env.DEFAULT_PYTHON }}-pydantic${{ matrix.pydantic-version }}-
            ${{ runner.os }}-python${{ env.DEFAULT_PYTHON }}-

      - name: Install dependencies
        run: |
          uv sync --all-extras --group test
          if [ "${{ matrix.pydantic-version }}" == "1" ]; then
            uv run pip install "pydantic<2.0.0"
          fi

      - name: Run Tests
        run: |
          source .env.local
          uv run coverage run -m pytest --junitxml=reports/junit/test-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.pydantic-version }}.xml

      - name: Dump backend logs on failure
        if: failure()
        uses: jwalton/gh-docker-logs@v2
        with:
          images: mtsrus/horizon-backend
          dest: ./logs

      - name: Shutdown Backend Container
        if: always()
        run: |
          docker compose -f docker-compose.test.yml down -v --remove-orphans

      - name: Upload server logs
        uses: actions/upload-artifact@v7
        if: failure()
        with:
          name: backend-logs-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.pydantic-version }}
          path: logs/*

      - name: Upload Coverage Results
        uses: actions/upload-artifact@v7
        if: success() || failure()
        with:
          name: coverage-${{ matrix.os }}-${{ matrix.python-version }}-${{ matrix.pydantic-version }}
          path: reports/
          # https://github.com/actions/upload-artifact/issues/602
          include-hidden-files: true

  all_done:
    name: Tests done
    runs-on: ubuntu-latest

    permissions:
      contents: write
      checks: write
      pull-requests: write

    if: success() || failure()
    needs: [tests]

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Download all raw coverage data
        uses: actions/download-artifact@v8
        with:
          path: reports/
          pattern: coverage-*
          merge-multiple: true

      - name: Show test results
        uses: mikepenz/action-junit-report@v6
        with:
          report_paths: reports/junit/*.xml

      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ env.DEFAULT_PYTHON }}

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: 'false'

      - name: Install dependencies
        run: |
          uv sync --group test

      - name: Combine Coverage Data
        run: |
          uv run coverage combine
          uv run coverage xml -o reports/coverage.xml

      - name: Coverage comment
        id: coverage
        uses: MishaKav/pytest-coverage-comment@v1
        with:
          pytest-xml-coverage-path: ./reports/coverage.xml
          default-branch: develop
          xml-skip-covered: true
          report-only-changed-files: true
          hide-comment: ${{ github.event_name != 'pull_request' }}

      - name: Dynamic Badges
        uses: schneegans/dynamic-badges-action@v1.7.0
        if: github.repository == 'MTSWebServices/horizon' && github.event_name == 'push'
        with:
          auth: ${{ secrets.AUTOMERGE_TOKEN }}
          gistID: 03e73a82ecc4709934540ce8201cc3b4
          filename: horizon_badge.json
          label: Coverage
          message: ${{ steps.coverage.outputs.coverage }}
          color: ${{ steps.coverage.outputs.color }}

      - name: Fail if coverage too low
        if: ${{ steps.coverage.outputs.coverage < env.MIN_COVERAGE }}
        run: |
          echo "Coverage is below ${{ env.MIN_COVERAGE }}%!"
          exit 1

      - name: All done
        run: echo 1