Merge pull request #3744 from nilsleiffischer/cmake_testing

Add standard CMake `BUILD_TESTING` option, document test targets

.github/workflows/Tests.yaml

@@ -193,6 +193,9 @@ jobs:
           git fetch upstream develop
       - name: Configure with cmake
         working-directory: /work
+        # Notes on the build configuration:
+        # - Set `BUILD_TESTING=OFF` to test a CMake configuration with tests
+        #   turned off.
         run: >
           mkdir build && cd build
 
@@ -206,6 +209,7 @@ jobs:
           -D USE_CCACHE=OFF
           -D DEBUG_SYMBOLS=OFF
           -D BUILD_PYTHON_BINDINGS=ON
+          -D BUILD_TESTING=OFF
           $GITHUB_WORKSPACE
       - name: Check clang-tidy
         working-directory: /work/build

CMakeLists.txt

@@ -102,7 +102,6 @@ include(SetupLIBXSMM)
 
 include(SetupBlaze)
 include(SetupBrigand)
-include(SetupCatch)
 include(SetupGoogleBenchmark)
 include(SetupGsl)
 include(SetupHdf5)
@@ -137,12 +136,16 @@ include(CodeCoverageDetection)
 include(SpectreAddLibraries)
 
 include(SpectreSetupTesting)
+if(BUILD_TESTING)
+  include(SetupCatch)
+  include(SetupPypp)
+  include(SpectreAddTestLibs)
+  include(SpectreAddCatchTests)
+  include(AddInputFileTests)
+  include(AddStandaloneTests)
+endif()
+
 include(SpectreSetupPythonPackage)
-include(SetupPypp)
-include(SpectreAddTestLibs)
-include(SpectreAddCatchTests)
-include(AddInputFileTests)
-include(AddStandaloneTests)
 
 include_directories(${CMAKE_SOURCE_DIR}/external)
 include_directories(${CMAKE_SOURCE_DIR}/src)
@@ -155,7 +158,9 @@ spectre_include_directories(${CMAKE_BINARY_DIR}/src/Parallel)
 
 add_subdirectory(external)
 add_subdirectory(src)
-add_subdirectory(tests)
+if(BUILD_TESTING)
+  add_subdirectory(tests)
+endif()
 
 include(PrintUsefulCMakeInfo)
 

cmake/SpectreSetupPythonPackage.cmake

@@ -196,7 +196,9 @@ function(SPECTRE_PYTHON_ADD_MODULE MODULE_NAME)
       LINK_FLAGS "${PY_LIB_LINK_FLAGS}"
       )
     set(SPECTRE_PYTHON_MODULE_IMPORT "from ._${ARG_LIBRARY_NAME} import *")
-    add_dependencies(test-executables ${ARG_LIBRARY_NAME})
+    if(BUILD_TESTING)
+      add_dependencies(test-executables ${ARG_LIBRARY_NAME})
+    endif()
     add_dependencies(all-pybindings ${ARG_LIBRARY_NAME})
   endif(BUILD_PYTHON_BINDINGS AND NOT "${ARG_SOURCES}" STREQUAL "")
 

cmake/SpectreSetupTesting.cmake

@@ -1,7 +1,7 @@
 # Distributed under the MIT License.
 # See LICENSE.txt for details.
 
-enable_testing(true)
+include(CTest)
 
 set(SPECTRE_TEST_RUNNER "" CACHE STRING
   "Run test executables through the given wrapper.")

docs/DevGuide/BuildSystem.md

@@ -166,6 +166,8 @@ cmake -D FLAG1=OPT1 ... -D FLAGN=OPTN <SPECTRE_ROOT>
 - BUILD_SHARED_LIBS
   - Whether shared libraries are built instead of static libraries
     (default is `OFF`)
+- BUILD_TESTING
+  - Enable building tests. (default is `ON`)
 - CHARM_ROOT
   - The path to the build directory of `Charm++`
 - CMAKE_BUILD_TYPE
@@ -298,6 +300,14 @@ cmake -D FLAG1=OPT1 ... -D FLAGN=OPTN <SPECTRE_ROOT>
 In addition to individual simulation executables, the following targets are
 available to build with `make` or `ninja`:
 
+- unit-tests
+  - Build unit tests, which you can run with `ctest -L unit`. Available if
+    `BUILD_TESTING` is `ON` (the default).
+- test-executables
+  - Build all tests, including executables, so you can run all tests with
+    `ctest`. Available if `BUILD_TESTING` is `ON` (the default). To compile
+    `test-executables` you may have to reduce the number of cores you build on
+    in parallel to avoid running out of memory.
 - all-pybindings
   - Build Python bindings. See \ref spectre_using_python for details.
 - install

src/Executables/ReduceCceWorldtube/CMakeLists.txt

@@ -26,4 +26,6 @@ set_target_properties(
   PROPERTIES LINK_FLAGS "-nomain-module -nomain"
   )
 
-add_dependencies(test-executables ${EXECUTABLE})
+if(BUILD_TESTING)
+  add_dependencies(test-executables ${EXECUTABLE})
+endif()