os-blas-test-matrix.yml

name: OS/BLAS test matrix

on:
  workflow_dispatch:
  pull_request:
    paths:
      - .github/workflows/os-blas-test-matrix.yml
      - .github/scripts/set-conda-test-matrix.py
      - .github/scripts/set-conda-pip-matrix.py
      - .github/conda-env/build-env.yml
      - .github/conda-env/test-env.yml

jobs:
  build-pip:
    name: Build pip Py${{ matrix.python }}, ${{ matrix.os }}, ${{ matrix.bla_vendor}} BLA_VENDOR
    runs-on: ${{ matrix.os }}-latest
    strategy:
        fail-fast: false
        matrix:
            os:
              - 'ubuntu'
              - 'macos'
            python:
              - '3.10'
              - '3.12'
            bla_vendor: [ 'unset' ]
            include:
              - os: 'ubuntu'
                python: '3.12'
                bla_vendor: 'Generic'
              - os: 'ubuntu'
                python: '3.12'
                bla_vendor: 'OpenBLAS'
              - os: 'macos'
                python: '3.12'
                bla_vendor: 'Apple'
              - os: 'macos'
                python: '3.12'
                bla_vendor: 'Generic'
              - os: 'macos'
                python: '3.12'
                bla_vendor: 'OpenBLAS'

    steps:
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python }}
      - name: Checkout Slycot
        uses: actions/checkout@v3
        with:
          repository: python-control/Slycot
          fetch-depth: 0
          submodules: 'recursive'
      - name: Setup Ubuntu
        if: matrix.os == 'ubuntu'
        run: |
          sudo apt-get -y update
          sudo apt-get -y install gfortran cmake --fix-missing
          case ${{ matrix.bla_vendor }} in
            unset | Generic )  sudo apt-get -y install libblas-dev liblapack-dev ;;
            OpenBLAS        ) sudo apt-get -y install libopenblas-dev ;;
            *)
              echo "bla_vendor option ${{ matrix.bla_vendor }} not supported"
              exit 1 ;;
          esac
      - name: Setup macOS
        if: matrix.os == 'macos'
        run: |
          case ${{ matrix.bla_vendor }} in
            unset | Generic | Apple ) ;; # Found in system
            OpenBLAS )
              brew install openblas
              echo "LDFLAGS=-L/opt/homebrew/opt/openblas/lib" >> $GITHUB_ENV
              echo "CPPFLAGS=-I/opt/homebrew/opt/openblas/include" >> $GITHUB_ENV
              ;;
            *)
              echo "bla_vendor option ${{ matrix.bla_vendor }} not supported"
              exit 1 ;;
          esac
          echo "FC=gfortran-14" >> $GITHUB_ENV
      - name: Build wheel
        env:
          BLA_VENDOR: ${{ matrix.bla_vendor }}
          CMAKE_GENERATOR: Unix Makefiles
        run: |
          if [[ $BLA_VENDOR = unset ]]; then unset BLA_VENDOR; fi
          python -m pip install --upgrade pip
          pip wheel -v -w . .
          wheeldir=slycot-wheels/${{ matrix.os }}-${{ matrix.python }}-${{ matrix.bla_vendor }}
          mkdir -p ${wheeldir}
          cp ./slycot*.whl ${wheeldir}/
      - name: Save wheel
        uses: actions/upload-artifact@v4
        with:
          name: slycot-wheels-${{ matrix.os }}-${{ matrix.python }}-${{ matrix.bla_vendor }}
          path: slycot-wheels
          retention-days: 5


  build-conda:
    name: Build conda Py${{ matrix.python }}, ${{ matrix.os }}
    runs-on: ${{ matrix.os }}-latest
    strategy:
        fail-fast: false
        matrix:
          os:
            - 'ubuntu'
            - 'macos'
          python:
            # build on one, expand matrix in conda-build from the Sylcot/conda-recipe/conda_build_config.yaml
            - '3.11'

    steps:
      - name: Checkout Slycot
        uses: actions/checkout@v3
        with:
          repository: python-control/Slycot
          fetch-depth: 0
          submodules: 'recursive'
      - name: Setup Conda
        uses: conda-incubator/setup-miniconda@v3
        with:
          python-version: ${{ matrix.python }}
          activate-environment: build-env
          environment-file: .github/conda-env/build-env.yml
          miniforge-version: latest
          channels: conda-forge,defaults
          channel-priority: strict
          auto-update-conda: false
          auto-activate-base: false
      - name: Conda build
        shell: bash -el {0}
        run: |
          set -e
          conda mambabuild conda-recipe
          # preserve directory structure for custom conda channel
          find "${CONDA_PREFIX}/conda-bld" -maxdepth 2 -name 'slycot*.tar.bz2' | while read -r conda_pkg; do
            conda_platform=$(basename $(dirname "${conda_pkg}"))
            mkdir -p "slycot-conda-pkgs/${conda_platform}"
            cp "${conda_pkg}" "slycot-conda-pkgs/${conda_platform}/"
          done
          python -m conda_index ./slycot-conda-pkgs
      - name: Save to local conda pkg channel
        uses: actions/upload-artifact@v4
        with:
          name: slycot-conda-pkgs-${{ matrix.os }}-${{ matrix.python }}
          path: slycot-conda-pkgs
          retention-days: 5


  create-wheel-test-matrix:
    name: Create wheel test matrix
    runs-on: ubuntu-latest
    needs: build-pip
    if: always()  # run tests for all successful builds, even if others failed
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - name: Merge artifacts
        uses: actions/upload-artifact/merge@v4
        with:
          name: slycot-wheels
          pattern: slycot-wheels-*
      - name: Checkout python-control
        uses: actions/checkout@v3
      - name: Download wheels (if any)
        uses: actions/download-artifact@v4
        with:
          name: slycot-wheels
          path: slycot-wheels
      - id: set-matrix
        run: |
          TEMPFILE="$(mktemp)"
          python3 .github/scripts/set-pip-test-matrix.py | tee $TEMPFILE
          echo "matrix=$(cat $TEMPFILE)" >> $GITHUB_OUTPUT


  create-conda-test-matrix:
    name: Create conda test matrix
    runs-on: ubuntu-latest
    needs: build-conda
    if: always()  # run tests for all successful builds, even if others failed
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - name: Merge artifacts
        uses: actions/upload-artifact/merge@v4
        with:
          name: slycot-conda-pkgs
          pattern: slycot-conda-pkgs-*
      - name: Checkout python-control
        uses: actions/checkout@v3
      - name: Download conda packages
        uses: actions/download-artifact@v4
        with:
          name: slycot-conda-pkgs
          path: slycot-conda-pkgs
      - id: set-matrix
        run: |
          TEMPFILE="$(mktemp)"
          python3 .github/scripts/set-conda-test-matrix.py | tee $TEMPFILE
          echo "matrix=$(cat $TEMPFILE)" >> $GITHUB_OUTPUT


  test-wheel:
    name: Test wheel ${{ matrix.packagekey }}, ${{matrix.blas_lib}} BLAS lib ${{ matrix.failok }}
    needs: create-wheel-test-matrix
    runs-on: ${{ matrix.os }}-latest
    continue-on-error: ${{ matrix.failok == 'FAILOK' }}

    strategy:
      fail-fast: false
      matrix: ${{ fromJSON(needs.create-wheel-test-matrix.outputs.matrix) }}

    steps:
      - name: Checkout Slycot
        uses: actions/checkout@v3
        with:
          repository: 'python-control/Slycot'
          path: slycot-src
      - name: Checkout python-control
        uses: actions/checkout@v3
      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python }}
      - name: Setup Ubuntu
        if: matrix.os == 'ubuntu'
        run: |
          set -xe
          sudo apt-get -y update
          case ${{ matrix.blas_lib }} in
            Generic )  sudo apt-get -y install libblas3 liblapack3 ;;
            unset | OpenBLAS ) sudo apt-get -y install libopenblas0 ;;
            *)
              echo "BLAS ${{ matrix.blas_lib }} not supported for wheels on Ubuntu"
              exit 1 ;;
          esac
          update-alternatives --display libblas.so.3-x86_64-linux-gnu
          update-alternatives --display liblapack.so.3-x86_64-linux-gnu
      - name: Setup macOS
        if: matrix.os == 'macos'
        run: |
          set -xe
          brew install coreutils
          case ${{ matrix.blas_lib }} in
            unset | Generic | Apple ) ;; # system provided (Uses Apple Accelerate Framework)
            OpenBLAS )
              brew install openblas
              echo "DYLIB_LIBRARY_PATH=/usr/local/opt/openblas/lib" >> $GITHUB_ENV
              ;;
            *)
              echo "BLAS option ${{ matrix.blas_lib }} not supported for wheels on MacOS"
              exit 1 ;;
          esac
      - name: Download wheels
        uses: actions/download-artifact@v4
        with:
          name: slycot-wheels
          path: slycot-wheels
      - name: Install Wheel
        run: |
          python -m pip install --upgrade pip
          pip install matplotlib scipy pytest pytest-cov pytest-timeout coverage numpydoc
          pip install slycot-wheels/${{ matrix.packagekey }}/slycot*.whl
          pip show slycot
      - name: Test with pytest
        run: JOBNAME="$JOBNAME" pytest control/tests
        env:
          JOBNAME: wheel ${{ matrix.packagekey }} ${{ matrix.blas_lib }}


  test-conda:
    name: Test conda ${{ matrix.packagekey }}, ${{matrix.blas_lib}} BLAS lib ${{ matrix.failok }}
    needs: create-conda-test-matrix
    runs-on: ${{ matrix.os }}-latest
    continue-on-error: ${{ matrix.failok == 'FAILOK' }}

    strategy:
      fail-fast: false
      matrix: ${{ fromJSON(needs.create-conda-test-matrix.outputs.matrix) }}

    defaults:
      run:
        shell: bash -el {0}

    steps:
      - name: Checkout Slycot
        uses: actions/checkout@v3
        with:
          repository: 'python-control/Slycot'
          path: slycot-src
      - name: Checkout python-control
        uses: actions/checkout@v3
      - name: Setup macOS
        if: matrix.os == 'macos'
        run: brew install coreutils
      - name: Setup Conda
        uses: conda-incubator/setup-miniconda@v3
        with:
          python-version: ${{ matrix.python }}
          miniforge-version: latest
          activate-environment: test-env
          environment-file: .github/conda-env/test-env.yml
          channels: conda-forge,defaults
          channel-priority: strict
          auto-activate-base: false
      - name: Download conda packages
        uses: actions/download-artifact@v4
        with:
          name: slycot-conda-pkgs
          path: slycot-conda-pkgs
      - name: Install Conda package
        run: |
          set -e
          case ${{ matrix.blas_lib }} in
            unset        ) # the conda-forge default (os dependent)
              conda install libblas libcblas liblapack
              ;;
            Generic      )
              conda install 'libblas=*=*netlib' 'libcblas=*=*netlib' 'liblapack=*=*netlib'
              echo "libblas * *netlib" >> $CONDA_PREFIX/conda-meta/pinned
              ;;
            OpenBLAS     )
              conda install 'libblas=*=*openblas' openblas
              echo "libblas * *openblas" >> $CONDA_PREFIX/conda-meta/pinned
              ;;
            Intel10_64lp )
              conda install 'libblas=*=*mkl' mkl
              echo "libblas * *mkl" >> $CONDA_PREFIX/conda-meta/pinned
              ;;
          esac
          if [ "${{ matrix.os }}" = "windows" ]; then
            echo "Installing slycot from conda-forge on Windows"
            conda install slycot
          else
            echo "Installing built conda package from local channel"
            conda install -c ./slycot-conda-pkgs slycot
          fi	  
          conda list
      - name: Test with pytest
        run: JOBNAME="$JOBNAME" pytest control/tests
        env:
          JOBNAME: conda ${{ matrix.packagekey }} ${{ matrix.blas_lib }}