ci.yml

name: Cosserat-CI

# Controls when the action will run. 
on:
  workflow_dispatch:
  pull_request:
  push:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  build-and-test:
    name: Run on ${{ matrix.os }} with SOFA ${{ matrix.sofa_branch }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-22.04, macos-12, windows-2022]
        sofa_branch: [master]
        python_version: ['3.10']

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      - name: Setup SOFA and environment
        id: sofa
        uses: sofa-framework/sofa-setup-action@v5
        with:
          sofa_root: ${{ github.workspace }}/sofa
          sofa_version: ${{ matrix.sofa_branch }}
          sofa_scope: 'standard'
          sofa_with_sofapython3: 'true'

      - name: Checkout source code
        uses: actions/checkout@v2
        with:
          path: ${{ env.WORKSPACE_SRC_PATH }}

      - name: Build and install
        shell: bash
        run: |
          cmake_options="-GNinja \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_INSTALL_PREFIX="$WORKSPACE_INSTALL_PATH" \
            -DCMAKE_PREFIX_PATH="$SOFA_ROOT/lib/cmake" \
            -DPYTHON_ROOT=$PYTHON_ROOT -DPython_ROOT=$PYTHON_ROOT \
            -DPYTHON_EXECUTABLE=$PYTHON_EXE -DPython_EXECUTABLE=$PYTHON_EXE"
          if [ -e "$(command -v ccache)" ]; then
            cmake_options="$cmake_options -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache"
          fi
          cmake_options="$(echo $cmake_options)" # prettify
          
          if [[ "$RUNNER_OS" == "Windows" ]]; then
            cmd //c "${{ steps.sofa.outputs.vs_vsdevcmd }} \
              && cd /d $WORKSPACE_BUILD_PATH \
              && cmake $cmake_options ../src \
              && ninja install"
          else
            cd "$WORKSPACE_BUILD_PATH"
            ccache -z
            cmake $cmake_options ../src
            ninja install
            echo ${CCACHE_BASEDIR}
            ccache -s
          fi

      - name: Sanitize artifact name
        id: sanitize
        # This step removes special characters from the artifact name to ensure compatibility with upload-artifact
        # Characters removed: " : < > | * ? \r \n \ /
        # Spaces are replaced with underscores
        # This sanitization prevents errors in artifact creation and retrieval
        shell: pwsh
        run: |
          $originalName = "Cosserat_${{ steps.sofa.outputs.run_branch }}_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${{ runner.os }}"
          $artifact_name = $originalName -replace '[":;<>|*?\r\n\\/]', '' -replace ' ', '_'
          echo "artifact_name=$artifact_name" >> $env:GITHUB_OUTPUT

      - name: Create artifact
        uses: actions/upload-artifact@v4.4.0
        with:
          name: ${{ steps.sanitize.outputs.artifact_name }}
          path: ${{ env.WORKSPACE_INSTALL_PATH }}

      - name: Install artifact
        uses: actions/download-artifact@v4.1.7
        with:
          name: ${{ steps.sanitize.outputs.artifact_name }}
          path: ${{ env.WORKSPACE_ARTIFACT_PATH }}

      # - name: Set env vars for tests
      #   shell: bash
      #   run: |
      #     # Set env vars for tests
      #     if [[ "$RUNNER_OS" == "Windows" ]]; then
      #       echo "$(cd $WORKSPACE_ARTIFACT_PATH/lib && pwd -W)" >> $GITHUB_PATH
      #       echo "$(cd $WORKSPACE_ARTIFACT_PATH/bin && pwd -W)" >> $GITHUB_PATH
      #     elif [[ "$RUNNER_OS" == "macOS" ]]; then
      #       echo "DYLD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$DYLD_LIBRARY_PATH" | tee -a $GITHUB_ENV
      #     fi
      #     echo "LD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$LD_LIBRARY_PATH" | tee -a $GITHUB_ENV
      #     # Add execution right on the tests
      #     chmod +x $WORKSPACE_BUILD_PATH/bin/*_test${{ steps.sofa.outputs.exe }}
           
      # - name: Check environment vars for tests
      #   shell: bash
      #   run: |
      #     echo '------ ls -la "$WORKSPACE_SRC_PATH" ------'
      #     ls -la "$WORKSPACE_SRC_PATH"
      #     echo '------ ls -la "$WORKSPACE_BUILD_PATH" ------'
      #     ls -la "$WORKSPACE_BUILD_PATH"
      #     echo '------ ls -la "$WORKSPACE_INSTALL_PATH" ------'
      #     ls -la "$WORKSPACE_INSTALL_PATH"
      #     echo '------ ls -la "$WORKSPACE_ARTIFACT_PATH" ------'
      #     ls -la "$WORKSPACE_ARTIFACT_PATH"
      #     echo '----------------------'
      #     echo "SOFA_ROOT = $SOFA_ROOT"
      #     echo '----------------------'
      #     python -c "import sys; print('sys.version = ' + str(sys.version)); print('sys.path = ' + str(sys.path))"

      # - name: Run tests CosseratPlugin_test
      #   if: always()
      #   shell: bash
      #   run: |
      #     cd $WORKSPACE_BUILD_PATH
      #     ./bin/CosseratPlugin_test${{ steps.sofa.outputs.exe }}

  deploy:
      name: Deploy artifacts
      if: always() && startsWith(github.repository, 'SofaDefrost') && (startsWith(github.ref, 'refs/heads/') || startsWith(github.ref, 'refs/tags/')) # we are not on a fork and on a branch or a tag (not a PR)
      needs: [build-and-test]
      runs-on: ubuntu-latest
      continue-on-error: true
      steps:
        - name: Get artifacts
          uses: actions/download-artifact@v4.1.7
          with:
            path: artifacts

        - name: Zip artifacts
          shell: bash
          run: |
            cd $GITHUB_WORKSPACE/artifacts
            for artifact in *; do
              zip $artifact.zip -r $artifact/*
            done
        - name: Upload release
          uses: softprops/action-gh-release@v1
          with:
            name: ${{ github.ref_name }}
            tag_name: release-${{ github.ref_name }}
            fail_on_unmatched_files: false
            target_commitish: ${{ github.sha }}
            files: |
              artifacts/Cosserat_*_Linux.zip
              artifacts/Cosserat_*_Windows.zip
              artifacts/Cosserat_*_macOS.zip