rename, refactors. Create lib helper methods that setup or teardown all cpputest for freertos provided modules (convenience method for tests).

mattheweshleman · mattheweshleman · commit a3e8216087c5 · 2024-10-28T08:24:57.000-05:00
diff --git a/cpputest-for-freertos-lib/CMakeLists.txt b/cpputest-for-freertos-lib/CMakeLists.txt
@@ -36,12 +36,13 @@ include_directories(include)
 set(FREERTOS_KERNEL_PATH ${CMS_FREERTOS_KERNEL_TOP_DIR} CACHE INTERNAL "")
 
 add_library(cpputest-for-freertos-lib
-        src/cpputest_freertos_task.cpp
-        src/cpputest_freertos_queue.cpp
-        src/cpputest_freertos_assert.cpp
-        src/cpputest_freertos_timers.cpp
+        src/cpputest_for_freertos_task.cpp
+        src/cpputest_for_freertos_queue.cpp
+        src/cpputest_for_freertos_assert.cpp
+        src/cpputest_for_freertos_timers.cpp
         src/cpputest_main.cpp
-        src/cpputest_freertos_semaphore.cpp
+        src/cpputest_for_freertos_semaphore.cpp
+        include/cpputest_for_freertos_lib.hpp
 )
 
 add_subdirectory(tests)
diff --git a/cpputest-for-freertos-lib/include/cpputest_for_freertos_assert.hpp b/cpputest-for-freertos-lib/include/cpputest_for_freertos_assert.hpp
@@ -21,8 +21,8 @@
 ///***************************************************************************
 /// @endcond
 
-#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_ASSERT_HPP
-#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_ASSERT_HPP
+#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_ASSERT_HPP
+#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_ASSERT_HPP
 
 #include "FreeRTOS.h"
 #include "CppUTestExt/MockSupport.h"
@@ -45,4 +45,4 @@ namespace cms {
     }   // namespace test
 }   // namespace cms
 
-#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_ASSERT_HPP
+#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_ASSERT_HPP
diff --git a/cpputest-for-freertos-lib/include/cpputest_for_freertos_lib.hpp b/cpputest-for-freertos-lib/include/cpputest_for_freertos_lib.hpp
@@ -0,0 +1,54 @@
+/// @brief Top level init/teardown methods for CppUTest for FreeRTOS library.
+/// @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
+///   info@covemountainsoftware.com
+///***************************************************************************
+/// @endcond
+
+#ifndef CPPUTEST_FOR_FREERTOS_LIB_HPP
+#define CPPUTEST_FOR_FREERTOS_LIB_HPP
+
+#include "cpputest_for_freertos_assert.hpp"
+#include "cpputest_for_freertos_task.hpp"
+#include "cpputest_for_freertos_timers.hpp"
+
+namespace cms {
+    namespace test {
+        /**
+         * call this in your unit test setup() method to initialize
+         * all available CppUTest for FreeRTOS modules.
+         */
+        void LibInitAll() {
+            TaskInit();
+            AssertOutputEnable();
+            TimersInit();
+        }
+
+        /**
+         * call this in your unit test teardown() method to correctly
+         * destroy/teardown all available CppUTest for FreeRTOS modules.
+         */
+        void LibTeardownAll() {
+            TimersDestroy();
+            TaskDestroy();
+        }
+    } // namespace test
+} //namespace cms
+
+#endif //CPPUTEST_FOR_FREERTOS_LIB_HPP
diff --git a/cpputest-for-freertos-lib/include/cpputest_for_freertos_task.hpp b/cpputest-for-freertos-lib/include/cpputest_for_freertos_task.hpp
@@ -21,8 +21,8 @@
 ///   info@covemountainsoftware.com
 ///***************************************************************************
 /// @endcond
-#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TASK_HPP
-#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TASK_HPP
+#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TASK_HPP
+#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TASK_HPP
 
 namespace cms {
     namespace test {
@@ -41,4 +41,4 @@ namespace cms {
     }
 }
 
-#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TASK_HPP
+#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TASK_HPP
diff --git a/cpputest-for-freertos-lib/include/cpputest_for_freertos_timers.hpp b/cpputest-for-freertos-lib/include/cpputest_for_freertos_timers.hpp
@@ -1,6 +1,6 @@
 
-#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TIMERS_HPP
-#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TIMERS_HPP
+#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TIMERS_HPP
+#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TIMERS_HPP
 
 #include <chrono>
 
@@ -39,4 +39,4 @@ namespace test {
 } //namespace
 }//namespace
 
-#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TIMERS_HPP
+#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TIMERS_HPP
diff --git a/cpputest-for-freertos-lib/src/cpputest_for_freertos_assert.cpp b/cpputest-for-freertos-lib/src/cpputest_for_freertos_assert.cpp
@@ -22,7 +22,7 @@
 /// @endcond
 
 #include <cstdio>
-#include "cpputest_freertos_assert.hpp"
+#include "cpputest_for_freertos_assert.hpp"
 
 static bool m_printAssert = true;
 
diff --git a/cpputest-for-freertos-lib/src/cpputest_for_freertos_fake_queue.hpp b/cpputest-for-freertos-lib/src/cpputest_for_freertos_fake_queue.hpp
@@ -1,6 +1,6 @@
 
-#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_FAKE_QUEUE_HPP
-#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_FAKE_QUEUE_HPP
+#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_FAKE_QUEUE_HPP
+#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_FAKE_QUEUE_HPP
 
 #include <deque>
 #include <vector>
@@ -14,4 +14,4 @@ typedef struct QueueDefinition
     std::deque<std::vector<uint8_t>> queue = {};
 } FakeQueue;
 
-#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_FAKE_QUEUE_HPP
+#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_FAKE_QUEUE_HPP
diff --git a/cpputest-for-freertos-lib/src/cpputest_for_freertos_queue.cpp b/cpputest-for-freertos-lib/src/cpputest_for_freertos_queue.cpp
@@ -24,7 +24,7 @@
 ///***************************************************************************
 /// @endcond
 
-#include "cpputest_freertos_fake_queue.hpp"
+#include "cpputest_for_freertos_fake_queue.hpp"
 #include <cstring>
 #include "FreeRTOS.h"
 #include "queue.h"
diff --git a/cpputest-for-freertos-lib/src/cpputest_for_freertos_semaphore.cpp b/cpputest-for-freertos-lib/src/cpputest_for_freertos_semaphore.cpp
@@ -1,4 +1,4 @@
-#include "cpputest_freertos_fake_queue.hpp"
+#include "cpputest_for_freertos_fake_queue.hpp"
 #include <cstring>
 #include "queue.h"
 #include "semphr.h"
diff --git a/cpputest-for-freertos-lib/src/cpputest_for_freertos_task.cpp b/cpputest-for-freertos-lib/src/cpputest_for_freertos_task.cpp
@@ -28,7 +28,7 @@
 /// @endcond
 #include "FreeRTOS.h"
 #include "task.h"
-#include "cpputest_freertos_timers.hpp"
+#include "cpputest_for_freertos_timers.hpp"
 
 namespace cms {
 namespace test {
diff --git a/cpputest-for-freertos-lib/src/cpputest_for_freertos_timers.cpp b/cpputest-for-freertos-lib/src/cpputest_for_freertos_timers.cpp
diff --git a/cpputest-for-freertos-lib/tests/cpputest_freertos_assert_tests.cpp b/cpputest-for-freertos-lib/tests/cpputest_freertos_assert_tests.cpp
@@ -21,7 +21,7 @@
 ///***************************************************************************
 /// @endcond
 #include "CppUTest/TestHarness.h"
-#include "cpputest_freertos_assert.hpp"
+#include "cpputest_for_freertos_assert.hpp"
 
 TEST_GROUP(AssertTests)
 {
diff --git a/cpputest-for-freertos-lib/tests/cpputest_freertos_task_tests.cpp b/cpputest-for-freertos-lib/tests/cpputest_freertos_task_tests.cpp
@@ -22,8 +22,8 @@
 /// @endcond
 #include "FreeRTOS.h"
 #include "task.h"
-#include "cpputest_freertos_timers.hpp"
-#include "cpputest_freertos_task.hpp"
+#include "cpputest_for_freertos_timers.hpp"
+#include "cpputest_for_freertos_task.hpp"
 #include "CppUTest/TestHarness.h"
 
 TEST_GROUP(TaskTests)
diff --git a/cpputest-for-freertos-lib/tests/cpputest_freertos_timers_tests.cpp b/cpputest-for-freertos-lib/tests/cpputest_freertos_timers_tests.cpp
@@ -22,7 +22,7 @@
 /// @endcond
 #include "FreeRTOS.h"
 #include "timers.h"
-#include "cpputest_freertos_timers.hpp"
+#include "cpputest_for_freertos_timers.hpp"
 #include "CppUTest/TestHarness.h"
 #include "CppUTestExt/MockSupport.h"
 
diff --git a/example/services/buttonService/test/buttonServiceTests.cpp b/example/services/buttonService/test/buttonServiceTests.cpp
@@ -23,7 +23,7 @@ SOFTWARE.
 */
 
 #include "buttonService.h"
-#include "cpputest_freertos_task.hpp"
+#include "cpputest_for_freertos_lib.hpp"
 #include "mockButtonReader.hpp"
 #include "CppUTest/TestHarness.h"
 #include "CppUTestExt/MockSupport.h"
@@ -37,7 +37,7 @@ TEST_GROUP(HwLockCtrlServiceTests) {
     uint8_t testContextObject = 1;
 
     void setup() final {
-        cms::test::TaskInit();
+        cms::test::LibInitAll();
         mock("ButtonReader").expectOneCall("Init");
         ButtonService_Init();
         ButtonService_Start(EXECUTION_OPTION_UNIT_TEST);
@@ -55,12 +55,12 @@ TEST_GROUP(HwLockCtrlServiceTests) {
     void teardown() final {
         ButtonService_Destroy(); //ensure we are stopped/clean/destroyed.
         mock().clear();
-        cms::test::TaskDestroy();
+        cms::test::LibTeardownAll();
     }
 
     static void GiveProcessingTime() {
         //use our unit testing backdoor to service
-        //the active object's internal queue. This avoids threading issues
+        //the active object's internal semaphore. This avoids threading issues
         //with unit tests, creating 100% predictable unit tests.
         while (ButtonService_ProcessOneEvent(EXECUTION_OPTION_UNIT_TEST)) {}
     }
diff --git a/example/services/hwLockCtrlService/test/hwLockCtrlServiceTests.cpp b/example/services/hwLockCtrlService/test/hwLockCtrlServiceTests.cpp
@@ -22,9 +22,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 #include "hwLockCtrlService.h"
-#include "cpputest_freertos_timers.hpp"
-#include "cpputest_freertos_assert.hpp"
-#include "cpputest_freertos_task.hpp"
+#include "cpputest_for_freertos_lib.hpp"
 #include "CppUTest/TestHarness.h"
 #include "CppUTestExt/MockSupport.h"
 #include "hwLockCtrl.h"
@@ -61,8 +59,7 @@ TEST_GROUP(HwLockCtrlServiceTests)
 {
     void setup() final
     {
-        cms::test::TaskInit();
-        cms::test::TimersInit();
+        cms::test::LibInitAll();
         HLCS_Init();
         HLCS_RegisterChangeStateCallback(TestLockStateCallback);
         HLCS_RegisterSelfTestResultCallback(TestSelfTestResultCallback);
@@ -72,19 +69,18 @@ TEST_GROUP(HwLockCtrlServiceTests)
     {
         HLCS_Destroy(); //ensure we are stopped/clean/destroyed.
         mock().clear();
-        cms::test::TimersDestroy();
-        cms::test::TaskDestroy();
+        cms::test::LibTeardownAll();
     }
 
-    void GiveProcessingTime()
+    static void GiveProcessingTime()
     {
         //use our unit testing backdoor to service
         //the active object's internal queue. This avoids threading issues
         //with unit tests, creating 100% predictable unit tests.
-        while (true == HLCS_ProcessOneEvent(EXECUTION_OPTION_UNIT_TEST)) {}
+        while (HLCS_ProcessOneEvent(EXECUTION_OPTION_UNIT_TEST)) {}
     }
 
-    void StartServiceToLocked()
+    static void StartServiceToLocked()
     {
         mock(HW_LOCK_CTRL_MOCK).expectOneCall("Init");
         mock(HW_LOCK_CTRL_MOCK).expectOneCall("Lock");
@@ -95,7 +91,7 @@ TEST_GROUP(HwLockCtrlServiceTests)
         CHECK_TRUE(HLCS_LOCK_STATE_LOCKED == HLCS_GetState());
     }
 
-    void TestUnlock()
+    static void TestUnlock()
     {
         mock(HW_LOCK_CTRL_MOCK).expectOneCall("Unlock");
         mock(CB_MOCK).expectOneCall("LockStateCallback").withIntParameter("state", static_cast<int>(HLCS_LOCK_STATE_UNLOCKED));
@@ -105,7 +101,7 @@ TEST_GROUP(HwLockCtrlServiceTests)
         CHECK_TRUE(HLCS_LOCK_STATE_UNLOCKED == HLCS_GetState());
     }
 
-    void StartServiceToUnlocked()
+    static void StartServiceToUnlocked()
     {
         mock(HW_LOCK_CTRL_MOCK).expectOneCall("Init");
         mock(HW_LOCK_CTRL_MOCK).expectOneCall("Lock");

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@`
`21`	`21`	`/// [email protected]`
`22`	`22`	`///***************************************************************************`
`23`	`23`	`/// @endcond`
`24`		`-#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TASK_HPP`
`25`		`-#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TASK_HPP`
	`24`	`+#ifndef CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TASK_HPP`
	`25`	`+#define CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TASK_HPP`
`26`	`26`
`27`	`27`	`namespace cms {`
`28`	`28`	`namespace test {`
`@@ -41,4 +41,4 @@ namespace cms {`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`-#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FREERTOS_TASK_HPP`
	`44`	`+#endif //CPPUTEST_FOR_FREERTOS_LIB_CPPUTEST_FOR_FREERTOS_TASK_HPP`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#include "cpputest_freertos_fake_queue.hpp"`
	`1`	`+#include "cpputest_for_freertos_fake_queue.hpp"`
`2`	`2`	`#include <cstring>`
`3`	`3`	`#include "queue.h"`
`4`	`4`	`#include "semphr.h"`