Fix nasa#296, Consistent CFE_EVS_SendEvent handling in UT

unit-test/CMakeLists.txt

@@ -61,7 +61,7 @@ add_cfe_coverage_stubs(cf_internal
   stubs/cf_utils_stubs.c
 )
 
-target_link_libraries(coverage-cf_internal-stubs core_api ut_assert)
+target_link_libraries(coverage-cf_internal-stubs ut_core_api_stubs ut_assert)
 target_include_directories(coverage-cf_internal-stubs PUBLIC utilities)
 
 # Generate a dedicated "testrunner" executable for each test file

unit-test/cf_app_tests.c

@@ -296,7 +296,6 @@ void Test_CF_TableInit_FailBecause_CFE_TBL_Register_DidNotReturnSuccess(void)
     int32 result = -1;
 
     UT_SetDefaultReturnValue(UT_KEY(CFE_TBL_Register), result);
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
 
     /* Act */
     UtAssert_INT32_EQ(CF_TableInit(), result);
@@ -311,7 +310,6 @@ void Test_CF_TableInit_FailBecause_CFE_TBL_Load_DidNotReturnSuccess(void)
     int32 result = -1;
 
     UT_SetDefaultReturnValue(UT_KEY(CFE_TBL_Load), result);
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
 
     /* Act */
     UtAssert_INT32_EQ(CF_TableInit(), result);
@@ -327,7 +325,6 @@ void Test_CF_TableInit_FailBecause_CFE_TBL_Manage_DidNotReturnSuccess(void)
 
     /* Arrange */
     UT_SetDefaultReturnValue(UT_KEY(CFE_TBL_Manage), result);
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
 
     /* Act */
     UtAssert_INT32_EQ(CF_TableInit(), result);
@@ -343,7 +340,6 @@ void Test_CF_TableInit_FailBecause_CFE_TBL_GetAddress_DidNotReturnSuccess(void)
 
     /* Arrange */
     UT_SetDefaultReturnValue(UT_KEY(CFE_TBL_GetAddress), result);
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
 
     /* Act */
     UtAssert_INT32_EQ(CF_TableInit(), result);
@@ -591,7 +587,6 @@ void Test_CF_ProcessMsg_UnrecognizedCommandEnterDefaultPath(void)
     CFE_SB_Buffer_t *arg_msg      = NULL;
 
     UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &forced_MsgID, sizeof(forced_MsgID), false);
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
 
     /* Act */
     CF_ProcessMsg(arg_msg);
@@ -633,18 +628,14 @@ void Test_CF_AppMain_CallTo_CF_Init_DoNotReturn_CFE_SUCCESS_Set_CF_AppData_run_s
 void Test_CF_AppMain_CFE_SB_ReceiveBuffer_Cases(void)
 {
     CFE_SB_Buffer_t  sbbuf;
-    CFE_SB_Buffer_t *sbbufptr  = NULL;
-    uint16           events[2] = {0};
+    CFE_SB_Buffer_t *sbbufptr = NULL;
 
     memset(&sbbuf, 0, sizeof(sbbuf));
 
     /* Run loop once */
     UT_SetDeferredRetcode(UT_KEY(CFE_ES_RunLoop), 1, true);
     UT_SetDefaultReturnValue(UT_KEY(CFE_ES_RunLoop), false);
 
-    /* Capture events */
-    UT_SetDataBuffer(UT_KEY(CFE_EVS_SendEvent), events, sizeof(events), false);
-
     /* Unit under test does not use the buffer in this case */
     UT_SetDataBuffer(UT_KEY(CFE_SB_ReceiveBuffer), &sbbufptr, sizeof(sbbufptr), false);
 
@@ -660,26 +651,24 @@ void Test_CF_AppMain_CFE_SB_ReceiveBuffer_Cases(void)
 
     /* Event from CF_Init and CF_AppMain */
     UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 2);
-    UtAssert_UINT32_EQ(events[0], CF_EID_INF_INIT);
-    UtAssert_UINT32_EQ(events[1], CF_EID_ERR_INIT_MSG_RECV);
+    UtAssert_UINT32_EQ(UT_CF_CapturedEventIDs[0], CF_EID_INF_INIT);
+    UtAssert_UINT32_EQ(UT_CF_CapturedEventIDs[1], CF_EID_ERR_INIT_MSG_RECV);
 
     /* Reset, return CFE_SUCCESS from CFE_SB_ReceiveBuffer and buffer NULL */
-    UT_ResetState(UT_KEY(CFE_EVS_SendEvent));
-    UT_SetDataBuffer(UT_KEY(CFE_EVS_SendEvent), events, sizeof(events), false);
+    UT_CF_ResetEventCapture();
     UT_SetDataBuffer(UT_KEY(CFE_SB_ReceiveBuffer), &sbbufptr, sizeof(sbbufptr), false);
     UT_SetDeferredRetcode(UT_KEY(CFE_ES_RunLoop), 1, true);
 
     UtAssert_VOIDCALL(CF_AppMain());
 
     /* Event from CF_Init and CF_AppMain */
     UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 2);
-    UtAssert_UINT32_EQ(events[0], CF_EID_INF_INIT);
-    UtAssert_UINT32_EQ(events[1], CF_EID_ERR_INIT_MSG_RECV);
+    UtAssert_UINT32_EQ(UT_CF_CapturedEventIDs[0], CF_EID_INF_INIT);
+    UtAssert_UINT32_EQ(UT_CF_CapturedEventIDs[1], CF_EID_ERR_INIT_MSG_RECV);
 
     /* Reset, return non-error codes and non-NULL buffer */
-    UT_ResetState(UT_KEY(CFE_EVS_SendEvent));
+    UT_CF_ResetEventCapture();
     UT_ResetState(UT_KEY(CFE_ES_RunLoop));
-    UT_SetDataBuffer(UT_KEY(CFE_EVS_SendEvent), events, sizeof(events), false);
     sbbufptr = &sbbuf;
     UT_SetDataBuffer(UT_KEY(CFE_SB_ReceiveBuffer), &sbbufptr, sizeof(sbbufptr), false);
     UT_SetDeferredRetcode(UT_KEY(CFE_ES_RunLoop), 1, true);
@@ -691,7 +680,7 @@ void Test_CF_AppMain_CFE_SB_ReceiveBuffer_Cases(void)
 
     /* Event from CF_Init */
     UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 1);
-    UtAssert_UINT32_EQ(events[0], CF_EID_INF_INIT);
+    UtAssert_UINT32_EQ(UT_CF_CapturedEventIDs[0], CF_EID_INF_INIT);
     UtAssert_STUB_COUNT(CFE_ES_RunLoop, 3);
 }
 

unit-test/cf_cfdp_dispatch_tests.c

@@ -94,7 +94,7 @@ static void UT_CFDP_Dispatch_SetupBasicTestState(UT_CF_Setup_t setup, CF_Logical
     }
 
     /* reset the event ID capture between each sub-case */
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
+    UT_CF_ResetEventCapture();
 }
 
 /*******************************************************************************

unit-test/cf_cfdp_r_tests.c

@@ -113,7 +113,7 @@ static void UT_CFDP_R_SetupBasicTestState(UT_CF_Setup_t setup, CF_Logical_PduBuf
     }
 
     /* reset the event ID capture between each sub-case */
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
+    UT_CF_ResetEventCapture();
 }
 
 /*******************************************************************************
@@ -368,7 +368,7 @@ void Test_CF_CFDP_R_Init(void)
     t->flags.rx.md_recv = true;
     UtAssert_VOIDCALL(CF_CFDP_R_Init(t));
     UtAssert_STUB_COUNT(CF_CFDP_ArmAckTimer, 2);
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 
     /* failure of file open, class 1 */
     UT_CFDP_R_SetupBasicTestState(UT_CF_Setup_RX, NULL, NULL, NULL, &t, NULL);
@@ -478,7 +478,7 @@ void Test_CF_CFDP_R_CheckCrc(void)
     UT_CFDP_R_SetupBasicTestState(UT_CF_Setup_RX, NULL, NULL, NULL, &t, NULL);
     t->crc.result = 0xc0ffee;
     UtAssert_INT32_EQ(CF_CFDP_R_CheckCrc(t, 0xc0ffee), 0);
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 }
 
 void Test_CF_CFDP_R2_Complete(void)

unit-test/cf_cfdp_s_tests.c

@@ -136,7 +136,7 @@ static void UT_CFDP_S_SetupBasicTestState(UT_CF_Setup_t setup, CF_Logical_PduBuf
     }
 
     /* reset the event ID capture between each sub-case */
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
+    UT_CF_ResetEventCapture();
 }
 
 /*******************************************************************************
@@ -664,7 +664,7 @@ void Test_CF_CFDP_S_SubstateSendMetadata(void)
     UT_CFDP_S_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, NULL);
     OS_OpenCreate(&t->fd, "ut", 0, 0); /* sets fd */
     UtAssert_VOIDCALL(CF_CFDP_S_SubstateSendMetadata(t));
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
     UtAssert_UINT32_EQ(t->state_data.s.sub_state, CF_TxSubState_FILEDATA);
 
     /* this retval is sticky and applies for the rest of the test cases */
@@ -705,7 +705,7 @@ void Test_CF_CFDP_S_SubstateSendMetadata(void)
     UT_CFDP_S_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, NULL);
     UT_SetDeferredRetcode(UT_KEY(CF_CFDP_SendMd), 1, CF_SendRet_NO_MSG);
     UtAssert_VOIDCALL(CF_CFDP_S_SubstateSendMetadata(t));
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
     UtAssert_UINT32_EQ(t->history->cc, 0);
 
     /* everything works */

unit-test/cf_cfdp_sbintf_tests.c

@@ -173,7 +173,7 @@ static void UT_CFDP_SetupBasicTestState(UT_CF_Setup_t setup, CF_Logical_PduBuffe
     }
 
     /* reset the event ID capture between each sub-case */
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
+    UT_CF_ResetEventCapture();
 }
 
 /* end cf_cfdp_tests local utility functions */
@@ -333,20 +333,20 @@ void Test_CF_CFDP_MsgOutGet(void)
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, NULL);
     UtAssert_NOT_NULL(CF_CFDP_MsgOutGet(t, false));
     UtAssert_STUB_COUNT(CFE_SB_ReleaseMessageBuffer, 0);
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 
     /* This should discard the old message, and get a new one */
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, NULL);
     UtAssert_NOT_NULL(CF_CFDP_MsgOutGet(t, false));
     UtAssert_STUB_COUNT(CFE_SB_ReleaseMessageBuffer, 1);
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 
     /* test the various throttling mechanisms */
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, &config);
     config->chan[UT_CFDP_CHANNEL].max_outgoing_messages_per_wakeup = 3;
     UtAssert_NOT_NULL(CF_CFDP_MsgOutGet(t, false));
     UtAssert_NULL(CF_CFDP_MsgOutGet(t, false));
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_TX, NULL, &c, NULL, &t, NULL);
     c->sem_id = OS_ObjectIdFromInteger(123);
@@ -359,13 +359,13 @@ void Test_CF_CFDP_MsgOutGet(void)
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, NULL);
     t->flags.com.suspended = 1;
     UtAssert_NULL(CF_CFDP_MsgOutGet(t, false));
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 
     /* channel is frozen */
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_TX, NULL, NULL, NULL, &t, NULL);
     CF_AppData.hk.channel_hk[UT_CFDP_CHANNEL].frozen = 1;
     UtAssert_NULL(CF_CFDP_MsgOutGet(t, false));
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
     CF_AppData.hk.channel_hk[UT_CFDP_CHANNEL].frozen = 0;
 
     /* no msg available from SB */
@@ -376,7 +376,7 @@ void Test_CF_CFDP_MsgOutGet(void)
     /* same, but the silent flag should supress the event */
     UT_CFDP_SetupBasicTestState(UT_CF_Setup_NONE, NULL, NULL, NULL, &t, NULL);
     UtAssert_NULL(CF_CFDP_MsgOutGet(t, true));
-    UT_CF_AssertEventID(0);
+    UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 0);
 }
 
 /*******************************************************************************

unit-test/cf_cfdp_tests.c

@@ -141,7 +141,7 @@ static void UT_CFDP_SetupBasicTestState(UT_CF_Setup_t setup, CF_Logical_PduBuffe
     }
 
     /* reset the event ID capture between each sub-case */
-    UT_CF_ResetEventCapture(UT_KEY(CFE_EVS_SendEvent));
+    UT_CF_ResetEventCapture();
 }
 
 /* end cf_cfdp_tests local utility functions */