build: Add option to force assertions (#1474)

Add CMake option `-DASSERTIONS=ON` to force-enable assertions in code.
Use this for CI sanitizer builds.

Author: chfast

CMakeLists.txt

@@ -10,6 +10,7 @@ endif()
 
 option(BUILD_SHARED_LIBS "Build evmone as a shared library" ON)
 option(COVERAGE "Build with coverage instrumentation" OFF)
+option(ASSERTIONS "Force enable the assertions in the code ignoring the CMAKE_BUILD_TYPE default" OFF)
 option(EVMONE_TESTING "Build tests and test tools" OFF)
 option(EVMONE_FUZZING "Instrument libraries and build fuzzing tools" OFF)
 
@@ -91,6 +92,18 @@ if(COVERAGE)
     )
 endif()
 
+if(ASSERTIONS)
+    if(CMAKE_CONFIGURATION_TYPES)
+        message(FATAL_ERROR "ASSERTIONS option is not supported with multi-configuration generators")
+    endif()
+    # Remove -DNDEBUG from default build type flags.
+    string(TOUPPER "${CMAKE_BUILD_TYPE}" BUILD_TYPE_UPPER)
+    get_property(ENABLED_LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES)
+    foreach(LANG IN LISTS ENABLED_LANGUAGES)
+        string(REGEX REPLACE " *-DNDEBUG" "" CMAKE_${LANG}_FLAGS_${BUILD_TYPE_UPPER} "${CMAKE_${LANG}_FLAGS_${BUILD_TYPE_UPPER}}")
+    endforeach()
+endif()
+
 set(CMAKE_C_VISIBILITY_PRESET hidden)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
 set(CMAKE_VISIBILITY_INLINES_HIDDEN YES)

circle.yml

@@ -148,6 +148,26 @@ commands:
             curl -L --retry 3 -C - --output-dir /tmp -O https://github.com/<<parameters.repo>>/releases/download/<<parameters.release>>/fixtures_<<parameters.fixtures_suffix>>.tar.gz
             tar -xzf /tmp/fixtures_*.tar.gz
             ls -l
+  run_execution_spec_tests:
+    steps:
+      - download_execution_spec_tests:
+          release: v5.4.0
+          # develop includes stable
+          fixtures_suffix: develop
+      - run:
+          name: "Execution spec tests (develop, state_tests)"
+          # Tests for in-development EVM revision currently passing.
+          working_directory: ~/build
+          command: >
+            LLVM_PROFILE_FILE=state_tests.profraw
+            bin/evmone-statetest ~/spec-tests/fixtures/state_tests
+      - run:
+          name: "Execution spec tests (develop, blockchain_tests)"
+          # Tests for in-development EVM revision currently passing.
+          working_directory: ~/build
+          command: >
+            LLVM_PROFILE_FILE=blockchain_tests.profraw
+            bin/evmone-blockchaintest ~/spec-tests/fixtures/blockchain_tests
 
   build:
     description: "Build"
@@ -392,24 +412,7 @@ jobs:
       CMAKE_OPTIONS: -DCOVERAGE=1
     steps:
       - build
-      - download_execution_spec_tests:
-          release: v5.4.0
-          # develop includes stable
-          fixtures_suffix: develop
-      - run:
-          name: "Execution spec tests (develop, state_tests)"
-          # Tests for in-development EVM revision currently passing.
-          working_directory: ~/build
-          command: >
-            LLVM_PROFILE_FILE=state_tests.profraw
-            bin/evmone-statetest ~/spec-tests/fixtures/state_tests
-      - run:
-          name: "Execution spec tests (develop, blockchain_tests)"
-          # Tests for in-development EVM revision currently passing.
-          working_directory: ~/build
-          command: >
-            LLVM_PROFILE_FILE=blockchain_tests.profraw
-            bin/evmone-blockchaintest ~/spec-tests/fixtures/blockchain_tests
+      - run_execution_spec_tests
       - collect_coverage_clang:
           ignore_filename_regex: lib/evmone/(advanced|cpu_check|eof|lru_cache|tracing|vm)|test/(experimental|t8n|unittests|utils)
           binaries: evmone-statetest evmone-blockchaintest
@@ -534,6 +537,7 @@ jobs:
     executor: linux-gcc-multilib
     environment:
       TOOLCHAIN: cxx17-32bit
+      CMAKE_OPTIONS: -DASSERTIONS=ON
     steps:
       - build
       - test
@@ -542,11 +546,12 @@ jobs:
     executor: linux-clang-selfhosted
     environment:
       TOOLCHAIN: clang-libcxx-debug
-      CMAKE_OPTIONS: -DBUILD_SHARED_LIBS=NO -DSANITIZE=address,undefined,shift-exponent,implicit-conversion,nullability
+      CMAKE_OPTIONS: -DBUILD_SHARED_LIBS=NO -DASSERTIONS=ON -DSANITIZE=address,undefined,shift-exponent,implicit-conversion,nullability
       UBSAN_OPTIONS: halt_on_error=1
     steps:
       - build
       - test
+      - run_execution_spec_tests
 
   clang-tidy:
     executor: linux-clang-selfhosted
@@ -576,7 +581,7 @@ jobs:
     executor: linux-clang-selfhosted
     environment:
       CMAKE_GENERATOR: Ninja
-      CMAKE_OPTIONS: -DEVMONE_FUZZING=ON
+      CMAKE_OPTIONS: -DASSERTIONS=ON -DEVMONE_FUZZING=ON
     steps:
       - build
       - restore_cache:
@@ -597,7 +602,7 @@ jobs:
     executor: macos
     environment:
       BUILD_TYPE: RelWithDebInfo
-      CMAKE_OPTIONS: -DSANITIZE=address,undefined
+      CMAKE_OPTIONS: -DASSERTIONS=ON -DSANITIZE=address,undefined
       TESTS_FILTER: unittests
     steps:
       - run: