ci.yml

name: Build + Test

on:
  push:
    branches:
      - main
      - dev
  pull_request:
    branches:
      - main
      - dev
      - alpha-dev
  workflow_dispatch:

jobs:
  build-and-test:
    runs-on: ${{ matrix.os }}
    name: Testing on ${{ matrix.os }} with Python ${{ matrix.python }}
    strategy:
      matrix:
        os:
          - ubuntu-latest
          # Disable MacOS for now - we do not yet officially support it and we need to invest a bit
          # more efforts into investigating broken LAZ files written by Helios on MacOS.
          # - macos-latest
          - windows-latest
        python:
          - "3.8"
          - "3.12"
    
    defaults:
      run:
        # Conda requires a login shell in order to work properly
        shell: bash -l {0}  
    
    steps:
      - uses: actions/checkout@v4

      - name: Create Helios dev environment
        uses: conda-incubator/setup-miniconda@v2
        with:
          auto-update-conda: true
          auto-activate-base: false
          activate-environment: helios-dev
          environment-file: environment-dev.yml
          python-version: ${{ matrix.python }}

      - name: Install Helios
        run: |
          python -m pip install -v .
      
      - name: Run tests
        run: |
          python -m pytest -m exe
          python -m pytest -m pyh

  address-sanitizer:
    name: Address Sanitizer
    runs-on: ubuntu-latest
    env:
      ASAN_OPTIONS: "detect_stack_use_after_return=1:check_initialization_order=1:strict_init_order=1"

    defaults:
      run:
        # Conda requires a login shell in order to work properly
        shell: bash -l {0}
    steps:
      - uses: actions/checkout@v4

      - name: Create Helios dev environment
        uses: conda-incubator/setup-miniconda@v2
        with:
          auto-update-conda: true
          auto-activate-base: false
          activate-environment: helios-dev
          environment-file: environment-dev.yml
          python-version: "3.11"

      - name: Install Helios
        run: |
          python -m pip install -v .
        env:
          SKBUILD_CMAKE_BUILD_TYPE: "Debug"
          SKBUILD_CMAKE_ARGS: "-DCMAKE_CXX_FLAGS=\"-fsanitize=address -fsanitize-address-use-after-scope -fno-omit-frame-pointer\""

      - name: run python tests
        shell: bash
        # for LD_PRELOAD see https://github.com/google/sanitizers/issues/934#issuecomment-649516500
        run: |
          echo "leak:/usr/bin/bash" > supp.txt
          # hack to prevent external libs from dlclosing libraries,
          # which otherwise results in <module not found> LSAN leaks that cannot be suppressed
          # https://github.com/google/sanitizers/issues/89#issuecomment-406316683
          echo "#include <stdio.h>" > dlclose.c
          echo "int dlclose(void *handle) { return 0; }" >> dlclose.c
          clang -shared dlclose.c -o libdlclose.so
          LSAN_OPTIONS=suppressions="$(pwd)/supp.txt" LD_PRELOAD="$(gcc -print-file-name=libasan.so) /usr/lib/x86_64-linux-gnu/libstdc++.so.6 $(pwd)/libdlclose.so" PYTHONMALLOC=malloc pytest -s