Arm backend: Enable C++ tests for VGF runtime. (pytorch#23238)

Enable C++ runtime tests for VGF backend.


cc @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils
@Sebastian-Larsson @robell @rascani

Signed-off-by: Elena Zhelezina <elena.zhelezina@arm.com>

Author: wwwind

.github/workflows/pull.yml

@@ -905,6 +905,7 @@ jobs:
         include:
           - test_arm_backend: test_pytest_ops_vkml
           - test_arm_backend: test_ootb_tests_vgf
+          - test_arm_backend: test_runtime_vgf
       fail-fast: false
     with:
       runner: linux.2xlarge.memory

.github/workflows/trunk.yml

@@ -328,6 +328,7 @@ jobs:
           - test_arm_backend: test_pytest_models_vkml
           - test_arm_backend: test_run_vkml
           - test_arm_backend: test_ootb_tests_vgf
+          - test_arm_backend: test_runtime_vgf
           - test_arm_backend: test_smaller_stories_llama_vkml
       fail-fast: false
     with:

backends/arm/CMakeLists.txt

@@ -251,35 +251,6 @@ if(EXECUTORCH_BUILD_VGF)
       NO_DEFAULT_PATH
     )
 
-    if(EXECUTORCH_BUILD_TESTS)
-      add_executable(
-        vgf_neural_statistics_test
-        ${EXECUTORCH_ROOT}/backends/arm/test/vgf_neural_statistics_test.cpp
-        ${EXECUTORCH_ROOT}/backends/arm/runtime/VGFNeuralStatistics.cpp
-      )
-      target_include_directories(
-        vgf_neural_statistics_test
-        PRIVATE ${_common_include_directories} ${VULKAN_HEADERS_PATH}
-                ${VOLK_HEADERS_PATH}
-      )
-      target_compile_options(
-        vgf_neural_statistics_test PRIVATE -DUSE_VULKAN_WRAPPER
-                                           -DUSE_VULKAN_VOLK
-      )
-      target_link_libraries(vgf_neural_statistics_test PRIVATE executorch_core)
-      if(TARGET GTest::gtest_main)
-        target_link_libraries(
-          vgf_neural_statistics_test PRIVATE GTest::gtest_main
-        )
-      else()
-        target_link_libraries(
-          vgf_neural_statistics_test PRIVATE gtest gtest_main
-        )
-      endif()
-      add_test(NAME vgf_neural_statistics_test
-               COMMAND vgf_neural_statistics_test
-      )
-    endif()
   endif()
 
   if(TARGET VGF::vgf)
@@ -322,6 +293,32 @@ if(EXECUTORCH_BUILD_VGF)
   executorch_target_link_options_shared_lib(vgf_backend)
 
   if(EXECUTORCH_BUILD_TESTS)
+    add_executable(
+      vgf_neural_statistics_test
+      ${EXECUTORCH_ROOT}/backends/arm/test/vgf_neural_statistics_test.cpp
+      ${EXECUTORCH_ROOT}/backends/arm/runtime/VGFNeuralStatistics.cpp
+      ${EXECUTORCH_ROOT}/backends/vulkan/third-party/volk/volk.c
+    )
+    target_include_directories(
+      vgf_neural_statistics_test
+      PRIVATE ${_common_include_directories} ${VULKAN_HEADERS_PATH}
+              ${VOLK_HEADERS_PATH}
+    )
+    target_compile_options(
+      vgf_neural_statistics_test PRIVATE -DUSE_VULKAN_WRAPPER -DUSE_VULKAN_VOLK
+    )
+    target_link_libraries(
+      vgf_neural_statistics_test PRIVATE executorch_core ${CMAKE_DL_LIBS}
+    )
+    if(TARGET GTest::gtest_main)
+      target_link_libraries(
+        vgf_neural_statistics_test PRIVATE GTest::gtest_main
+      )
+    else()
+      target_link_libraries(vgf_neural_statistics_test PRIVATE gtest gtest_main)
+    endif()
+    add_test(NAME vgf_neural_statistics_test COMMAND vgf_neural_statistics_test)
+
     add_executable(
       vgf_vulkan_features_test
       ${EXECUTORCH_ROOT}/backends/arm/test/vgf_vulkan_features_test.cpp

backends/arm/test/test_arm_backend.sh

@@ -454,6 +454,54 @@ test_pytest_vgf_smoke() {
     echo "${TEST_SUITE_NAME}: PASS"
 }
 
+test_runtime_vgf() {
+    echo "${TEST_SUITE_NAME}: Run VGF C++ unit tests"
+
+    # Keep this separate from the executor_runner build. The normal VKML runner
+    # intentionally does not enable EXECUTORCH_BUILD_TESTS.
+    local ctest_build_dir="${et_root_dir}/arm_test/vgf_runtime_tests"
+    local python_executable="${PYTHON_EXECUTABLE:-}"
+
+    if [[ -z "${python_executable}" ]]; then
+        if command -v python3 >/dev/null 2>&1; then
+            python_executable="$(command -v python3)"
+        elif command -v python >/dev/null 2>&1; then
+            python_executable="$(command -v python)"
+        else
+            echo "Python is required to configure the VGF build."
+            return 1
+        fi
+    fi
+
+    # Always configure a clean tree so stale CMake cache values cannot make CI
+    # silently skip EXECUTORCH_BUILD_TESTS or EXECUTORCH_BUILD_VGF.
+    rm -rf "${ctest_build_dir}"
+
+    cmake \
+        -S "${et_root_dir}" \
+        -B "${ctest_build_dir}" \
+        -DCMAKE_BUILD_TYPE=Debug \
+        -DEXECUTORCH_BUILD_TESTS=ON \
+        -DEXECUTORCH_BUILD_VGF=ON \
+        -DEXECUTORCH_BUILD_VULKAN=OFF \
+        -DPYTHON_EXECUTABLE="${python_executable}"         -DPython3_EXECUTABLE="${python_executable}"
+
+    # Build the VGF tests explicitly. This makes a missing/renamed target fail
+    # the job instead of being hidden among unrelated C++ tests.
+    cmake --build "${ctest_build_dir}" \
+        --target vgf_neural_statistics_test vgf_vulkan_features_test \
+        --parallel
+
+    # --no-tests=error is intentional: discovering zero VGF tests must fail CI.
+    ctest \
+        --test-dir "${ctest_build_dir}" \
+        --output-on-failure \
+        --no-tests=error \
+        -R '^vgf_'
+
+    echo "${TEST_SUITE_NAME}: PASS"
+}
+
 # --------------------------------------
 # -------- Out-of-the-box tests --------
 # --------------------------------------