unit_tests.yml

name: Unit Tests
permissions: read-all

on:
  workflow_dispatch:
  merge_group:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

env:
  DEBIAN_FRONTEND: noninteractive
  CMAKE_GENERATOR: Ninja
  DEFAULT_CXX_STANDARD: 23
  DEFAULT_LLVM_VERSION: 22
  DEFAULT_GCC_VERSION: 14
  MULL_LLVM_MAJOR_VERSION: 20
  MULL_LLVM_VERSION: 20.1.2
  MULL_VERSION: 0.34.0
  HYPOTHESIS_PROFILE: default

concurrency:
  group: ${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

jobs:
  build_and_test_24:
    runs-on: &runner ${{ github.repository_owner == 'intel' && 'intel-' || '' }}ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        compiler: [clang, gcc]
        version: [12, 13, 14, 18, 19, 20, 21, 22]
        cxx_standard: [23]
        stdlib: [libstdc++, libc++]
        build_type: [Debug]
        include:
          - compiler: clang
            cc: "clang"
            cxx: "clang++"
            cxx_flags: "-stdlib=libstdc++"
          - version: 22
            compiler: clang
            toolchain_root: "/usr/lib/llvm-22"
          - version: 22
            compiler: clang
            stdlib: libc++
            cxx_flags: "-stdlib=libc++"
          - version: 21
            compiler: clang
            toolchain_root: "/usr/lib/llvm-21"
          - version: 21
            compiler: clang
            stdlib: libc++
            cxx_flags: "-stdlib=libc++"
          - version: 20
            compiler: clang
            toolchain_root: "/usr/lib/llvm-20"
          - version: 20
            compiler: clang
            stdlib: libc++
            cxx_flags: "-stdlib=libc++"
          - version: 19
            compiler: clang
            toolchain_root: "/usr/lib/llvm-19"
          - version: 19
            compiler: clang
            stdlib: libc++
            cxx_flags: "-stdlib=libc++"
          - version: 18
            compiler: clang
            toolchain_root: "/usr/lib/llvm-18"
          - version: 18
            compiler: clang
            stdlib: libc++
            cxx_flags: "-stdlib=libc++"
          - compiler: gcc
            toolchain_root: "/usr"
            cxx_flags: ""
          - version: 14
            compiler: gcc
            cc: "gcc-14"
            cxx: "g++-14"
          - version: 13
            compiler: gcc
            cc: "gcc-13"
            cxx: "g++-13"
          - version: 12
            compiler: gcc
            cc: "gcc-12"
            cxx: "g++-12"
            cxx_flags: ""
        exclude:
          - compiler: gcc
            version: 22
          - compiler: gcc
            version: 21
          - compiler: gcc
            version: 20
          - compiler: gcc
            version: 19
          - compiler: gcc
            version: 18
          - compiler: clang
            version: 14
          - compiler: clang
            version: 13
          - compiler: clang
            version: 12
          - compiler: gcc
            stdlib: libc++

    steps:
      - uses: &checkout actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install build tools
        run: |
          if [[ "${{matrix.compiler}}" == "clang" ]]; then
            DISTRO=$(lsb_release -cs)
            wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc
            sudo add-apt-repository -y deb "https://apt.llvm.org/$DISTRO/" "llvm-toolchain-$DISTRO-${{matrix.version}}" main
            sudo apt update && sudo apt install -y ninja-build clang-${{matrix.version}} libc++-${{matrix.version}}-dev libc++abi-${{matrix.version}}-dev
          else
            sudo apt update && sudo apt install -y ninja-build gcc-${{matrix.version}} g++-${{matrix.version}}
          fi

      - &restore_cpm_cache
        name: Restore CPM cache
        env:
          cache-name: cpm-cache-0
        id: cpm-cache-restore
        uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ~/cpm-cache
          key: ${{runner.os}}-${{env.cache-name}}-${{ hashFiles('**/CMakeLists.txt', 'cmake/**') }}
          restore-keys: |
            ${{runner.os}}-${{env.cache-name}}-

      - name: Configure CMake
        env:
          CC: ${{matrix.toolchain_root}}/bin/${{matrix.cc}}
          CXX: ${{matrix.toolchain_root}}/bin/${{matrix.cxx}}
        run: cmake -B ${{github.workspace}}/build -DCMAKE_CXX_STANDARD=${{matrix.cxx_standard}} -DCMAKE_CXX_FLAGS_INIT=${{matrix.cxx_flags}} -DCMAKE_BUILD_TYPE=${{matrix.build_type}} -DCPM_SOURCE_CACHE=~/cpm-cache

      - &save_cpm_cache
        name: Save CPM cache
        env:
          cache-name: cpm-cache-0
        if: steps.cpm-cache-restore.outputs.cache-hit != 'true'
        uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
        with:
          path: ~/cpm-cache
          key: ${{runner.os}}-${{env.cache-name}}-${{ hashFiles('**/CMakeLists.txt', 'cmake/**') }}

      - &python_test_reqs
        name: Install python test requirements
        run: |
          python3 -m venv ${{github.workspace}}/test_venv
          source ${{github.workspace}}/test_venv/bin/activate
          pip install -r ${{github.workspace}}/requirements.txt
          echo "${{github.workspace}}/test_venv/bin" >> "$GITHUB_PATH"

      - name: Build Unit Tests
        run: cmake --build ${{github.workspace}}/build --config ${{matrix.build_type}} -v -t build_unit_tests

      - name: Test
        working-directory: ${{github.workspace}}/build
        run: ctest --output-on-failure -j -C ${{matrix.build_type}}

  quality_checks_pass:
    runs-on: *runner
    steps:
      - name: Checkout target branch
        uses: *checkout
        with:
          ref: ${{github.base_ref}}

      - name: Extract target branch SHA
        run: echo "branch=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
        id: target_branch

      - name: Checkout PR branch
        uses: *checkout

      - name: Setup python venv
        run: |
          python3 -m venv ${{github.workspace}}/test_venv
          source ${{github.workspace}}/test_venv/bin/activate
          echo "${{github.workspace}}/test_venv/bin" >> "$GITHUB_PATH"

      - name: Install build tools
        run: |
          DISTRO=$(lsb_release -cs)
          wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc
          sudo add-apt-repository -y deb "https://apt.llvm.org/$DISTRO/" "llvm-toolchain-$DISTRO-${{env.DEFAULT_LLVM_VERSION}}" main
          sudo apt update && sudo apt install -y ninja-build clang-tidy-${{env.DEFAULT_LLVM_VERSION}} clang-format-${{env.DEFAULT_LLVM_VERSION}}

      - name: Install cmake-format
        run: |
          pip install cmakelang pyyaml

      - *restore_cpm_cache

      - name: Configure CMake
        env:
          CC: "/usr/lib/llvm-${{env.DEFAULT_LLVM_VERSION}}/bin/clang"
          CXX: "/usr/lib/llvm-${{env.DEFAULT_LLVM_VERSION}}/bin/clang++"
          PR_TARGET_BRANCH: ${{ steps.target_branch.outputs.branch }}
        run: cmake -B ${{github.workspace}}/build -DCMAKE_CXX_STANDARD=${{env.DEFAULT_CXX_STANDARD}} -DCPM_SOURCE_CACHE=~/cpm-cache

      - *save_cpm_cache

      - name: Run quality checks
        run: cmake --build ${{github.workspace}}/build -t ci-quality

  sanitize:
    runs-on: *runner
    strategy:
      fail-fast: false
      matrix:
        sanitizer: [undefined, address, thread]
        compiler: [clang, gcc]
        include:
          - compiler: clang
            cc: "clang"
            cxx: "clang++"
            toolchain_root: "/usr/lib/llvm-22"
          - compiler: gcc
            cc: "gcc-14"
            cxx: "g++-14"
            toolchain_root: "/usr"

    steps:
      - uses: *checkout

      - name: Install build tools
        run: |
          if [[ "${{matrix.compiler}}" == "clang" ]]; then
            DISTRO=$(lsb_release -cs)
            wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc
            sudo add-apt-repository -y deb "https://apt.llvm.org/$DISTRO/" "llvm-toolchain-$DISTRO-${{env.DEFAULT_LLVM_VERSION}}" main
            sudo apt update && sudo apt install -y ninja-build clang-${{env.DEFAULT_LLVM_VERSION}}
          else
            sudo apt update && sudo apt install -y ninja-build ${{matrix.cc}} ${{matrix.cxx}}
          fi

      - *restore_cpm_cache

      - name: Configure CMake
        env:
          CC: ${{matrix.toolchain_root}}/bin/${{matrix.cc}}
          CXX: ${{matrix.toolchain_root}}/bin/${{matrix.cxx}}
          SANITIZERS: ${{matrix.sanitizer}}
        run: cmake -B ${{github.workspace}}/build -DCMAKE_CXX_STANDARD=${{env.DEFAULT_CXX_STANDARD}} -DCPM_SOURCE_CACHE=~/cpm-cache

      - *save_cpm_cache

      - *python_test_reqs

      # https://github.com/actions/runner-images/issues/9524
      - name: Fix kernel mmap rnd bits
        # Asan in llvm 14 provided in ubuntu 22.04 is incompatible with
        # high-entropy ASLR in much newer kernels that GitHub runners are
        # using leading to random crashes: https://reviews.llvm.org/D148280
        run: sudo sysctl vm.mmap_rnd_bits=28

      - name: Build Unit Tests
        run: cmake --build ${{github.workspace}}/build -t unit_tests

  valgrind:
    runs-on: *runner
    steps:
      - uses: *checkout

      - name: Install build tools
        run: |
          sudo apt update && sudo apt install -y gcc-${{env.DEFAULT_GCC_VERSION}} g++-${{env.DEFAULT_GCC_VERSION}} ninja-build valgrind python3-venv python3-pip

      - *restore_cpm_cache

      - name: Configure CMake
        env:
          CC: "/usr/bin/gcc-${{env.DEFAULT_GCC_VERSION}}"
          CXX: "/usr/bin/g++-${{env.DEFAULT_GCC_VERSION}}"
        run: cmake -B ${{github.workspace}}/build -DCMAKE_CXX_STANDARD=${{env.DEFAULT_CXX_STANDARD}} -DCPM_SOURCE_CACHE=~/cpm-cache

      - *save_cpm_cache

      - *python_test_reqs

      - name: Build Unit Tests
        run: cmake --build ${{github.workspace}}/build -t build_unit_tests

      - name: Test
        working-directory: ${{github.workspace}}/build
        run: |
          ctest --output-on-failure -j -E "EXPECT_FAIL|PYTHON" -T memcheck

          LOGFILE=$(ls ./Testing/Temporary/LastDynamicAnalysis_*.log)
          FAILSIZE=$(du -c ./Testing/Temporary/MemoryChecker.* | tail -1 | cut -f1)
          { echo "<details>";
          echo "<summary>"; } >> "$GITHUB_STEP_SUMMARY"

          if [ "$FAILSIZE" != "0" ]; then
            echo "Failing tests:" | tee -a "$GITHUB_STEP_SUMMARY"
          else
            echo "No failing tests" >> "$GITHUB_STEP_SUMMARY"
          fi
          echo "</summary>" >> "$GITHUB_STEP_SUMMARY"

          for f in ./Testing/Temporary/MemoryChecker.*
          do
            if [ -s "$f" ]; then
              FILENAME=$(realpath "$f")
              TEST_COMMAND=$(grep "$FILENAME" "$LOGFILE")
              echo "" | tee -a "$GITHUB_STEP_SUMMARY"
              echo "========================================"
              echo "$TEST_COMMAND" | tee -a "$GITHUB_STEP_SUMMARY"
              echo "--------------------"
              cat "$f"
            fi
          done

          echo "</details>" >> "$GITHUB_STEP_SUMMARY"
          test "$FAILSIZE" = "0"

  mutate:
    runs-on: *runner
    steps:
      - uses: *checkout

      - name: Install build tools
        run: |
          DISTRO=$(lsb_release -cs)
          wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | sudo tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc
          sudo add-apt-repository -y deb "https://apt.llvm.org/$DISTRO/" "llvm-toolchain-$DISTRO-${{env.MULL_LLVM_MAJOR_VERSION}}" main
          sudo apt update && sudo apt install -y ninja-build clang-${{env.MULL_LLVM_MAJOR_VERSION}}

      - name: Install mull
        env:
          mull-pkg: Mull-${{env.MULL_LLVM_MAJOR_VERSION}}-${{env.MULL_VERSION}}-LLVM-${{env.MULL_LLVM_VERSION}}-ubuntu-amd64-24.04.deb
        run: |
          MULL_DEB="$(mktemp)"
          wget -O "$MULL_DEB" https://github.com/mull-project/mull/releases/download/${{env.MULL_VERSION}}/${{env.mull-pkg}}
          sudo dpkg -i "$MULL_DEB"

      - *restore_cpm_cache

      - name: Configure CMake
        env:
          CC: "/usr/lib/llvm-${{env.MULL_LLVM_MAJOR_VERSION}}/bin/clang"
          CXX: "/usr/lib/llvm-${{env.MULL_LLVM_MAJOR_VERSION}}/bin/clang++"
        run: cmake -B ${{github.workspace}}/build -DCMAKE_CXX_STANDARD=${{env.DEFAULT_CXX_STANDARD}} -DCPM_SOURCE_CACHE=~/cpm-cache

      - *save_cpm_cache

      - *python_test_reqs

      - name: Build and run mull tests
        run: cmake --build build -t mull_tests

  merge_ok:
    runs-on: *runner
    needs: [build_and_test_24, mutate, quality_checks_pass, sanitize, valgrind]
    if: ${{ !cancelled() }}
    steps:
      - name: Enable merge
        if: >-
          ${{
               contains(needs.*.result, 'failure')
            || contains(needs.*.result, 'cancelled')
            || contains(needs.*.result, 'skipped')
          }}
        run: exit 1