Merge pull request #21 from bernedom/feature/disable-testing-option

Feature/disable testing option

CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog
 
+## 0.0.8
+
+*   Add cmake option `BERTRAND_BUILD_TESTING` (default `ON`) to disable bertrand tests if used with `add_subdirectory`
+
 ## 0.0.7
 
 *   Removing double underscores
-*   Unit-Tests work in release mode as well
+*   Unit-tests work in release mode as well
 
 ## 0.0.6
 

CMakeLists.txt

@@ -2,17 +2,19 @@ cmake_minimum_required(VERSION 3.12)
 
 project(
   "bertrand"
-  VERSION 0.0.7
+  VERSION 0.0.8
   DESCRIPTION
     "A header only c++ library providing functionality for design by contract"
   HOMEPAGE_URL "https://github.com/bernedom/bertrand")
 
+include(GNUInstallDirs)
+include(CTest)
+option(BERTRAND_BUILD_TESTING "enable testing for bertrand; Requires global BUILD_TESTING to be set" ON)
+
 add_library(${PROJECT_NAME} INTERFACE)
 # add alias so the project can be uses with add_subdirectory
 add_library(${PROJECT_NAME}::${PROJECT_NAME} ALIAS ${PROJECT_NAME})
 
-include(GNUInstallDirs)
-include(CTest)
 
 # Adding the install interface generator expression makes sure that the include
 # files are installed to the proper location (provided by GNUInstallDirs)
@@ -23,7 +25,7 @@ target_include_directories(
 
 target_compile_features(${PROJECT_NAME} INTERFACE cxx_std_17)
 
-if(BUILD_TESTING)
+if(BUILD_TESTING AND BERTRAND_BUILD_TESTING)
   add_subdirectory(test)
 endif()
 

README.md

@@ -22,7 +22,7 @@ float divide(float dividend, float divisor) {
 
 ```
 
-The contract related keywords `Require`, `Ensure` and `Invariant` are implemented. A failing contract results in immediate programm termination by an `abort`. The contract message is printed to stderr. 
+The contract related keywords `Require`, `Ensure` and `Invariant` are implemented. A failing contract results in immediate program termination by an `abort`. The contract message is printed to stderr. 
 
 By default contracts are enabled unless the `NDEBUG` compiler flag is set. Contracts can be force enabled or disabled by passing the compiler flag `BERTRAND_ENABLE_CONTRACTS` or `BERTRAND_DISABLE_CONTRACTS` passing both will lead to a compiler error. 
 
@@ -37,6 +37,16 @@ mkdir build && cd build
 cmake .. -DCMAKE_INSTALL_PREFIX:PATH=${HOME}/local-install
 cmake --build . --target install
 ```
+### cmake sub-directory
+
+bertrand can be included using `add_subdirectory` if it cannot be installed into a system. 
+
+If bertrand is included and the `EXCLUDE_FROM_ALL` flag is set, bertrand test can be disabled by setting the `BERTRAND_BUILD_TESTING` option
+```cmake
+  set(BERTRAND_BUILD_TESTING OFF)
+  add_subdirectory(${bertrand_SOURCE_DIR} ${bertrand_BINARY_DIR}
+                   EXCLUDE_FROM_ALL)
+```
 
 ### conan.io 
 

conanfile.py

@@ -3,7 +3,7 @@
 
 class bertrandConan(ConanFile):
     name = "bertrand"
-    version = "0.0.7"
+    version = "0.0.8"
     license = "LGPLv3"
     author = "Dominik Berner <dominik.berner+bertrand-conan@gmail.com"
     url = "https://github.com/bernedom/bertrand"

include/bertrand/bertrand.hpp

@@ -1,5 +1,5 @@
 /**
- * This file is part of "bertrand" version 0.0.7
+ * This file is part of "bertrand" version 0.0.8
  * https://github.com/bernedom/bertrand
  * A minimalistic, header only implementation of design by contract for C++
  *

test/installation-tests.sh

@@ -96,6 +96,39 @@ testConanInstallation()
     conan remove -f *@bertrand/testing
 }
 
+testDisablingOfBertrandBuildingTests()
+{
+    cmake "${ROOT_DIR}" -B"${BERTRAND_BUILD_DIR}" -DCMAKE_INSTALL_PREFIX:PATH="${INSTALL_PATH}" -DBUILD_TESTING=on -DBERTRAND_BUILD_TESTING=off -G Ninja
+    cmake --build "${BERTRAND_BUILD_DIR}" --config Release
+    CURRENT_DIR=$(pwd)
+    cd "${BERTRAND_BUILD_DIR}"
+    NUMBER_OF_TESTS=$(ctest -N -o | grep -E '^Total Tests: [0-9]+')
+    cd "${CURRENT_DIR}"
+    assertEquals "No tests found" "Total Tests: 0" "${NUMBER_OF_TESTS}"
+}
+
+testGlobalDisablingOfTests()
+{
+    cmake "${ROOT_DIR}" -B"${BERTRAND_BUILD_DIR}" -DCMAKE_INSTALL_PREFIX:PATH="${INSTALL_PATH}" -DBUILD_TESTING=off -DBERTRAND_BUILD_TESTING=on -G Ninja
+    cmake --build "${BERTRAND_BUILD_DIR}" --config Release
+    CURRENT_DIR=$(pwd)
+    cd "${BERTRAND_BUILD_DIR}"
+    NUMBER_OF_TESTS=$(ctest -N -o | grep -E '^Total Tests: [0-9]+')
+    cd "${CURRENT_DIR}"
+    assertEquals "No tests found" "Total Tests: 0" "${NUMBER_OF_TESTS}"
+}
+
+
+testAllTestsEnabled()
+{
+    cmake "${ROOT_DIR}" -B"${BERTRAND_BUILD_DIR}" -DCMAKE_INSTALL_PREFIX:PATH="${INSTALL_PATH}" -DBUILD_TESTING=on -DBERTRAND_BUILD_TESTING=on -G Ninja
+    cmake --build "${BERTRAND_BUILD_DIR}" --config Release
+    CURRENT_DIR=$(pwd)
+    cd "${BERTRAND_BUILD_DIR}"
+    NUMBER_OF_TESTS=$(ctest -N -o | grep -E '^Total Tests: [0-9]+')
+    cd "${CURRENT_DIR}"
+    assertNotEquals "Tests found" "Total Tests: 0" "${NUMBER_OF_TESTS}"
+}
 
 # Load shUnit2.
 . shunit2