Merge pull request #60 from thnkslprpt/fix-59-apply-consistent-event-id-names

dzbaker · web-flow · commit 0a9099fff80e · 2024-07-15T08:44:15.000-04:00
Fix #59, Apply consistent Event ID names to common events
diff --git a/fsw/inc/fm_events.h b/fsw/inc/fm_events.h
@@ -39,7 +39,7 @@
  *  This event message is issued after the File Manager application has
  *  successfully completed startup initialization.
  */
-#define FM_STARTUP_EID 1
+#define FM_INIT_INF_EID 1
 
 /**
  * \brief FM Initialization Register For Event Services Failed Event ID
@@ -71,7 +71,7 @@
  *  This is a fatal error that will cause the File Manager application
  *  to terminate.
  */
-#define FM_STARTUP_CREAT_PIPE_ERR_EID 3
+#define FM_CR_PIPE_ERR_EID 3
 
 /**
  * \brief FM Initialization Subscribe to HK Request Failed Event ID
@@ -188,7 +188,7 @@
  *  This event message is generated upon receipt of a housekeeping
  *  request command packet with an invalid length.
  */
-#define FM_HK_REQ_ERR_EID 11
+#define FM_HKREQ_LEN_ERR_EID 11
 
 /**
  * \brief FM No-op Command Event ID
@@ -200,7 +200,7 @@
  *  This event message signals the successful completion of a
  *  /FM_Noop command.
  */
-#define FM_NOOP_CMD_EID 12
+#define FM_NOOP_INF_EID 12
 
 /**
  * \brief FM No-op Command Length Invalid Event ID
@@ -227,7 +227,7 @@
  *  This event message signals the successful completion of a
  *  /FM_ResetCtrs command.
  */
-#define FM_RESET_CMD_EID 14
+#define FM_RESET_INF_EID 14
 
 /**
  * \brief FM Reset Counters Command Length Invalid Event ID
diff --git a/fsw/inc/fm_msgdefs.h b/fsw/inc/fm_msgdefs.h
@@ -44,7 +44,7 @@
  *       #FM_NoopCmd_t
  *
  *  \par Command Success Verification
- *       - Informational event #FM_NOOP_CMD_EID will be sent
+ *       - Informational event #FM_NOOP_INF_EID will be sent
  *       - #FM_HousekeepingPkt_Payload_t.CommandCounter will increment
  *
  *  \par Command Error Conditions
@@ -75,7 +75,7 @@
  *
  *  \par Command Success Verification
  *       - Command counters will be set to zero (see description)
- *       - Debug event #FM_RESET_CMD_EID will be sent
+ *       - Debug event #FM_RESET_INF_EID will be sent
  *
  *  \par Command Error Conditions
  *       - Invalid command packet length
diff --git a/fsw/src/fm_app.c b/fsw/src/fm_app.c
@@ -186,8 +186,8 @@ CFE_Status_t FM_AppInit(void)
         Result = CFE_SB_CreatePipe(&FM_GlobalData.CmdPipe, FM_APP_PIPE_DEPTH, FM_APP_PIPE_NAME);
         if (Result != CFE_SUCCESS)
         {
-            CFE_EVS_SendEvent(FM_STARTUP_CREAT_PIPE_ERR_EID, CFE_EVS_EventType_ERROR,
-                              "%s create SB input pipe: result = 0x%08X", ErrText, (unsigned int)Result);
+            CFE_EVS_SendEvent(FM_CR_PIPE_ERR_EID, CFE_EVS_EventType_ERROR, "%s create SB input pipe: result = 0x%08X",
+                              ErrText, (unsigned int)Result);
         }
         else
         {
@@ -229,7 +229,7 @@ CFE_Status_t FM_AppInit(void)
                 FM_ChildInit();
 
                 /* Application startup event message */
-                CFE_EVS_SendEvent(FM_STARTUP_EID, CFE_EVS_EventType_INFORMATION,
+                CFE_EVS_SendEvent(FM_INIT_INF_EID, CFE_EVS_EventType_INFORMATION,
                                   "Initialization complete: version %d.%d.%d.%d", FM_MAJOR_VERSION, FM_MINOR_VERSION,
                                   FM_REVISION, FM_MISSION_REV);
             }
diff --git a/fsw/src/fm_cmds.c b/fsw/src/fm_cmds.c
@@ -57,7 +57,7 @@ bool FM_NoopCmd(const CFE_SB_Buffer_t *BufPtr)
 {
     const char *CmdText = "No-op";
 
-    CFE_EVS_SendEvent(FM_NOOP_CMD_EID, CFE_EVS_EventType_INFORMATION, "%s command: FM version %d.%d.%d.%d", CmdText,
+    CFE_EVS_SendEvent(FM_NOOP_INF_EID, CFE_EVS_EventType_INFORMATION, "%s command: FM version %d.%d.%d.%d", CmdText,
                       FM_MAJOR_VERSION, FM_MINOR_VERSION, FM_REVISION, FM_MISSION_REV);
 
     return true;
@@ -81,7 +81,7 @@ bool FM_ResetCountersCmd(const CFE_SB_Buffer_t *BufPtr)
     FM_GlobalData.ChildCmdWarnCounter = 0;
 
     /* Send command completion event (debug) */
-    CFE_EVS_SendEvent(FM_RESET_CMD_EID, CFE_EVS_EventType_DEBUG, "%s command", CmdText);
+    CFE_EVS_SendEvent(FM_RESET_INF_EID, CFE_EVS_EventType_DEBUG, "%s command", CmdText);
 
     return true;
 }
diff --git a/fsw/src/fm_dispatch.c b/fsw/src/fm_dispatch.c
@@ -390,7 +390,7 @@ bool FM_SetPermissionsVerifyDispatch(const CFE_SB_Buffer_t *BufPtr)
 void FM_SendHkVerifyDispatch(const CFE_SB_Buffer_t *BufPtr)
 {
     /* Verify command packet length */
-    if (!FM_IsValidCmdPktLength(&BufPtr->Msg, sizeof(FM_SendHkCmd_t), FM_HK_REQ_ERR_EID, "HK Request"))
+    if (!FM_IsValidCmdPktLength(&BufPtr->Msg, sizeof(FM_SendHkCmd_t), FM_HKREQ_LEN_ERR_EID, "HK Request"))
     {
         return;
     }
diff --git a/unit-test/fm_app_tests.c b/unit-test/fm_app_tests.c
@@ -94,7 +94,7 @@ void Test_FM_AppMain_SBReceiveBufferDefaultOption(void)
     UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 3);
     UtAssert_STUB_COUNT(CFE_ES_ExitApp, 1);
     UtAssert_STUB_COUNT(CFE_SB_ReceiveBuffer, 1);
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_STARTUP_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, FM_SB_RECEIVE_ERR_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventType, CFE_EVS_EventType_ERROR);
@@ -168,7 +168,7 @@ void Test_FM_AppMain_BufPtrNotEqualNull(void)
     UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 2);
     UtAssert_STUB_COUNT(CFE_ES_ExitApp, 1);
     UtAssert_STUB_COUNT(CFE_SB_ReceiveBuffer, 1);
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_STARTUP_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, FM_EXIT_ERR_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventType, CFE_EVS_EventType_ERROR);
@@ -202,7 +202,7 @@ void Test_FM_AppInit_CreatePipeFail(void)
     UtAssert_STUB_COUNT(CFE_EVS_Register, 1);
     UtAssert_STUB_COUNT(CFE_EVS_SendEvent, 1);
     UtAssert_STUB_COUNT(CFE_SB_CreatePipe, 1);
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_STARTUP_CREAT_PIPE_ERR_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_CR_PIPE_ERR_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_ERROR);
 }
 
@@ -282,7 +282,7 @@ void Test_FM_AppInit_TableInitSuccess(void)
     UtAssert_STUB_COUNT(CFE_SB_CreatePipe, 1);
     UtAssert_STUB_COUNT(CFE_SB_Subscribe, 2);
     UtAssert_STUB_COUNT(FM_ChildInit, 1);
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_STARTUP_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
 }
 
diff --git a/unit-test/fm_cmds_tests.c b/unit-test/fm_cmds_tests.c
@@ -74,7 +74,7 @@ void Test_FM_NoopCmd_Success(void)
 
     UtAssert_INT32_EQ(call_count_CFE_EVS_SendEvent, 1);
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_NOOP_CMD_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_NOOP_INF_EID);
 
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
 
@@ -114,7 +114,7 @@ void Test_FM_ResetCountersCmd_Success(void)
 
     UtAssert_INT32_EQ(call_count_CFE_EVS_SendEvent, 1);
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_RESET_CMD_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, FM_RESET_INF_EID);
 
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_DEBUG);
 

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@`
`44`	`44`	`* #FM_NoopCmd_t`
`45`	`45`	`*`
`46`	`46`	`* \par Command Success Verification`
`47`		`- * - Informational event #FM_NOOP_CMD_EID will be sent`
	`47`	`+ * - Informational event #FM_NOOP_INF_EID will be sent`
`48`	`48`	`* - #FM_HousekeepingPkt_Payload_t.CommandCounter will increment`
`49`	`49`	`*`
`50`	`50`	`* \par Command Error Conditions`
`@@ -75,7 +75,7 @@`
`75`	`75`	`*`
`76`	`76`	`* \par Command Success Verification`
`77`	`77`	`* - Command counters will be set to zero (see description)`
`78`		`- * - Debug event #FM_RESET_CMD_EID will be sent`
	`78`	`+ * - Debug event #FM_RESET_INF_EID will be sent`
`79`	`79`	`*`
`80`	`80`	`* \par Command Error Conditions`
`81`	`81`	`* - Invalid command packet length`
Original file line number	Diff line number	Diff line change
`@@ -186,8 +186,8 @@ CFE_Status_t FM_AppInit(void)`
`186`	`186`	`Result = CFE_SB_CreatePipe(&FM_GlobalData.CmdPipe, FM_APP_PIPE_DEPTH, FM_APP_PIPE_NAME);`
`187`	`187`	`if (Result != CFE_SUCCESS)`
`188`	`188`	`{`
`189`		`- CFE_EVS_SendEvent(FM_STARTUP_CREAT_PIPE_ERR_EID, CFE_EVS_EventType_ERROR,`
`190`		`- "%s create SB input pipe: result = 0x%08X", ErrText, (unsigned int)Result);`
	`189`	`+ CFE_EVS_SendEvent(FM_CR_PIPE_ERR_EID, CFE_EVS_EventType_ERROR, "%s create SB input pipe: result = 0x%08X",`
	`190`	`+ ErrText, (unsigned int)Result);`
`191`	`191`	`}`
`192`	`192`	`else`
`193`	`193`	`{`
`@@ -229,7 +229,7 @@ CFE_Status_t FM_AppInit(void)`
`229`	`229`	`FM_ChildInit();`
`230`	`230`
`231`	`231`	`/* Application startup event message */`
`232`		`- CFE_EVS_SendEvent(FM_STARTUP_EID, CFE_EVS_EventType_INFORMATION,`
	`232`	`+ CFE_EVS_SendEvent(FM_INIT_INF_EID, CFE_EVS_EventType_INFORMATION,`
`233`	`233`	`"Initialization complete: version %d.%d.%d.%d", FM_MAJOR_VERSION, FM_MINOR_VERSION,`
`234`	`234`	`FM_REVISION, FM_MISSION_REV);`
`235`	`235`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ bool FM_NoopCmd(const CFE_SB_Buffer_t *BufPtr)`
`57`	`57`	`{`
`58`	`58`	`const char *CmdText = "No-op";`
`59`	`59`
`60`		`- CFE_EVS_SendEvent(FM_NOOP_CMD_EID, CFE_EVS_EventType_INFORMATION, "%s command: FM version %d.%d.%d.%d", CmdText,`
	`60`	`+ CFE_EVS_SendEvent(FM_NOOP_INF_EID, CFE_EVS_EventType_INFORMATION, "%s command: FM version %d.%d.%d.%d", CmdText,`
`61`	`61`	`FM_MAJOR_VERSION, FM_MINOR_VERSION, FM_REVISION, FM_MISSION_REV);`
`62`	`62`
`63`	`63`	`return true;`
`@@ -81,7 +81,7 @@ bool FM_ResetCountersCmd(const CFE_SB_Buffer_t *BufPtr)`
`81`	`81`	`FM_GlobalData.ChildCmdWarnCounter = 0;`
`82`	`82`
`83`	`83`	`/* Send command completion event (debug) */`
`84`		`- CFE_EVS_SendEvent(FM_RESET_CMD_EID, CFE_EVS_EventType_DEBUG, "%s command", CmdText);`
	`84`	`+ CFE_EVS_SendEvent(FM_RESET_INF_EID, CFE_EVS_EventType_DEBUG, "%s command", CmdText);`
`85`	`85`
`86`	`86`	`return true;`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -390,7 +390,7 @@ bool FM_SetPermissionsVerifyDispatch(const CFE_SB_Buffer_t *BufPtr)`
`390`	`390`	`void FM_SendHkVerifyDispatch(const CFE_SB_Buffer_t *BufPtr)`
`391`	`391`	`{`
`392`	`392`	`/* Verify command packet length */`
`393`		`- if (!FM_IsValidCmdPktLength(&BufPtr->Msg, sizeof(FM_SendHkCmd_t), FM_HK_REQ_ERR_EID, "HK Request"))`
	`393`	`+ if (!FM_IsValidCmdPktLength(&BufPtr->Msg, sizeof(FM_SendHkCmd_t), FM_HKREQ_LEN_ERR_EID, "HK Request"))`
`394`	`394`	`{`
`395`	`395`	`return;`
`396`	`396`	`}`