Add tests - First round

.github/workflows/tests.yml

@@ -0,0 +1,71 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+env:
+  CMLIB_VERSION: 1.0.0
+
+jobs:
+  test_linux:
+    strategy:
+      matrix:
+        image: [
+          "test_debian:bullseye",
+          "test_debian:trixie",
+          "test_debian:bookworm",
+          "test_ubuntu:2004",
+          "test_ubuntu:2204",
+          "test_ubuntu:2404",
+          "test_fedora:41",
+          "test_fedora:42"
+          ]
+
+    runs-on: ubuntu-latest
+    container:
+        image: ghcr.io/cmakelib/${{ matrix.image }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Run tests
+        run: |
+            git config --global --add safe.directory "$(pwd)"
+            git remote set-url origin "${{ github.server_url }}/${{ github.repository }}"
+            git clone --branch "v${CMLIB_VERSION}" https://github.com/cmakelib/cmakelib.git
+            export CMLIB_DIR=$(pwd)/cmakelib
+            cd test/ && cmake .
+
+  test_macos:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Run tests
+        run: |
+            git config --global --add safe.directory "$(pwd)"
+            git remote set-url origin "${{ github.server_url }}/${{ github.repository }}"
+            git clone --branch "v${CMLIB_VERSION}" https://github.com/cmakelib/cmakelib.git
+            export CMLIB_DIR=$(pwd)/cmakelib
+            cd test/ && cmake .
+
+  test_windows:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Run tests
+        run: |
+            git config --global --add safe.directory "$(pwd)"
+            git remote set-url origin "${{ github.server_url }}/${{ github.repository }}"
+            git clone --branch "v$Env:CMLIB_VERSION" https://github.com/cmakelib/cmakelib.git
+            $Env:CMLIB_DIR=$(Join-Path -Path $(Get-Location).Path -ChildPath "cmakelib")
+            cd test/ && cmake .

CMDEFConfig.cmake

@@ -1,2 +1,2 @@
 
-INCLUDE("${CMAKE_CURRENT_LIST_DIR}/FinDBASEDEF.cmake")
+INCLUDE("${CMAKE_CURRENT_LIST_DIR}/FindCMDEF.cmake")

FindCMDEF.cmake

@@ -9,7 +9,7 @@
 # - include all CMDEF modules
 #
 
-CMAKE_MINIMUM_REQUIRED(VERSION 3.21 FATAL_ERROR)
+CMAKE_MINIMUM_REQUIRED(VERSION 3.22 FATAL_ERROR)
 
 SET(CMDEF_PACKAGE_NAME "CMDEF")
 
@@ -30,5 +30,7 @@ INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMDEF_LINK_OPTION.cmake)
 INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMDEF_INSTALL.cmake)
 INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMDEF_PACKAGE.cmake)
 
+INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMDEF_CLEANUP.cmake)
+
 INCLUDE(${CMAKE_CURRENT_LIST_DIR}/system_modules/CMDEF_HELPER.cmake)
 

README.md

@@ -1,52 +1,59 @@
 
-# CMake-lib Basedef component
+# CMake-lib Definition Framework Component
 
-CMake-lib provides consistent setting for built environment.
+Linux: ![buildbadge_github], Windows: ![buildbadge_github], Mac OS: ![buildbadge_github]
+
+CMDEF aka **CMake-lib Definition Framework**
+
+CMake-lib provides consistent settings for build environment.
 It simplifies and maintains built option, libraries and executables.
 
 ## Requirements
 
-- [CMLIB] library installed 
+CMDEF is intended to be used thru [CMLIB].
+
+CMDEF is not supposed to be used separately.
+
+To use the library install [CMLIB] and call `FIND_PACKAGE(CMLIB COMPONENTS CMDEF)`
 
 ## General
 
 The library is not mainly intended for extending CMake functionality.
 
 It's set of wrappers and helpers which enables easily use of existing CMake
-features.
+features in a more standardised manner across multiple projects.
 
 ### Definition of Main target
 
 Each CMake project has one main target - the target for which the project is
 created, compiled, ...
 
-For example we have CMake project for building chrome browser.
-Browser is represented by one executable called `chrome`. That executable
+For example - CMake project for building chrome browser.
+Browser is represented by the executable called `chrome`. The executable
 must have own target in CMake project.
 
 By that target other project properties are referenced - installer name, application name, documentation etc.
-We call this type of target as 'main target' (the 'object' for which we
-create the CMake project)
+This type of target is called 'main target' (the 'object' for which the CMake project is created).
 
-In the library the 'main target' is represented by MAIN_TARGET variable/parameter for macros/functions
+The library 'main target' is represented by LIBRARY_GROUP argument with suffix added according to a library type created.
 
 ## Usage
 
-Let GIT_URI be a GIT URI of this repository.
-
+```cmake
 	FIND_PACKAGE(CMLIB COMPONENTS CMDEF)
+```
 
 ### Set build defaults
 
-CMake-lib sets and maintains build/link flags and global wide definitions
+CMake-lib sets and maintains build and link flags and global wide definitions.
 
 Component workflow
 
 - reset CMake default build flags by `CMDEF_CLEANUP`
 - set default build and link options  by `CMDEF_COMPILE_OPTIONS`, `CMDEF_LINK_OPTIONS`
-- set compile definitions by `CMDEF_COMPIE_DEFINITIONS`
+- set compile definitions by `CMDEF_COMPILE_DEFINITIONS`
 
-examples can be found at [example] directory
+examples can be found at [example] directory.
 
 ## Function list
 
@@ -55,7 +62,7 @@ Each entry in list represents one feature for CMake.
 Most of the functions are just wrappers which enclosures base feature of
 CMake.
 
-Detailed documentation for each function can be found at appropriate module.
+Detailed documentation for each function can be found at the appropriate module.
 
 - [CMDEF_ADD_LIBRARY.cmake]
 - [CMDEF_ADD_EXECUTABLE.cmake]
@@ -67,13 +74,15 @@ Detailed documentation for each function can be found at appropriate module.
 - [CMDEF_LINK_OPTION.cmake]
 - [CMDEF_PACKAGE.cmake]
 
-## Config Variables
+## Documentation
+
+Every function has a comprehensive documentation written as part of the function definition.
 
-Configuration variables detailed desc. for the library is located at [doc/CacheVariables.md]
+Context documentation is located at [doc/README.md]
 
 ## Coding standards
 
-- We use Uppercase for all keywords and global variables
+- The uppercase letters are used for all keywords and global variables
 - Each helper function must begin with '_'
 
 [CMLIB]: https://github.com/cmakelib/cmakelib
@@ -88,4 +97,7 @@ Configuration variables detailed desc. for the library is located at [doc/CacheV
 [CMDEF_LINK_OPTION.cmake]: system_modules/CMDEF_LINK_OPTION.cmake
 [CMDEF_PACKAGE.cmake]: system_modules/CMDEF_PACKAGE.cmake
 [doc/CacheVariables.md]: doc/CacheVariables.md
+[doc/README.md]: doc/README.md
 [example]: example/
+
+[buildbadge_github]: https://github.com/cmakelib/cmakelib-component-cmdef/actions/workflows/tests.yml/badge.svg

doc/CacheVariables.md

@@ -1,5 +1,5 @@
 
-# CMDEf cache variables
+# CMDEF cache variables
 
 Each section represent one Cache variable used in CMDEF.
 
@@ -31,10 +31,10 @@ It tries to set the variable in the following order
 
 ## CMDEF_BUILD_TYPE_CMAKE_BUILD_TYPE_OVERRIDE:BOOL=\<conditional>
 
-Indicate if the CMAKE_BUILD_TYPE is overriden by CMDEF library.
+Indicate if the CMAKE_BUILD_TYPE is overridden by CMDEF library.
 
 - If the CMAKE_BUILD_TYPE is not set the CMDEF try to set the CMAKE_BUILD_TYPE variable
-  to the predefined value stored in CMDEF_BUILD_TYPE_DEFAULT variable. In this case the vairable is set to ON.
+  to the predefined value stored in CMDEF_BUILD_TYPE_DEFAULT variable. In this case the variable is set to ON.
 - If the CMAKE_BUILD_TYPE is set explicitly the variable is set to OFF.
 
 ## CMDEF_BUILD_TYPE_DEFAULT:STRING=Debug
@@ -43,7 +43,7 @@ Default build type if CMAKE_BUILD_TYPE is not specified.
 
 ## CMDEF_BUILD_TYPE_LIST:STRING,LIST=\<conditional>
 
-List of the suported byuld types. CMAKE_BUILD_TYPE must hold exactly one value from this list.
+List of the supported build types. CMAKE_BUILD_TYPE must hold exactly one value from this list.
 
 Type: String, List
 
@@ -67,7 +67,7 @@ It tries to set the variable in the following order
 1. filled from ENV variable CMDEF_DISTRO_ID if defined
 1. auto filled by CMDEF library (by `lsb_release` utility)
 
-## CMDEF_DISTRO_VERSION_ID:STRING=\<conditional\>
+## CMDEF_DISTRO_VERSION_ID:STRING=\<conditional>
 
 Distribution version ID (eg for debian bullseye: 11, ...). It always holds lowercase value...
 

doc/PackageChain.md

@@ -50,7 +50,7 @@ CMDEF_ADD_EXECUTABLE(
 
 Configure installation of a target, that will export it and create the target's `.cmake` file.
 
-`NAMESPACE` is **required** when using the whole chain and it must be **equal** to the name of the **main target**.
+`NAMESPACE` is **optional** but **recommended** when using the whole chain. When specified, it must be **equal** to the name of the **main target** and end with `::`. If using `CMDEF_PACKAGE`, the namespace consistency is validated automatically.
 > **main target** - the 'object' for which we create the CMake project. It relates to CMDEF_PACKAGE
 
 #### Example
@@ -106,7 +106,7 @@ make install  # Install cmake files, mylib-shared.so and myexecutable to <instal
 cpack         # Create archive libmylib-shared-dev_1.0.0_<architecture>.zip
 ```
 
-> Note that when `CMAKE_BUILD_TYPE=Debug`, the libraries and executables **OUTPUT_NAME** will have a suffix `d` added to them.
+> Note that when `CMAKE_BUILD_TYPE=Debug`, the libraries and executables **OUTPUT_NAME** will have a debug suffix added to them (controlled by `CMDEF_EXECUTABLE_NAME_DEBUG_SUFFIX`, typically `d`).
 
 The created package has the following structure:
 

doc/README.md

@@ -0,0 +1,9 @@
+
+# Detailed Documentation for CMDEF Component
+
+This directory contains detailed documentation for the CMDEF component of the CMake-lib library.
+
+## Documentation Files
+
+- [CacheVariables.md](CacheVariables.md): Describes all cache variables used by the CMDEF component.
+- [PackageChain.md](PackageChain.md): Explains the package chain workflow and functions provided by CMDEF.

example/executable/CMakeLists.txt

@@ -14,6 +14,7 @@ PROJECT(${CMAKE_PROJECT_NAME})
 FIND_PACKAGE(CMLIB COMPONENTS CMDEF)
 
 
+CMDEF_CLEANUP()
 
 #
 # Add Definitions for each build type globally
@@ -36,7 +37,7 @@ IF(CMDEF_OS_LINUX)
 	)
 ELSEIF(CMDEF_OS_WINDOWS)
 	CMDEF_COMPILE_OPTIONS(
-		ALL /wd4996 # Disable deprectation warning on Windows OS
+		ALL /wd4996 # Disable deprecation warning on Windows OS
 	)
 ENDIF()
 
@@ -53,7 +54,7 @@ CMDEF_ADD_EXECUTABLE(
 
 CMDEF_COMPILE_DEFINITIONS_TARGET(
 	TARGET executable
-	VISIBLITY PUBLIC
+	VISIBILITY PUBLIC
 	ALL RETURN_CODE=245
 	DEBUG RETURN_CODE_DEBUG=1000
 	RELEASE RETURN_CODE_RELEASE=2020
@@ -66,7 +67,7 @@ CMDEF_COMPILE_DEFINITIONS_TARGET(
 ADD_EXECUTABLE(cmake_executable main.c)
 CMDEF_COMPILE_DEFINITIONS_TARGET(
 	TARGET cmake_executable
-	VISIBLITY PRIVATE
+	VISIBILITY PRIVATE
 	ALL RETURN_CODE=255
 	DEBUG RETURN_CODE_DEBUG=10000
 	RELEASE RETURN_CODE_RELEASE=20200
@@ -93,4 +94,4 @@ CMDEF_PACKAGE(
 # Just choose generator and include CPack
 #
 SET(CPACK_GENERATOR ZIP)
-INCLUDE(CPack)
+INCLUDE(CPack)

example/library-interface/CMakeLists.txt

@@ -104,7 +104,7 @@ CMDEF_INSTALL(TARGET testlink-executable NAMESPACE testlib-shared::)
 #
 CMDEF_COMPILE_OPTIONS_TARGET(
 	TARGET testlib-shared
-	VISIBLITY PUBLIC
+	VISIBILITY PUBLIC
 	DEBUG -Wall
 )
 

example/library-interface/main.cpp

@@ -1,5 +1,5 @@
 /**
- * @brief Test exacutable to test all defined symbols are linked correctly
+ * @brief Test executable to test all defined symbols are linked correctly
  */
 
 #include <testlib/printAllMessages.hpp>

example/library/CMakeLists.txt

@@ -49,7 +49,7 @@ CMDEF_ADD_LIBRARY(
 #
 CMDEF_COMPILE_OPTIONS_TARGET(
 	TARGET testlib-shared
-	VISIBLITY PUBLIC
+	VISIBILITY PUBLIC
 	DEBUG -Wall
 )
 

system_modules/CMDEF_ADD_EXECUTABLE.cmake

@@ -64,7 +64,7 @@ FUNCTION(CMDEF_ADD_EXECUTABLE)
 	IF(CMDEF_OS_WINDOWS AND __WIN32)
 		SET(exec_flag WIN32)
 	ELSEIF(CMDEF_OS_MACOS AND __MACOS_BUNDLE)
-		SET(exec_flag MACOS_BUNDLE)
+		SET(exec_flag MACOSX_BUNDLE)
 	ENDIF()
 
 	SET(output_name ${__TARGET})

system_modules/CMDEF_ADD_LIBRARY.cmake

@@ -35,9 +35,9 @@ INCLUDE(${CMAKE_CURRENT_LIST_DIR}/CMDEF_RESOURCE.cmake)
 # SOURCES - all c/cpp/h/hpp files will be added as source to given target.
 #
 # SOURCE_BASE_DIRECTORY - INTERFACE library only. Only for installation.
-# It is base directory for all source files.
-# If defined, source files will be installed with relative path from this directory.
-# Else, source files will be installed directly in CMDEF_SOURCE_INSTALL_DIR
+# It is base directory for all source files. 
+# If defined, source files specified by SOURCES will be installed with relative path respective to SOURCE_BASE_DIRECTORY.
+# Else, source files specified by SOURCES will be installed directly into CMDEF_SOURCE_INSTALL_DIR.
 #
 # [Custom properties]
 # CMDEF_LIBRARY - property which mark library as "created by CMDEF_ADD_LIBRARY"

system_modules/CMDEF_BUILD_TYPE.cmake

@@ -28,7 +28,7 @@ SET(CMDEF_BUILD_TYPE_DEFAULT "Debug"
 MACRO(_CMDEF_BUILD_TYPE_SET_CMAKE_BUILD_TYPE_OVERRIDE opt ${ARGN})
 	SET(CMDEF_BUILD_TYPE_CMAKE_BUILD_TYPE_OVERRIDE ${opt}
 		CACHE BOOL
-		"ON if the CMAKE_BUILD_TYPE is overriden by CMDEF, OFF otherwise"
+		"ON if the CMAKE_BUILD_TYPE is overridden by CMDEF, OFF otherwise"
 		${ARGN}
 	)
 ENDMACRO()
@@ -65,7 +65,7 @@ UNSET(all_find)
 
 
 ##
-# Initialize CMake veriables according to CMDEF definitions
+# Initialize CMake variables according to CMDEF definitions
 #
 # <function>(
 # )