Improve undefined sanitizer support.

.github/workflows/ci_linux_clang.yml

@@ -68,14 +68,25 @@ jobs:
             cc: "clang-14", cxx: "clang++-14",
             cxx_standard: 20
           }
+          - {
+            name: "Ubuntu 22.04 Clang with sanitizers",
+            os: ubuntu-22.04,
+            build_type: Debug,
+            cc: "clang", cxx: "clang++",
+            enable_sanitizers_in_tests: ON
+          }
     steps:
       - uses: actions/checkout@v2
       - name: Build project
         env:
           CC: ${{ matrix.config.cc }}
           CXX: ${{ matrix.config.cxx }}
         run: |
-          cmake -S . -B build -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }} -DENABLE_TESTING=ON -DOVERRIDE_CXX_STANDARD_FOR_TESTS=${{ matrix.config.cxx_standard }}
+          cmake -S . -B build \
+            -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }} \
+            -DENABLE_TESTING=ON \
+            -DOVERRIDE_CXX_STANDARD_FOR_TESTS=${{ matrix.config.cxx_standard }} \
+            -DENABLE_SANITIZERS_IN_TESTS=${{ matrix.config.enable_sanitizers_in_tests }}
           cmake --build build -j
       - name: Run tests
         run: |

.github/workflows/ci_linux_gcc.yml

@@ -62,14 +62,25 @@ jobs:
             cc: "gcc-12", cxx: "g++-12",
             cxx_standard: 20
           }
+          - {
+            name: "Ubuntu 22.04 GCC with sanitizers",
+            os: ubuntu-22.04,
+            build_type: Debug,
+            cc: "gcc", cxx: "g++",
+            enable_sanitizers_in_tests: ON
+          }
     steps:
       - uses: actions/checkout@v2
       - name: Build project
         env:
           CC: ${{ matrix.config.cc }}
           CXX: ${{ matrix.config.cxx }}
         run: |
-          cmake -S . -B build -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }} -DENABLE_TESTING=ON -DOVERRIDE_CXX_STANDARD_FOR_TESTS=${{ matrix.config.cxx_standard }}
+          cmake -S . -B build \
+            -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }} \
+            -DENABLE_TESTING=ON \
+            -DOVERRIDE_CXX_STANDARD_FOR_TESTS=${{ matrix.config.cxx_standard }} \
+            -DENABLE_SANITIZERS_IN_TESTS=${{ matrix.config.enable_sanitizers_in_tests }}
           cmake --build build -j
       - name: Run tests
         run: |

.github/workflows/ci_windows_msvc.yml

@@ -59,7 +59,11 @@ jobs:
       - uses: actions/checkout@v2
       - name: Build project
         run: |
-          cmake -S . -B build -G "${{ matrix.config.generator }}" -A ${{ matrix.config.architecture }} -DENABLE_TESTING=ON -DOVERRIDE_CXX_STANDARD_FOR_TESTS=${{ matrix.config.cxx_standard }}
+          cmake -S . -B build \
+            -G "${{ matrix.config.generator }}" \
+            -A ${{ matrix.config.architecture }} \
+            -DENABLE_TESTING=ON \
+            -DOVERRIDE_CXX_STANDARD_FOR_TESTS=${{ matrix.config.cxx_standard }}
           cmake --build build --config ${{ matrix.config.build_type }} -j
       - name: Run tests
         run: |

CMakeLists.txt

@@ -3,9 +3,10 @@ cmake_minimum_required(VERSION 3.14)
 
 project(FakeIt VERSION 2.3.2 LANGUAGES CXX)
 
-option(ENABLE_COVERAGE "Enable coverage reporting for gcc/clang." OFF)
 option(ENABLE_TESTING "Enable build of tests." OFF)
 option(OVERRIDE_CXX_STANDARD_FOR_TESTS "Override the C++ standard used for building tests." "")
+option(ENABLE_SANITIZERS_IN_TESTS "Enable address / undefined sanitizers in tests." OFF)
+option(ENABLE_COVERAGE "Enable coverage reporting for gcc/clang." OFF)
 
 # Directory containing main targets of FakeIt.
 add_subdirectory(include)

include/mockutils/Macros.hpp

@@ -20,3 +20,9 @@
 #else
 #   define FAKEIT_CPLUSPLUS __cplusplus
 #endif
+
+#ifdef __GNUG__
+#   define FAKEIT_DISARM_UBSAN __attribute__((no_sanitize("undefined")))
+#else
+#   define FAKEIT_DISARM_UBSAN
+#endif

include/mockutils/VTUtils.hpp

@@ -10,6 +10,7 @@
 
 #include <functional>
 #include <type_traits>
+#include "mockutils/Macros.hpp"
 #include "mockutils/VirtualOffestSelector.hpp"
 #include "mockutils/union_cast.hpp"
 
@@ -37,6 +38,7 @@ namespace fakeit {
 #endif
 
         template<typename C>
+        FAKEIT_DISARM_UBSAN
         static typename std::enable_if<std::has_virtual_destructor<C>::value, unsigned int>::type
         getDestructorOffset() {
             VirtualOffsetSelector offsetSelctor;

tests/CMakeLists.txt

@@ -45,6 +45,17 @@ if(OVERRIDE_CXX_STANDARD_FOR_TESTS)
     message(STATUS "Building tests in C++${OVERRIDE_CXX_STANDARD_FOR_TESTS}.")
 endif()
 
+if(ENABLE_SANITIZERS_IN_TESTS)
+    if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "^(Apple)?Clang$")
+        target_compile_options(FakeIt_tests PRIVATE -fsanitize=address,undefined -fno-sanitize-recover=address,undefined)
+        target_link_options(FakeIt_tests PRIVATE -fsanitize=address,undefined -fno-sanitize-recover=address,undefined)
+        target_compile_definitions(FakeIt_tests PRIVATE FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS)
+        message(STATUS "Sanitizers enabled: address, undefined.")
+    else()
+        message(SEND_ERROR "Sanitizers requested but compiler is not compatible.")
+    endif()
+endif()
+
 if(ENABLE_COVERAGE)
     if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "^(Apple)?Clang$")
         target_compile_options(FakeIt_tests PRIVATE --coverage)

tests/default_behaviore_tests.cpp

@@ -22,9 +22,13 @@ struct DefaultBehavioreTests : tpunit::TestFixture {
 			TEST(DefaultBehavioreTests::DefaultBeaviorOfVoidFunctionsIsToDoNothing), //
 			TEST(DefaultBehavioreTests::ReturnByValue_ReturnDefaultConstructedObject), //
 			TEST(DefaultBehavioreTests::ReturnByValue_ThrowExceptionIfNotDefaultConstructible), //
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 			TEST(DefaultBehavioreTests::ReturnByReference_ReturnReferenceToNullIfAbstract), //
+#endif
 			TEST(DefaultBehavioreTests::ReturnByReference_ReturnReferenceToDefaultConstructedObject), //
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 			TEST(DefaultBehavioreTests::ReturnByReference_ReturnReferenceToNullIfNotDefaultConstructible), //
+#endif
 			TEST(DefaultBehavioreTests::ReturnPtr_NullPtrIfPtrToAbstract),
 			TEST(DefaultBehavioreTests::production_shared_ptr_mock_used_in_invocation)
 			//TEST(DefaultBehavioreTests::should_survive_delete_of_mock_instance_by_user)

tests/referece_types_tests.cpp

@@ -57,30 +57,41 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 
 	void implicitStubbingDefaultReturnValues() {
 		Mock<ReferenceInterface> mock;
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 		Fake( //
 				Method(mock,returnIntByRef), //
 				Method(mock,returnAbstractTypeByRef), //
 				Method(mock,returnConcreteTypeByRef) //
 				);
+#else
+		Fake( //
+				Method(mock,returnIntByRef), //
+				Method(mock,returnConcreteTypeByRef) //
+				);
+#endif
 
 		ReferenceInterface & i = mock.get();
 
 		// Fundamental types are initiated to 0.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(0, i.returnIntByRef());
 
-		// Concrete types types are initiated by default ctor.
+		// Concrete types are initiated by default ctor.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(ConcreteType(), i.returnConcreteTypeByRef());
 
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 		// For abstract types return a reference to nullptr.
 		ASSERT_EQUAL(nullptr, &i.returnAbstractTypeByRef());
+#endif
 	}
 
 	void explicitStubbingDefualtReturnValues() {
 		Mock<ReferenceInterface> mock;		//
 		When(Method(mock,returnIntByRef)).Return(); //
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 		When(Method(mock,returnAbstractTypeByRef)).Return(); //
+#endif
 		When(Method(mock,returnConcreteTypeByRef)).Return(); //
 
 		ReferenceInterface & i = mock.get();
@@ -89,12 +100,14 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 		// Return a reference to the default value.
 		ASSERT_EQUAL(0, i.returnIntByRef());
 
-		// Concrete types types are initiated by default ctor.
+		// Concrete types are initiated by default ctor.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(ConcreteType(), i.returnConcreteTypeByRef());
 
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 		// For abstract types return a reference to nullptr.
 		ASSERT_EQUAL(nullptr, &i.returnAbstractTypeByRef());
+#endif
 	}
 
 	void explicitStubbingReturnValues() {
@@ -113,7 +126,7 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 		// Return a reference to the default value.
 		ASSERT_EQUAL(1, i.returnIntByRef());
 
-		// Concrete types types are initiated by default ctor.
+		// Concrete types are initiated by default ctor.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(&c, &i.returnConcreteTypeByRef());
 
@@ -137,7 +150,7 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 		// Return a reference to the default value.
 		ASSERT_EQUAL(1, i.returnIntByRef());
 
-		// Concrete types types are initiated by default ctor.
+		// Concrete types are initiated by default ctor.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(&c, &i.returnConcreteTypeByRef());
 
@@ -161,7 +174,7 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 		// Return a reference to the default value.
 		ASSERT_EQUAL(1, i.returnIntByRef());
 
-		// Concrete types types are initiated by default ctor.
+		// Concrete types are initiated by default ctor.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(&c, &i.returnConcreteTypeByRef());
 
@@ -172,7 +185,9 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 	void explicitStubbingDefualtReturnValues_with_AlwaysReturn() {
 		Mock<ReferenceInterface> mock;
 		When(Method(mock,returnIntByRef)).AlwaysReturn();
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 		When(Method(mock,returnAbstractTypeByRef)).AlwaysReturn(); //
+#endif
 		When(Method(mock,returnConcreteTypeByRef)).AlwaysReturn(); //
 
 		ReferenceInterface & i = mock.get();
@@ -181,13 +196,14 @@ struct ReferenceTypesTests: tpunit::TestFixture {
 		// Return a reference to the default value.
 		ASSERT_EQUAL(0, i.returnIntByRef());
 
-		// Concrete types types are initiated by default ctor.
+		// Concrete types are initiated by default ctor.
 		// Return a reference to the default value.
 		ASSERT_EQUAL(ConcreteType(), i.returnConcreteTypeByRef());
 
+#ifndef FAKEIT_DISABLE_UBSAN_TRIGGERING_TESTS
 		// For abstract types return a reference to nullptr.
 		ASSERT_EQUAL(nullptr, &i.returnAbstractTypeByRef());
+#endif
 	}
 
 } __ReferenceTypesTests;
-

tests/stubbing_tests.cpp

@@ -9,8 +9,6 @@
 #include <string>
 #include <queue>
 
-#include "mockutils/Macros.hpp"
-
 #include "tpunit++.hpp"
 #include "fakeit.hpp"