Introduce four CMake options to enable/disabled test variants or test frameworks

By default all four test variants (Catch2 vs. GTest and Approval vs. Unit) are enabled.

cpp/CMakeLists.txt

@@ -6,6 +6,14 @@ set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 # uncomment this line to enable coverage measurements using gcov
 # set(CMAKE_CXX_FLAGS "--coverage")
 
+option(BUILD_APPROVAL_TESTS_WITH_GTEST "Use GoogleTest for approval testing" ON)
+
+option(BUILD_UNIT_TESTS_WITH_GTEST "Use GoogleTest for unit testing" ON)
+
+option(BUILD_APPROVAL_TESTS_WITH_CATCH2 "Use Catch2 for approval testing" ON)
+
+option(BUILD_UNIT_TESTS_WITH_CATCH2 "Use Catch2 for unit testing" ON)
+
 enable_testing()
 add_subdirectory(src)
 add_subdirectory(test)

cpp/README.md

@@ -6,16 +6,16 @@ The C++ version of the Gilded Rose refactoring kata is available in four variant
 * Catch2 test framework
   1. Traditional unit test with the [Catch2](https://github.com/catchorg/Catch2) test framework in the `test/cpp_catch2_unittest` folder.
   2. [Approval tests](https://github.com/approvals/ApprovalTests.cpp) with the [Catch2](https://github.com/catchorg/Catch2) test framework in the `test/cpp_catch2_approvaltest` folder.
-* Google Test framework
+* GoogleTest framework
-  1. Traditional unit test with the [Googletest](https://github.com/google/googletest) test framework in the `test/cpp_googletest_unittest` folder.
+  1. Traditional unit test with the [GoogleTest](https://github.com/google/googletest) test framework in the `test/cpp_googletest_unittest` folder.
-  2. [Approval tests](https://github.com/approvals/ApprovalTests.cpp) with the [Googletest](https://github.com/google/googletest) test framework in the `test/cpp_googletest_approvaltest` folder.
+  2. [Approval tests](https://github.com/approvals/ApprovalTests.cpp) with the [GoogleTest](https://github.com/google/googletest) test framework in the `test/cpp_googletest_approvaltest` folder.
 
 The `GildedRose.cc` file, i.e. the code under test, is identical in all four variants.
 
 ## Prerequisites
 
-* CMake version >= 3.13
+* CMake version ≥ 3.13
-* C++ compiler that supports C++14
+* C++ compiler that supports C++14 
 
 ## How to build and run tests in a terminal
 
@@ -27,6 +27,19 @@ The `GildedRose.cc` file, i.e. the code under test, is identical in all four var
     $ cmake ..
     $ cmake --build .
 
+The following test specific options for building with CMake are available.
+
+* `BUILD_APPROVAL_TESTS_WITH_CATCH2:BOOL=ON`
+This option builds the approval tests with the Catch2 test framework.
+* `BUILD_UNIT_TESTS_WITH_CATCH2:BOOL=ON`
+This option builds the unit tests with the Catch2 test framework.
+* `BUILD_APPROVAL_TESTS_WITH_GTEST:BOOL=ON`
+This option builds the approval tests with the GoogleTest test framework.
+* `BUILD_UNIT_TESTS_WITH_GTEST:BOOL=ON`
+This option builds the unit tests with the GoogleTest test framework.
+
+For example, run the CMake configuration `cmake -DBUILD_APPROVAL_TESTS_WITH_CATCH2=OFF -DBUILD_UNIT_TESTS_WITH_CATCH2=OFF ..` to disable the Catch2 based tests.
+
 ### Show available tests
 
     $ cd ${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp/build
@@ -55,12 +68,12 @@ The `GildedRose.cc` file, i.e. the code under test, is identical in all four var
 2. Select menu `File - Open...`
 3. Select folder `${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp`
 4. Select menu `Build - Build Project`
-4. Select menu `Run - Run...`
+5. Select menu `Run - Run...`
-4. Select what test variant to run, e.g. `GildedRoseCatch2ApprovalTests`.
+6. Select what test variant to run, e.g. `GildedRoseCatch2ApprovalTests`.
 
-## How to build and run tests using Visual Studio 2019 
+## How to build and run tests using Visual Studio ≥ 2019 
 
-1. Start Visual Studio 2019
+1. Start Visual Studio
 2. Select `Open a local folder`
 3. Select folder `${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp`
 4. Wait for message `CMake generation finished.` in the CMake output window at the bottom

cpp/test/CMakeLists.txt

@@ -1,29 +1,35 @@
 include(FetchContent)
 
-FetchContent_Declare(
+if (BUILD_APPROVAL_TESTS_WITH_GTEST OR BUILD_UNIT_TESTS_WITH_GTEST)
-  googletest
+  FetchContent_Declare(
-  GIT_REPOSITORY https://github.com/google/googletest.git
+    googletest
-  GIT_TAG v1.16.0
+    GIT_REPOSITORY https://github.com/google/googletest.git
-  GIT_SHALLOW TRUE
+    GIT_TAG v1.16.0
-)
+    GIT_SHALLOW TRUE
+  )
+  FetchContent_MakeAvailable(googletest)
+endif()
 
-FetchContent_Declare(
+if (BUILD_APPROVAL_TESTS_WITH_CATCH2 OR BUILD_UNIT_TESTS_WITH_CATCH2)
-  catch2 
+  FetchContent_Declare(
-  GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+    catch2 
-  GIT_TAG v3.8.0
+    GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-  GIT_SHALLOW TRUE
+    GIT_TAG v3.8.0
-)
+    GIT_SHALLOW TRUE
+  )
+  FetchContent_MakeAvailable(catch2)
+endif()
 
-FetchContent_MakeAvailable(googletest catch2)
+if (BUILD_APPROVAL_TESTS_WITH_GTEST OR BUILD_UNIT_TESTS_WITH_GTEST)
+  # Force Google Test to link the C/C++ runtimes dynamically
+  set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
 
-# Force Google Test to link the C/C++ runtimes dynamically
+  # Disable building GMock
-set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+  set(BUILD_GMOCK OFF CACHE BOOL "" FORCE)
 
-# Disable building GMock
+  # Do not install GTest 
-set(BUILD_GMOCK OFF CACHE BOOL "" FORCE)
+  set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
-
+endif()
-# Do not install GTest 
-set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
 
 add_subdirectory(cpp_catch2_approvaltest)
 add_subdirectory(cpp_catch2_unittest)

cpp/test/cpp_catch2_approvaltest/CMakeLists.txt

@@ -1,20 +1,22 @@
-set(TEST_NAME GildedRoseCatch2ApprovalTests)
+if (BUILD_APPROVAL_TESTS_WITH_CATCH2)
-add_executable(${TEST_NAME})
+  set(TEST_NAME GildedRoseCatch2ApprovalTests)
-target_sources(${TEST_NAME} PRIVATE GildedRoseCatch2ApprovalTests.cc)
+  add_executable(${TEST_NAME})
-target_include_directories(${TEST_NAME} PUBLIC ../third_party)
+  target_sources(${TEST_NAME} PRIVATE GildedRoseCatch2ApprovalTests.cc)
-target_link_libraries(${TEST_NAME} GildedRoseLib Catch2::Catch2 Catch2::Catch2WithMain)
+  target_include_directories(${TEST_NAME} PUBLIC ../third_party)
-set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 14)
+  target_link_libraries(${TEST_NAME} GildedRoseLib Catch2::Catch2 Catch2::Catch2WithMain)
-add_test(
+  set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 14)
+  add_test(
     NAME ${TEST_NAME}
     COMMAND ${TEST_NAME}
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
+  )
-
+  
-# Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
+  # Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
-# The __FILE__ macro is used by Catch2 to get the path to current test file.
+  # The __FILE__ macro is used by Catch2 to get the path to current test file.
-# Links:
+  # Links:
-# * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
-# * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
-if (MSVC)
+  if (MSVC)
     target_compile_options(${TEST_NAME} PRIVATE "/FC")
-endif()
+  endif()
+endif()

cpp/test/cpp_catch2_unittest/CMakeLists.txt

@@ -1,19 +1,21 @@
-set(TEST_NAME GildedRoseCatch2UnitTests)
+if (BUILD_UNIT_TESTS_WITH_CATCH2)
-add_executable(${TEST_NAME})
+  set(TEST_NAME GildedRoseCatch2UnitTests)
-target_sources(${TEST_NAME} PRIVATE GildedRoseCatch2UnitTests.cc)
+  add_executable(${TEST_NAME})
-target_link_libraries(${TEST_NAME} GildedRoseLib Catch2::Catch2 Catch2::Catch2WithMain )
+  target_sources(${TEST_NAME} PRIVATE GildedRoseCatch2UnitTests.cc)
-set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 14)
+  target_link_libraries(${TEST_NAME} GildedRoseLib Catch2::Catch2 Catch2::Catch2WithMain )
-add_test(
+  set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 14)
+  add_test(
     NAME ${TEST_NAME}
     COMMAND ${TEST_NAME}
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
+  )
-
+  
-# Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
+  # Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
-# The __FILE__ macro is used by Catch2 to get the path to current test file.
+  # The __FILE__ macro is used by Catch2 to get the path to current test file.
-# Links:
+  # Links:
-# * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
-# * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
-if (MSVC)
+  if (MSVC)
     target_compile_options(${TEST_NAME} PRIVATE "/FC")
+  endif()
 endif()

cpp/test/cpp_googletest_approvaltest/CMakeLists.txt

@@ -1,20 +1,22 @@
-set(TEST_NAME GildedRoseGoogletestApprovalTests)
+if (BUILD_APPROVAL_TESTS_WITH_GTEST)
-add_executable(${TEST_NAME})
+  set(TEST_NAME GildedRoseGoogletestApprovalTests)
-target_sources(${TEST_NAME} PRIVATE GildedRoseGoogletestApprovalTests.cc)
+  add_executable(${TEST_NAME})
-target_include_directories(${TEST_NAME} PUBLIC ../third_party)
+  target_sources(${TEST_NAME} PRIVATE GildedRoseGoogletestApprovalTests.cc)
-target_link_libraries(${TEST_NAME} GildedRoseLib gtest)
+  target_include_directories(${TEST_NAME} PUBLIC ../third_party)
-set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 11)
+  target_link_libraries(${TEST_NAME} GildedRoseLib gtest)
-add_test(
+  set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 11)
+  add_test(
     NAME ${TEST_NAME}
     COMMAND ${TEST_NAME}
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
+  )
-
+  
-# Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
+  # Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
-# The __FILE__ macro can be used to get the path to current test file.
+  # The __FILE__ macro can be used to get the path to current test file.
-# Links:
+  # Links:
-# * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
-# * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
-if (MSVC)
+  if (MSVC)
     target_compile_options(${TEST_NAME} PRIVATE "/FC")
+  endif()
 endif()

cpp/test/cpp_googletest_unittest/CMakeLists.txt

@@ -1,19 +1,21 @@
-set(TEST_NAME GildedRoseGoogletestUnitTests)
+if (BUILD_UNIT_TESTS_WITH_GTEST)
-add_executable(${TEST_NAME})
+  set(TEST_NAME GildedRoseGoogletestUnitTests)
-target_sources(${TEST_NAME} PRIVATE GildedRoseGoogletestUnitTests.cc)
+  add_executable(${TEST_NAME})
-target_link_libraries(${TEST_NAME} GildedRoseLib gtest gtest_main)
+  target_sources(${TEST_NAME} PRIVATE GildedRoseGoogletestUnitTests.cc)
-set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 11)
+  target_link_libraries(${TEST_NAME} GildedRoseLib gtest gtest_main)
-add_test(
+  set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 11)
+  add_test(
     NAME ${TEST_NAME}
     COMMAND ${TEST_NAME}
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-)
+  )
-
+  
-# Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
+  # Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path. 
-# The __FILE__ macro can be used to get the path to current test file.
+  # The __FILE__ macro can be used to get the path to current test file.
-# Links:
+  # Links:
-# * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
-# * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
+  # * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
-if (MSVC)
+  if (MSVC)
     target_compile_options(${TEST_NAME} PRIVATE "/FC")
+  endif()
 endif()

cpp/test/cpp_texttest/CMakeLists.txt

@@ -4,9 +4,9 @@ target_sources(${TEST_NAME} PRIVATE GildedRoseTextTests.cc)
 target_link_libraries(${TEST_NAME} GildedRoseLib)
 set_property(TARGET ${TEST_NAME} PROPERTY CXX_STANDARD 11)
 add_test(
-    NAME ${TEST_NAME}
+  NAME ${TEST_NAME}
-    COMMAND ${TEST_NAME}
+  COMMAND ${TEST_NAME}
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 )
 
 # Set compiler option /FC for Visual Studio to to make the __FILE__ macro expand to full path.
@@ -15,5 +15,5 @@ add_test(
 # * https://docs.microsoft.com/en-us/cpp/preprocessor/predefined-macros?view=vs-2019
 # * https://docs.microsoft.com/en-us/cpp/build/reference/fc-full-path-of-source-code-file-in-diagnostics?view=vs-2019
 if (MSVC)
-    target_compile_options(${TEST_NAME} PRIVATE "/FC")
+  target_compile_options(${TEST_NAME} PRIVATE "/FC")
 endif()