Option to turn off tests in the build (#42)

* feat: Option to turn of tests * feat: Option to turn of tests * fix: Removes test check on coverage * docs: Force update options cache
tezc · Feb 14, 2021 · dbfc704 · dbfc704
1 parent 9db998b
commit dbfc704
Show file tree

Hide file tree

Showing 23 changed files with 1,299 additions and 1,290 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -11,6 +11,12 @@ endif ()
 
 message(STATUS "Build type ${CMAKE_BUILD_TYPE}")
 
+option(SC_BUILD_TEST "Build tests" ON)
+if(NOT SC_BUILD_TEST)
+  message(STATUS "Turned off building tests because SC is a subproject.")
+  message(STATUS "Turned off coverage because SC is a subproject.")
+endif()
+
 add_subdirectory(array)
 add_subdirectory(buffer)
 add_subdirectory(condition)
@@ -37,46 +43,47 @@ add_subdirectory(uri)
 # --------------------------------------------------------------------------- #
 # --------------------- Test Configuration Start ---------------------------- #
 # --------------------------------------------------------------------------- #
-
+if(SC_BUILD_TEST)
 # ----------------------- - Code Coverage Start ----------------------------- #
 
-if (${CMAKE_BUILD_TYPE} MATCHES "Coverage")
-    if ("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-        add_compile_options(--coverage)
-        link_libraries(gcov)
-    else()
-        message(FATAL_ERROR "Only GCC is supported for coverage")
-    endif()
-endif ()
+  if (${CMAKE_BUILD_TYPE} MATCHES "Coverage")
+      if ("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+          add_compile_options(--coverage)
+          link_libraries(gcov)
+      else()
+          message(FATAL_ERROR "Only GCC is supported for coverage")
+      endif()
+  endif ()
 
-add_custom_target(coverage)
-add_custom_command(
-        TARGET coverage
-        COMMAND lcov --capture --directory .
-        --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-        COMMAND lcov --remove coverage.info '/usr/*' '*example*' '*test*'
-        --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-        COMMAND lcov --list coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-)
+  add_custom_target(coverage)
+  add_custom_command(
+          TARGET coverage
+          COMMAND lcov --capture --directory .
+          --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+          COMMAND lcov --remove coverage.info '/usr/*' '*example*' '*test*'
+          --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+          COMMAND lcov --list coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+  )
 
 # -------------------------- Code Coverage End ------------------------------ #
 
-SET(MEMORYCHECK_COMMAND_OPTIONS
-        "-q --log-fd=2 --trace-children=yes --track-origins=yes       \
-         --leak-check=full --show-leak-kinds=all \
-         --error-exitcode=255")
+  SET(MEMORYCHECK_COMMAND_OPTIONS
+          "-q --log-fd=2 --trace-children=yes --track-origins=yes       \
+           --leak-check=full --show-leak-kinds=all \
+           --error-exitcode=255")
 
-add_custom_target(valgrind ${CMAKE_COMMAND}
-        -E env CTEST_OUTPUT_ON_FAILURE=1
-        ${CMAKE_CTEST_COMMAND} -C $<CONFIG>
-        --overwrite MemoryCheckCommandOptions=${MEMORYCHECK_COMMAND_OPTIONS}
-        --verbose -T memcheck WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+  add_custom_target(valgrind ${CMAKE_COMMAND}
+          -E env CTEST_OUTPUT_ON_FAILURE=1
+          ${CMAKE_CTEST_COMMAND} -C $<CONFIG>
+          --overwrite MemoryCheckCommandOptions=${MEMORYCHECK_COMMAND_OPTIONS}
+          --verbose -T memcheck WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 
-add_custom_target(check ${CMAKE_COMMAND}
-        -E env CTEST_OUTPUT_ON_FAILURE=1
-        ${CMAKE_CTEST_COMMAND} -C $<CONFIG> --verbose
-        WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+  add_custom_target(check ${CMAKE_COMMAND}
+          -E env CTEST_OUTPUT_ON_FAILURE=1
+          ${CMAKE_CTEST_COMMAND} -C $<CONFIG> --verbose
+          WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 
-add_dependencies(coverage check)
+  add_dependencies(coverage check)
 
+endif ()
 # ----------------------- Test Configuration End ---------------------------- #
diff --git a/README.md b/README.md
@@ -75,6 +75,7 @@ FetchContent_Declare(
   sc_lib
   GIT_REPOSITORY https://github.com/tezc/sc.git
   GIT_TAG        master)
+SET(SC_BUILD_TEST OFF CACHE BOOL "Turn off sc_lib tests" FORCE)
 
 FetchContent_MakeAvailable(sc_lib)
 

diff --git a/array/CMakeLists.txt b/array/CMakeLists.txt
@@ -20,83 +20,83 @@ endif ()
 # --------------------------------------------------------------------------- #
 # --------------------- Test Configuration Start ---------------------------- #
 # --------------------------------------------------------------------------- #
+if(SC_BUILD_TEST)
 
-include(CTest)
-include(CheckCCompilerFlag)
+  include(CTest)
+  include(CheckCCompilerFlag)
 
-enable_testing()
+  enable_testing()
 
-add_executable(${PROJECT_NAME}_test array_test.c sc_array.c)
+  add_executable(${PROJECT_NAME}_test array_test.c sc_array.c)
 
-target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_SIZE_MAX=140000ul)
+  target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_SIZE_MAX=140000ul)
 
-message(STATUS "Compiler is ${CMAKE_C_COMPILER_ID}")
+  message(STATUS "Compiler is ${CMAKE_C_COMPILER_ID}")
 
-if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-    if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
-            "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-        message(STATUS "Defined SC_HAVE_WRAP")
-        target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_HAVE_WRAP)
-        target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-builtin)
-        target_link_options(${PROJECT_NAME}_test PRIVATE -Wl,--wrap=realloc)
-    endif ()
-endif ()
+  if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
+      if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
+              "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+          message(STATUS "Defined SC_HAVE_WRAP")
+          target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_HAVE_WRAP)
+          target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-builtin)
+          target_link_options(${PROJECT_NAME}_test PRIVATE -Wl,--wrap=realloc)
+      endif ()
+  endif ()
 
-if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
-        "${CMAKE_C_COMPILER_ID}" STREQUAL "AppleClang" OR
-        "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+  if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
+          "${CMAKE_C_COMPILER_ID}" STREQUAL "AppleClang" OR
+          "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
 
-    target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-omit-frame-pointer)
+      target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-omit-frame-pointer)
 
-    if (SANITIZER)
-        target_compile_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
-        target_link_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
-    endif ()
-endif ()
+      if (SANITIZER)
+          target_compile_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
+          target_link_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
+      endif ()
+  endif ()
 
-add_test(NAME ${PROJECT_NAME}_test COMMAND ${PROJECT_NAME}_test)
+  add_test(NAME ${PROJECT_NAME}_test COMMAND ${PROJECT_NAME}_test)
 
-SET(MEMORYCHECK_COMMAND_OPTIONS
-        "-q --log-fd=2 --trace-children=yes --track-origins=yes       \
-         --leak-check=full --show-leak-kinds=all  \
-         --error-exitcode=255")
+  SET(MEMORYCHECK_COMMAND_OPTIONS
+          "-q --log-fd=2 --trace-children=yes --track-origins=yes       \
+           --leak-check=full --show-leak-kinds=all  \
+           --error-exitcode=255")
 
-add_custom_target(valgrind_${PROJECT_NAME} ${CMAKE_COMMAND}
-        -E env CTEST_OUTPUT_ON_FAILURE=1
-        ${CMAKE_CTEST_COMMAND} -C $<CONFIG>
-        --overwrite MemoryCheckCommandOptions=${MEMORYCHECK_COMMAND_OPTIONS}
-        --verbose -T memcheck WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+  add_custom_target(valgrind_${PROJECT_NAME} ${CMAKE_COMMAND}
+          -E env CTEST_OUTPUT_ON_FAILURE=1
+          ${CMAKE_CTEST_COMMAND} -C $<CONFIG>
+          --overwrite MemoryCheckCommandOptions=${MEMORYCHECK_COMMAND_OPTIONS}
+          --verbose -T memcheck WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 
-add_custom_target(check_${PROJECT_NAME} ${CMAKE_COMMAND}
-        -E env CTEST_OUTPUT_ON_FAILURE=1
-        ${CMAKE_CTEST_COMMAND} -C $<CONFIG> --verbose
-        WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+  add_custom_target(check_${PROJECT_NAME} ${CMAKE_COMMAND}
+          -E env CTEST_OUTPUT_ON_FAILURE=1
+          ${CMAKE_CTEST_COMMAND} -C $<CONFIG> --verbose
+          WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 
 # ----------------------- - Code Coverage Start ----------------------------- #
 
-if (${CMAKE_BUILD_TYPE} MATCHES "Coverage")
-    if ("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-        target_compile_options(${PROJECT_NAME}_test PRIVATE --coverage)
-        target_link_libraries(${PROJECT_NAME}_test gcov)
-    else()
-        message(FATAL_ERROR "Only GCC is supported for coverage")
-    endif()
-endif ()
-
-add_custom_target(coverage_${PROJECT_NAME})
-add_custom_command(
-        TARGET coverage_${PROJECT_NAME}
-        COMMAND lcov --capture --directory .
-        --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-        COMMAND lcov --remove coverage.info '/usr/*' '*example*' '*test*'
-        --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-        COMMAND lcov --list coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-)
-
-add_dependencies(coverage_${PROJECT_NAME} check_${PROJECT_NAME})
+  if (${CMAKE_BUILD_TYPE} MATCHES "Coverage")
+      if ("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+          target_compile_options(${PROJECT_NAME}_test PRIVATE --coverage)
+          target_link_libraries(${PROJECT_NAME}_test gcov)
+      else()
+          message(FATAL_ERROR "Only GCC is supported for coverage")
+      endif()
+  endif ()
+
+  add_custom_target(coverage_${PROJECT_NAME})
+  add_custom_command(
+          TARGET coverage_${PROJECT_NAME}
+          COMMAND lcov --capture --directory .
+          --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+          COMMAND lcov --remove coverage.info '/usr/*' '*example*' '*test*'
+          --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+          COMMAND lcov --list coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+  )
+
+  add_dependencies(coverage_${PROJECT_NAME} check_${PROJECT_NAME})
 
 # -------------------------- Code Coverage End ------------------------------ #
-
-
+endif ()
 # ----------------------- Test Configuration End ---------------------------- #
 
diff --git a/buffer/CMakeLists.txt b/buffer/CMakeLists.txt
@@ -20,80 +20,80 @@ endif ()
 # --------------------------------------------------------------------------- #
 # --------------------- Test Configuration Start ---------------------------- #
 # --------------------------------------------------------------------------- #
+if(SC_BUILD_TEST)
 
-include(CTest)
-include(CheckCCompilerFlag)
+  include(CTest)
+  include(CheckCCompilerFlag)
 
-enable_testing()
+  enable_testing()
 
-add_executable(${PROJECT_NAME}_test buf_test.c sc_buf.c)
+  add_executable(${PROJECT_NAME}_test buf_test.c sc_buf.c)
 
-target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_SIZE_MAX=140000ul)
+  target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_SIZE_MAX=140000ul)
 
-if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-    if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
-            "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-        target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_HAVE_WRAP)
-        target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-builtin)
-        target_link_options(${PROJECT_NAME}_test PRIVATE
-                -Wl,--wrap=vsnprintf,--wrap=malloc,--wrap=realloc,--wrap=strlen)
-    endif ()
-endif ()
+  if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
+      if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
+              "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+          target_compile_options(${PROJECT_NAME}_test PRIVATE -DSC_HAVE_WRAP)
+          target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-builtin)
+          target_link_options(${PROJECT_NAME}_test PRIVATE
+                  -Wl,--wrap=vsnprintf,--wrap=malloc,--wrap=realloc,--wrap=strlen)
+      endif ()
+  endif ()
 
-if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
-        "${CMAKE_C_COMPILER_ID}" STREQUAL "AppleClang" OR
-        "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-    target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-omit-frame-pointer)
+  if ("${CMAKE_C_COMPILER_ID}" STREQUAL "Clang" OR
+          "${CMAKE_C_COMPILER_ID}" STREQUAL "AppleClang" OR
+          "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+      target_compile_options(${PROJECT_NAME}_test PRIVATE -fno-omit-frame-pointer)
 
-    if (SANITIZER)
-        target_compile_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
-        target_link_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
-    endif ()
-endif ()
+      if (SANITIZER)
+          target_compile_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
+          target_link_options(${PROJECT_NAME}_test PRIVATE -fsanitize=${SANITIZER})
+      endif ()
+  endif ()
 
-add_test(NAME ${PROJECT_NAME}_test COMMAND ${PROJECT_NAME}_test)
+  add_test(NAME ${PROJECT_NAME}_test COMMAND ${PROJECT_NAME}_test)
 
-SET(MEMORYCHECK_COMMAND_OPTIONS
-        "-q --log-fd=2 --trace-children=yes --track-origins=yes       \
-         --leak-check=full --show-leak-kinds=all  \
-         --error-exitcode=255")
+  SET(MEMORYCHECK_COMMAND_OPTIONS
+          "-q --log-fd=2 --trace-children=yes --track-origins=yes       \
+           --leak-check=full --show-leak-kinds=all  \
+           --error-exitcode=255")
 
-add_custom_target(valgrind_${PROJECT_NAME} ${CMAKE_COMMAND}
-        -E env CTEST_OUTPUT_ON_FAILURE=1
-        ${CMAKE_CTEST_COMMAND} -C $<CONFIG>
-        --overwrite MemoryCheckCommandOptions=${MEMORYCHECK_COMMAND_OPTIONS}
-        --verbose -T memcheck WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+  add_custom_target(valgrind_${PROJECT_NAME} ${CMAKE_COMMAND}
+          -E env CTEST_OUTPUT_ON_FAILURE=1
+          ${CMAKE_CTEST_COMMAND} -C $<CONFIG>
+          --overwrite MemoryCheckCommandOptions=${MEMORYCHECK_COMMAND_OPTIONS}
+          --verbose -T memcheck WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 
-add_custom_target(check_${PROJECT_NAME} ${CMAKE_COMMAND}
-        -E env CTEST_OUTPUT_ON_FAILURE=1
-        ${CMAKE_CTEST_COMMAND} -C $<CONFIG> --verbose
-        WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+  add_custom_target(check_${PROJECT_NAME} ${CMAKE_COMMAND}
+          -E env CTEST_OUTPUT_ON_FAILURE=1
+          ${CMAKE_CTEST_COMMAND} -C $<CONFIG> --verbose
+          WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
 
 # ----------------------- - Code Coverage Start ----------------------------- #
 
-if (${CMAKE_BUILD_TYPE} MATCHES "Coverage")
-    if ("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
-        target_compile_options(${PROJECT_NAME}_test PRIVATE --coverage)
-        target_link_libraries(${PROJECT_NAME}_test gcov)
-    else()
-        message(FATAL_ERROR " Only GCC is supported for coverage")
-    endif()
-endif ()
-
-add_custom_target(coverage_${PROJECT_NAME})
-add_custom_command(
-        TARGET coverage_${PROJECT_NAME}
-        COMMAND lcov --capture --directory .
-        --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-        COMMAND lcov --remove coverage.info '/usr/*' '*example*' '*test*'
-        --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-        COMMAND lcov --list coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
-)
-
-add_dependencies(coverage_${PROJECT_NAME} check_${PROJECT_NAME})
+  if (${CMAKE_BUILD_TYPE} MATCHES "Coverage")
+      if ("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU")
+          target_compile_options(${PROJECT_NAME}_test PRIVATE --coverage)
+          target_link_libraries(${PROJECT_NAME}_test gcov)
+      else()
+          message(FATAL_ERROR " Only GCC is supported for coverage")
+      endif()
+  endif ()
+
+  add_custom_target(coverage_${PROJECT_NAME})
+  add_custom_command(
+          TARGET coverage_${PROJECT_NAME}
+          COMMAND lcov --capture --directory .
+          --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+          COMMAND lcov --remove coverage.info '/usr/*' '*example*' '*test*'
+          --output-file coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+          COMMAND lcov --list coverage.info --rc lcov_branch_coverage=1 --rc lcov_excl_br_line='assert'
+  )
+
+  add_dependencies(coverage_${PROJECT_NAME} check_${PROJECT_NAME})
 
 # -------------------------- Code Coverage End ------------------------------ #
-
-
+endif ()
 # ----------------------- Test Configuration End ---------------------------- #