unit_tests.yml

name: Unit tests

on:
  push:
    branches:
      - master
      - dev
  pull_request:
    branches:
      - master
  workflow_dispatch:

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

jobs:
  unit_tests:

    runs-on: ubuntu-latest
    env:
      GH_TOKEN: ${{ github.token }}
    strategy:
      matrix:
        combos: [{group: 1, python_version: '3.9'},
                 {group: 2, python_version: '3.10'},
                 {group: 3, python_version: '3.11'},
                 {group: 4, python_version: '3.12'},
                 {group: 5, python_version: '3.12'},
                 {group: 6, python_version: '3.12'},
                 {group: 7, python_version: '3.12'},
                 {group: 8, python_version: '3.12'}]

    steps:
      - uses: actions/checkout@v4

      - name: Filter changes
        id: changes
        uses: dorny/paths-filter@v3
        with:
          filters: |
            has_changes:
              - 'desc/**'
              - 'tests/**'
              - 'requirements.txt'
              - 'devtools/dev-requirements.txt'
              - 'setup.cfg'
              - '.github/workflows/unit_tests.yml'

      - name: Check for relevant changes
        id: check_changes
        run: echo "has_changes=${{ steps.changes.outputs.has_changes }}" >> $GITHUB_ENV

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

      - name: Restore Python environment cache
        if: env.has_changes == 'true'
        id: restore-env
        uses: actions/cache/restore@v4
        with:
          path: .venv-${{ matrix.combos.python_version }}
          key: ${{ runner.os }}-venv-${{ matrix.combos.python_version }}-${{ hashFiles('devtools/dev-requirements.txt', 'requirements.txt') }}

      - name: Set up virtual environment if not restored from cache
        if: steps.restore-env.outputs.cache-hit != 'true' && env.has_changes == 'true'
        run: |
          gh cache list
          python -m venv .venv-${{ matrix.combos.python_version }}
          source .venv-${{ matrix.combos.python_version }}/bin/activate
          python -m pip install --upgrade pip
          pip install -r devtools/dev-requirements.txt
          pip install matplotlib==3.7.2

      - name: Set Swap Space
        if: env.has_changes == 'true'
        uses: pierotofy/set-swap-space@master
        with:
          swap-size-gb: 10

      - name: Test with pytest
        if: env.has_changes == 'true'
        run: |
          source .venv-${{ matrix.combos.python_version }}/bin/activate
          pip install matplotlib==3.7.2
          pwd
          lscpu
          python -m pytest -v -m unit \
            --durations=0 \
            --cov-report xml:cov.xml \
            --cov-config=setup.cfg \
            --cov=desc/ \
            --mpl \
            --mpl-results-path=mpl_results.html \
            --mpl-generate-summary=html \
            --splits 8 \
            --group ${{ matrix.combos.group }} \
            --splitting-algorithm least_duration \
            --db ./prof.db

      - name: save coverage file and plot comparison results
        if: always() && env.has_changes == 'true'
        uses: actions/upload-artifact@v4
        with:
          name: unit_test_artifact-${{ matrix.combos.python_version }}-${{ matrix.combos.group }}
          path: |
            ./cov.xml
            ./mpl_results.html
            ./prof.db

      - name: Upload coverage
        if: env.has_changes == 'true'
        id : codecov
        uses: Wandalen/wretry.action@v1.3.0
        with:
          action: codecov/codecov-action@v3
          with: |
            token: ${{ secrets.CODECOV_TOKEN }}
            name: codecov-umbrella
            files: ./cov.xml
            fail_ci_if_error: true
            verbose: true
          attempt_limit: 10
          attempt_delay: 60000 # ms, 1 min

      - name: Generate 100% Coverage Report
        if: env.has_changes == 'false'
        run: |
          echo '<?xml version="1.0" ?>
          <coverage line-rate="1" lines-covered="1" lines-valid="1" branches-covered="0" branches-valid="0" complexity="0" version="7.6.1">
            <sources>
              <source>/home/runner/work/DESC/DESC/desc</source>
            </sources>
            <packages>
              <package name="." line-rate="1" branch-rate="1" complexity="0">
                <classes>
                  <class name="__init__.py" filename="__init__.py" complexity="0" line-rate="1" branch-rate="0">
                  <methods/>
                    <lines>
                      <line number="3" hits="1"/>
                    </lines>
                  </class>
                </classes>
              </package>
            </packages>
          </coverage>' > cov.xml

      - name: Upload 100% Coverage Report if skipped
        if: env.has_changes == 'false'
        id: upload-coverage
        uses: Wandalen/wretry.action@v1.3.0
        with:
          action: codecov/codecov-action@v3
          with: |
            token: ${{ secrets.CODECOV_TOKEN }}
            name: codecov-umbrella
            files: ./cov.xml
            fail_ci_if_error: true
            verbose: true
          attempt_limit: 10
          attempt_delay: 60000 # ms, 1 min