cmake-build.yaml

name: CMake build and tests

on: [ push ]

# TODO: just use CMake presets?

# https://github.com/actions/runner/issues/382
env:
  ErrorView: NormalView

jobs:
  build:
    env:
      VALGRIND_GIT_TAG: VALGRIND_3_22_0
      VALGRIND_PREFIX: ${{ github.workspace }}/valgrind/
      UMB_VALGRIND_BIN: ${{ github.workspace }}/valgrind/bin/valgrind

    name: ${{ matrix.os }}-${{ matrix.build_type }}-${{ github.workflow }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        build_type: [ Debug, Release ]
        os: [ ubuntu-latest, windows-latest ]
        include:
          - os: windows-latest
            vcpkg_commit_id: 'fe1e9f508ee13ed3d0a7d318beac7efe1ec4f9d7'
            umb_include_meta: OFF  # TODO: fix later. Boost Hana (and other) issues on MSVC.
            umb_run_clang_format: OFF # TODO: seems to cause issues on the runner.
            cxx_compiler: cl
            cmake_generator: Visual Studio 17 2022
            cmake_extra_args: -A x64
          - os: ubuntu-latest
            vcpkg_commit_id: 'fe1e9f508ee13ed3d0a7d318beac7efe1ec4f9d7'
            umb_include_meta: ON
            umb_run_clang_format: ON
            cxx_compiler: g++
            cmake_generator: Ninja
            # cmake_extra_args:

    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true

      - name: Change default cmd.exe codepage on Windows
        run: REG ADD HKCU\Console\%SystemRoot^%_system32_cmd.exe /v CodePage /t REG_DWORD /d 65001
        if: matrix.os == 'windows-latest'

      - name: Change default PowerShell codepage on Windows
        run: REG ADD HKCU\Console\%SystemRoot^%_System32_WindowsPowerShell_v1.0_powershell.exe /v CodePage /t REG_DWORD /d 65001
        if: matrix.os == 'windows-latest'

      - name: Install apt dependencies
        uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: autoconf-archive gcc-13 g++13 libc6-dbg
          version: 1.0  # NOTE: this is cache version according to the docs.
        if: matrix.os == 'ubuntu-latest'

      - name: Cache Valgrind
        uses: actions/cache@v3
        id: cache-valgrind
        if: matrix.os == 'ubuntu-latest'
        with:
          path: ${{ env.VALGRIND_PREFIX }}
          key: ${{ runner.os }}-cache-${{ env.VALGRIND_GIT_TAG }}
          restore-keys: ${{ runner.os }}-cache-${{ env.VALGRIND_GIT_TAG }}

      - name: Install Valgrind
        if: ${{ (matrix.os == 'ubuntu-latest') && (steps.cache-valgrind.outputs.cache-hit != 'true') }}
        run: git clone https://sourceware.org/git/valgrind.git --depth 1 --branch ${{ env.VALGRIND_GIT_TAG }}
          && cd valgrind
          && ./autogen.sh
          && ./configure --prefix=${{ env.VALGRIND_PREFIX }}
          && make -j2
          && make install
        # && find / -name valgrind 2>/dev/null
        # && test -e ${{ env.UMB_VALGRIND_BIN }} && echo "Valgrind bin found" || echo "Valgrind bin not found"

      - name: Set default GCC
        run: sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-13 13
          --slave /usr/bin/g++ g++ /usr/bin/g++-13
        if: matrix.os == 'ubuntu-latest'

      - name: Print GCC version
        run: gcc --version
        if: matrix.os == 'ubuntu-latest'

      - name: Print clang-format version
        run: clang-format --version
        if: matrix.os == 'ubuntu-latest'

      - name: Setup MSVC
        uses: ilammy/msvc-dev-cmd@v1
        if: matrix.os == 'windows-latest'

      - name: Print MSVC version
        run: cl.exe
        if: matrix.os == 'windows-latest'

      - name: Install Ninja
        uses: seanmiddleditch/gha-setup-ninja@master

      - name: Create Build Environment
        run: cmake -E make_directory ${{ github.workspace }}/build

      - name: Setup vcpkg
        uses: lukka/run-vcpkg@main
        id: runvcpkg
        with:
          vcpkgDirectory: '${{ runner.workspace }}/build/vcpkg'
          vcpkgGitCommitId: '${{ matrix.vcpkg_commit_id }}'
          # Run vcpkg with the command specified by the `runVcpkgFormatString` input.
          runVcpkgInstall: true
          vcpkgJsonGlob: '**/vcpkg.json'

      - name: Print output of run-vcpkg's action.
        run: echo "root='${{ steps.runvcpkg.outputs.RUNVCPKG_VCPKG_ROOT_OUT }}', triplet='${{ steps.runvcpkg.outputs.RUNVCPKG_VCPKG_DEFAULT_TRIPLET_OUT }}' "

      - name: Configure CMake
        working-directory: ${{ github.workspace }}/build
        run: cmake -G "${{ matrix.cmake_generator }}" ${{ env.cmake_extra_args }} ${{ github.workspace }}
          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
          -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON
          -DCMAKE_TOOLCHAIN_FILE=${{ env.VCPKG_ROOT }}/scripts/buildsystems/vcpkg.cmake
          -DBUILD_TESTS=ON
          -DUMB_INCLUDE_META=${{ matrix.umb_include_meta }}
          -DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }}
          -DUMB_RUN_CLANG_FORMAT=${{ matrix.umb_run_clang_format }}

      - name: Build
        working-directory: ${{ github.workspace }}/build
        run: cmake --build . --config ${{ matrix.build_type }}

      - name: Test
        working-directory: ${{ github.workspace }}/build
        run: ctest -C ${{ matrix.build_type }} --verbose

      - name: Print Valgrind version
        run:
          # find / -name valgrind 2>/dev/null &&
          ${{ env.UMB_VALGRIND_BIN }} --version
        if: matrix.os == 'ubuntu-latest'

      - name: Run CTest with Valgrind
        env:
          VALGRIND_LIB: ${{ env.VALGRIND_PREFIX }}/libexec/valgrind/
        run: ctest -C ${{ matrix.build_type }} --verbose -T memcheck

      - name: Run UMB generator with Valgrind
        env:
          UMB_GEN_BIN: build/uscript_msgbuf_generator
          VALGRIND_LIB: ${{ env.VALGRIND_PREFIX }}/libexec/valgrind/
        run: tests/gen_test_messages_with_valgrind.sh
        if: matrix.os == 'ubuntu-latest'

      - name: Archive UMB generated C++ files
        uses: actions/upload-artifact@v3
        with:
          name: umb-generated-cpp-${{ matrix.os }}-${{ matrix.build_type }}
          path: |
            build/generated/*.umb.cpp
            build/generated/*.umb.hpp

      - name: Archive UMB generated UnrealScript files
        uses: actions/upload-artifact@v3
        with:
          name: umb-generated-uscript-${{ matrix.os }}-${{ matrix.build_type }}
          path: |
            build/generated/*.uc

      - name: Archive UMB build artifacts
        uses: actions/upload-artifact@v3
        with:
          name: umb-generator-executable-${{ matrix.os }}-${{ matrix.build_type }}
          path: |
            build/templates/
            build/*.exe
            build/*.pdb
            build/*.dll
            build/*.a
            build/*.lib
            build/*.so
            build/uscript_msgbuf_generator
            build/umb_echo_server


  build-and-test-with-udk:
    needs: [ build ]
    uses: ./.github/workflows/udk-tests.yaml