mirror of https://github.com/emilybache/GildedRose-Refactoring-Kata.git synced 2025-12-11 20:02:09 +00:00

tbeu 784920714a 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.

2025-02-15 09:38:07 +01:00

3.2 KiB

Raw Blame History

C++ version of Gilded Rose refactoring kata

Introduction

The C++ version of the Gilded Rose refactoring kata is available in four variants using different test frameworks:

Catch2 test framework
1. Traditional unit test with the Catch2 test framework in the test/cpp_catch2_unittest folder.
2. Approval tests with the Catch2 test framework in the test/cpp_catch2_approvaltest folder.
GoogleTest framework
1. Traditional unit test with the GoogleTest test framework in the test/cpp_googletest_unittest folder.
2. Approval tests with the 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
C++ compiler that supports C++14

How to build and run tests in a terminal

Build tests

$ cd ${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp
$ mkdir build
$ cd build
$ 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
$ ctest -N
Test project ${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp/build
  Test #1: GildedRoseCatch2ApprovalTests
  Test #2: GildedRoseCatch2UnitTests
  Test #3: GildedRoseGoogletestApprovalTests
  Test #4: GildedRoseGoogletestUnitTests

Run all tests

$ ctest

Run all tests with verbose output

$ ctest -VV

Run a specific test with verbose output

$ ctest -VV --tests-regex Catch2Approval

How to build and run tests using the CLion IDE

Start CLion
Select menu File - Open...
Select folder ${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp
Select menu Build - Build Project
Select menu Run - Run...
Select what test variant to run, e.g. GildedRoseCatch2ApprovalTests.

How to build and run tests using Visual Studio ≥ 2019

Start Visual Studio
Select Open a local folder
Select folder ${GIT_FOLDER}/GildedRose-Refactoring-Kata/cpp
Wait for message CMake generation finished. in the CMake output window at the bottom
Select what test variant to run in the drop down menu for Startup Items, e.g. GildedRoseCatch2ApprovalTests.exe.
Select menu Debug - Start

3.2 KiB Raw Blame History