Major refactor: configured sanitizer build/testing

Author: ramsafin

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         compiler: [gcc, clang]
-        build_type: [RelWithDebInfo]
+        build_type: [RelWithDebInfo, Sanitize]
 
     env:
       ENABLE_TESTING: ON
@@ -37,16 +37,11 @@ jobs:
             echo "CXX=g++" >> $GITHUB_ENV
           fi
 
-      - name: Configure with CMake
-        run: >
-          cmake -S . -B build
-          -G Ninja
-          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
-          -DENABLE_TESTING=${{ env.ENABLE_TESTING }}
-          ${{ matrix.build_type == 'RelWithDebInfo' && '-DENABLE_ASAN=ON -DENABLE_UBSAN=ON' || '' }}
+      - name: Configure with CMake Preset
+        run: cmake --preset ${{ matrix.compiler }}-${{ matrix.build_type }}
 
       - name: Build
-        run: cmake --build build
+        run: cmake --build --preset ${{ matrix.compiler }}-${{ matrix.build_type }}
 
       - name: Run tests
-        run: ctest --test-dir build --output-on-failure
+        run: ctest --preset ${{ matrix.compiler }}-${{ matrix.build_type }} --output-on-failure

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.20 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.23 FATAL_ERROR)
 project(modern_cpp_project LANGUAGES CXX)
 
 # Enable C++20 with strict enforcement
@@ -8,14 +8,18 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 # Export compile_commands.json for clangd and clang-tidy
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-# Sanitizer options
-option(ENABLE_ASAN "Enable AddressSanitizer" ON)
-option(ENABLE_UBSAN "Enable UndefinedBehaviorSanitizer" ON)
+# Add custom "Sanitize" build type for multi-config generators (e.g., Visual Studio)
+if(CMAKE_CONFIGURATION_TYPES)
+  list(APPEND CMAKE_CONFIGURATION_TYPES Sanitize)
+  list(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)
+  set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING "" FORCE)
+endif()
 
+# Load sanitizer flags if needed
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 include(Sanitizers)
 
-# Targets
+# === Application target ===
 add_executable(${PROJECT_NAME}
   src/main.cpp
 )
@@ -28,11 +32,11 @@ if(TARGET sanitizers)
   target_link_libraries(${PROJECT_NAME} PRIVATE sanitizers)
 endif()
 
-# Testing options
+# === Unit Testing ===
 option(ENABLE_TESTING "Build tests" ON)
 
 if(ENABLE_TESTING)
-  message(STATUS "Enabled unit tests")
+  message(STATUS "✅ Enabled unit tests")
   enable_testing()
   add_subdirectory(tests)
 endif()

CMakePresets.json

@@ -12,71 +12,85 @@
       "generator": "Ninja",
       "binaryDir": "${sourceDir}/build/${presetName}",
       "cacheVariables": {
-        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
-        "ENABLE_TESTING": "ON"
+        "ENABLE_TESTING": "ON",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
       }
     },
     {
-      "name": "gcc-release",
+      "name": "gcc-RelWithDebInfo",
       "inherits": "base",
-      "description": "Build using GCC in Release mode",
+      "description": "GCC with RelWithDebInfo",
       "cacheVariables": {
-        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
         "CMAKE_C_COMPILER": "/usr/bin/gcc",
         "CMAKE_CXX_COMPILER": "/usr/bin/g++"
       }
     },
     {
-      "name": "gcc-relwithdebinfo",
+      "name": "gcc-Sanitize",
       "inherits": "base",
-      "description": "GCC with RelWithDebInfo and sanitizers",
+      "description": "GCC with ASan/UBSan (custom Sanitize build type)",
       "cacheVariables": {
-        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
-        "ENABLE_ASAN": "ON",
-        "ENABLE_UBSAN": "ON",
+        "CMAKE_BUILD_TYPE": "Sanitize",
         "CMAKE_C_COMPILER": "/usr/bin/gcc",
         "CMAKE_CXX_COMPILER": "/usr/bin/g++"
       }
     },
     {
-      "name": "clang-release",
+      "name": "clang-RelWithDebInfo",
       "inherits": "base",
-      "description": "Build using Clang in Release mode",
+      "description": "Clang with RelWithDebInfo",
       "cacheVariables": {
-        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
         "CMAKE_C_COMPILER": "/usr/bin/clang",
         "CMAKE_CXX_COMPILER": "/usr/bin/clang++"
       }
     },
     {
-      "name": "clang-relwithdebinfo",
+      "name": "clang-Sanitize",
       "inherits": "base",
-      "description": "Clang with RelWithDebInfo and sanitizers",
+      "description": "Clang with ASan/UBSan (custom Sanitize build type)",
       "cacheVariables": {
-        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
-        "ENABLE_ASAN": "ON",
-        "ENABLE_UBSAN": "ON",
+        "CMAKE_BUILD_TYPE": "Sanitize",
         "CMAKE_C_COMPILER": "/usr/bin/clang",
         "CMAKE_CXX_COMPILER": "/usr/bin/clang++"
       }
     }
   ],
   "buildPresets": [
     {
-      "name": "gcc-release",
-      "configurePreset": "gcc-release"
+      "name": "gcc-RelWithDebInfo",
+      "configurePreset": "gcc-RelWithDebInfo"
+    },
+    {
+      "name": "gcc-Sanitize",
+      "configurePreset": "gcc-Sanitize"
+    },
+    {
+      "name": "clang-RelWithDebInfo",
+      "configurePreset": "clang-RelWithDebInfo"
+    },
+    {
+      "name": "clang-Sanitize",
+      "configurePreset": "clang-Sanitize"
+    }
+  ],
+  "testPresets": [
+    {
+      "name": "gcc-RelWithDebInfo",
+      "configurePreset": "gcc-RelWithDebInfo"
     },
     {
-      "name": "gcc-relwithdebinfo",
-      "configurePreset": "gcc-relwithdebinfo"
+      "name": "gcc-Sanitize",
+      "configurePreset": "gcc-Sanitize"
     },
     {
-      "name": "clang-release",
-      "configurePreset": "clang-release"
+      "name": "clang-RelWithDebInfo",
+      "configurePreset": "clang-RelWithDebInfo"
     },
     {
-      "name": "clang-relwithdebinfo",
-      "configurePreset": "clang-relwithdebinfo"
+      "name": "clang-Sanitize",
+      "configurePreset": "clang-Sanitize"
     }
   ]
 }

cmake/Sanitizers.cmake

@@ -1,24 +1,15 @@
-# Optional CMake variables:
-# - ENABLE_ASAN=ON
-# - ENABLE_UBSAN=ON
-
-# Create sanitizer interface library if enabled
-if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-  set(SANITIZER_FLAGS "")
-
-  if(ENABLE_ASAN)
-    list(APPEND SANITIZER_FLAGS -fsanitize=address)
-  endif()
-
-  if(ENABLE_UBSAN)
-    list(APPEND SANITIZER_FLAGS -fsanitize=undefined)
-  endif()
-
-  if(SANITIZER_FLAGS)
-    add_library(sanitizers INTERFACE)
-    target_compile_options(sanitizers INTERFACE ${SANITIZER_FLAGS})
-    target_link_options(sanitizers INTERFACE ${SANITIZER_FLAGS})
-    message(STATUS "Sanitizer interface created with flags: ${SANITIZER_FLAGS}")
-  endif()
+# Enable AddressSanitizer + UndefinedBehaviorSanitizer only for "Sanitize" build type
+if(CMAKE_BUILD_TYPE STREQUAL "Sanitize")
+  set(SANITIZER_FLAGS
+    -fsanitize=address
+    -fsanitize=undefined
+    -O1
+    -g
+  )
+
+  add_library(sanitizers INTERFACE)
+  target_compile_options(sanitizers INTERFACE ${SANITIZER_FLAGS})
+  target_link_options(sanitizers INTERFACE ${SANITIZER_FLAGS})
+
+  message(STATUS "Sanitize build: enabled with flags: ${SANITIZER_FLAGS}")
 endif()
-

tests/CMakeLists.txt

@@ -1,21 +1,21 @@
 include(FetchContent)
 
+# Download and configure GoogleTest
 FetchContent_Declare(
   googletest
   URL https://github.com/google/googletest/archive/refs/tags/v1.17.0.zip
   DOWNLOAD_EXTRACT_TIMESTAMP TRUE  # Prevents timestamp-related rebuild issues
 )
 
-# Windows-specific: avoid CRT conflicts
+# Avoid static/shared CRT mismatch on Windows
 set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
 
 FetchContent_MakeAvailable(googletest)
 
-# Unit tests
+# === Unit Test Target ===
 add_executable(unit_tests
-  main.cpp
+  test_main.cpp
   test_core.cpp
-  test_sanitizers.cpp
 )
 
 target_link_libraries(unit_tests
@@ -27,7 +27,7 @@ target_include_directories(unit_tests
 )
 
 if(TARGET sanitizers)
-  message(STATUS "Enabled sanitizers for unit tests")
+  message(STATUS "✅ Enabled sanitizers for unit tests")
   target_link_libraries(unit_tests PRIVATE sanitizers)
 endif()