ci.yml

name: CI

on:
  push:
    branches:
      - main
    tags:
      - '**'
  pull_request:

env:
  MPLBACKEND: Agg
  PYTEST_ADDOPTS: --color=yes

jobs:
  static-code-checks:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python 3.11
        uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Run Ruff
        uses: chartboost/ruff-action@v1

  tests:
    needs: static-code-checks
    strategy:
      matrix:
        include:
          - python-version: "3.9"

          - python-version: "3.10"

          - python-version: "3.11"
            extra-args: ['codecov']
   
    runs-on: ubuntu-latest

    defaults:
      run:
        shell: bash -leo pipefail {0}

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
    
      - name: Prepare environment file for Mamba installation
        env:
          PYTHON_VERSION: ${{ matrix.python-version }}
        run: |
          # setup correct python version
          sed -i -e "s/- python=.*/- python=$PYTHON_VERSION/g" environment.yml

      - name: Setup Mamba
        uses: mamba-org/setup-micromamba@v1
        with:
          environment-file: environment.yml
          cache-environment: true
          post-cleanup: 'all'


      - name: Build the package
        run: |
          pip install build
          python -m build

      - name: Install the package
        run: pip install .[test]

      - name: Install the package in editable mode
        run: pip install --editable .[test]

      - name: Tests with pytest
        env:
          COVERAGE_PROCESS_START: .coveragerc
          PYTHONPATH: .

        run: |
          # to measure coverage when using subprocess for testing scripts we create sitecustomize.py
          # as specified in https://coverage.readthedocs.io/en/latest/subprocess.html
          # to initialize the coverage start up.
          echo "create sitecustomize.py"
          echo "import coverage; coverage.process_startup()" > $PYTHONPATH/sitecustomize.py
          pytest --basetemp=test_osa -vv --cov --cov-report=xml src
          cat coverage.xml

      - name: Codecov
        uses: codecov/codecov-action@v3
        if: contains(matrix.extra-args, 'codecov')