Merge branch 'main' into pr/232

aminya · Aug 8, 2023 · da802f2 · da802f2
2 parents a7da167 + 54831cb
commit da802f2
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -104,19 +104,11 @@ if(FEATURE_TESTS)
   set(ENABLE_CPPCHECK "ENABLE_CPPCHECK")
   set(ENABLE_COVERAGE "ENABLE_COVERAGE")
 
-  if(NOT
-     "${CMAKE_SYSTEM_NAME}"
-     STREQUAL
-     "Windows")
-    set(ENABLE_SANITIZER_ADDRESS "ENABLE_SANITIZER_ADDRESS")
-    set(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR "ENABLE_SANITIZER_UNDEFINED_BEHAVIOR")
-  else()
-    # or it is MSVC and has run vcvarsall
-    string(FIND "$ENV{PATH}" "$ENV{VSINSTALLDIR}" index_of_vs_install_dir)
-    if(MSVC AND "${index_of_vs_install_dir}" STREQUAL "-1")
-      set(ENABLE_SANITIZER_ADDRESS "ENABLE_SANITIZER_ADDRESS")
-    endif()
-  endif()
+  check_sanitizers_support(ENABLE_SANITIZER_ADDRESS
+                           ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
+                           ENABLE_SANITIZER_LEAK
+                           ENABLE_SANITIZER_THREAD
+                           ENABLE_SANITIZER_MEMORY)
 endif()
 
 if(FEATURE_DOCS)
@@ -141,8 +133,8 @@ project_options(
       ${ENABLE_COVERAGE}
       ${ENABLE_SANITIZER_ADDRESS}
       ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
-      # ENABLE_SANITIZER_THREAD
-      # ENABLE_SANITIZER_MEMORY
+      # ${ENABLE_SANITIZER_THREAD}
+      # ${ENABLE_SANITIZER_MEMORY}
       # ENABLE_CONTROL_FLOW_PROTECTION
       # ENABLE_STACK_PROTECTION
       # ENABLE_OVERFLOW_PROTECTION

diff --git a/docker/Dockerfile.mingw b/docker/Dockerfile.mingw
@@ -11,13 +11,7 @@ RUN npm install -g setup-cpp
 FROM base AS setup
 
 # install cmake, ninja, and ccache
-RUN setup-cpp --cmake true --ninja true --ccache true --cppcheck true --vcpkg true --conan true --task true --powershell true
-
-# TODO: install cross-compiler with setup_cpp_linux
-# NOTE: install mingw by hand, waiting for setup-cpp to have mingw cross-compiler support
-RUN apt-get update && apt-get install -y \
-    mingw-w64 \
-    && rm -rf /var/lib/apt/lists/*
+RUN setup-cpp --compiler mingw --cmake true --ninja true --ccache true --cppcheck true --vcpkg true --conan true --task true --powershell true
 
 COPY ./docker/entrypoint.sh /docker-entrypoint.sh
 ENTRYPOINT [ "/docker-entrypoint.sh" ]

diff --git a/docs/src/project_options_example.md b/docs/src/project_options_example.md
@@ -57,19 +57,11 @@ if(FEATURE_TESTS)
   set(ENABLE_CPPCHECK "ENABLE_CPPCHECK")
   set(ENABLE_COVERAGE "ENABLE_COVERAGE")
 
-  if(NOT
-     "${CMAKE_SYSTEM_NAME}"
-     STREQUAL
-     "Windows")
-    set(ENABLE_SANITIZER_ADDRESS "ENABLE_SANITIZER_ADDRESS")
-    set(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR "ENABLE_SANITIZER_UNDEFINED_BEHAVIOR")
-  else()
-    # or it is MSVC and has run vcvarsall
-    string(FIND "$ENV{PATH}" "$ENV{VSINSTALLDIR}" index_of_vs_install_dir)
-    if(MSVC AND "${index_of_vs_install_dir}" STREQUAL "-1")
-      set(ENABLE_SANITIZER_ADDRESS "ENABLE_SANITIZER_ADDRESS")
-    endif()
-  endif()
+  check_sanitizers_support(ENABLE_SANITIZER_ADDRESS
+                           ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
+                           ENABLE_SANITIZER_LEAK
+                           ENABLE_SANITIZER_THREAD
+                           ENABLE_SANITIZER_MEMORY)
 endif()
 
 if(FEATURE_DOCS)
@@ -94,8 +86,8 @@ project_options(
       ${ENABLE_COVERAGE}
       ${ENABLE_SANITIZER_ADDRESS}
       ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
-      # ENABLE_SANITIZER_THREAD
-      # ENABLE_SANITIZER_MEMORY
+      # ${ENABLE_SANITIZER_THREAD}
+      # ${ENABLE_SANITIZER_MEMORY}
       # ENABLE_CONTROL_FLOW_PROTECTION
       # ENABLE_STACK_PROTECTION
       # ENABLE_OVERFLOW_PROTECTION

diff --git a/src/Utilities.cmake b/src/Utilities.cmake
@@ -157,3 +157,48 @@ function(detect_custom_linker LINKER)
     set(${LINKER} "gold" PARENT_SCOPE)
   endif()
 endfunction()
+
+# detect sanitizers support for compiler
+function(check_sanitizers_support
+        ENABLE_SANITIZER_ADDRESS
+        ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
+        ENABLE_SANITIZER_LEAK
+        ENABLE_SANITIZER_THREAD
+        ENABLE_SANITIZER_MEMORY)
+  set(SANITIZERS "")
+  if(NOT "${CMAKE_SYSTEM_NAME}" STREQUAL "Windows")
+    list(APPEND SANITIZERS "address")
+    list(APPEND SANITIZERS "undefined")
+    list(APPEND SANITIZERS "leak")
+    list(APPEND SANITIZERS "thread")
+    list(APPEND SANITIZERS "memory")
+  elseif(MSVC)
+    # or it is MSVC and has run vcvarsall
+    string(FIND "$ENV{PATH}" "$ENV{VSINSTALLDIR}" index_of_vs_install_dir)
+    if("${index_of_vs_install_dir}" STREQUAL "-1")
+      list(APPEND SANITIZERS "address")
+    endif()
+  endif()
+
+  list(JOIN SANITIZERS "," LIST_OF_SANITIZERS)
+
+  if(LIST_OF_SANITIZERS)
+    if(NOT "${LIST_OF_SANITIZERS}" STREQUAL "")
+      if("address" IN_LIST SANITIZERS)
+        set(${ENABLE_SANITIZER_ADDRESS} "ENABLE_SANITIZER_ADDRESS" PARENT_SCOPE)
+      endif()
+      if("undefined" IN_LIST SANITIZERS)
+        set(${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR} "ENABLE_SANITIZER_UNDEFINED_BEHAVIOR" PARENT_SCOPE)
+      endif()
+      if("leak" IN_LIST SANITIZERS)
+        set(${ENABLE_SANITIZER_LEAK} "ENABLE_SANITIZER_LEAK" PARENT_SCOPE)
+      endif()
+      if("thread" IN_LIST SANITIZERS)
+        set(${ENABLE_SANITIZER_THREAD} "ENABLE_SANITIZER_THREAD" PARENT_SCOPE)
+      endif()
+      if("memory" IN_LIST SANITIZERS)
+        set(${ENABLE_SANITIZER_MEMORY} "ENABLE_SANITIZER_MEMORY" PARENT_SCOPE)
+      endif()
+    endif()
+  endif()
+endfunction()
diff --git a/tests/myproj/CMakeLists.txt b/tests/myproj/CMakeLists.txt
@@ -33,18 +33,11 @@ set(PCH_HEADERS
 )
 
 # Enable sanitizers and static analyzers when running the tests
-set(ENABLE_SANITIZER_ADDRESS OFF)
-set(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR OFF)
-if(NOT "${CMAKE_SYSTEM_NAME}" STREQUAL "Windows")
-  set(ENABLE_SANITIZER_ADDRESS "ENABLE_SANITIZER_ADDRESS")
-  set(ENABLE_SANITIZER_UNDEFINED_BEHAVIOR "ENABLE_SANITIZER_UNDEFINED_BEHAVIOR")
-else()
-  # or it is MSVC and has run vcvarsall
-  string(FIND "$ENV{PATH}" "$ENV{VSINSTALLDIR}" index_of_vs_install_dir)
-  if(MSVC AND "${index_of_vs_install_dir}" STREQUAL "-1")
-    set(ENABLE_SANITIZER_ADDRESS "ENABLE_SANITIZER_ADDRESS")
-  endif()
-endif()
+check_sanitizers_support(ENABLE_SANITIZER_ADDRESS
+                         ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
+                         ENABLE_SANITIZER_LEAK
+                         ENABLE_SANITIZER_THREAD
+                         ENABLE_SANITIZER_MEMORY)
 
 # Detect custom linker
 if(NOT MSVC)
@@ -74,10 +67,10 @@ project_options(
   # ENABLE_BUILD_WITH_TIME_TRACE
   # ENABLE_UNITY
   ${ENABLE_SANITIZER_ADDRESS}
-  # ENABLE_SANITIZER_LEAK
+  # ${ENABLE_SANITIZER_LEAK}
   ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
-  # ENABLE_SANITIZER_THREAD
-  # ENABLE_SANITIZER_MEMORY
+  # ${ENABLE_SANITIZER_THREAD}
+  # ${ENABLE_SANITIZER_MEMORY}
   # CLANG_WARNINGS "-Weverything"
   LINKER "${LINKER}"
 )