Add AddressSanitizer to DEBUG builds (#1279)

#1276 addressed a
`Segementation fault`, but from the error alone, the root cause was not
obvious:
```
31168 Segmentation fault: 11  build/cpp_client
```

By adding
[`asan`](https://learn.microsoft.com/en-us/cpp/sanitizers/asan) to the
`DEBUG` builds, the CI job would've failed with a much more helpful
error message:
```
=================================================================
==37978==ERROR: AddressSanitizer: SEGV on unknown address 0x000000000040 (pc 0x7eff21446d48 bp 0x7efeff67fce0 sp 0x7efeff67fcd0 T22)
==37978==The signal is caused by a READ memory access.
==37978==Hint: address points to the zero page.

    #0 0x7eff21446d48 in hazelcast::logger::enabled(hazelcast::logger::level) /home/runner/work/hazelcast-cpp-client/hazelcast-cpp-client/hazelcast/src/hazelcast/logger.cpp:71
    #1 0x7eff20a05b1d in hazelcast::client::protocol::codec::client_addclusterviewlistener_handler::handle(hazelcast::client::protocol::ClientMessage&) /home/runner/work/hazelcast-cpp-client/hazelcast-cpp-client/hazelcast/generated-sources/src/hazelcast/client/protocol/codec/codecs.cpp:145

{...}

AddressSanitizer can not provide additional info.
SUMMARY: AddressSanitizer: SEGV /home/runner/work/hazelcast-cpp-client/hazelcast-cpp-client/hazelcast/src/hazelcast/logger.cpp:71 in hazelcast::logger::enabled(hazelcast::logger::level)
```

---------

Co-authored-by: ihsan demir <[email protected]>

Author: JackPGreen

.github/actions/build-test/unix/action.yml

@@ -61,6 +61,7 @@ runs:
         AWS_ACCESS_KEY_ID: ${{ inputs.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ inputs.AWS_SECRET_ACCESS_KEY }}
         HZ_TEST_AWS_INSTANCE_PRIVATE_IP: ${{ inputs.HZ_TEST_AWS_INSTANCE_PRIVATE_IP }}
+        BUILD_TYPE: ${{ inputs.BUILD_TYPE }}
       shell: ${{ env.shell }}
       run: |
         ./scripts/test-unix.sh

.github/actions/coverage-report/action.yml

@@ -22,6 +22,7 @@ env:
   # Not possible to set this as a default
   # https://github.com/orgs/community/discussions/46670
   shell: bash
+  BUILD_TYPE: Debug
 
 runs:
   using: composite
@@ -63,7 +64,7 @@ runs:
       env:
         BUILD_DIR: build
         COVERAGE: ON
-        BUILD_TYPE: Debug
+        BUILD_TYPE: ${{ env.BUILD_TYPE }}
       shell: ${{ env.shell }}
       run: |
         ./scripts/build-unix.sh        \
@@ -80,6 +81,7 @@ runs:
         AWS_ACCESS_KEY_ID: ${{ inputs.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ inputs.AWS_SECRET_ACCESS_KEY }}
         HZ_TEST_AWS_INSTANCE_PRIVATE_IP: ${{ inputs.HZ_TEST_AWS_INSTANCE_PRIVATE_IP }}
+        BUILD_TYPE: ${{ env.BUILD_TYPE }}
       shell: ${{ env.shell }}
       run: |
         ulimit -c unlimited

scripts/build-unix.sh

@@ -33,6 +33,8 @@ CXXFLAGS="$CXXFLAGS -Wall"
 if [ "${BUILD_TYPE}" = "Debug" ]; then
   # treat compiler warnings as errors when the build type is Debug
   CXXFLAGS="$CXXFLAGS -Werror"
+  # enable address sanitizer to provide meaningful stack traces
+  CXXFLAGS="$CXXFLAGS -fsanitize=address -fno-omit-frame-pointer"
 fi
 
 # remove the given build directory if already exists

scripts/build-windows.bat

@@ -12,10 +12,18 @@
 
 @call .\scripts\windows-common.bat
 
-REM print variables for debugging
-@echo SOLUTION_TYPE = %SOLUTION_TYPE%
-@echo PLATFORM      = %PLATFORM%
-@echo BUILD_DIR     = %BUILD_DIR%
+@REM print variables for debugging
+@echo SOLUTION_TYPE         = %SOLUTION_TYPE%
+@echo PLATFORM              = %PLATFORM%
+@echo BUILD_DIR             = %BUILD_DIR%
+@echo BUILD_CONFIGURATION   = %BUILD_CONFIGURATION%
+
+if "%BUILD_CONFIGURATION%"=="Debug" (
+    @REM Enable address sanitizer to provide meaningful stack traces
+    @REM Not enabled due to failure with tooling on GitHub Actions
+    @REM https://github.com/actions/runner-images/issues/7739
+    @REM set CXXFLAGS=%CXXFLAGS% -fsanitize=address
+)
 
 REM remove the given build directory if already exists
 @rd /s /q %BUILD_DIR%

scripts/test-unix.sh

@@ -54,6 +54,13 @@ else
   echo "Server started in $((RC_START_TIMEOUT_IN_SECS - timeout)) seconds"
 fi
 
+if [ "${BUILD_TYPE}" = "Debug" ] && [ -z "${ASAN_OPTIONS}" ]; then
+  # disable leak detection
+  # need to address outstanding issues before we can aggressively block new ones
+  # https://github.com/hazelcast/hazelcast-cpp-client/issues/1282
+  export ASAN_OPTIONS=detect_leaks=0
+fi
+
 echo "Starting the client test now."
 ${TEST_EXECUTABLE} --gtest_output="xml:CPP_Client_Test_Report.xml" &
 testPid=$!

scripts/test-windows.bat

@@ -46,6 +46,15 @@ exit /b 1
 
 :server_started
 
+if "%BUILD_CONFIGURATION%"=="Debug" (
+  if "x%ASAN_OPTIONS%"=="x" (
+    @REM disable leak detection
+    @REM need to address outstanding issues before we can aggressively block new ones
+    @REM https://github.com/hazelcast/hazelcast-cpp-client/issues/1282
+    set ASAN_OPTIONS=detect_leaks=0
+  )
+)
+
 echo "Starting the client test now."
 
 set PATH=%BUILD_DIR%\%BUILD_CONFIGURATION%;%BUILD_DIR%\bin\%BUILD_CONFIGURATION%;%PATH%