pull in the qassert-meta library.

Use it to print additional information on any recognized QP asserts encountered during unit testing.

Author: mattheweshleman

CMakeLists.txt

@@ -9,6 +9,7 @@ add_compile_options(-Wall -Wextra -Werror)
 
 set(CMS_EXTERNALS_TOP_DIR ${CMAKE_CURRENT_SOURCE_DIR}/externals)
 set(CMS_CMAKE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/cpputest-for-qpc-lib/cmake CACHE INTERNAL "")
+set(CMS_QASSERT_META_TOP_DIR ${CMS_EXTERNALS_TOP_DIR}/qassert-meta)
 
 if(NOT DEFINED CMS_QPC_TOP_DIR)
     set(CMS_QPC_TOP_DIR ${CMS_EXTERNALS_TOP_DIR}/qpc)
@@ -21,5 +22,13 @@ if(NOT DEFINED CMS_QPC_TOP_DIR)
     FetchContent_MakeAvailable(qpc)
 endif(NOT DEFINED CMS_QPC_TOP_DIR)
 
+FetchContent_Declare(qassert-meta
+        GIT_REPOSITORY https://github.com/covemountainsoftware/qassert-meta.git
+        GIT_TAG        a53c87e1a351f9c0444fcd2c68bb0583e2109b11
+        SOURCE_DIR     ${CMS_QASSERT_META_TOP_DIR}
+)
+message("Fetching qassert-meta git repository")
+FetchContent_MakeAvailable(qassert-meta)
+
 include(${CMS_CMAKE_DIR}/qpcCMakeSupport.cmake)
 add_subdirectory(cpputest-for-qpc-lib)

cpputest-for-qpc-lib/CMakeLists.txt

@@ -11,7 +11,7 @@ add_library(cpputest-for-qpc-lib
         src/cms_cpputest_qf_onCleanup.cpp
         src/cpputestMain.cpp
         ${CMS_QPC_QF_SRCS})
-
+target_link_libraries(cpputest-for-qpc-lib qassert-meta-lib)
 add_subdirectory(tests)
 
 target_include_directories(cpputest-for-qpc-lib PUBLIC

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

@@ -34,15 +34,26 @@ namespace test {
 static constexpr const char* QASSERT_MOCK_NAME  = "QASSERT";
 static constexpr const char* ONERROR_FUNC_NAME  = "Q_onError";
 
+void QAssertMetaOutputEnable();
+void QAssertMetaOutputDisable();
+
 inline void MockExpectQAssert()
 {
+    //if we are formally expecting an assert,
+    //then disable the meta output.
+    QAssertMetaOutputDisable();
+
     mock(QASSERT_MOCK_NAME)
       .expectOneCall(ONERROR_FUNC_NAME)
       .ignoreOtherParameters();
 }
 
 inline void MockExpectQAssert(const char* module, int id)
 {
+    //if we are formally expecting an assert,
+    //then disable the meta output.
+    QAssertMetaOutputDisable();
+
     mock(QASSERT_MOCK_NAME)
       .expectOneCall(ONERROR_FUNC_NAME)
       .withParameter("module", module)

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

@@ -30,10 +30,34 @@
 #include "qp_port.h" //required for Q_NORETURN definition, needed by qsafe.h
 #include "qsafe.h"
 #include "cmsQAssertMockSupport.hpp"
+#include "qassert-meta.h"
+
+static bool m_printAssertMeta = true;
+
+void cms::test::QAssertMetaOutputEnable()
+{
+    m_printAssertMeta = true;
+}
+
+void cms::test::QAssertMetaOutputDisable()
+{
+    m_printAssertMeta = false;
+}
 
 void Q_onError(char const* const module, int_t const id)
 {
-    //fprintf(stderr, "%s(%s , %d)\n", __FUNCTION__ , module, id);
+    if (m_printAssertMeta)
+    {
+        fprintf(stdout, "\n%s(%s:%d)\n", __FUNCTION__ , module, id);
+        QAssertMetaDescription meta;
+        bool found = QAssertMetaGetDescription(module, id, &meta);
+        if (found)
+        {
+            fprintf(stdout, "Additional details on (%s:%d):  %s\n", module, id, meta.brief);
+            fprintf(stdout, "Tips/More:\n%s\n", meta.tips);
+            fprintf(stdout, "URL:  %s\n", meta.url);
+        }
+    }
 
     // The TEST_EXIT macro used below is throwing an exception.
     // However, many of QP/QF methods are marked as 'noexcept'

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

@@ -29,6 +29,8 @@
 #include <cassert>
 #include <vector>
 #include "CppUTest/TestHarness.h"
+#include "qassert-meta.h"
+#include "cmsQAssertMockSupport.hpp"
 
 namespace cms {
 namespace test {
@@ -80,6 +82,9 @@ void Setup(enum_t const maxPubSubSignalValue, uint32_t ticksPerSecond,
         CreatePoolConfigsFromArg(pubSubEventMemPoolConfigs);
     }
 
+    QAssertMetaInit();
+    QAssertMetaOutputEnable();
+
     QF_init();
     QF_psInit(l_subscriberStorage->data(), maxPubSubSignalValue);
 

externals/.gitignore

@@ -1 +1,2 @@
 qpc/
+qassert-meta/