build.yml

# SPDX-FileCopyrightText: 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
#
# SPDX-License-Identifier: MIT

name: CI

on:
  push:
    branches:
      - master
      - 3.1
  pull_request:
    branches:
      - master
      - 3.1

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - windows-latest
          - macos-latest

        config:
          - preset: ci-dev-client-only-qt5
            qt_version: "5.15"
            cmake_osx_architectures: "x86_64"
            tests_with: qt5

          - preset: ci-dev-client-only-qt6
            qt_version: "6.5.*"
            qt_modules: qtshadertools qtscxml
            tests_with: qt6

          - preset: ci-dev-client-and-ui-qt5
            qt_version: "5.15"
            cmake_osx_architectures: "x86_64"
            tests_with: qt5

          - preset: ci-dev-client-and-ui-qt6
            qt_version: "6.5.*"
            qt_modules: qtscxml
            tests_with: qt6

          - preset: ci-dev-probe-only-qt5
            qt_version: "5.15"
            cmake_osx_architectures: "x86_64"

          - preset: ci-dev-probe-only-qt6
            qt_version: "6.5.*"
            qt_modules: qtscxml

        # GitHub actions is now powered by AppleSilicon macs
        # and these presets are failing
        exclude:
          - os: macos-latest
            config:
              preset: ci-dev-client-and-ui-qt5

          - os: macos-latest
            config:
              preset: ci-dev-client-and-ui-qt6

    steps:
      - name: Install Qt with options and default aqtversion
        uses: jurplel/install-qt-action@v3
        with:
          aqtversion: null # use whatever the default is
          modules: ${{ matrix.config.qt_modules }}
          version: ${{ matrix.config.qt_version }}
          cache: true

      - name: Checkout sources
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Install Dependencies on Linux
        if: ${{ runner.os == 'Linux' }}
        run: |
          sudo apt update -qq
          sudo apt install -y gdb doxygen

      - name: Install Dependencies on macOS
        if: ${{ runner.os == 'macOS' }}
        run: brew install bison

      - name: Install ninja-build tool (must be after Qt due PATH changes)
        uses: turtlesec-no/get-ninja@main

      - name: Add Bison to PATH (must be after Qt due PATH changes)
        if: ${{ runner.os == 'macOS' }}
        run: echo "/opt/homebrew/opt/bison/bin" >> $GITHUB_PATH

      - name: Make sure MSVC is found when Ninja generator is in use
        if: ${{ runner.os == 'Windows' }}
        uses: ilammy/msvc-dev-cmd@v1

      - name: Configure project
        run: >
          cmake -S . -G Ninja --preset ${{ matrix.config.preset }}
          -DCMAKE_OSX_ARCHITECTURES=${{ matrix.config.cmake_osx_architectures}}
          -DGAMMARAY_WITH_KDSME=ON
          -DGAMMARAY_BUILD_DOCS=${{ runner.os == 'Linux' }}

      - name: Build Project
        run: cmake --build ./build-${{ matrix.config.preset }}

      - name: Enable gdb attaching
        if: ${{ runner.os == 'Linux' && matrix.config.tests_with != '' }}
        run: echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

        # Exclude
        # quickmaterialtest|quicktexturetest fails because of QT_QUICK_BACKEND=software
      - name: Run tests on Linux Qt5 (offscreen)
        if: ${{ runner.os == 'Linux' && matrix.config.tests_with == 'qt5' }}
        run: >
          ctest --test-dir ./build-${{ matrix.config.preset }} --output-on-failure
          --exclude-regex "quickmaterialtest|quicktexturetest"
        env:
          QT_QPA_PLATFORM: offscreen
          QT_QUICK_BACKEND: software

        # Exclude
        # quickmaterialtest|quicktexturetest fails because of QT_QUICK_BACKEND=software AND QT_QPA_PLATFORM=offscreen
        # quickinspectortest|quickinspectortest2 fails at CI, local with 6.2.4 passes
      - name: Run tests on Linux Qt6 (offscreen)
        if: ${{ runner.os == 'Linux' && matrix.config.tests_with == 'qt6' }}
        run: >
          ctest --test-dir ./build-${{ matrix.config.preset }} --output-on-failure
          --exclude-regex "quickmaterialtest|quicktexturetest|quickinspectortest|quickinspectortest2"
        env:
          QT_QPA_PLATFORM: offscreen
          QT_QUICK_BACKEND: software

        # Exclude
        #23 - probeabidetectortest (Failed)
        #26 - launchertest (Failed)
        #37 - quickinspectortest2 (Failed)
      - name: Run tests Qt5 on macOS
        if: ${{ runner.os == 'macOS' && matrix.config.tests_with == 'qt5' }}
        run: >
          ctest --test-dir ./build-${{ matrix.config.preset }} --output-on-failure
          --exclude-regex "probeabidetectortest|launchertest|quickinspectortest2"

        # Exclude
        #28 - probeabidetectortest (Failed)
        #31 - launchertest (Failed)
        #32 - clientconnectiontest (Failed)
        # quickinspectortest2
      - name: Run tests Qt6 on macOS
        if: ${{ runner.os == 'macOS' && matrix.config.tests_with == 'qt6' }}
        run: >
          ctest --test-dir ./build-${{ matrix.config.preset }} --output-on-failure
          --exclude-regex
          "probeabidetectortest|launchertest|clientconnectiontest|quickinspectortest2|quicktexturetest"

        # Exclude
        # quicktexturetest
        # bindinginspectortest
      - name: Qt5 Run tests on Windows
        if: ${{ runner.os == 'Windows' && matrix.config.tests_with == 'qt5' }}
        run: >
          ctest --test-dir ./build-${{ matrix.config.preset }} -C 'Release' --output-on-failure
          --exclude-regex "quicktexturetest|bindinginspectortest"

        # Exclude
        # quicktexturetest
      - name: Qt6 Run tests on Windows
        if: ${{ runner.os == 'Windows' && matrix.config.tests_with == 'qt6' }}
        run: >
          ctest --test-dir ./build-${{ matrix.config.preset }} -C 'Release' --output-on-failure
          --exclude-regex "quicktexturetest|launchertest|probesettingstest"

      - name: Read tests log when it fails
        uses: andstor/file-reader-action@v1
        if: ${{ failure() }}
        with:
          path: "./build-${{ matrix.config.preset }}/Testing/Temporary/LastTest.log"