add example timer behavior to the hw lock ctrl service, demonstrating time movement.

Also test an assert.

Author: mattheweshleman

example/services/hwLockCtrlService/src/hwLockCtrlService.c

@@ -28,6 +28,7 @@ SOFTWARE.
 #include "FreeRTOS.h"
 #include "task.h"
 #include "queue.h"
+#include "timers.h"
 
 typedef enum Signal
 {
@@ -36,6 +37,7 @@ typedef enum Signal
     SIG_REQUEST_LOCKED,
     SIG_REQUEST_UNLOCKED,
     SIG_REQUEST_SELF_TEST,
+    SIG_REQUEST_CURRENT_CHECK,
     SIG_REQUEST_THREAD_EXIT
 } SignalT;
 
@@ -58,6 +60,8 @@ static void* HLCS_SmLocked(const HLCS_EventTypeT* const event);
 static void* HLCS_SmUnlocked(const HLCS_EventTypeT* const event);
 static void* HLCS_SmSelfTest(const HLCS_EventTypeT* const event);
 static void HLCS_Task(void*);
+static void HLCS_CheckCurrentTimerCallback( TimerHandle_t xTimer );
+static void HLCS_DoCurrentCheck();
 
 //constants
 static const size_t QueueDepth = 10;
@@ -74,6 +78,7 @@ static HLCS_ChangeStateCallback s_stateChangedCallback = NULL;
 static HLCS_SelfTestResultCallback s_selfTestResultCallback = NULL;
 static HLCS_StateMachineFunc s_currentState = NULL;
 static HLCS_StateMachineFunc s_stateHistory = NULL;
+static TimerHandle_t s_timer = NULL;
 
 //internal macros for state machine readability
 #define TransitionTo(x) (x)
@@ -85,6 +90,7 @@ void HLCS_Init()
     configASSERT(s_lockState == HLCS_LOCK_STATE_UNKNOWN);
     configASSERT(s_thread == NULL);
     configASSERT(s_eventQueue == NULL);
+    configASSERT(s_timer == NULL);
     configASSERT(s_stateChangedCallback == NULL);
     configASSERT(s_selfTestResultCallback == NULL);
     configASSERT(s_currentState == NULL);
@@ -94,6 +100,10 @@ void HLCS_Init()
     s_eventQueue = xQueueCreate(QueueDepth, sizeof(HLCS_EventTypeT));
     configASSERT(s_eventQueue != 0);
 
+    s_timer = xTimerCreate("current", pdMS_TO_TICKS(5000), pdTRUE,
+                           NULL, HLCS_CheckCurrentTimerCallback);
+    configASSERT(s_timer != 0);
+
     //thread is created in Start()
 }
 
@@ -106,6 +116,11 @@ void HLCS_Destroy()
         vTaskDelete(s_thread);
         vQueueDelete(s_eventQueue);
     }
+    if (s_timer != NULL)
+    {
+        xTimerDelete(s_timer, 1000);
+        s_timer = NULL;
+    }
     s_lockState = HLCS_LOCK_STATE_UNKNOWN;
     s_eventQueue = NULL;
     s_stateChangedCallback = NULL;
@@ -130,6 +145,10 @@ void HLCS_Start(ExecutionOptionT option)
     {
         HLCS_SmInitialize();
     }
+
+    BaseType_t rtn = xTimerStart(s_timer, 1000);
+    configASSERT(rtn == pdPASS);
+
 }
 
 HLCS_LockStateT HLCS_GetState()
@@ -284,6 +303,10 @@ void* HLCS_SmLocked(const HLCS_EventTypeT* const event)
     case SIG_REQUEST_SELF_TEST:
         rtn = TransitionTo(HLCS_SmSelfTest);
         break;
+    case SIG_REQUEST_CURRENT_CHECK:
+        HLCS_DoCurrentCheck();
+        rtn = Handled();
+        break;
     default:
         rtn = Handled();
         break;
@@ -315,6 +338,10 @@ void* HLCS_SmUnlocked(const HLCS_EventTypeT* const event)
     case SIG_REQUEST_SELF_TEST:
         rtn = TransitionTo(HLCS_SmSelfTest);
         break;
+    case SIG_REQUEST_CURRENT_CHECK:
+        HLCS_DoCurrentCheck();
+        rtn = Handled();
+        break;
     default:
         rtn = Handled();
         break;
@@ -386,3 +413,14 @@ void HLCS_Task(void* params)
         HLCS_ProcessOneEvent(EXECUTION_OPTION_NORMAL);
     }
 }
+
+void HLCS_CheckCurrentTimerCallback( TimerHandle_t xTimer )
+{
+    HLCS_PushEvent(SIG_REQUEST_CURRENT_CHECK);
+}
+
+void HLCS_DoCurrentCheck()
+{
+    int32_t milliamps = HwLockCtrlReadCurrent();
+    configASSERT(milliamps < 2000);
+}

example/services/hwLockCtrlService/test/hwLockCtrlServiceTests.cpp

@@ -22,13 +22,17 @@ 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/TestHarness.h"
 #include "CppUTestExt/MockSupport.h"
 #include "hwLockCtrl.h"
 
 static constexpr const char* HW_LOCK_CTRL_MOCK = "HwLockCtrl";
 static constexpr const char* CB_MOCK = "TestCb";
 
+using namespace std::chrono_literals;
+
 static void TestLockStateCallback(HLCS_LockStateT state)
 {
     mock(CB_MOCK).actualCall("LockStateCallback").withIntParameter("state", static_cast<int>(state));
@@ -56,6 +60,7 @@ TEST_GROUP(HwLockCtrlServiceTests)
 {
     void setup() final
     {
+        cms::test::InitFakeTimers();
         HLCS_Init();
         HLCS_RegisterChangeStateCallback(TestLockStateCallback);
         HLCS_RegisterSelfTestResultCallback(TestSelfTestResultCallback);
@@ -65,6 +70,7 @@ TEST_GROUP(HwLockCtrlServiceTests)
     {
         HLCS_Destroy(); //ensure we are stopped/clean/destroyed.
         mock().clear();
+        cms::test::DestroyFakeTimers();
     }
 
     void GiveProcessingTime()
@@ -201,14 +207,20 @@ TEST(HwLockCtrlServiceTests, given_unlocked_when_selftest_request_which_fails_th
     mock().checkExpectations();
 }
 
-TEST(HwLockCtrlServiceTests, rapid_create_start_destroy_handles_real_thread_correctly)
-{
-    //just make sure we don't see a crash or other hang or
-    //unexpected behavior.
-    mock().ignoreOtherCalls();
-    HLCS_Start(EXECUTION_OPTION_NORMAL);
-    HLCS_Destroy();
-    HLCS_Init();
-    HLCS_Start(EXECUTION_OPTION_NORMAL);
-    HLCS_Destroy();
+TEST(HwLockCtrlServiceTests, given_unlocked_when_5_secs_passes_then_checks_current) {
+    StartServiceToUnlocked();
+    mock(HW_LOCK_CTRL_MOCK).expectOneCall("ReadCurrent").andReturnValue(100);
+    cms::test::MoveTimeForward(5s);
+    GiveProcessingTime();
+    mock().checkExpectations();
+}
+
+TEST(HwLockCtrlServiceTests, if_current_exceeds_2amps_will_assert) {
+    StartServiceToUnlocked();
+    mock(HW_LOCK_CTRL_MOCK).expectOneCall("ReadCurrent").andReturnValue(2001);
+    cms::test::AssertOutputDisable();
+    cms::test::MockExpectAssert();
+    cms::test::MoveTimeForward(5s);
+    GiveProcessingTime();
+    mock().checkExpectations();
 }