Tests: Add QtTests run to CI

2026-02-27 11:21:05 -06:00
parent 7be33f496e
commit 659780c31b
4 changed files with 132 additions and 0 deletions
@@ -68,6 +68,12 @@ runs:
          testCommand: ${{ inputs.builddir }}/tests/Gui_tests_run --gtest_output=json:${{ inputs.reportdir }}gui_gtest_results.json
          testLogFile: ${{ inputs.reportdir }}gui_gtest_test_log.txt
          testName: Gui
+      - name: C++ Qt tests
+        id: qttests
+        uses: ./.github/workflows/actions/runCPPTests/runQtTests
+        with:
+          builddir: ${{ inputs.builddir }}
+          testLogFile: ${{ inputs.reportdir }}qt_ctest_log.txt
      - name: C++ Material tests
        id: material
        uses: ./.github/workflows/actions/runCPPTests/runSingleTest
@@ -0,0 +1,55 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# SPDX-FileNotice: Part of the FreeCAD project.
+
+name: runQtTests
+description: "Run all QtTest-based C++ tests (those labelled 'Qt' in CTest), generate log and report"
+
+inputs:
+  builddir:
+    description: "Build directory containing CTestTestfile.cmake"
+    required: true
+  testLogFile:
+    description: "Path for the command-line output of the tests"
+    required: true
+outputs:
+  reportText:
+    description: "Report text"
+    value: ${{ steps.report.outputs.reportText }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Run Qt tests via CTest
+      shell: bash -l {0}
+      env:
+        BUILD_DIR: ${{ inputs.builddir }}
+        TEST_LOG_FILE: ${{ inputs.testLogFile }}
+      run: |
+        set -o pipefail
+        ctest --test-dir "$BUILD_DIR" -L Qt --output-on-failure | tee -a "$TEST_LOG_FILE"
+    - name: Parse test results
+      if: always()
+      id: report
+      shell: bash -l {0}
+      env:
+        TEST_LOG_FILE: ${{ inputs.testLogFile }}
+      run: |
+        result=$(grep -E "(Test #|tests passed|tests failed|Total Test time)" "$TEST_LOG_FILE" || true)
+        if grep -qE "[1-9][0-9]* tests failed" "$TEST_LOG_FILE"
+        then
+          reportText="<details><summary>:fire: QtTest C++ tests failed</summary>\n"
+        else
+          reportText="<details><summary>:heavy_check_mark: QtTest C++ tests succeeded</summary>\n"
+        fi
+        reportText+="\n"
+        reportText+="Results\n"
+        reportText+="\n"
+        reportText+='```\n'
+        reportText+="$result\n"
+        reportText+='```\n'
+        reportText+="</details>\n"
+        reportText+="\n"
+        echo "reportText<<EOD" >> $GITHUB_OUTPUT
+        echo -e "$reportText" >> $GITHUB_OUTPUT
+        echo "EOD" >> $GITHUB_OUTPUT
+        echo -e "$reportText"
@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# SPDX-FileNotice: Part of the FreeCAD project.
+
+name: runSingleQtTest
+description: "Run a single QtTest-based C++ test executable, generate log and report"
+
+inputs:
+  testCommand:
+    description: "Test executable path"
+    required: true
+  testLogFile:
+    description: "Path for the command-line output of the tests"
+    required: true
+  testName:
+    description: "A descriptive name for the test suite"
+    required: true
+outputs:
+  reportText:
+    description: "Report text"
+    value: ${{ steps.report.outputs.reportText }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Run QtTest tests
+      shell: bash -l {0}
+      env:
+        QT_QPA_PLATFORM: offscreen
+        TEST_COMMAND: ${{ inputs.testCommand }}
+        TEST_LOG_FILE: ${{ inputs.testLogFile }}
+      run: |
+        set -o pipefail
+        $TEST_COMMAND | tee -a "$TEST_LOG_FILE"
+    - name: Parse test results
+      if: always()
+      id: report
+      shell: bash -l {0}
+      env:
+        TEST_LOG_FILE: ${{ inputs.testLogFile }}
+        TEST_NAME: ${{ inputs.testName }}
+      run: |
+        # This bonkers sed regex is to try to find the start and end of the QtTest output block, which is not really
+        # designed to be machine-readable. Why did they have to choose asterisks?!?!
+        result=$(sed -n '/^\*\*\*\*\*\*\*\*\* Start/,/^\*\*\*\*\*\*\*\*\* Finished/p' "$TEST_LOG_FILE" || true)
+        if grep -qE "^FAIL!" "$TEST_LOG_FILE"
+        then
+          reportText="<details><summary>:fire: QtTest C++ test suite '${TEST_NAME}' failed</summary>\n"
+        else
+          reportText="<details><summary>:heavy_check_mark: QtTest C++ test suite '${TEST_NAME}' succeeded</summary>\n"
+        fi
+        reportText+="\n"
+        reportText+="Results\n"
+        reportText+="\n"
+        reportText+='```\n'
+        reportText+="$result\n"
+        reportText+='```\n'
+        reportText+="</details>\n"
+        reportText+="\n"
+        echo "reportText<<EOD" >> $GITHUB_OUTPUT
+        echo -e "$reportText" >> $GITHUB_OUTPUT
+        echo "EOD" >> $GITHUB_OUTPUT
+        echo -e "$reportText"
@@ -77,6 +77,15 @@ function(setup_qt_test)
            FreeCADGui
            ${QtTest_LIBRARIES}
            ${${_testname}_LIBS})
+
+        if(NOT WIN32)
+            set_target_properties(${_testname}_Tests_run PROPERTIES
+                RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/tests)
+        endif()
+
+        set_tests_properties(${_testname}_Tests_run PROPERTIES
+            LABELS "Qt"
+            ENVIRONMENT "QT_QPA_PLATFORM=offscreen")
    endforeach()
 endfunction()