CI.yml

# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the action will run.
on:
  # Triggers the workflow on push or pull request events but only for the master branch
  push:
    branches: [main]
  pull_request:
    branches: [main]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

  # # Run tests every month
  # schedule:
  #   - cron: '0 0 1 * *'

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  linux:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - name: "Ubuntu OpenMPI g++"
            CC_COMPILER: gcc
            CXX_COMPILER: g++
            container: "ubuntu_gcc_openmpi"
            MPIEXEC_PREFLAGS: "--allow-run-as-root --oversubscribe"
            USE_SANITIZER: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: "--cap-add SYS_PTRACE"
            CODE_COVERAGE: "OFF"

          - name: "Ubuntu OpenMPI clang++"
            CC_COMPILER: clang
            CXX_COMPILER: clang++
            container: "ubuntu_clang_openmpi"
            MPIEXEC_PREFLAGS: "--allow-run-as-root --oversubscribe"
            USE_SANITIZER: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: "--cap-add SYS_PTRACE"
            CODE_COVERAGE: "OFF"

          - name: "Ubuntu MPICH g++"
            CC_COMPILER: gcc
            CXX_COMPILER: g++
            container: "ubuntu_gcc_mpich"
            MPIEXEC_PREFLAGS: ""
            CMAKE_BUILD_TYPE: Debug
            DOCKER_OPTIONS: " "
            CODE_COVERAGE: "ON"

          - name: "Ubuntu MPICH clang++"
            CC_COMPILER: clang
            CXX_COMPILER: clang++
            container: "ubuntu_clang_mpich"
            MPIEXEC_PREFLAGS: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: " "
            CODE_COVERAGE: "OFF"

          # Hangs on github
          - name: "Debian OpenMPI g++"
            CC_COMPILER: gcc
            CXX_COMPILER: g++
            container: "debian_gcc_openmpi"
            MPIEXEC_PREFLAGS: "--allow-run-as-root --oversubscribe"
            USE_SANITIZER: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: "--cap-add SYS_PTRACE"
            CODE_COVERAGE: "OFF"

          - name: "Debian OpenMPI clang++"
            CC_COMPILER: clang
            CXX_COMPILER: clang++
            container: "debian_clang_openmpi"
            MPIEXEC_PREFLAGS: "--allow-run-as-root --oversubscribe"
            USE_SANITIZER: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: "--cap-add SYS_PTRACE"
            CODE_COVERAGE: "OFF"

          - name: "Debian MPICH g++"
            CC_COMPILER: gcc
            CXX_COMPILER: g++
            container: "debian_gcc_mpich"
            MPIEXEC_PREFLAGS: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: " "
            CODE_COVERAGE: "OFF"

          - name: "Debian MPICH clang++"
            CC_COMPILER: clang
            CXX_COMPILER: clang++
            container: "debian_clang_mpich"
            MPIEXEC_PREFLAGS: ""
            CMAKE_BUILD_TYPE: Release
            DOCKER_OPTIONS: " "
            CODE_COVERAGE: "OFF"

    container:
      image: pierremarchand/htool_testing_environments:${{ matrix.container }}
      options: --user root ${{ matrix.DOCKER_OPTIONS }}

    name: CI (${{ matrix.name }})

    env:
      CC: ${{ matrix.CC_COMPILER }}
      CXX: ${{ matrix.CXX_COMPILER }}

    # Steps represent a sequence of tasks that will be executed as part of the job
    if: "!contains(github.event.head_commit.message, '[ci skip]')"
    steps:
      - name: Checkout htool-python
        uses: actions/checkout@v3
        with:
          submodules: "true"

      - name: Activate virtualenv
        run: |
          . /usr/local/share/venv/bin/activate
          echo PATH=$PATH >> $GITHUB_ENV

      - name: Build package in release
        if: matrix.CODE_COVERAGE == 'OFF'
        run: |
          python3 -m pip install .[dev]

      - name: Build package in debug for coverage
        if: matrix.CODE_COVERAGE == 'ON'
        run: |
          mkdir build && cd build
          python3 -m pip install numpy matplotlib ruff pytest mpi4py scipy 
          CC=${{ matrix.CC_COMPILER }} CXX=${{ matrix.CXX_COMPILER }} cmake -DUSE_SANITIZER=${{ matrix.USE_SANITIZER }} -DCMAKE_BUILD_TYPE=${{ matrix.CMAKE_BUILD_TYPE }} -DCODE_COVERAGE=${{ matrix.CODE_COVERAGE }} ../
          make

      - name: Run tests
        run: |
          export PYTHONPATH="$PWD/build"
          mpirun -np 1 ${{ matrix.MPIEXEC_PREFLAGS }} python3 -m pytest tests
          mpirun -np 2 ${{ matrix.MPIEXEC_PREFLAGS }} python3 -m pytest tests
          mpirun -np 3 ${{ matrix.MPIEXEC_PREFLAGS }} python3 -m pytest tests
          mpirun -np 4 ${{ matrix.MPIEXEC_PREFLAGS }} python3 -m pytest tests

      - name: Check format
        if: matrix.CODE_COVERAGE == 'ON'
        # https://github.com/actions/checkout/pull/762
        run: |
          git config --global --add safe.directory `pwd` 
          cd build
          make format
          make cmake-format
          git diff --exit-code

      - name: Check with ruff
        run: |
          ruff check example/ tests/

      - name: Generate coverage reports
        if: matrix.CODE_COVERAGE == 'ON'
        run: |
          lcov --ignore-errors mismatch --capture --base-directory ./ --directory build/ --output-file coverage.info
          lcov --remove  coverage.info '/usr/*' '*/hpddm/*' '*/pybind11/*' '*/lib/htool/*' --output-file  ../coverage.info

      - uses: actions/upload-artifact@v4
        with:
          path: coverage.info
          if-no-files-found: error
        if: matrix.CODE_COVERAGE == 'ON'

  coverage:
    runs-on: ubuntu-latest
    if: ${{ success() }}
    needs: [ linux ]
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/download-artifact@v4
      - name: Upload coverage report
        uses: codecov/codecov-action@v4
        with:
          fail_ci_if_error: true
          file: ./coverage.info
          token: ${{ secrets.CODECOV_TOKEN }}
          verbose: true