test_suite_ubuntu_cuda_gnu.yml

# Workflow to run the FTorch test suite on a CUDA enabled runner with the GNU compiler
name: Test suite (Ubuntu CUDA GNU)

# Controls when the workflow will run
on:

  # Triggers the workflow on pushes to the "main" branch, i.e., PR merges
  push:
    branches: [ "main" ]
    paths:
      # This workflow
      - '.github/workflows/test_suite_ubuntu_cuda_gnu.yml'
      # Library source files
      - 'src/*.fypp'
      - 'src/*.f90'
      - 'src/*.F90'
      - 'src/*.c'
      - 'src/*.cpp'
      - 'src/*.h'
      # Unit tests
      - 'test/unit/**/*.pf'
      # Integration tests
      - 'examples/**/*.py'
      - 'examples/**/*.f90'
      # Build system
      - '**CMakeLists.txt'
      - '**requirements.txt'

  pull_request:
    paths:
      - '.github/workflows/test_suite_ubuntu_cuda_gnu.yml'

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

# Cancel jobs running if new commits are pushed
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

# Write permissions are not required
permissions: {}

# Workflow run - one or more jobs that can run sequentially or in parallel
jobs:
  test-suite:
    name: test suite

    # The type of runner that the job will run on
    runs-on: GPU-runner
    strategy:
      fail-fast: true

    # Terminate the job if it runs for more than 15 minutes
    timeout-minutes: 15

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - name: Checkout FTorch repository
        with:
          persist-credentials: true
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

      - name: Setup Python
        uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6
        with:
          python-version: '3.13'  # Use 3.13 as no PyTorch wheels for 3.14 yet.

      - name: Install ftorch_utils
        run: |
          python -m pip install --upgrade pip
          python -m venv ftorch
          . ftorch/bin/activate
          # CUDA v12.9 chosen as latest supported by PyTorch
          # Check this is <= what GPU-runner has installed (backwards compatible)
          pip install . --extra-index-url https://download.pytorch.org/whl/cu129 --group test

      - name: Install cmake and NVIDIA dev toolkit
        run: |
          sudo apt update
          sudo apt install -y cmake nvidia-cuda-toolkit

        # Currently used by example_mpi
      - name: Install an MPI distribution
        run: |
          sudo apt install -y openmpi-bin openmpi-common libopenmpi-dev

      - name: Install pFUnit
        run: |
          export FC=/usr/bin/gfortran
          # TODO: Avoid version pinning (needed because version appears in install path)
          git clone -b v4.12.0 https://github.com/Goddard-Fortran-Ecosystem/pFUnit.git
          mkdir pFUnit/build
          cd pFUnit/build
          # MPI support is currently not needed for the unit testing
          cmake .. -DSKIP_MPI=YES
          make -j 4 install

      - name: Build FTorch
        env:
          FORTRAN_STANDARD: f2008
        run: |
          . ftorch/bin/activate
          VN=$(python -c "import sys; print('.'.join(sys.version.split('.')[:2]))")
          export Torch_DIR=${VIRTUAL_ENV}/lib/python${VN}/site-packages
          export BUILD_DIR=$(pwd)/build
          # Install to /tmp/ to ensure independent from the CMake build in standalone check.
          export INSTALL_DIR=/tmp/ftorch-install
          mkdir -p ${INSTALL_DIR}
          # NOTE: The pFUnit version (pinned during installation above) is used in the install path.
          export PFUNIT_DIR=$(pwd)/pFUnit/build/installed/PFUNIT-4.12
          mkdir -p ${BUILD_DIR}
          cd ${BUILD_DIR}
          cmake .. \
            -DPython_EXECUTABLE="$(which python)" \
            -DCMAKE_BUILD_TYPE=Release \
            -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \
            -DCMAKE_BUILD_TESTS=TRUE \
            -DGPU_DEVICE=CUDA \
            -DMULTI_GPU=OFF \
            -DCMAKE_PREFIX_PATH="${PFUNIT_DIR};${Torch_DIR}" \
            -DCMAKE_Fortran_FLAGS="-std=${FORTRAN_STANDARD}"
          cmake --build .
          cmake --install .

      - name: Run unit tests
        run: |
          . ftorch/bin/activate
          cd build
          ctest --verbose --tests-regex cuda

      - name: Run integration tests
        run: |
          . ftorch/bin/activate
          cd build
          ctest --verbose --tests-regex example