cpp-ci-serial-programs-base.yml

name: C++ CI Serial Programs base
on:
  workflow_call:
    inputs:
      os:
        required: true
        type: string

      compiler:
        required: true
        type: string

      upload-build:
        type: boolean
        default: false

      run-tests:
        type: boolean
        default: false

      run-clang-query:
        type: boolean
        default: false

jobs:
  build:
    runs-on: ${{inputs.os}}

    steps:
      - name: Set variables
        shell: bash
        run: |
          if [[ "${{inputs.compiler}}" == "clang" ]]; then
            if [[ "${{inputs.os}}" == windows* ]]; then
              CMAKE_ADDITIONAL_FLAGS="-T ClangCL"
            elif [[ "${{inputs.os}}" == ubuntu* ]]; then
              CMAKE_ADDITIONAL_FLAGS="-DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=RelWithDebInfo"
            fi
          fi
          echo "CMAKE_ADDITIONAL_FLAGS=$CMAKE_ADDITIONAL_FLAGS" >> $GITHUB_ENV

          if [[ "${{inputs.os}}" == windows* ]]; then
            UPLOAD_FOLDER="Arduino-Source/SerialPrograms/bin/RelWithDebInfo"
          else
            UPLOAD_FOLDER="Arduino-Source/SerialPrograms/bin"
          fi
          echo "UPLOAD_FOLDER=$UPLOAD_FOLDER" >> $GITHUB_ENV

      - name: Checkout Arduino-Source
        uses: actions/checkout@v7
        with:
          path: 'Arduino-Source'
          submodules: 'recursive'

      - name: Install Qt
        uses: jurplel/install-qt-action@v4
        with:
          # Delete aqtsource once https://github.com/miurahr/aqtinstall/issues/1007 is fixed and released
          aqtsource: 'git+https://github.com/miurahr/aqtinstall'
          version: '6.10.2'
          modules: 'qtmultimedia qtserialport'

      - name: Install dependencies (Ubuntu)
        if: startsWith(inputs.os, 'ubuntu')
        run: |
          cd Arduino-Source
          sudo apt update
          sudo apt upgrade 
          sudo apt install clang-tools libopencv-dev libsystemd-dev

          sudo apt install ./3rdPartyBinaries/libdpp-10.1.5-linux-x64.deb

      - name: Install dependencies (Mac)
        if: startsWith(inputs.os, 'mac')
        run: |
          cd Arduino-Source
          brew install opencv@4 onnxruntime

          brew tap-new --no-git PA/libdpp
          brew trust PA/libdpp
          FORMULA_DIR="$(brew --repo PA/libdpp)/Formula"
          mkdir -p "$FORMULA_DIR"
          cp 3rdPartyBinaries/libdpp@10.1.5.rb "$FORMULA_DIR/"
          brew install libdpp@10.1.5

      - name: Generate binaries
        run: |
          cd Arduino-Source/SerialPrograms
          mkdir bin
          cd bin
          cmake .. -DQT_MAJOR:STRING=6 ${{env.CMAKE_ADDITIONAL_FLAGS}}
          cmake --build . --config RelWithDebInfo --parallel 10

      - name: Prepare upload build
        if: inputs.upload-build
        shell: bash
        run: |
          {
            echo "https://github.com/${{github.repository_owner}}/Arduino-Source/commit/$(git -C Arduino-Source rev-parse HEAD)"
            echo "https://github.com/${{github.repository_owner}}/Packages/commit/$(git -C Arduino-Source/Packages rev-parse HEAD)"
          } > ${{env.UPLOAD_FOLDER}}/version.txt

      - name: Upload Build
        uses: actions/upload-artifact@v7
        if: inputs.upload-build
        with:
          name: Serial Programs (os=${{inputs.os}} - compiler=${{inputs.compiler}})
          path: ${{env.UPLOAD_FOLDER}}

      - name: Upload Executable Only
        uses: actions/upload-artifact@v7
        if: inputs.upload-build && startsWith(inputs.os, 'windows')
        with:
          name: Standalone Executable (os=${{inputs.os}})
          path: ${{env.UPLOAD_FOLDER}}/SerialPrograms.exe

      - name: Checkout CommandLineTests
        uses: actions/checkout@v7
        if: inputs.run-tests
        with:
          repository: 'PokemonAutomation/CommandLineTests'
          path: 'CommandLineTests'

      - name: Run tests (Windows)
        if: startsWith(inputs.os, 'windows') && inputs.run-tests
        run: |
          cd Arduino-Source/SerialPrograms/bin
          $process = Start-Process -FilePath "./RelWithDebInfo/SerialPrograms.exe" `
                                   -ArgumentList "--command-line-test-mode --command-line-test-folder ../../../CommandLineTests" `
                                   -NoNewWindow -Wait -PassThru
          if ($process.ExitCode -ne 0) {
              Write-Error "Tests failed with exit code $($process.ExitCode)"
              exit 1
          }

      - name: Run tests (Ubuntu)
        if: startsWith(inputs.os, 'ubuntu') && inputs.run-tests
        env:
          QT_QPA_PLATFORM: offscreen
          TESSDATA_PREFIX: ${{ github.workspace }}/Arduino-Source/SerialPrograms/bin/Resources/Tesseract
        run: |
          cd Arduino-Source/SerialPrograms/bin
          ./SerialPrograms --command-line-test-mode --command-line-test-folder ../../../CommandLineTests

      - name: Run tests (Mac)
        if: startsWith(inputs.os, 'mac') && inputs.run-tests
        run: |
          cd Arduino-Source/SerialPrograms/bin
          ./SerialPrograms.app/Contents/MacOS/SerialPrograms --command-line-test-mode --command-line-test-folder ../../../CommandLineTests

      - name: Run clang query
        if: inputs.run-clang-query
        run : |
          cd Arduino-Source

          cat << 'EOF' > query.txt
          match cxxConstructExpr(
            isExpansionInFileMatching("SerialPrograms/"),
            hasDeclaration(cxxConstructorDecl(ofClass(hasName("std::filesystem::path")))),
            hasArgument(0, hasType(asString("std::string")))
          )
          EOF

          files=$(jq -r '.[].file' SerialPrograms/bin/compile_commands.json)
          echo "$files" | xargs --max-args=100 clang-query -p SerialPrograms/bin/ -f query.txt >> clang-query-output.txt
          echo "Clang query output (begin)"
          cat clang-query-output.txt
          echo "Clang query output (end)"
          if grep --silent "Match #" clang-query-output.txt; then
            echo "::error Forbidden code detected! It can be one of the following:"
            echo "::error - std::filesystem::path created from std::string. More information https://discord.com/channels/695809740428673034/1462210406616531259/1462567541825339635"
            echo "::error - ImageViewRGB32 created from VideoSnapshot&& that is stored. It is a dangling pointer as nothing hold the data anymore"
            echo "::error You can read more about the exact error with the artifact below."
            exit 1
          fi

      - name: Upload Clang query output
        uses: actions/upload-artifact@v7
        if: inputs.run-clang-query && always()
        with:
          name: Clang query output (compiler=${{inputs.compiler}})
          path: |
            Arduino-Source/SerialPrograms/bin/compile_commands.json
            Arduino-Source/clang-query-output.txt