feat: add tests for sanitizers (#320)

* feat: add tests for sanitizers

* test: add threadsan to sanitizer tests

Author: rjaegers

test/CMakeLists.txt

@@ -11,3 +11,4 @@ add_subdirectory(fuzzing)
 add_subdirectory(gcc)
 add_subdirectory(gcc-arm-none-eabi)
 add_subdirectory(mutation)
+add_subdirectory(sanitizers)

test/CMakePresets.json

@@ -7,7 +7,6 @@
       "binaryDir": "${sourceDir}/build/${presetName}",
       "hidden": true,
       "cacheVariables": {
-        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
         "CMAKE_BUILD_TYPE": "Debug"
       }
     },
@@ -63,14 +62,19 @@
       "targets": ["test-clang-cl"]
     },
     {
-      "name": "clang-tidy",
+      "name": "clang-iwyu",
       "configurePreset": "clang",
-      "targets": ["test-clang-tidy"]
+      "targets": ["test-clang-iwyu"]
     },
     {
-      "name": "clang-iwyu",
+      "name": "clang-sanitizers",
       "configurePreset": "clang",
-      "targets": ["test-clang-iwyu"]
+      "targets": ["test-asan", "test-memsan", "test-threadsan", "test-ubsan"]
+    },
+    {
+      "name": "clang-tidy",
+      "configurePreset": "clang",
+      "targets": ["test-clang-tidy"]
     },
     {
       "name": "coverage",
@@ -97,6 +101,11 @@
       "configurePreset": "gcc",
       "targets": ["test-gcc-lld"]
     },
+    {
+      "name": "gcc-sanitizers",
+      "configurePreset": "gcc",
+      "targets": ["test-asan", "test-threadsan", "test-ubsan"]
+    },
     {
       "name": "gcc-arm-none-eabi",
       "configurePreset": "gcc-arm-none-eabi",

test/sanitizers/CMakeLists.txt

@@ -0,0 +1,15 @@
+add_executable(test-asan EXCLUDE_FROM_ALL asan.cpp)
+target_compile_options(test-asan PRIVATE -fsanitize=address -fno-omit-frame-pointer)
+target_link_options(test-asan PRIVATE -fsanitize=address)
+
+add_executable(test-threadsan EXCLUDE_FROM_ALL threadsan.cpp)
+target_compile_options(test-threadsan PRIVATE -fsanitize=thread -fno-omit-frame-pointer)
+target_link_options(test-threadsan PRIVATE -fsanitize=thread)
+
+add_executable(test-ubsan EXCLUDE_FROM_ALL ubsan.cpp)
+target_compile_options(test-ubsan PRIVATE -fsanitize=undefined -fno-omit-frame-pointer)
+target_link_options(test-ubsan PRIVATE -fsanitize=undefined)
+
+add_executable(test-memsan EXCLUDE_FROM_ALL memsan.cpp)
+target_compile_options(test-memsan PRIVATE -fsanitize=memory -fno-omit-frame-pointer)
+target_link_options(test-memsan PRIVATE -fsanitize=memory)

test/sanitizers/asan.cpp

@@ -0,0 +1,7 @@
+#include <array>
+
+int main()
+{
+    std::array<int, 10> a = { 0 };
+    return a[10];
+}

test/sanitizers/memsan.cpp

@@ -0,0 +1,5 @@
+int main()
+{
+    int i;
+    return i;
+}

test/sanitizers/threadsan.cpp

@@ -0,0 +1,12 @@
+#include <thread>
+
+int main()
+{
+    int i = 0;
+
+    std::thread t([&] { i = 10; });
+    i = 20;
+    t.join();
+
+    return i;
+}

test/sanitizers/ubsan.cpp

@@ -0,0 +1,5 @@
+int main()
+{
+    const char* c = nullptr;
+    return *c;
+}

test/testsuite.bats

@@ -251,3 +251,45 @@ teardown() {
   assert_success
   assert_output --partial "Server Version:"
 }
+
+# bats test_tags=tc:21
+@test "sanitizers should detect undefined or suspicious behavior in code compiled with gcc" {
+  run cmake --preset gcc
+  run cmake --build --preset gcc-sanitizers
+  assert_success
+
+  run build/gcc/sanitizers/test-asan
+  assert_failure
+  assert_output --partial "AddressSanitizer: stack-buffer-overflow"
+
+  run build/gcc/sanitizers/test-threadsan
+  assert_failure
+  assert_output --partial "ThreadSanitizer: data race"
+
+  run build/gcc/sanitizers/test-ubsan
+  assert_failure
+  assert_output --partial "runtime error: load of null pointer"
+}
+
+# bats test_tags=tc:22
+@test "sanitizers should detect undefined or suspicious behavior in code compiled with clang" {
+  run cmake --preset clang
+  run cmake --build --preset clang-sanitizers
+  assert_success
+
+  run build/clang/sanitizers/test-asan
+  assert_failure
+  assert_output --partial "AddressSanitizer: stack-buffer-overflow"
+
+  run build/clang/sanitizers/test-memsan
+  assert_failure
+  assert_output --partial "MemorySanitizer: use-of-uninitialized-value"
+
+  run build/clang/sanitizers/test-threadsan
+  assert_failure
+  assert_output --partial "ThreadSanitizer: data race"
+
+  run build/clang/sanitizers/test-ubsan
+  assert_failure
+  assert_output --partial "runtime error: load of null pointer"
+}