CI.yml

# This starter workflow is for a CMake project running on multiple platforms. There is a different starter workflow if you just want a single platform.
# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-single-platform.yml
name: CMake on multiple platforms

on:
  push:
    branches: [ develop ]
  pull_request:
    branches: [ develop ]

jobs:
  build:
    runs-on: ${{ matrix.os }}

    strategy:
      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations. Consider changing this to true when your workflow is stable.
      fail-fast: false

      # Set up a matrix to run the following 3 configurations:
      # 1. <Windows, Release, latest MSVC compiler toolchain on the default runner image, default generator>
      # 2. <Linux, Release, latest GCC compiler toolchain on the default runner image, default generator>
      # 3. <Linux, Release, latest Clang compiler toolchain on the default runner image, default generator>
      #
      # To add more build types (Release, Debug, RelWithDebInfo, etc.) customize the build_type list.
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]
        build_type: [Release, RelWithDebInfo]
        c_compiler: [gcc, clang, cl]
        include:
          - os: windows-latest
            c_compiler: cl
            cpp_compiler: cl
          - os: ubuntu-latest
            c_compiler: gcc
            cpp_compiler: g++
          - os: ubuntu-latest
            c_compiler: clang
            cpp_compiler: clang++
          - os: macOS-latest
            c_compiler: clang
            cpp_compiler: clang++
          - os: macOS-latest
            c_compiler: gcc
            cpp_compiler: g++
        exclude:
          - os: windows-latest
            c_compiler: gcc
          - os: windows-latest
            c_compiler: clang
          - os: ubuntu-latest
            c_compiler: cl
          - os: macOS-latest
            c_compiler: cl

    steps:
    - uses: actions/checkout@v4
  
    - name: Install lfontconfig
      if: matrix.os == 'ubuntu-latest'
      run: |
        sudo apt-get update
        sudo apt-get install -y libfontconfig1-dev

    - name: Install embree (Ubuntu)
      if: matrix.os == 'ubuntu-latest'
      run: |
        sudo apt-get update
        sudo apt-get install -y libembree-dev

    - name: Install embree (macOS)
      if: matrix.os == 'macOS-latest'
      run: |
        brew install embree

    - name: Install embree (Windows)
      if: matrix.os == 'windows-latest'
      shell: pwsh
      run: |
        $embreeVersion = "4.4.0"
        $embreeUrl = "https://github.com/embree/embree/releases/download/v$embreeVersion/embree-$embreeVersion.x64.windows.zip"
        $embreeZip = "$env:TEMP\embree.zip"
        $embreeDir = "C:\embree"
        
        Write-Host "Downloading Embree $embreeVersion..."
        Invoke-WebRequest -Uri $embreeUrl -OutFile $embreeZip
        
        Write-Host "Extracting Embree..."
        Expand-Archive -Path $embreeZip -DestinationPath $embreeDir -Force
        
        # $embreeRoot = Get-ChildItem -Path $embreeDir -Directory -Filter "embree*" | Select-Object -First 1
        $embreeCMake = Join-Path $embreeDir "lib\cmake\embree-$embreeVersion"
        $embreeLib = Join-Path $embreeDir "bin"
        
        # Write-Host "Embree root: $($embreeRoot.FullName)"
        Write-Host "Embree CMake: $embreeCMake"
        Write-Host "Embree Lib: $embreeLib"
        
        echo "embree_DIR=$embreeCMake" >> $env:GITHUB_ENV
        echo "$embreeLib" >> $env:GITHUB_PATH

    - name: Set reusable strings
      # Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
      id: strings
      shell: bash
      run: |
        echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"

    - name: Configure CMake
      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
      run: >
        cmake -B ${{ steps.strings.outputs.build-output-dir }}
        -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
        -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
        -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
        -DSOLTRACE_BUILD_GUI=OFF
        -DSOLTRACE_BUILD_EMBREE_SUPPORT=ON
        -S ${{ github.workspace }}

    - name: Build-Windows
      # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
      if: matrix.os == 'windows-latest'
      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
      
    - name: Build-Mac-Linux
      if: matrix.os != 'windows-latest'
      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}

    # - name: List test directory
    #   run: |
    #       dir build/google-tests
          

    - name: Test
      working-directory: ${{ steps.strings.outputs.build-output-dir }}
      # Execute tests defined by the CMake configuration. Note that --build-config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
      # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
      run: |
        cd ${{ steps.strings.outputs.build-output-dir }}/google-tests
        ctest --output-on-failure --build-config ${{ matrix.build_type }} -VV

  # New Dedicated GPU Run Job (Runs in parallel with the CPU Matrix)
  build-gpu:
    name: build-gpu (ubuntu-24.04-gpu, Release, gcc, OptiX)
    runs-on: gpu-runner
    container:
      image: ghcr.io/nlr-soltrace/soltrace-build-env:latest
      options: --gpus all
      env:
        NVIDIA_DRIVER_CAPABILITIES: all
        CUDA_CACHE_PATH: /tmp
      credentials:
        username: ${{ github.actor }}
        password: ${{ secrets.GITHUB_TOKEN }}

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

      - name: Install Dependencies
        run: |
          apt-get update
          apt-get install -y libembree-dev

      - name: Configure SolTrace
        run: |
          cmake -B build \
            -DCMAKE_BUILD_TYPE=Release \
            -DSOLTRACE_BUILD_OPTIX_SUPPORT=ON \
            -DSOLTRACE_BUILD_GUI=OFF \
            -DSOLTRACE_BUILD_EMBREE_SUPPORT=ON \
            -DSAMPLES_PTX_DIR="$GITHUB_WORKSPACE/build/lib/ptx" \
            -DFULL_FIELD_VALIDATION_TEST=OFF \
            -DSOLTRACE_BUILD_PERF_TEST=ON \
            -S .

      - name: Build SolTrace
        run: cmake --build build -j4

      - name: Test GPU Build
        working-directory: ./build
        # Runs the entire test suite, natively using the GPU!
        run: ctest --output-on-failure --build-config Release -VV