test.yml

name: 'Test Suite'

on:
  push:
    branches: [master]
  pull_request:
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  lint-gate:
    name: Lint Gate
    runs-on: ubuntu-latest
    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Initialize MFC
        run: ./mfc.sh init

      - name: Check Formatting
        run: |
          ./mfc.sh format -j "$(nproc)"
          git diff --exit-code || (echo "::error::Code is not formatted. Run './mfc.sh format' locally." && exit 1)

      - name: Spell Check
        run: ./mfc.sh spelling

      - name: Lint Toolchain
        run: ./mfc.sh lint

      - name: Lint Source - No Raw Directives
        run: |
          ! grep -iR '!\$acc\|!\$omp' --exclude="parallel_macros.fpp" --exclude="acc_macros.fpp" --exclude="omp_macros.fpp" --exclude="shared_parallel_macros.fpp" --exclude="syscheck.fpp" ./src/*

      - name: Lint Source - No Double Precision Intrinsics
        run: |
          ! grep -iR 'double_precision\|dsqrt\|dexp\|dlog\|dble\|dabs\|double\ precision\|real(8)\|real(4)\|dprod\|dmin\|dmax\|dfloat\|dreal\|dcos\|dsin\|dtan\|dsign\|dtanh\|dsinh\|dcosh\|d0' --exclude-dir=syscheck --exclude="*nvtx*" --exclude="*precision_select*" ./src/*

      - name: Lint Source - No Junk Code
        run: |
          ! grep -iR -e '\.\.\.' -e '\-\-\-' -e '===' ./src/*

      - name: Lint Docs
        run: python3 toolchain/mfc/lint_docs.py

  file-changes:
    name: Detect File Changes
    runs-on: 'ubuntu-latest'
    outputs: 
      checkall: ${{ steps.changes.outputs.checkall }}
    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Detect Changes
        uses: dorny/paths-filter@v3
        id: changes
        with: 
          filters: ".github/file-filter.yml"

  github:
    name: Github
    if: needs.file-changes.outputs.checkall == 'true'
    needs: [lint-gate, file-changes]
    strategy:
      matrix:
        os:    ['ubuntu', 'macos']
        mpi:   ['mpi']
        precision: ['']
        debug: ['debug', 'no-debug']
        intel: [true, false]
        exclude:
          - os:    macos
            intel: true

        include:
          - os:    ubuntu
            mpi:   no-mpi
            precision: single
            debug: no-debug
            intel: false

      fail-fast: false
    continue-on-error: true
    runs-on: ${{ matrix.os }}-latest

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Restore Build Cache
        uses: actions/cache@v4
        with:
          path: build
          key: mfc-build-${{ matrix.os }}-${{ matrix.mpi }}-${{ matrix.debug }}-${{ matrix.precision }}-${{ matrix.intel }}-${{ hashFiles('CMakeLists.txt', 'toolchain/dependencies/**', 'toolchain/cmake/**', 'src/**/*.fpp', 'src/**/*.f90') }}

      - name: Setup MacOS
        if:   matrix.os == 'macos'
        run:  |
          brew update
          brew upgrade
          brew install coreutils python fftw hdf5 gcc@15 boost open-mpi lapack
          echo "FC=gfortran-15" >> $GITHUB_ENV
          echo "BOOST_INCLUDE=/opt/homebrew/include/" >> $GITHUB_ENV

      - name: Setup Ubuntu
        if:   matrix.os == 'ubuntu' && matrix.intel == false
        run: |
           sudo apt update -y
           sudo apt install -y cmake gcc g++ python3 python3-dev hdf5-tools \
                    libfftw3-dev libhdf5-dev openmpi-bin libopenmpi-dev \
                    libblas-dev liblapack-dev

      - name: Setup Ubuntu (Intel)
        if:   matrix.os == 'ubuntu' && matrix.intel == true
        run: |
          wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
          sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
          sudo add-apt-repository "deb https://apt.repos.intel.com/oneapi all main"
          sudo apt-get update
          sudo apt-get install -y intel-oneapi-compiler-fortran intel-oneapi-mpi intel-oneapi-mpi-devel
          source /opt/intel/oneapi/setvars.sh
          printenv >> $GITHUB_ENV

      - name: Set up Python 3.14
        uses: actions/setup-python@v5
        with:
          python-version: '3.14'

      - name: Build
        run:  |
          /bin/bash mfc.sh test -v --dry-run -j "$(nproc)" --${{ matrix.debug }} --${{ matrix.mpi }} --${{ matrix.precision }} $TEST_ALL
        env:
          TEST_ALL: ${{ matrix.mpi == 'mpi' && '--test-all' || '' }}

      - name: Test
        run: |
          rm -f tests/failed_uuids.txt
          TEST_EXIT=0
          /bin/bash mfc.sh test -v --max-attempts 3 -j "$(nproc)" $TEST_ALL $TEST_PCT || TEST_EXIT=$?

          # Retry only if a small number of tests failed (sporadic failures)
          if [ -f tests/failed_uuids.txt ]; then
            NUM_FAILED=$(wc -l < tests/failed_uuids.txt)
            if [ "$NUM_FAILED" -gt 0 ] && [ "$NUM_FAILED" -le 5 ]; then
              FAILED=$(cat tests/failed_uuids.txt | tr '\n' ' ')
              echo ""
              echo "=== Retrying $NUM_FAILED failed test(s): $FAILED ==="
              echo ""
              /bin/bash mfc.sh test -v --max-attempts 3 -j "$(nproc)" --only $FAILED $TEST_ALL || exit $?
            else
              echo "Too many failures ($NUM_FAILED) to retry — likely a real issue."
              exit 1
            fi
          elif [ "$TEST_EXIT" -ne 0 ]; then
            exit $TEST_EXIT
          fi
        env:
          TEST_ALL: ${{ matrix.mpi == 'mpi' && '--test-all' || '' }}
          TEST_PCT: ${{ matrix.debug == 'debug' && '-% 20' || '' }}

  self:
    name: "${{ matrix.cluster_name }} (${{ matrix.device }}${{ matrix.interface != 'none' && format('-{0}', matrix.interface) || '' }}${{ matrix.shard != '' && format(' [{0}]', matrix.shard) || '' }})"
    if: github.repository == 'MFlowCode/MFC' && needs.file-changes.outputs.checkall == 'true'
    needs: [lint-gate, file-changes]
    continue-on-error: false
    timeout-minutes: 480
    strategy:
      matrix:
        include:
          # Phoenix (GT) — build+test combined in SLURM job
          - runner:       'gt'
            cluster:      'phoenix'
            cluster_name: 'Georgia Tech | Phoenix'
            device: 'gpu'
            interface: 'acc'
            shard: ''
          - runner:       'gt'
            cluster:      'phoenix'
            cluster_name: 'Georgia Tech | Phoenix'
            device: 'gpu'
            interface: 'omp'
            shard: ''
          - runner:       'gt'
            cluster:      'phoenix'
            cluster_name: 'Georgia Tech | Phoenix'
            device: 'cpu'
            interface: 'none'
            shard: ''
          # Frontier (ORNL) — build on login node, GPU tests sharded for batch partition
          - runner:       'frontier'
            cluster:      'frontier'
            cluster_name: 'Oak Ridge | Frontier'
            device: 'gpu'
            interface: 'acc'
            shard: '1/2'
          - runner:       'frontier'
            cluster:      'frontier'
            cluster_name: 'Oak Ridge | Frontier'
            device: 'gpu'
            interface: 'acc'
            shard: '2/2'
          - runner:       'frontier'
            cluster:      'frontier'
            cluster_name: 'Oak Ridge | Frontier'
            device: 'gpu'
            interface: 'omp'
            shard: '1/2'
          - runner:       'frontier'
            cluster:      'frontier'
            cluster_name: 'Oak Ridge | Frontier'
            device: 'gpu'
            interface: 'omp'
            shard: '2/2'
          - runner:       'frontier'
            cluster:      'frontier'
            cluster_name: 'Oak Ridge | Frontier'
            device: 'cpu'
            interface: 'none'
            shard: ''
          # Frontier AMD — build on login node, GPU tests sharded for batch partition
          - runner:       'frontier'
            cluster:      'frontier_amd'
            cluster_name: 'Oak Ridge | Frontier (AMD)'
            device: 'gpu'
            interface: 'omp'
            shard: '1/2'
          - runner:       'frontier'
            cluster:      'frontier_amd'
            cluster_name: 'Oak Ridge | Frontier (AMD)'
            device: 'gpu'
            interface: 'omp'
            shard: '2/2'
          - runner:       'frontier'
            cluster:      'frontier_amd'
            cluster_name: 'Oak Ridge | Frontier (AMD)'
            device: 'cpu'
            interface: 'none'
            shard: ''
    runs-on:
      group:  phoenix
      labels: ${{ matrix.runner }}
    env:
      NODE_OPTIONS: ${{ matrix.cluster == 'phoenix' && '--max-old-space-size=2048' || '' }}
    steps:
      - name: Clone
        uses: actions/checkout@v4
        with:
          clean: false

      - name: Build
        if:   matrix.cluster != 'phoenix'
        uses: nick-fields/retry@v3
        with:
          max_attempts: 3
          retry_wait_seconds: 60
          timeout_minutes: 480
          command: bash .github/workflows/${{ matrix.cluster }}/build.sh ${{ matrix.device }} ${{ matrix.interface }}
          on_retry_command: ./mfc.sh clean

      - name: Test
        run:  bash .github/workflows/${{ matrix.cluster }}/submit.sh .github/workflows/${{ matrix.cluster }}/test.sh ${{ matrix.device }} ${{ matrix.interface }} ${{ matrix.shard }}

      - name: Print Logs
        if:   always()
        run:  cat test-${{ matrix.device }}-${{ matrix.interface }}.out

      - name: Archive Logs
        uses: actions/upload-artifact@v4
        if:   matrix.cluster != 'phoenix'
        with:
          name: logs-${{ strategy.job-index }}-${{ matrix.device }}-${{ matrix.interface }}
          path: test-${{ matrix.device }}-${{ matrix.interface }}.out