only use doctest when building tests

Author: artemdinaburg

CMakeLists.txt

@@ -1,152 +1,65 @@
 #
-# Copyright (c) 2020-present, Trail of Bits, Inc.
-# All rights reserved.
+# Copyright (c) 2025-present, Trail of Bits, Inc.
 #
 # This source code is licensed in accordance with the terms specified in
 # the LICENSE file found in the root directory of this source tree.
 #
 
-cmake_minimum_required(VERSION 3.21)
+set(src_dir "${CMAKE_CURRENT_LIST_DIR}/src")
+set(build_dir "${CMAKE_CURRENT_BINARY_DIR}/build")
 
-include("cmake/options.cmake")
+# Fetch the submodule if we don't yet have it.
+if(NOT EXISTS "${src_dir}/CMakeLists.txt")
+  execute_process(
+    COMMAND "${GIT_EXECUTABLE}" submodule update --init vendor/rellic/src
+    WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
 
-project(rellic)
-set(CMAKE_CXX_VISIBILITY_PRESET hidden)
-set(CMAKE_C_VISIBILITY_PRESET hidden)
-set (VISIBILITY_INLINES_HIDDEN YES)
-include("cmake/settings.cmake")
-include(GNUInstallDirs)
-
-if(RELLIC_ENABLE_INSTALL)
-  include("cmake/packaging.cmake")
-endif(RELLIC_ENABLE_INSTALL)
-
-enable_language(C CXX ASM)
-
-set(RELLIC_SOURCE_DIR "${PROJECT_SOURCE_DIR}")
-
-add_library("${PROJECT_NAME}_cxx_settings" INTERFACE)
-target_compile_features("${PROJECT_NAME}_cxx_settings"
-  INTERFACE
-    cxx_std_17
-)
-
-# warnings and compiler settings
-if(NOT DEFINED WIN32)
-  target_compile_options("${PROJECT_NAME}_cxx_settings"
-    INTERFACE
-      -Werror
-      # -Wconversion
-      -pedantic
-      -Wno-unreachable-code-return
-  )
-endif(NOT DEFINED WIN32)
-
-#
-# libraries
-#
-
-find_package(gflags CONFIG REQUIRED)
-find_package(glog CONFIG REQUIRED)
-find_package(Z3 4.8 CONFIG REQUIRED)
-find_package(doctest CONFIG REQUIRED)
-find_package(LLVM 20 CONFIG REQUIRED)
-message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
-llvm_map_components_to_libnames(llvm_libs support core irreader bitreader bitwriter)
-
-find_package(MLIR 20 CONFIG REQUIRED)
-message(STATUS "Using MLIRConfig.cmake in: ${MLIR_DIR}")
-
-find_package(Clang 20 CONFIG REQUIRED)
-message(STATUS "Using ClangConfig.cmake in: ${Clang_DIR}")
-
-
-#
-# helper macro to set target properties
-#
-
-if(RELLIC_ENABLE_INSTALL)
-  export(PACKAGE "${PROJECT_NAME}")
-
-  set(cmake_install_dir "lib/cmake/${PROJECT_NAME}")
-
-  include(CMakePackageConfigHelpers)
-  configure_package_config_file("${PROJECT_NAME}Config.cmake.in"
-      "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-      INSTALL_DESTINATION "${cmake_install_dir}"
-  )
-
-  install(
-      FILES
-          "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-      DESTINATION "${cmake_install_dir}"
-  )
-  install(EXPORT "${PROJECT_NAME}Targets"
-      DESTINATION "${cmake_install_dir}"
-      NAMESPACE "${PROJECT_NAME}::"
-  )
-  install(
-    TARGETS
-      "${PROJECT_NAME}_cxx_settings"
-    EXPORT
-      "${PROJECT_NAME}Targets"
-  )
-endif(RELLIC_ENABLE_INSTALL)
-
-#
-# rellic libraries
-#
-
-add_subdirectory(lib)
-
-#
-# rellic executables
-#
-
-add_subdirectory(tools)
-
-#
-# tests
-#
-
-
-if (RELLIC_ENABLE_TESTING)
-  enable_testing()
-
-  add_subdirectory(unittests)
-
-  get_target_property(CLANG_PATH clang LOCATION)
-  message(STATUS "Clang path for tests: \"${CLANG_PATH}\"")
-
-  find_package(Python3 COMPONENTS Interpreter REQUIRED)
-  message(STATUS "Python path for tests: \"${Python3_EXECUTABLE}\"")
-
-  if(DEFINED CMAKE_OSX_SYSROOT)
-    set(RELLIC_TEST_ARGS "--cflags=-isysroot" "--cflags=${CMAKE_OSX_SYSROOT}")
-  else()
-    set(RELLIC_TEST_ARGS "")
-  endif()
-
-  # Tests that survive a complete roundtrip
-  add_test(NAME test_roundtrip_rebuild
-    COMMAND "${Python3_EXECUTABLE}" scripts/roundtrip.py $<TARGET_FILE:${RELLIC_DECOMP}> tests/tools/decomp/ "${CLANG_PATH}" --timeout 30 ${RELLIC_TEST_ARGS}
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-  )
+  execute_process(
+    COMMAND "${GIT_EXECUTABLE}" submodule set-branch --branch llvm20 vendor/rellic/src
+    WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}")
+endif()
 
-  # Tests that may not roundtrip yet, but should emit C
-  add_test(NAME test_roundtrip_translate_only
-    COMMAND "${Python3_EXECUTABLE}" scripts/roundtrip.py --translate-only $<TARGET_FILE:${RELLIC_DECOMP}> tests/tools/decomp/failing-rebuild/ "${CLANG_PATH}" --timeout 30 ${RELLIC_TEST_ARGS}
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+# Only fetch doctest if testing is enabled
+if(RELLIC_ENABLE_TESTING)
+  include(FetchContent)
+  FetchContent_Declare(
+    doctest
+    GIT_REPOSITORY https://github.com/doctest/doctest.git
+    GIT_TAG v2.4.11
   )
+  FetchContent_MakeAvailable(doctest)
+endif()
 
-  # Tests that can be decompiled
-  add_test(NAME test_decompile
-    COMMAND "${Python3_EXECUTABLE}" scripts/decompile.py $<TARGET_FILE:${RELLIC_DECOMP}> tests/tools/decomp/ --timeout 30
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-  )
+set(REMILL_PREFIX_PATH ${CMAKE_PREFIX_PATH})
 
-  add_test(NAME test_headergen
-    COMMAND "${Python3_EXECUTABLE}" scripts/test-headergen.py $<TARGET_FILE:${RELLIC_HEADERGEN}> tests/tools/headergen/ "${CLANG_PATH}" ${RELLIC_TEST_ARGS}
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-  )
+if (PE_USE_VENDORED_CLANG)
+  set(REMILL_PREFIX_PATH ${PE_VENDOR_INSTALL_DIR})
 endif()
+
+execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory "${build_dir}")
+
+execute_process(COMMAND ${CMAKE_COMMAND}
+                        -G "${CMAKE_GENERATOR}"
+                        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+                        "-DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}"
+                        "-DCMAKE_INSTALL_PREFIX=${PE_VENDOR_INSTALL_DIR}"
+                        "-DCMAKE_PREFIX_PATH=${REMILL_PREFIX_PATH}"
+                        "-DCMAKE_INSTALL_RPATH=${CMAKE_INSTALL_RPATH}"
+                        "-DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}"
+                        "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}"
+                        "-Dglog_DIR=${PE_VENDOR_INSTALL_DIR}/lib/cmake/glog"
+                        -DRELLIC_ENABLE_INSTALL=ON
+                        -DRELLIC_ENABLE_TESTING=OFF
+                        "${src_dir}"
+               WORKING_DIRECTORY "${build_dir}")
+
+# (c) Build just mycomp in the nested build. Don't specify a --config
+#     because we cannot know what config the developer will be using
+#     at this point. For non-multi-config generators, we've already
+#     specified CMAKE_BUILD_TYPE above in (b).
+execute_process(COMMAND ${CMAKE_COMMAND} --build . --target install
+                WORKING_DIRECTORY "${build_dir}")
+
+if(DEFINED ENV{CI})
+  execute_process(COMMAND ${CMAKE_COMMAND} -E remove_directory "${build_dir}")
+endif()