perf: enhance tests with vcpkg feature (#181)

Move test dependencies to vcpkg manifest with the explict declaration.

See vcpkg feature:
- <https://learn.microsoft.com/en-us/vcpkg/concepts/features>
-
<https://learn.microsoft.com/en-us/vcpkg/users/examples/selecting-llvm-features>

Signed-off-by: msclock <msclock@qq.com>

Author: msclock

CMakeLists.txt

@@ -29,7 +29,6 @@ include(cmake-modules/build/Cppcheck)
 include(cmake-modules/build/Ccache)
 include(cmake-modules/build/LinkOptimization)
 include(cmake-modules/test/Default)
-include(cmake-modules/test/GoogleTest)
 include(cmake-modules/test/Valgrind)
 include(cmake-modules/install/Default)
 include(cmake-modules/install/Common)
@@ -47,6 +46,10 @@ include(ConfigureVersion)
 include(ConfigureDocs)
 include(ConfigureCoverage)
 
+if(test IN_LIST VCPKG_MANIFEST_FEATURES)
+  include(ConfigureTest)
+endif()
+
 add_subdirectory(src)
 
 # Print project final information

cmake/ConfigureTest.cmake

@@ -0,0 +1,33 @@
+#[[
+Enable tests in CMake, and use CTest module to create a ``BUILD_TESTING``
+option to select whether to enable tests.
+
+Note:
+  Use the module has some requirements:
+    - Being placed in front of test configuration instructions in cmake.
+    - Being placed in the source directory root because ctest expects to
+      find a test file in the build directory root.
+]]
+
+include_guard(GLOBAL)
+
+# Prevent the module from being used in the wrong location
+if(NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
+  message(
+    FATAL_ERROR
+      "This module should be in the project root directory and placed "
+      "in front of any test configuration instructions in cmake")
+endif()
+
+# Include CTest module to enable testing support. It creates a ``BUILD_TESTING``
+# option that selects whether to enable testing support (``ON`` by default).
+include(CTest)
+
+function(add_test_subdirectory src)
+  if(NOT IS_ABSOLUTE src)
+    cmake_path(ABSOLUTE_PATH src BASE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+               OUTPUT_VARIABLE src)
+  endif()
+  message(STATUS "Adding tests from ${src}")
+  add_subdirectory(${src})
+endfunction()

cmake/presets/toolchains/vcpkg.json

@@ -7,6 +7,7 @@
       "toolchainFile": "${sourceDir}/cmake/vcpkg/vcpkg.toolchain.cmake",
       "cacheVariables": {
         "VCPKG_INSTALL_OPTIONS": "--no-print-usage",
+        "VCPKG_MANIFEST_FEATURES": "test",
         "VCPKG_OVERLAY_TRIPLETS": "${sourceDir}/cmake/vcpkg/triplets",
         "VCPKG_OVERLAY_PORTS": "${sourceDir}/cmake/vcpkg/ports"
       }

cmake/vcpkg/bootstrap/vcpkg_export_mode.cmake

@@ -29,6 +29,20 @@ function(_vcpkg_setup_export export_export_dir export_vcpkg_root)
       )
     endif()
 
+    if(DEFINED VCPKG_FEATURE_FLAGS OR DEFINED CACHE{VCPKG_FEATURE_FLAGS})
+      list(JOIN VCPKG_FEATURE_FLAGS "," vcpkg_feature_flags)
+      set(vcpkg_feature_flags "--feature-flags=${vcpkg_feature_flags}")
+    endif()
+
+    foreach(_vcpkg_feature IN LISTS VCPKG_MANIFEST_FEATURES)
+      list(APPEND vcpkg_additional_manifest_params
+           "--x-feature=${_vcpkg_feature}")
+    endforeach()
+
+    if(VCPKG_MANIFEST_NO_DEFAULT_FEATURES)
+      list(APPEND vcpkg_additional_manifest_params "--x-no-default-features")
+    endif()
+
     set(_additional_args
         --vcpkg-root
         ${_VCPKG_ROOT}
@@ -44,8 +58,11 @@ function(_vcpkg_setup_export export_export_dir export_vcpkg_root)
         "${_export_install_dir}")
 
     execute_process(
-      COMMAND ${vcpkg_cmd} install --x-manifest-root ${CMAKE_SOURCE_DIR}
-              ${_additional_args} ${VCPKG_INSTALL_OPTIONS}
+      COMMAND
+        ${vcpkg_cmd} install "--x-wait-for-lock"
+        "--x-manifest-root=${CMAKE_SOURCE_DIR}" ${_additional_args}
+        ${vcpkg_feature_flags} ${vcpkg_additional_manifest_params}
+        ${VCPKG_INSTALL_OPTIONS}
       WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
       RESULT_VARIABLE install_packages_result)
 

src/compile/CMakeLists.txt

@@ -71,9 +71,6 @@ install_target(
 
 install_dependency(TARGETS ${target_name})
 
-# Tests
-message(STATUS "BUILD_TESTING:${BUILD_TESTING}")
-
 if(BUILD_TESTING)
-  add_subdirectory(tests)
+  add_test_subdirectory(tests)
 endif()

src/compile/tests/CMakeLists.txt

@@ -1,3 +1,6 @@
+find_package(GTest CONFIG REQUIRED)
+include(GoogleTest)
+
 file(GLOB files "*.cpp")
 
 foreach(_file ${files})

src/exe/CMakeLists.txt

@@ -32,7 +32,6 @@ install(TARGETS ${target_name}
 
 install_dependency(TARGETS ${target_name})
 
-# Test
 if(BUILD_TESTING)
-  add_subdirectory(tests)
+  add_test_subdirectory(tests)
 endif()

src/exe/tests/CMakeLists.txt

@@ -1,3 +1,6 @@
+find_package(GTest CONFIG REQUIRED)
+include(GoogleTest)
+
 file(GLOB files "*.cpp")
 
 foreach(_file ${files})

src/header/CMakeLists.txt

@@ -25,7 +25,6 @@ install_target(
   DEPENDENCIES
   spdlog::spdlog)
 
-# Test
 if(BUILD_TESTING)
-  add_subdirectory(tests)
+  add_test_subdirectory(tests)
 endif()

src/header/tests/CMakeLists.txt

@@ -1,3 +1,6 @@
+find_package(GTest CONFIG REQUIRED)
+include(GoogleTest)
+
 file(GLOB files "*.cpp")
 
 foreach(_file ${files})