Merge pull request #1 from emrekovanci/feature-tests

emrekovanci · web-flow · commit c9038a2c82fb · 2024-03-02T14:40:08.000+03:00
Feature tests
diff --git a/.clang-format b/.clang-format
@@ -78,14 +78,17 @@ MaxEmptyLinesToKeep: 1
 # Sorting
 IncludeBlocks: Regroup
 IncludeCategories:
-  # "Header.h", "Header.hpp" etc.
+  # Test headers
   - Priority: 1
+    Regex: '<(catch2|gtest).*>'
+  # "Header.h", "Header.hpp" etc.
+  - Priority: 2
     Regex: '^\"(.+)\"$'
   # Core Library
-  - Priority: 2
+  - Priority: 3
     Regex: '^<Core\/'
   # C++ standard headers
-  - Priority: 3
+  - Priority: 4
     Regex: '<[[:alnum:]_-]+>'
 SortIncludes: true
 SortUsingDeclarations: true
diff --git a/.clangd b/.clangd
@@ -4,9 +4,6 @@ CompileFlags:
   Add:
     - "-ferror-limit=0"
 
-  Remove:
-    - "-mabi"
-
   # if you are using VSCode and CMake Tools(provided by Microsoft) add
     # "cmake.copyCompileCommands": "${workspaceFolder}/.vscode/compile_commands.json" to VSCode settings
     # because CompilationDatabase field in .clangd doesn't support multiple folders to search
@@ -22,7 +19,7 @@ InlayHints:
 
 Diagnostics:
   UnusedIncludes: Strict
-  MissingIncludes: Strict
+  MissingIncludes: None
 
 ---
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -72,6 +72,15 @@ jobs:
           else
             cmake --build --preset=${{ matrix.compiler }}-${{ matrix.build_type }}
           fi
+      - name: Test
+        if: ${{ matrix.build_type == 'Debug' }}
+        shell: bash
+        run: |
+          if [ "${{ runner.os }}" == "Windows" ]; then
+            ctest --preset=test-Windows-${{ matrix.compiler }}-${{ matrix.build_type }}
+          else
+            ctest --preset=test-${{ matrix.compiler }}-${{ matrix.build_type }}
+          fi
 
   format:
     name: Formatting
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,5 +8,15 @@ project(
     LANGUAGES CXX
 )
 
+if(FEATURE_TESTS)
+    enable_testing()
+    find_package(Catch2 REQUIRED)
+endif()
+
 add_subdirectory(library)
 add_subdirectory(app)
+
+set(CPACK_PACKAGE_FILE_NAME
+    "${CMAKE_PROJECT_NAME}-${CMAKE_PROJECT_VERSION}-${CMAKE_SYSTEM_NAME}-${CMAKE_BUILD_TYPE}-${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION}"
+)
+include(CPack)
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -33,7 +33,7 @@
                 "value": "x64",
                 "strategy": "external"
             },
-            "toolset":{
+            "toolset": {
                 "value": "host=x64",
                 "strategy": "external"
             }
@@ -108,7 +108,9 @@
             "name": "debug",
             "hidden": true,
             "cacheVariables": {
-                "CMAKE_BUILD_TYPE": "Debug"
+                "CMAKE_BUILD_TYPE": "Debug",
+                "VCPKG_MANIFEST_FEATURES": "tests",
+                "FEATURE_TESTS": true
             }
         },
         {
@@ -120,52 +122,84 @@
         },
         {
             "name": "Windows-msvc-Debug",
-            "inherits": ["confs-windows-msvc-common", "debug"]
+            "displayName": "win-msvc-debug",
+            "inherits": [
+                "confs-windows-msvc-common",
+                "debug"
+            ]
         },
         {
             "name": "Windows-msvc-Release",
-            "inherits": ["confs-windows-msvc-common", "release"]
+            "displayName": "win-msvc-release",
+            "inherits": [
+                "confs-windows-msvc-common",
+                "release"
+            ]
         },
         {
             "name": "Windows-llvm-Debug",
-            "inherits": ["confs-windows-llvm-common", "debug"]
+            "displayName": "win-llvm-debug",
+            "inherits": [
+                "confs-windows-llvm-common",
+                "debug"
+            ]
         },
         {
             "name": "Windows-llvm-Release",
-            "inherits": ["confs-windows-llvm-common", "release"]
+            "displayName": "win-llvm-release",
+            "inherits": [
+                "confs-windows-llvm-common",
+                "release"
+            ]
         },
         {
             "name": "llvm-Debug",
-            "inherits": ["confs-linux-llvm-common", "debug"]
+            "inherits": [
+                "confs-linux-llvm-common",
+                "debug"
+            ]
         },
         {
             "name": "llvm-Release",
-            "inherits": ["confs-linux-llvm-common", "release"]
+            "inherits": [
+                "confs-linux-llvm-common",
+                "release"
+            ]
         },
         {
             "name": "gcc-Debug",
-            "inherits": ["confs-linux-gcc-common", "debug"]
+            "inherits": [
+                "confs-linux-gcc-common",
+                "debug"
+            ]
         },
         {
             "name": "gcc-Release",
-            "inherits": ["confs-linux-gcc-common", "release"]
+            "inherits": [
+                "confs-linux-gcc-common",
+                "release"
+            ]
         }
     ],
     "buildPresets": [
         {
             "name": "Windows-msvc-Debug",
+            "displayName": "win-msvc-debug",
             "configurePreset": "Windows-msvc-Debug"
         },
         {
             "name": "Windows-msvc-Release",
+            "displayName": "win-msvc-release",
             "configurePreset": "Windows-msvc-Release"
         },
         {
             "name": "Windows-llvm-Debug",
+            "displayName": "win-llvm-debug",
             "configurePreset": "Windows-llvm-Debug"
         },
         {
             "name": "Windows-llvm-Release",
+            "displayName": "win-llvm-release",
             "configurePreset": "Windows-llvm-Release"
         },
         {
@@ -184,5 +218,106 @@
             "name": "gcc-Release",
             "configurePreset": "gcc-Release"
         }
+    ],
+    "testPresets": [
+        {
+            "name": "test-common",
+            "hidden": true,
+            "output": {
+                "outputOnFailure": true
+            },
+            "execution": {
+                "noTestsAction": "error",
+                "stopOnFailure": true
+            }
+        },
+        {
+            "name": "test-Windows-msvc-Debug",
+            "displayName": "test-win-msvc-debug",
+            "inherits": "test-common",
+            "configurePreset": "Windows-msvc-Debug"
+        },
+        {
+            "name": "test-Windows-llvm-Debug",
+            "displayName": "test-win-llvm-debug",
+            "inherits": "test-common",
+            "configurePreset": "Windows-llvm-Debug"
+        },
+        {
+            "name": "test-llvm-Debug",
+            "displayName": "test-llvm-debug",
+            "inherits": "test-common",
+            "configurePreset": "llvm-Debug"
+        },
+        {
+            "name": "test-gcc-Debug",
+            "displayName": "test-gcc-debug",
+            "inherits": "test-common",
+            "configurePreset": "gcc-Debug"
+        }
+    ],
+    "packagePresets": [
+        {
+            "name": "package-Windows-msvc-Debug",
+            "displayName": "pkg-windows-msvc-debug",
+            "configurePreset": "Windows-msvc-Debug",
+            "generators": [
+                "TGZ"
+            ]
+        },
+        {
+            "name": "package-Windows-llvm-Debug",
+            "displayName": "pkg-windows-llvm-debug",
+            "configurePreset": "Windows-llvm-Debug",
+            "generators": [
+                "TGZ"
+            ]
+        }
+    ],
+    "workflowPresets": [
+        {
+            "name": "Windows-msvc-Debug",
+            "displayName": "win-msvc-debug",
+            "steps": [
+                {
+                    "type": "configure",
+                    "name": "Windows-msvc-Debug"
+                },
+                {
+                    "type": "build",
+                    "name": "Windows-msvc-Debug"
+                },
+                {
+                    "type": "test",
+                    "name": "test-Windows-msvc-Debug"
+                },
+                {
+                    "type": "package",
+                    "name": "package-Windows-msvc-Debug"
+                }
+            ]
+        },
+        {
+            "name": "Windows-llvm-Debug",
+            "displayName": "win-llvm-debug",
+            "steps": [
+                {
+                    "type": "configure",
+                    "name": "Windows-llvm-Debug"
+                },
+                {
+                    "type": "build",
+                    "name": "Windows-llvm-Debug"
+                },
+                {
+                    "type": "test",
+                    "name": "test-Windows-llvm-Debug"
+                },
+                {
+                    "type": "package",
+                    "name": "package-Windows-llvm-Debug"
+                }
+            ]
+        }
     ]
 }
diff --git a/app/App.cpp b/app/App.cpp
@@ -1,9 +1,11 @@
 #include <Core/Lib.hpp>
 
+#include <iostream>
+
 int main()
 {
     Lib lib;
-    lib.displayName();
+    std::cout << lib.getName();
 
     return 0;
 }
diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt
@@ -1,4 +1,5 @@
 # Define executable and its properties
-add_executable(${PROJECT_NAME} App.cpp)
-target_link_libraries(${PROJECT_NAME} PRIVATE Core)
-set_target_properties(${PROJECT_NAME} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${PROJECT_NAME})
+add_executable(Application App.cpp)
+target_link_libraries(Application PRIVATE Core)
+set_target_properties(Application PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/Application)
+install(TARGETS Application)
diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt
@@ -14,6 +14,11 @@ set(LIBRARY_SOURCES
 add_library(Core STATIC ${LIBRARY_HEADERS} ${LIBRARY_SOURCES})
 target_include_directories(Core PUBLIC ${PROJECT_SOURCE_DIR}/library/include)
 target_compile_features(Core PUBLIC cxx_std_17)
+install(TARGETS Core)
+
+if (FEATURE_TESTS)
+    add_subdirectory(${PROJECT_SOURCE_DIR}/library/test)
+endif()
 
 # Group headers and sources for IDE
 source_group(TREE ${INCROOT} PREFIX "Headers" FILES ${LIBRARY_HEADERS})
diff --git a/library/include/Core/Lib.hpp b/library/include/Core/Lib.hpp
@@ -6,7 +6,7 @@ struct Lib
 {
     Lib();
 
-    void displayName() const;
+    std::string getName() const;
 
 private:
     std::string m_name;
diff --git a/library/src/Core/Lib.cpp b/library/src/Core/Lib.cpp
@@ -1,13 +1,11 @@
 #include <Core/Lib.hpp>
 
-#include <iostream>
-
 Lib::Lib() :
     m_name { "Library" }
 {
 }
 
-void Lib::displayName() const
+std::string Lib::getName() const
 {
-    std::cout << m_name;
+    return m_name;
 }
diff --git a/library/test/CMakeLists.txt b/library/test/CMakeLists.txt
@@ -0,0 +1,7 @@
+include(Catch)
+
+add_executable(CoreTests ${PROJECT_SOURCE_DIR}/library/test/Tests.cpp)
+target_link_libraries(CoreTests PRIVATE Core Catch2::Catch2WithMain)
+target_compile_features(CoreTests PRIVATE cxx_std_17)
+set_target_properties(CoreTests PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/Core/Tests)
+catch_discover_tests(CoreTests)
diff --git a/library/test/Tests.cpp b/library/test/Tests.cpp
@@ -0,0 +1,9 @@
+#include <catch2/catch_test_macros.hpp>
+
+#include <Core/Lib.hpp>
+
+TEST_CASE("some_fun")
+{
+    Lib lib;
+    REQUIRE(lib.getName() == "Library");
+}
diff --git a/vcpkg.json b/vcpkg.json
@@ -4,5 +4,17 @@
     "version-string": "0.1.0",
     "dependencies": [
 
-    ]
+    ],
+    "default-features": [],
+    "features": {
+        "tests": {
+            "description": "Dependencies for testing",
+            "dependencies": [
+                {
+                    "name": "catch2",
+                    "version>=": "3.4.0"
+                }
+            ]
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,11 @@`
`1`	`1`	`#include <Core/Lib.hpp>`
`2`	`2`
	`3`	`+#include <iostream>`
	`4`	`+`
`3`	`5`	`int main()`
`4`	`6`	`{`
`5`	`7`	`Lib lib;`
`6`		`- lib.displayName();`
	`8`	`+ std::cout << lib.getName();`
`7`	`9`
`8`	`10`	`return 0;`
`9`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ struct Lib`
`6`	`6`	`{`
`7`	`7`	`Lib();`
`8`	`8`
`9`		`- void displayName() const;`
	`9`	`+ std::string getName() const;`
`10`	`10`
`11`	`11`	`private:`
`12`	`12`	`std::string m_name;`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,11 @@`
`1`	`1`	`#include <Core/Lib.hpp>`
`2`	`2`
`3`		`-#include <iostream>`
`4`		`-`
`5`	`3`	`Lib::Lib() :`
`6`	`4`	`m_name { "Library" }`
`7`	`5`	`{`
`8`	`6`	`}`
`9`	`7`
`10`		`-void Lib::displayName() const`
	`8`	`+std::string Lib::getName() const`
`11`	`9`	`{`
`12`		`- std::cout << m_name;`
	`10`	`+ return m_name;`
`13`	`11`	`}`