Fix #50, Apply consistent Event ID names to common events

nasa · Apr 6, 2023 · 0a7a50d · 0a7a50d
1 parent da7a5ff
commit 0a7a50d
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 33 deletions.
diff --git a/config/default_hs_msgdefs.h b/config/default_hs_msgdefs.h
@@ -62,7 +62,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -84,7 +84,7 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdCount will be cleared
- *       - The #HS_RESET_DBG_EID debug event message will be
+ *       - The #HS_RESET_INF_EID debug event message will be
  *         generated when the command is executed
  *
  *  \par Error Conditions
@@ -93,7 +93,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -125,7 +125,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -157,7 +157,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -189,7 +189,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -221,7 +221,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -253,7 +253,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -285,7 +285,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -317,7 +317,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -349,7 +349,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -381,7 +381,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None
@@ -413,7 +413,7 @@
  *
  *  \par Evidence of failure may be found in the following telemetry:
  *       - #HS_HkTlm_Payload_t.CmdErrCount will increment
- *       - Error specific event message #HS_LEN_ERR_EID
+ *       - Error specific event message #HS_CMD_LEN_ERR_EID
  *
  *  \par Criticality
  *       None

diff --git a/fsw/inc/hs_events.h b/fsw/inc/hs_events.h
@@ -39,7 +39,7 @@
  *  This event message is issued when the CFS Health and Safety has
  *  completed initialization.
  */
-#define HS_INIT_EID 1
+#define HS_INIT_INF_EID 1
 
 /**
  * \brief HS Application Fatal Termination Event ID
@@ -76,7 +76,7 @@
  *  is unable to create its command pipe via the #CFE_SB_CreatePipe
  *  API
  */
-#define HS_CR_CMD_PIPE_ERR_EID 4
+#define HS_CR_PIPE_ERR_EID 4
 
 /**
  * \brief HS Create Software Bus Event Pipe Failed Event ID
@@ -297,7 +297,7 @@
  *  This event message is issued when a ground command message is received
  *  with a message length that doesn't match the expected value.
  */
-#define HS_LEN_ERR_EID 22
+#define HS_CMD_LEN_ERR_EID 22
 
 /**
  * \brief HS No-op Command Event ID
@@ -313,14 +313,14 @@
 /**
  * \brief HS Reset Counters Command Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATIONAL
  *
  *  \par Cause:
  *
  *  This event message is issued when a reset counters command has
  *  been received.
  */
-#define HS_RESET_DBG_EID 24
+#define HS_RESET_INF_EID 24
 
 /**
  * \brief HS Enable Application Monitoring Command Event ID

diff --git a/fsw/src/hs_app.c b/fsw/src/hs_app.c
@@ -330,7 +330,7 @@ int32 HS_AppInit(void)
     /*
     ** Application initialization event
     */
-    CFE_EVS_SendEvent(HS_INIT_EID, CFE_EVS_EventType_INFORMATION, "HS Initialized.  Version %d.%d.%d.%d",
+    CFE_EVS_SendEvent(HS_INIT_INF_EID, CFE_EVS_EventType_INFORMATION, "HS Initialized.  Version %d.%d.%d.%d",
                       HS_MAJOR_VERSION, HS_MINOR_VERSION, HS_REVISION, HS_MISSION_REV);
 
     return Status;
@@ -353,7 +353,7 @@ int32 HS_SbInit(void)
     Status = CFE_SB_CreatePipe(&HS_AppData.CmdPipe, HS_CMD_PIPE_DEPTH, HS_CMD_PIPE_NAME);
     if (Status != CFE_SUCCESS)
     {
-        CFE_EVS_SendEvent(HS_CR_CMD_PIPE_ERR_EID, CFE_EVS_EventType_ERROR, "Error Creating SB Command Pipe,RC=0x%08X",
+        CFE_EVS_SendEvent(HS_CR_PIPE_ERR_EID, CFE_EVS_EventType_ERROR, "Error Creating SB Command Pipe,RC=0x%08X",
                           (unsigned int)Status);
         return Status;
     }

diff --git a/fsw/src/hs_cmds.c b/fsw/src/hs_cmds.c
@@ -209,7 +209,7 @@ void HS_ResetCmd(const CFE_SB_Buffer_t *BufPtr)
 {
     HS_ResetCounters();
 
-    CFE_EVS_SendEvent(HS_RESET_DBG_EID, CFE_EVS_EventType_DEBUG, "Reset counters command");
+    CFE_EVS_SendEvent(HS_RESET_INF_EID, CFE_EVS_EventType_DEBUG, "Reset counters command");
 }
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

diff --git a/unit-test/hs_app_tests.c b/unit-test/hs_app_tests.c
@@ -301,7 +301,7 @@ void HS_AppMain_Test_NominalRcvMsgError(void)
     UtAssert_True(HS_AppData.EventsMonitoredCount == 1, "HS_AppData.EventsMonitoredCount == 1");
 
     /* Verify results */
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_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, HS_APP_EXIT_EID);
@@ -422,7 +422,7 @@ void HS_AppMain_Test_SBSubscribeEVSLongError(void)
     UtAssert_True(call_count_CFE_EVS_SendEvent == 3, "CFE_EVS_SendEvent was called %u time(s), expected 3",
                   call_count_CFE_EVS_SendEvent);
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_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, HS_SUB_LONG_EVS_ERR_EID);
@@ -473,7 +473,7 @@ void HS_AppMain_Test_SBSubscribeEVSShortError(void)
     HS_AppMain();
 
     /* Verify results */
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_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, HS_SUB_SHORT_EVS_ERR_EID);
@@ -558,7 +558,7 @@ void HS_AppMain_Test_StateDisabled(void)
     HS_AppMain();
 
     /* Verify results */
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
 
     call_count_CFE_EVS_SendEvent = UT_GetStubCount(UT_KEY(CFE_EVS_SendEvent));
@@ -735,7 +735,7 @@ void HS_AppInit_Test_CorruptCDSResetsPerformed(void)
 
     UtAssert_True(strCmpResult == 0, "Event string matched expected result, '%s'", context_CFE_EVS_SendEvent[0].Spec);
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, HS_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventType, CFE_EVS_EventType_INFORMATION);
 
     strCmpResult =
@@ -867,7 +867,7 @@ void HS_AppInit_Test_CorruptCDSNoEvent(void)
     UtAssert_True(HS_AppData.CurrentCPUHogState == HS_CPUHOG_DEFAULT_STATE,
                   "HS_AppData.CurrentCPUHogState == HS_CPUHOG_DEFAULT_STATE");
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
 
     call_count_CFE_EVS_SendEvent = UT_GetStubCount(UT_KEY(CFE_EVS_SendEvent));
@@ -915,7 +915,7 @@ void HS_AppInit_Test_RestoreCDSError(void)
 
     UtAssert_True(strCmpResult == 0, "Event string matched expected result, '%s'", context_CFE_EVS_SendEvent[0].Spec);
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventID, HS_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[1].EventType, CFE_EVS_EventType_INFORMATION);
 
     strCmpResult =
@@ -971,7 +971,7 @@ void HS_AppInit_Test_DisableSavingToCDS(void)
     UtAssert_True(HS_AppData.CurrentCPUHogState == HS_CPUHOG_DEFAULT_STATE,
                   "HS_AppData.CurrentCPUHogState == HS_CPUHOG_DEFAULT_STATE");
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_INIT_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
     strCmpResult =
         strncmp(ExpectedEventString[0], context_CFE_EVS_SendEvent[0].Spec, CFE_MISSION_EVS_MAX_MESSAGE_LENGTH);
@@ -1028,7 +1028,7 @@ void HS_AppInit_Test_SBInitError(void)
 
     /* This event message is not generated directly by the function under test, but it's useful to check for it to
      * ensure that an SB init error occurred rather than a TBL init error */
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_CR_CMD_PIPE_ERR_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_CR_PIPE_ERR_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_ERROR);
     strCmpResult =
         strncmp(ExpectedEventString[0], context_CFE_EVS_SendEvent[0].Spec, CFE_MISSION_EVS_MAX_MESSAGE_LENGTH);
@@ -1189,7 +1189,7 @@ void HS_SbInit_Test_CreateSBCmdPipeError(void)
     UT_SetDataBuffer(UT_KEY(CFE_SB_CreatePipe), &PipeId, sizeof(PipeId), false);
     UT_SetDataBuffer(UT_KEY(CFE_SB_CreatePipe), &PipeId, sizeof(PipeId), false);
 
-    /* Set CFE_SB_CreatePipe to return -1 on first call, to generate error HS_CR_CMD_PIPE_ERR_EID */
+    /* Set CFE_SB_CreatePipe to return -1 on first call, to generate error HS_CR_PIPE_ERR_EID */
     UT_SetDeferredRetcode(UT_KEY(CFE_SB_CreatePipe), 1, -1);
 
     /* Execute the function being tested */
@@ -1200,7 +1200,7 @@ void HS_SbInit_Test_CreateSBCmdPipeError(void)
     UtAssert_BOOL_FALSE(CFE_RESOURCEID_TEST_DEFINED(HS_AppData.EventPipe));
     UtAssert_BOOL_FALSE(CFE_RESOURCEID_TEST_DEFINED(HS_AppData.WakeupPipe));
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_CR_CMD_PIPE_ERR_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_CR_PIPE_ERR_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_ERROR);
 
     strCmpResult =

diff --git a/unit-test/hs_cmds_tests.c b/unit-test/hs_cmds_tests.c
@@ -1034,7 +1034,7 @@ void HS_ResetCmd_Test(void)
     /* Verify results */
     UtAssert_True(HS_AppData.CmdCount == 0, "HS_AppData.CmdCount == 0");
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_RESET_DBG_EID);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HS_RESET_INF_EID);
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_DEBUG);
 
     strCmpResult =