Simplify cmake test invocation

Differential Revision: D66737276 Pull Request resolved: pytorch#7043
kirklandsign · Dec 5, 2024 · cd306d3 · cd306d3
1 parent 5b2129e
commit cd306d3
Show file tree

Hide file tree

Showing 36 changed files with 225 additions and 330 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -200,8 +200,6 @@ option(EXECUTORCH_BUILD_EXTENSION_TENSOR "Build the Tensor extension" OFF)
 
 option(EXECUTORCH_BUILD_EXTENSION_TRAINING "Build the training extension" OFF)
 
-option(EXECUTORCH_BUILD_GTESTS "Build googletest based test binaries" OFF)
-
 option(EXECUTORCH_BUILD_MPS "Build the MPS backend" OFF)
 
 option(EXECUTORCH_BUILD_NEURON "Build the backends/mediatek directory" OFF)
@@ -216,6 +214,8 @@ option(EXECUTORCH_BUILD_KERNELS_QUANTIZED "Build the quantized kernels" OFF)
 
 option(EXECUTORCH_BUILD_DEVTOOLS "Build the ExecuTorch Developer Tools")
 
+option(EXECUTORCH_BUILD_TESTS "Build CMake-based unit tests" OFF)
+
 option(EXECUTORCH_NNLIB_OPT "Build Cadence backend Hifi nnlib kernel" OFF)
 
 option(EXECUTORCH_CADENCE_CPU_RUNNER "Build Cadence backend CPU runner" OFF)
@@ -330,6 +330,10 @@ if(EXECUTORCH_BUILD_PTHREADPOOL)
   )
 endif()
 
+if(EXECUTORCH_BUILD_TESTS)
+  include(CTest)
+endif()
+
 if(NOT PYTHON_EXECUTABLE)
   resolve_python_executable()
 endif()
@@ -625,7 +629,7 @@ cmake_dependent_option(
 )
 
 # Add googletest if any test targets should be built
-if(EXECUTORCH_BUILD_GTESTS)
+if(BUILD_TESTING)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/third-party/googletest)
 endif()
 
@@ -829,5 +833,7 @@ if(EXECUTORCH_BUILD_VULKAN)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/vulkan)
 endif()
 
+include(Test.cmake)
+
 # Print all summary
 executorch_print_configuration_summary()
diff --git a/Test.cmake b/Test.cmake
@@ -0,0 +1,29 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+#
+# A helper CMake file to trigger C++ unit tests.
+#
+
+if(BUILD_TESTING)
+  # This contains the list of tests which are always built
+  add_subdirectory(extension/evalue_util/test)
+  add_subdirectory(extension/kernel_util/test)
+  add_subdirectory(extension/memory_allocator/test)
+  add_subdirectory(extension/parallel/test)
+  add_subdirectory(extension/pytree/test)
+  add_subdirectory(kernels/portable/cpu/util/test)
+  add_subdirectory(kernels/prim_ops/test)
+  add_subdirectory(kernels/test)
+  add_subdirectory(runtime/core/exec_aten/testing_util/test)
+  add_subdirectory(runtime/core/exec_aten/util/test)
+  add_subdirectory(runtime/core/portable_type/test)
+  add_subdirectory(runtime/core/test)
+  add_subdirectory(runtime/executor/test)
+  add_subdirectory(runtime/kernel/test)
+  add_subdirectory(runtime/platform/test)
+  add_subdirectory(test/utils)
+endif()
diff --git a/backends/xnnpack/CMakeLists.txt b/backends/xnnpack/CMakeLists.txt
@@ -140,3 +140,7 @@ install(
   INCLUDES
   DESTINATION ${_common_include_directories}
 )
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()
diff --git a/backends/xnnpack/test/CMakeLists.txt b/backends/xnnpack/test/CMakeLists.txt
@@ -12,20 +12,13 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(backends_xnnpack_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 
 include(${EXECUTORCH_ROOT}/build/Test.cmake)
 
-set(_test_srcs # We can't put runtime/test_runtime_utils.cpp because we don't
-               # build aten
+set(_test_srcs
     runtime/test_xnnexecutor.cpp
-    ${EXECUTORCH_ROOT}/extension/threadpool/threadpool.cpp
-    ${EXECUTORCH_ROOT}/extension/threadpool/threadpool_guard.cpp
     ${EXECUTORCH_ROOT}/extension/threadpool/test/threadpool_test.cpp
 )
 

diff --git a/build/Test.cmake b/build/Test.cmake
@@ -17,38 +17,6 @@
 # It should also be cmake-lint clean.
 #
 
-include(${EXECUTORCH_ROOT}/build/Utils.cmake)
-
-# Find prebuilt executorch library
-find_package(executorch CONFIG REQUIRED)
-
-enable_testing()
-find_package(GTest CONFIG REQUIRED)
-
-target_link_options_shared_lib(cpuinfo)
-target_link_options_shared_lib(extension_data_loader)
-target_link_options_shared_lib(portable_kernels)
-target_link_options_shared_lib(portable_ops_lib)
-target_link_options_shared_lib(pthreadpool)
-target_link_options_shared_lib(quantized_ops_lib)
-
-# Add code coverage flags to supported compilers
-if(EXECUTORCH_USE_CPP_CODE_COVERAGE)
-  if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
-    string(APPEND CMAKE_C_FLAGS " --coverage -fprofile-abs-path")
-    string(APPEND CMAKE_CXX_FLAGS " --coverage -fprofile-abs-path")
-  elseif("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
-    string(APPEND CMAKE_C_FLAGS " -fprofile-instr-generate -fcoverage-mapping")
-    string(APPEND CMAKE_CXX_FLAGS
-           " -fprofile-instr-generate -fcoverage-mapping"
-    )
-  else()
-    message(ERROR
-            "Code coverage for compiler ${CMAKE_CXX_COMPILER_ID} is unsupported"
-    )
-  endif()
-endif()
-
 # A helper function to generate a gtest cxx executable target @param
 # target_name: name for the executable @param SOURCES <list_of_sources>: test
 # sources to be compiled. Sometimes util sources are used as well @param EXTRA
@@ -67,24 +35,14 @@ function(et_cxx_test target_name)
   set(multi_arg_names SOURCES EXTRA_LIBS)
   cmake_parse_arguments(ET_CXX_TEST "" "" "${multi_arg_names}" ${ARGN})
 
-  # Let files say "include <executorch/path/to/header.h>".
-  target_include_directories(executorch INTERFACE ${EXECUTORCH_ROOT}/..)
-
-  set(ET_TEST_UTIL_SOURCES
-      ${EXECUTORCH_ROOT}/runtime/core/exec_aten/testing_util/tensor_util.cpp
-  )
-
-  add_executable(${target_name} ${ET_CXX_TEST_SOURCES} ${ET_TEST_UTIL_SOURCES})
+  add_executable(${target_name} ${ET_CXX_TEST_SOURCES} ${EXECUTORCH_ROOT}/runtime/core/exec_aten/testing_util/tensor_util.cpp)
   # Includes gtest, gmock, executorch by default
   target_link_libraries(
     ${target_name} GTest::gtest GTest::gtest_main GTest::gmock executorch
     ${ET_CXX_TEST_EXTRA_LIBS}
   )
 
-  # add_test adds a test target to be used by ctest. We use `ExecuTorchTest` as
-  # the ctest target name for the test executable Usage: cd
-  # cmake-out/path/to/test/; ctest Note: currently we directly invoke the test
-  # target, without using ctest
-  add_test(ExecuTorchTest ${target_name})
+  # add_test adds a test target to be used by ctest
+  add_test(NAME ${target_name} COMMAND ${target_name})
 
 endfunction()
diff --git a/devtools/CMakeLists.txt b/devtools/CMakeLists.txt
@@ -218,3 +218,8 @@ install(
   INCLUDES
   DESTINATION ${_common_include_directories}
 )
+
+if(BUILD_TESTING)
+  # TODO: This is currently not working!
+  # add_subdirectory(etdump/tests)
+endif()
diff --git a/devtools/etdump/tests/CMakeLists.txt b/devtools/etdump/tests/CMakeLists.txt
@@ -12,10 +12,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(sdk_etdump_tests)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 
@@ -30,7 +26,7 @@ et_cxx_test(
   EXTRA_LIBS
   bundled_program
   etdump
-  flatccrt_d
+  flatccrt
 )
 target_include_directories(
   sdk_etdump_tests PRIVATE ${CMAKE_INSTALL_PREFIX}/sdk/include

diff --git a/examples/models/llama/tokenizer/test/CMakeLists.txt b/examples/models/llama/tokenizer/test/CMakeLists.txt
@@ -12,10 +12,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(tokenizer_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../../../..)
 

diff --git a/extension/data_loader/CMakeLists.txt b/extension/data_loader/CMakeLists.txt
@@ -29,3 +29,7 @@ install(
   INCLUDES
   DESTINATION ${_common_include_directories}
 )
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()
diff --git a/extension/data_loader/test/CMakeLists.txt b/extension/data_loader/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_data_loader_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 

diff --git a/extension/evalue_util/test/CMakeLists.txt b/extension/evalue_util/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_evalue_util_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 

diff --git a/extension/kernel_util/test/CMakeLists.txt b/extension/kernel_util/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_kernel_util_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 

diff --git a/extension/memory_allocator/test/CMakeLists.txt b/extension/memory_allocator/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_memory_allocator_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 

diff --git a/extension/module/CMakeLists.txt b/extension/module/CMakeLists.txt
@@ -51,3 +51,7 @@ install(
   INCLUDES
   DESTINATION ${_common_include_directories}
 )
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()
diff --git a/extension/module/test/CMakeLists.txt b/extension/module/test/CMakeLists.txt
@@ -4,8 +4,6 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-# @generated by test/utils/generate_gtest_cmakelists.py
-#
 # This file should be formatted with
 # ~~~
 # cmake-format -i CMakeLists.txt
@@ -14,10 +12,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_module_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 
@@ -36,3 +30,11 @@ et_cxx_test(
   portable_kernels
   portable_ops_lib
 )
+
+set(test_env "RESOURCES_PATH=${EXECUTORCH_ROOT}/extension/module/test/resources")
+
+set_property(
+  TEST extension_module_test
+  PROPERTY ENVIRONMENT
+           "${test_env}"
+)
diff --git a/extension/pytree/test/CMakeLists.txt b/extension/pytree/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_pytree_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 

diff --git a/extension/runner_util/CMakeLists.txt b/extension/runner_util/CMakeLists.txt
@@ -29,3 +29,7 @@ install(
   INCLUDES
   DESTINATION ${_common_include_directories}
 )
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()
diff --git a/extension/runner_util/test/CMakeLists.txt b/extension/runner_util/test/CMakeLists.txt
@@ -4,8 +4,6 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-# @generated by test/utils/generate_gtest_cmakelists.py
-#
 # This file should be formatted with
 # ~~~
 # cmake-format -i CMakeLists.txt
@@ -14,10 +12,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_runner_util_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 
@@ -35,3 +29,7 @@ et_cxx_test(
   portable_kernels
   portable_ops_lib
 )
+set_property(
+  TEST extension_runner_util_test
+  PROPERTY ENVIRONMENT "ET_MODULE_ADD_PATH=${CMAKE_BINARY_DIR}/ModuleAdd.pte"
+)
diff --git a/extension/tensor/CMakeLists.txt b/extension/tensor/CMakeLists.txt
@@ -29,3 +29,7 @@ install(
   INCLUDES
   DESTINATION ${_common_include_directories}
 )
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()
diff --git a/extension/tensor/test/CMakeLists.txt b/extension/tensor/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(extension_tensor_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../..)
 

diff --git a/kernels/portable/cpu/util/test/CMakeLists.txt b/kernels/portable/cpu/util/test/CMakeLists.txt
@@ -14,10 +14,6 @@
 #
 
 cmake_minimum_required(VERSION 3.19)
-project(kernels_portable_cpu_util_test)
-
-# Use C++17 for test.
-set(CMAKE_CXX_STANDARD 17)
 
 set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../../../..)