Merge pull request #4 from covemountainsoftware/2-break-up-into-library-specific-project-and-example-container-project

Resolve: break up into library specific project and example container project

Author: mattheweshleman

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "externals/qpc"]
-	path = externals/qpc
-	url = git@github.com:QuantumLeaps/qpc.git

CMakeLists.txt

@@ -1,24 +1,25 @@
 cmake_minimum_required(VERSION 3.16)
-project(cpputest-for-qpc)
+project(cpputest-for-qpc-lib)
+include(FetchContent)
 
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_C_STANDARD 11)
 
 add_compile_options(-Wall -Wextra -Werror)
 
-include_directories(include)
+set(CMS_EXTERNALS_TOP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/externals)
+set(CMS_CMAKE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/cpputest-for-qpc-lib/cmake)
 
-set(EXTERNALS_TOP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/externals)
-set(CMS_QPC_TOP_DIR ${EXTERNALS_TOP_DIR}/qpc)
+if(NOT DEFINED CMS_QPC_TOP_DIR)
+    set(CMS_QPC_TOP_DIR ${CMS_EXTERNALS_TOP_DIR}/qpc)
+    FetchContent_Declare(qpc
+            GIT_REPOSITORY https://github.com/QuantumLeaps/qpc.git
+            GIT_TAG        fcea9943bbeeca49c66ce124d4d71467f6e2661e #7.3.3
+            SOURCE_DIR     ${CMS_QPC_TOP_DIR}
+    )
+    message("Fetching QP/C git repository")
+    FetchContent_MakeAvailable(qpc)
+endif(NOT DEFINED CMS_QPC_TOP_DIR)
 
-include(externals/qpcCMakeSupport.txt)
-
-set(CMS_TEST_SUPPORT_TOP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/test_support)
-set(MOCKS_TOP_DIR ${CMS_TEST_SUPPORT_TOP_DIR}/mocks)
-set(DRIVERS_TOP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/drivers)
-set(CMS_UTILS_TOP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/utilities)
-
-add_subdirectory(utilities)
-add_subdirectory(test_support)
-add_subdirectory(drivers)
-add_subdirectory(examples)
+include(${CMS_CMAKE_DIR}/qpcCMakeSupport.cmake)
+add_subdirectory(cpputest-for-qpc-lib)

README.md

@@ -1,4 +1,4 @@
-# CppUTest for the QP/C (qpc) Real-Time Embedded Framework
+# CppUTest for the QP/C (qpc) Real-Time Embedded Framework (library only)
 
 Build and Test status: ![Build and Tests](https://github.com/covemountainsoftware/cpputest-for-qpc/actions/workflows/cmake.yml/badge.svg)
 
@@ -12,7 +12,7 @@ encourage and support efforts like this. Thank you!
 
 # Introduction
 
-The `cpputest-for-qpc` project enables CppUTest for the 
+The `cpputest-for-qpc` library project enables CppUTest for the 
 QP/C Real-Time Embedded Framework. This project provides for the 
 following capabilities:
 
@@ -22,7 +22,7 @@ following capabilities:
 * Supporting utilities to simplify unit testing of qpc 
   based active objects. Provided classes may also be useful in 
   the final target software, if C++ is also in use.
-* An example C language based active object under test.
+* A separate examples project providing usage/examples of this library
 
 Benefits of this approach to unit testing active objects include:
 * No surprises. The active object under test interacts with the 
@@ -43,19 +43,20 @@ Benefits of this approach to unit testing active objects include:
 
 # Environment
 
-This project was developed and proven in Ubuntu 20.04. In theory any 
+This project was developed and proven in Ubuntu 20.04 and 22.04. In theory any 
 build or host operating system environment supported by CppUTest will 
 be compatible with this code.
 
 ## Prerequisites
 
-* qpc (pulled in as a git submodule)
-  * After cloning this repository, do not forget to:
-  * `git submodule init`
-  * `git submodule update`
-* CppUTest (version 3.8-7 or version 4.0) (3.8 is the default in Ubuntu 20.04 while 4.0 is the default in Ubuntu 22.04)
 * CMake and associated build tools were used to develop
   and prove out this project.
+* QP/C 
+  * You can override the QPC to another directory with your project's exact QPC source code. 
+    Define the cmake variable CMS_QPC_TOP_DIR before including the internal CMakeLists.txt. 
+  * or:
+    * Do not define CMS_QPC_TOP_DIR, and the internal cmake will fetch the appropriate QP/C repo.
+* CppUTest (version 3.8-7 or version 4.0) (3.8 is the default in Ubuntu 20.04 while 4.0 is the default in Ubuntu 22.04)
 * This project requires support for C++14 and C11.
 
 ## Continuous Integration
@@ -125,7 +126,7 @@ behavior, using the exact same interfaces the active object would use
 in the production target. CppUTest provides for the mocking capabilities to 
 ensure that the active object under test is calling the expected APIs.
 
-Within this project, please see the tests for `examples/hwLockCtrlService` which
+Within the associated examples project, please see the tests for `examples/hwLockCtrlService` which
 provides examples of:
 * Testing for reaction to a published event, where the reaction is observed
   through a CppUTest `mock()`.

cpputest-for-qpc-lib/CMakeLists.txt

@@ -0,0 +1,18 @@
+include_directories(include)
+include_directories(${CMS_QPC_SRC_DIR})
+include_directories(${CMS_CPPUTEST_QP_PORT_TOP_DIR}/include)
+
+add_library(cpputest-for-qpc-lib
+        src/cpputest_qf_port.cpp
+        src/cms_cpputest_qf_ctrl.cpp
+        src/cms_cpputest_q_onAssert.cpp
+        src/cms_cpputest_qf_onCleanup.cpp
+        src/cpputestMain.cpp
+        ${CMS_QPC_QF_SRCS})
+
+add_subdirectory(tests)
+
+target_include_directories(cpputest-for-qpc-lib PUBLIC
+        ${CMS_QPC_INCLUDE_DIR}
+        ${CMS_CPPUTEST_QP_PORT_TOP_DIR}/include
+        ${CMS_UTILS_TOP_DIR}/include)

test_support/common/cpputestCMake.txt …st-for-qpc-lib/cmake/cpputestCMake.cmaketest_support/common/cpputestCMake.txt renamed to cpputest-for-qpc-lib/cmake/cpputestCMake.cmake test_support/common/cpputestCMake.txt renamed to cpputest-for-qpc-lib/cmake/cpputestCMake.cmake

@@ -0,0 +1,17 @@
+set(CMS_QPC_SRC_DIR ${CMS_QPC_TOP_DIR}/src)
+set(CMS_QPC_INCLUDE_DIR ${CMS_QPC_TOP_DIR}/include)
+set(CMS_QPC_QF_SRC_DIR ${CMS_QPC_SRC_DIR}/qf)
+
+set(CMS_QPC_QF_SRCS
+	${CMS_QPC_QF_SRC_DIR}/qep_hsm.c
+	${CMS_QPC_QF_SRC_DIR}/qep_msm.c
+	${CMS_QPC_QF_SRC_DIR}/qf_act.c
+	${CMS_QPC_QF_SRC_DIR}/qf_actq.c
+	${CMS_QPC_QF_SRC_DIR}/qf_defer.c
+	${CMS_QPC_QF_SRC_DIR}/qf_dyn.c
+	${CMS_QPC_QF_SRC_DIR}/qf_mem.c
+	${CMS_QPC_QF_SRC_DIR}/qf_ps.c
+	${CMS_QPC_QF_SRC_DIR}/qf_qact.c
+	${CMS_QPC_QF_SRC_DIR}/qf_qeq.c
+	${CMS_QPC_QF_SRC_DIR}/qf_qmact.c
+	${CMS_QPC_QF_SRC_DIR}/qf_time.c)