add version to cmake build and add an accessor to get the library's version string.

Author: mattheweshleman

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.16)
-project(cpputest-for-qpc-lib)
+project(cpputest-for-qpc-lib VERSION 1.0.0)
 include(FetchContent)
 
 set(CMAKE_CXX_STANDARD 14)

cpputest-for-qpc-lib/CMakeLists.txt

@@ -2,6 +2,8 @@ include_directories(include)
 include_directories(${CMS_QPC_SRC_DIR})
 include_directories(${CMS_CPPUTEST_QP_PORT_TOP_DIR}/include)
 
+add_definitions(-DCPPUTEST_FOR_QPC_LIB_VERSION=\"${cpputest-for-qpc-lib_VERSION}\")
+
 add_library(cpputest-for-qpc-lib
         src/cpputest_qf_port.cpp
         src/cms_cpputest_qf_ctrl.cpp

cpputest-for-qpc-lib/include/cms_cpputest_qf_ctrl.hpp

@@ -95,6 +95,10 @@ void PublishAndProcess(enum_t sig,
 void PublishAndProcess(QEvt const * e,
                        PublishedEventRecorder* recorder = nullptr);
 
+/// Get the internal library version string.
+/// Uses semantic versioning.
+const char * GetVersion();
+
 } //namespace qf_ctrl
 } //namespace test
 } //namespace cms

cpputest-for-qpc-lib/src/cms_cpputest_qf_ctrl.cpp

@@ -189,6 +189,11 @@ void CreatePoolConfigsFromArg(const MemPoolConfigs& pubSubEventMemPoolConfigs)
     }
 }
 
+const char * GetVersion()
+{
+    return CPPUTEST_FOR_QPC_LIB_VERSION;
+}
+
 }   // namespace qf_ctrl
 }   // namespace test
 }   // namespace cms

cpputest-for-qpc-lib/tests/cms_cpputest_qf_ctrlTests.cpp

@@ -25,6 +25,7 @@
 #include "qpc.h"
 
 #include <chrono>
+#include <string>
 #include "cms_cpputest_qf_ctrl.hpp"
 #include "cmsDummyActiveObject.hpp"
 #include "cms_cpputest.hpp"
@@ -146,4 +147,13 @@ TEST(qf_ctrlTests,
 
     CHECK_EQUAL(1, sigOneCount);
     CHECK_EQUAL(3, sigTwoCount);
+}
+
+TEST(qf_ctrlTests, qf_ctrl_provides_cpputest_for_qpc_lib_version)
+{
+    auto version = qf_ctrl::GetVersion();
+    CHECK_TRUE(version != nullptr);
+
+    std::string version_str(version);
+    CHECK_FALSE(version_str.empty());
 }