PostAndProcess(...) and ChangeMemPoolTeardownOption(...) pulled in from the 'qpc' version of this library.

And other improvements from the qpc version.

Author: mattheweshleman

cpputest-for-qpcpp-lib/cmake/cpputestCMake.cmake

@@ -9,11 +9,19 @@ else()
     message(STATUS "Found CppUTest version ${CPPUTEST_VERSION}")
 endif()
 
+if(CPPUTEST_VERSION_MAJOR LESS 4)
+    # likely 3.8
+    add_compile_definitions(CMS_CPPUTEST_LEGACY)
+else()
+    # 4.0 version or newer
+    add_compile_definitions(CMS_CPPUTEST_V4)
+endif()
+
 include_directories(${CPPUTEST_INCLUDE_DIRS})
 link_directories(${CPPUTEST_LIBRARIES})
 
 add_executable(${TEST_APP_NAME} ${TEST_SOURCES})
 target_link_libraries(${TEST_APP_NAME} ${APP_LIB_NAME} ${CPPUTEST_LDFLAGS})
 
 # (5) Run the test once the build is done
-add_custom_command(TARGET ${TEST_APP_NAME} COMMAND ./${TEST_APP_NAME} POST_BUILD)
+add_custom_command(TARGET ${TEST_APP_NAME} COMMAND ./${TEST_APP_NAME} POST_BUILD)

cpputest-for-qpcpp-lib/include/cms_cpputest.hpp

@@ -0,0 +1,17 @@
+//
+// Created by eshlemanm on 5/18/24, providing a minor porting layer
+// to handle CppUTest 3.8 versus 4.0 changes.
+//
+
+#ifndef CPPUTEST_FOR_QPC_CMS_CPPUTEST_HPP
+#define CPPUTEST_FOR_QPC_CMS_CPPUTEST_HPP
+
+#include "CppUTest/TestHarness.h"
+
+#ifdef CMS_CPPUTEST_LEGACY
+    #define CMS_TEST_EXIT  do { TEST_EXIT } while(0)
+#else
+  #define CMS_TEST_EXIT  do { TEST_EXIT; } while(0)
+#endif    
+
+#endif   // CPPUTEST_FOR_QPC_CMS_CPPUTEST_HPP

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

@@ -1,5 +1,5 @@
-/// @brief Supporting methods for setup, teardown, of a fake cpputest
-///        compatible port of the qpcpp QF framework.
+/// @brief Supporting methods for setup, teardown, and control of a fake
+///        cpputest compatible port of the QP/C++ (qpcpp) framework.
 /// @ingroup
 /// @cond
 ///***************************************************************************
@@ -22,8 +22,8 @@
 ///***************************************************************************
 /// @endcond
 
-#ifndef CPPUTEST_FOR_QPCPP_CMS_CPPUTEST_QF_CTRL_HPP
-#define CPPUTEST_FOR_QPCPP_CMS_CPPUTEST_QF_CTRL_HPP
+#ifndef CMS_CPPUTEST_QF_CTRL_HPP
+#define CMS_CPPUTEST_QF_CTRL_HPP
 
 #include <chrono>
 #include "qpcpp.hpp"
@@ -62,6 +62,8 @@ void Setup(enum_t maxPubSubSignalValue, uint32_t ticksPerSecond,
            const MemPoolConfigs& pubSubEventMemPoolConfigs = {},
            MemPoolTeardownOption memPoolOpt = MemPoolTeardownOption::CHECK_FOR_LEAKS);
 
+void ChangeMemPoolTeardownOption(MemPoolTeardownOption memPoolOpt);
+
 /// Teardown the QP/QF subsystem after completing a unit test.
 void Teardown();
 
@@ -95,6 +97,27 @@ void PublishAndProcess(enum_t sig,
 void PublishAndProcess(QP::QEvt const * e,
                        PublishedEventRecorder* recorder = nullptr);
 
+/// Helper method to Post an event to an active object
+/// followed internally by ProcessEvents().
+/// \param e
+/// \param dest
+inline void PostAndProcess(QP::QEvt const * e, QP::QActive* dest)
+{
+    dest->POST(e, nullptr);
+    ProcessEvents();
+}
+
+/// Helper method to Post a static const QEvt to an active object
+/// followed internally by ProcessEvents().
+/// \param sig (template param):  the signal value of the const event to post
+/// \param dest : the active object to post to.
+template <enum_t sig>
+inline void PostAndProcess(QP::QActive* dest)
+{
+    static const QP::QEvt constEvent = QP::QEvt(sig);
+    PostAndProcess(&constEvent, dest);
+}
+
 /// Get the internal library version string.
 /// Uses semantic versioning.
 const char * GetVersion();
@@ -103,4 +126,4 @@ const char * GetVersion();
 } //namespace test
 } //namespace cms
 
-#endif //CPPUTEST_FOR_QPCPP_CMS_CPPUTEST_QF_CTRL_HPP
+#endif //CMS_CPPUTEST_QF_CTRL_HPP

cpputest-for-qpcpp-lib/include/qassertMockSupport.hpp

@@ -1,4 +1,4 @@
-/// @brief Support methods to help with unit test mocks for QASSERT.
+/// @brief Support methods to help with unit testing for QASSERT.
 /// @ingroup
 /// @cond
 ///***************************************************************************
@@ -21,8 +21,8 @@
 ///***************************************************************************
 /// @endcond
 
-#ifndef CPPUTEST_FOR_QPCPP_QASSERTMOCKSUPPORT_HPP
-#define CPPUTEST_FOR_QPCPP_QASSERTMOCKSUPPORT_HPP
+#ifndef QASSERT_MOCK_SUPPORT_HPP
+#define QASSERT_MOCK_SUPPORT_HPP
 
 #include "CppUTestExt/MockSupport.h"
 #include "qsafe.h"
@@ -31,7 +31,7 @@ namespace cms {
 namespace test {
 
 static constexpr const char* QASSERT_MOCK_NAME  = "QASSERT";
-static constexpr const char* ONERROR_FUNC_NAME = "Q_onError";
+static constexpr const char* ONERROR_FUNC_NAME  = "Q_onError";
 
 inline void MockExpectQAssert()
 {
@@ -51,4 +51,4 @@ inline void MockExpectQAssert(const char* module, int id)
 }   // namespace test
 }   // namespace cms
 
-#endif   // CPPUTEST_FOR_QPCPP_QASSERTMOCKSUPPORT_HPP
+#endif   // QASSERT_MOCK_SUPPORT_HPP

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

@@ -26,7 +26,7 @@
 ///***************************************************************************
 /// @endcond
 
-#include "CppUTest/TestHarness.h"
+#include "cms_cpputest.hpp"
 #include "qp_port.hpp"
 #include "qsafe.h"
 #include "qassertMockSupport.hpp"
@@ -51,5 +51,5 @@ void Q_onError(char const* const module, int_t const id)
       .withParameter("module", module)
       .withParameter("id", id);
 
-    TEST_EXIT;
+      CMS_TEST_EXIT;
 }

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

@@ -127,6 +127,11 @@ void Teardown()
     }
 }
 
+void ChangeMemPoolTeardownOption(MemPoolTeardownOption memPoolOpt)
+{
+    l_memPoolOption = memPoolOpt;
+}
+
 void ProcessEvents()
 {
     QP::RunUntilNoReadyActiveObjects();

cpputest-for-qpcpp-lib/tests/CMakeLists.txt

@@ -5,6 +5,7 @@ set(TEST_SOURCES
         qassertTests.cpp
         cms_cpputest_qf_ctrlTests.cpp
         cms_cpputest_qf_ctrlPublishTests.cpp
+        cms_cpputest_qf_ctrl_post_tests.cpp
         publishedEventRecorderTests.cpp
         backedQueueTests.cpp
         orthogonalComponentTests.cpp
@@ -15,4 +16,4 @@ set(TEST_SOURCES
 # defined, and creates the cpputest based test executable target
 include(${CMS_CMAKE_DIR}/cpputestCMake.cmake)
 
-target_link_libraries(${TEST_APP_NAME} cpputest-for-qpcpp-lib  ${CPPUTEST_LDFLAGS})
+target_link_libraries(${TEST_APP_NAME} cpputest-for-qpcpp-lib  ${CPPUTEST_LDFLAGS})

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

@@ -98,6 +98,24 @@ TEST(qf_ctrlTests, setup_provides_option_to_skip_memory_pool_leak_detection)
     // teardown.
 }
 
+TEST(qf_ctrlTests, provides_modify_memory_pool_leak_detection)
+{
+    //Do a setup with leak detection.
+    qf_ctrl::Setup(10, 1000, qf_ctrl::MemPoolConfigs {},
+                   qf_ctrl::MemPoolTeardownOption::CHECK_FOR_LEAKS);
+
+    //but, this test only wants to disable leak detection, likely because of ASSERT
+    //testing which may interrupt normal event processing, resulting in false leaks.
+    qf_ctrl::ChangeMemPoolTeardownOption(qf_ctrl::MemPoolTeardownOption::IGNORE);
+
+    // purposeful leak of an allocated QEvt
+    QP::QEvt* volatile e = Q_NEW(QP::QEvt, 5);
+    (void)e;
+
+    // test should pass, as we disabled the memory pool leak detection during
+    // teardown.
+}
+
 TEST(qf_ctrlTests,
      qf_ctrl_provides_for_ability_to_move_time_forward_firing_active_object_timers_as_expected)
 {
@@ -147,4 +165,4 @@ TEST(qf_ctrlTests, qf_ctrl_provides_cpputest_for_qpcpp_lib_version)
 
     std::string version_str(version);
     CHECK_FALSE(version_str.empty());
-}
+}

cpputest-for-qpcpp-lib/tests/cms_cpputest_qf_ctrl_post_tests.cpp

@@ -0,0 +1,74 @@
+//// @brief  Tests for the qf_ctrl post related functions for the QF cpputest port.
+/// @ingroup
+/// @cond
+///***************************************************************************
+///
+/// Copyright (C) 2024 Matthew Eshleman. All rights reserved.
+///
+/// This program is open source software: you can redistribute it and/or
+/// modify it under the terms of the GNU General Public License as published
+/// by the Free Software Foundation, either version 3 of the License, or
+/// (at your option) any later version.
+///
+/// Alternatively, upon written permission from Matthew Eshleman, this program
+/// may be distributed and modified under the terms of a Commercial
+/// License. For further details, see the Contact Information below.
+///
+/// Contact Information:
+///   Matthew Eshleman
+///   https://covemountainsoftware.com
+///   [email protected]
+///***************************************************************************
+/// @endcond
+
+#include "cmsDummyActiveObject.hpp"
+#include "cms_cpputest_qf_ctrl.hpp"
+#include "qpcpp.hpp"
+
+//cpputest header include must always be last
+#include "CppUTest/TestHarness.h"
+
+using namespace cms::test;
+
+TEST_GROUP(qf_ctrl_post_tests)
+{
+    cms::DefaultDummyActiveObject* mDummy = nullptr;
+
+    void setup() final
+    {
+        qf_ctrl::Setup(QP::Q_USER_SIG, 100);
+        mDummy = new cms::DefaultDummyActiveObject();
+        mDummy->dummyStart();
+    }
+
+    void teardown() final
+    {
+        delete mDummy;
+        cms::test::qf_ctrl::Teardown();
+    }
+};
+
+TEST(qf_ctrl_post_tests,
+     provides_a_post_and_process_helper_func_with_trivial_signal_enum)
+{
+    static constexpr enum_t TEST1_SIG = QP::Q_USER_SIG + 1;
+    enum_t capturedSig = -1;
+    mDummy->SetPostedEventHandler([&](const QP::QEvt* e){
+        capturedSig = e->sig;
+    });
+    qf_ctrl::PostAndProcess<TEST1_SIG>(mDummy);
+    CHECK_EQUAL(TEST1_SIG, capturedSig);
+}
+
+TEST(qf_ctrl_post_tests,
+     provides_a_post_and_process_helper_func)
+{
+    static constexpr enum_t TEST2_SIG = QP::Q_USER_SIG + 111;
+    static const QP::QEvt testEvent = QP::QEvt(TEST2_SIG);
+    enum_t capturedSig = -1;
+    mDummy->SetPostedEventHandler([&](const QP::QEvt* e){
+        capturedSig = e->sig;
+    });
+    qf_ctrl::PostAndProcess(&testEvent, mDummy);
+    CHECK_EQUAL(TEST2_SIG, capturedSig);
+}