Merge pull request #111 from fdefelici/release_v2.4.5

Release v2.4.5

Author: fdefelici

.github/workflows/ci_action.yml

@@ -22,15 +22,15 @@ jobs:
       BUILD_DIR: ${{ github.workspace }}\build
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: List Workspace
         run:  dir /a ${{ github.workspace }}
       - name: Compile
         run: |
           echo "== CMAKE VERSION =="
           cmake --version
           echo "== CMAKE CONFIGURE =="
-          cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_BUILD=true
+          cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_BUILD=ON
           echo "== CMAKE BUILD =="
           cmake --build ${{env.BUILD_DIR}} --config Release
       - name: List Build
@@ -53,15 +53,15 @@ jobs:
       BUILD_DIR: ${{ github.workspace }}/build
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: List Workspace
         run:  ls -la ${{ github.workspace }}
       - name: Compile
         run: |
           echo "== CMAKE VERSION =="
           cmake --version
           echo "== CMAKE CONFIGURE =="
-          cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_BUILD=true
+          cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_BUILD=ON
           echo "== CMAKE BUILD =="
           cmake --build ${{env.BUILD_DIR}} --config Release
       - name: List Build
@@ -73,27 +73,27 @@ jobs:
           cd ${{ github.workspace }}
   build_ubuntu:
       name: Build ubuntu_${{matrix.compiler.c}}-${{matrix.compiler.v}}
-      runs-on: ubuntu-latest
+      runs-on: ubuntu-22.04
       strategy:
         fail-fast: false
         matrix:
           compiler: 
-            - {c: gcc, cpp: g++, v: 11, strict: false}
-            - {c: gcc, cpp: g++, v: 12, strict: false}
-            - {c: gcc, cpp: g++, v: 13, strict: true}
-            - {c: clang, cpp: clang++, v: 13, strict: true}
-            - {c: clang, cpp: clang++, v: 14, strict: true}
-            - {c: clang, cpp: clang++, v: 15, strict: true}
-            - {c: clang, cpp: clang++, v: 16, strict: true}
-            - {c: clang, cpp: clang++, v: 17, strict: true}
+            - {c: gcc, cpp: g++, v: 11, strict: OFF}
+            - {c: gcc, cpp: g++, v: 12, strict: OFF}
+            - {c: gcc, cpp: g++, v: 13, strict: ON}
+            - {c: clang, cpp: clang++, v: 13, strict: ON}
+            - {c: clang, cpp: clang++, v: 14, strict: ON}
+            - {c: clang, cpp: clang++, v: 15, strict: ON}
+            - {c: clang, cpp: clang++, v: 16, strict: ON}
+            - {c: clang, cpp: clang++, v: 17, strict: ON}
       defaults:
         run:
           shell: bash
       env:
         BUILD_DIR: ${{ github.workspace }}/build
       steps:
         - name: Checkout
-          uses: actions/checkout@v3
+          uses: actions/checkout@v4
         - name: List Workspace
           run:  ls -la ${{ github.workspace }}
         - name: Install Clang (if needed)
@@ -102,20 +102,30 @@ jobs:
           with:
             version: "${{ matrix.compiler.v }}"
             env: true  # set CC / CXX variable
+        - name: Install GCC (if needed)
+          # Installing GCC-13 due to regression introduced in ubuntu 22.04 image
+          # https://github.com/actions/runner-images/issues/9866
+          if: ${{ matrix.compiler.c == 'gcc' && matrix.compiler.v == 13 }} 
+          run: |
+            sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
+            sudo apt-get update -y
+            sudo apt-get install gcc-13
+            sudo apt-get install g++-13
         - name: Set Compiler # only if CC / CXX are not already set from new installation
           run: |
             if [ -z "${CC}" ]; then
               echo "CC=${{matrix.compiler.c}}-${{matrix.compiler.v}}" >> "$GITHUB_ENV"
               echo "CXX=${{matrix.compiler.cpp}}-${{matrix.compiler.v}}" >> "$GITHUB_ENV"
+            else
+              echo CC=$CC
+              echo CXX=$CXX
             fi
-            echo CC=$CC
-            echo CXX=$CXX
         - name: Compile
           run: |
             echo "== CMAKE VERSION =="
             cmake --version
             echo "== CMAKE CONFIGURE =="
-            cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_BUILD=true -DCLOVE_CMAKE__CPP_STRICT_WARN_AS_ERROR=${{matrix.compiler.strict}}
+            cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_BUILD=ON -DCLOVE_CMAKE__CPP_STRICT_WARN_AS_ERROR=${{matrix.compiler.strict}}
             echo "== CMAKE BUILD =="
             cmake --build ${{env.BUILD_DIR}} --config Release
         - name: List Build
@@ -135,15 +145,15 @@ jobs:
       BUILD_DIR: ${{ github.workspace }}/build
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: List Workspace
         run:  ls -la ${{ github.workspace }}
       - name: Compile
         run: |
           echo "== CMAKE VERSION =="
           cmake --version
           echo "== CMAKE CONFIGURE =="
-          cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_SANITY=true
+          cmake -B${{env.BUILD_DIR}} -DCLOVE_CMAKE__UC_SANITY=ON
           echo "== CMAKE BUILD =="
           cmake --build ${{env.BUILD_DIR}} --config Release
       - name: List Build

.github/workflows/release_action.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Upload Release Asset
         id: upload-release-asset 
         uses: actions/upload-release-asset@v1

CMakeLists.txt

@@ -1,33 +1,105 @@
 cmake_minimum_required(VERSION 3.18)
-project(CLoveUnit LANGUAGES C)
-include(CTest)
 
-#[[
-add_subdirectory(tests/functs)
-if (DEFINED CLOVE_CMAKE__CI_TRIGGERED)
-    add_subdirectory(tests/stricts/clove-c)
-    add_subdirectory(tests/stricts/clove-cpp)
-    add_subdirectory(examples/clove101)
-    add_subdirectory(examples/clovepp)
-endif()
+set(CLOVE_SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR})
+list(INSERT CMAKE_MODULE_PATH 0 ${CLOVE_SOURCE_DIR}/cmake/modules)
 
-if (DEFINED CLOVE_CMAKE__ENABLE_PERFS)
-add_subdirectory(tests/perfs)
-endif()
-]]
+include(CLoveModules)
+clove_get_version(CLOVE_VERSION)
+
+# Configure Project
+project(
+  CLoveUnit 
+  VERSION ${CLOVE_VERSION}
+  DESCRIPTION "Single-header Unit Testing framework for C (interoperable with C++) with test autodiscovery feature"
+  HOMEPAGE_URL "https://github.com/fdefelici/clove-unit"
+  LANGUAGES C
+)
+
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
+
+# Eventually CMAKE_INSTALL_PREFIX can be overridden by the user to change base installation path for the package
+clove_join_paths(CMAKE_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}" clove-unit ${PROJECT_VERSION})
+
+# Library Target definition and configuration
+add_library(clove-unit INTERFACE)
+add_library(clove-unit::clove-unit ALIAS clove-unit)
+
+target_include_directories(
+  clove-unit INTERFACE 
+  $<BUILD_INTERFACE:${CLOVE_SOURCE_DIR}>
+  $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+)
+
+target_compile_features(clove-unit INTERFACE c_std_11)
+
+# Install command stuffs for enabling find_package usage
+install(
+    TARGETS clove-unit 
+    EXPORT clove-unit-targets
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
 
-if (CLOVE_CMAKE__UC_BUILD)
+write_basic_package_version_file(
+  clove-unit-config-version.cmake
+  VERSION ${PROJECT_VERSION}
+  COMPATIBILITY AnyNewerVersion
+)
+
+configure_package_config_file(
+    ${CLOVE_SOURCE_DIR}/cmake/in/clove-unit-config.cmake.in
+    clove-unit-config.cmake
+    INSTALL_DESTINATION ${CMAKE_INSTALL_PREFIX}/cmake
+)
+
+install(
+    FILES ${CLOVE_SOURCE_DIR}/clove-unit.h
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+install(
+    FILES
+        ${PROJECT_BINARY_DIR}/clove-unit-config.cmake
+        ${PROJECT_BINARY_DIR}/clove-unit-config-version.cmake
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/cmake
+)
+
+install(
+    EXPORT clove-unit-targets
+    #NAMESPACE clove-unit::
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/cmake
+)
+
+export(PACKAGE clove-unit)
+
+
+#[[ 
+  In case this is the root project add dev targets (Development mode).
+  To avoid targets pollution when using FetchContent were only the target library is required
+  Note: PROJECT_IS_TOP_LEVEL cmake variable exists in version 3.21+
+]] 
+if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+  include(CTest)
+
+  option(CLOVE_CMAKE__UC_BUILD                  "enable build use case" OFF)
+  option(CLOVE_CMAKE__UC_SANITY                 "enable sanity check use case" OFF)
+  option(CLOVE_CMAKE__UC_PERFS                  "enable performance test use case" OFF)
+  option(CLOVE_CMAKE__CPP_STRICT_WARN_AS_ERROR  "threat compilation warning as error" OFF)
+
+  if (CLOVE_CMAKE__UC_BUILD)
     add_subdirectory(tests/functs)
     add_subdirectory(tests/stricts/clove-c)
     add_subdirectory(tests/stricts/clove-cpp)
     add_subdirectory(examples/clove101)
     add_subdirectory(examples/clovepp)
-endif()
+  endif()
 
-if (CLOVE_CMAKE__UC_SANITY)
+  if (CLOVE_CMAKE__UC_SANITY)
     add_subdirectory(tests/stricts/clove-sanity)
-endif()
+  endif()
 
-if (CLOVE_CMAKE__UC_PERFS)
+  if (CLOVE_CMAKE__UC_PERFS)
     add_subdirectory(tests/perfs)
+  endif()
+
 endif()

README.md

@@ -1,4 +1,4 @@
-# CLove-Unit · [![version](https://img.shields.io/github/v/release/fdefelici/clove-unit?label=latest&sort=semver)](./clove-unit.h) [![workflow](https://img.shields.io/github/actions/workflow/status/fdefelici/clove-unit/ci_action.yml)](https://github.com/fdefelici/clove-unit/actions/workflows/ci_action.yml) [![conan](https://img.shields.io/badge/conan-available-blueviolet)](https://conan.io/center/recipes/clove-unit) [![Discord channel](https://img.shields.io/discord/1167864219190964255?logo=discord&logoColor=violet)](https://discord.gg/Mjx4YRQfFt)
+# CLove-Unit · [![version](https://img.shields.io/github/v/release/fdefelici/clove-unit?label=latest&sort=semver)](./clove-unit.h) [![workflow](https://img.shields.io/github/actions/workflow/status/fdefelici/clove-unit/ci_action.yml)](https://github.com/fdefelici/clove-unit/actions/workflows/ci_action.yml) [![conan](https://img.shields.io/conan/v/clove-unit)](https://conan.io/center/recipes/clove-unit) [![Discord channel](https://img.shields.io/discord/1167864219190964255?logo=discord&logoColor=violet)](https://discord.gg/Mjx4YRQfFt)
 
 `CLove-Unit` is a single-header unit testing library designed for C (compatible with C++).
 
@@ -19,7 +19,7 @@ Consider also supporting `CLove-Unit` development becoming a [**sponsor**](https
 
 * [Features](#features)
 * [IDE Extensions](#ide-extensions)
-* [Supported Package Managers](#supported-package-managers)
+* [How to Integrate](#how-to-integrate)
 * [How It Works](#how-it-works)
 * [Getting Started](#getting-started)
 * [Programming API](#programming-api)
@@ -48,11 +48,88 @@ For those who prefer a UI oriented test executor, `CLove-Unit` is supported on t
 
 Have a look and enjoy ;-)
 
-## Supported Package Managers
+## How to Integrate
 
-`CLove-Unit` is also available on the following Package Managers:
+`CLove-Unit` can be imported in your project in the following ways:
+- Sourcing the header file
+- Using a Package Manager
+- Using CMake 
 
-* [Conan](https://conan.io/center/recipes/clove-unit)
+### Sourcing the Header file
+Being an header-only library, you can just download [clove-unit.h](./clove-unit.h) file and include it in your project.
+
+```c
+#include "clove-unit.h"
+```
+
+Then remember to properly configure your compiler include paths.
+
+### Using a Package Manager
+`CLove-Unit` is currently available on the following Package Managers:
+
+* [Conan](https://conan.io): read [here](https://conan.io/center/recipes/clove-unit) for details on how to import it.
+
+### Using CMake 
+In case you still need dependency management, but you want to avoid Package Manager configuration complexity, you can use standard mechansim provided by `CMake` such as [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html), [add_subdirectory](https://cmake.org/cmake/help/latest/command/add_subdirectory.html) and [find_package](https://cmake.org/cmake/help/latest/command/find_package.html).
+
+> NOTE: CMake library is named `clove-unit`
+
+Here a few examples:
+
+* **FetchContent**
+
+  ```cmake
+  cmake_minimum_required(VERSION 3.18)
+  project(TestProject C)
+
+  Include(FetchContent)
+  FetchContent_Declare(
+    clove-unit
+    GIT_REPOSITORY https://github.com/fdefelici/clove-unit.git
+    GIT_TAG master       # or eventually any branch, tag or commit sha
+  )
+  FetchContent_MakeAvailable(clove-unit)
+
+  add_executable(tests <YOUR_TEST_FILES>)
+  target_link_libraries(tests clove-unit)
+  ```
+
+* **add_subdirectory** 
+
+  First download `CLove-Unit` repository and then point properly to it like this:
+
+  ```cmake
+  cmake_minimum_required(VERSION 3.18)
+  project(TestProject C)
+
+  add_subdirectory(<PATH_TO_CLOVE_UNIT_REPOSITORY>)  
+
+  add_executable(tests <YOUR_TEST_FILES>)
+  target_link_libraries(tests clove-unit)
+  ```
+
+* **find_package** 
+
+  First download `CLove-Unit` repository and then run cmake install command on it. 
+
+  Package will be installed in at following path: `<CMAKE_INSTALL_PREFIX>/clove-unit/<CLOVE_VERSION>`
+  
+  Eventually you may want to customize [CMAKE_INSTALL_PREFIX](https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html) variable to override cmake default installation path for packages.
+
+  
+  Then use the package as follow:
+  ```cmake
+  cmake_minimum_required(VERSION 3.18)
+  project(TestProject C)
+
+  find_package(clove-unit REQUIRED PATHS <INSTALLATION_PATH>)  
+
+  # or more strict
+  # find_package(clove-unit <CLOVE_VERSION> EXACT REQUIRED PATHS <INSTALLATION_PATH>)  
+
+  add_executable(tests <YOUR_TEST_FILES>)
+  target_link_libraries(tests clove-unit)
+  ```
 
 ## How It Works
 
@@ -236,10 +313,10 @@ Assertions that can be used within a `CLOVE_TEST` definition.
 
 Helper APIs to support test implementation.
 
-| API                      | Description                                                |
-|--------------------------|------------------------------------------------------------|
-| `CLOVE_EXEC_PATH()`      | Macro to easily retrieve executable path as a `char*`      |
-| `CLOVE_EXEC_BASE_PATH()` | Macro to easily retrieve executable base path as a `char*` |
+| API                      | Description                                                               |
+|--------------------------|---------------------------------------------------------------------------|
+| `CLOVE_EXEC_PATH()`      | Macro to easily retrieve executable absolute path as a `const char*`      |
+| `CLOVE_EXEC_BASE_PATH()` | Macro to easily retrieve executable absolute base path as a `const char*` |
 
 ## Command-Line API