Merge pull request #67 from thnkslprpt/fix-66-update-reset-counters-event-type

Fix #66, Update Reset Counters event type to INFO

Author: dzbaker

.github/pull_request_template.md

@@ -10,7 +10,7 @@ A clear and concise description of what the contribution is.
 **Testing performed**
 Steps taken to test the contribution:
 1. Build steps '...'
-1. Execution steps '...'
+2. Execution steps '...'
 
 **Expected behavior changes**
 A clear and concise description of how this contribution will change behavior and level of impact.

.github/workflows/codeql-build.yml

@@ -3,14 +3,14 @@ name: CodeQl Analysis
 on:
   push:
   pull_request:
-  
+
 
 jobs:
   codeql:
     name: Codeql Analysis
     uses: nasa/cFS/.github/workflows/codeql-reusable.yml@main
     with:
-      component-path: apps/hk 
+      component-path: apps/hk
       prep: 'make prep; make -C build/tools/elf2cfetbl'
       make: 'make -C build/native/default_cpu1/apps/hk'
       setup: |

.github/workflows/format-check.yml

@@ -9,4 +9,3 @@ jobs:
   format-check:
     name: Run format check
     uses: nasa/cFS/.github/workflows/format-check.yml@main
-    

.github/workflows/static-analysis.yml

@@ -10,4 +10,4 @@ jobs:
     name: Run cppcheck
     uses: nasa/cFS/.github/workflows/static-analysis.yml@main
     with:
-      strict-dir-list: './fsw'    
+      strict-dir-list: './fsw'

docs/dox_src/cfs_hk.dox

@@ -54,7 +54,7 @@
 
   This document provides a complete specification for the commands and telemetry associated
   with the CFS Housekeeping (HK) application software.  The document is intended primarily
-  for users of the software (operations personal, test engineers, and maintenance personnel).
+  for users of the software (operations personnel, test engineers, and maintenance personnel).
   The last section of the document, the deployment guide section, is intended for mission
   developers when deploying and configuring the FM application software for a mission
   flight software build environment.

fsw/inc/hk_events.h

@@ -81,7 +81,7 @@
 /**
  * \brief HK Reset Counters Command Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *

fsw/inc/hk_extern_typedefs.h

@@ -33,8 +33,8 @@
  *       Dictates the number of elements in the hk copy table.
  *
  *  \par Limits
- *       The maximum size of this paramater is 8192
+ *       The maximum size of this parameter is 8192
  */
 #define HK_COPY_TABLE_ENTRIES 128
 
-#endif /* HK_EXTERN_TYPEDEFS_H */
+#endif /* HK_EXTERN_TYPEDEFS_H */

fsw/inc/hk_platform_cfg.h

@@ -38,7 +38,7 @@
  *  \par Limits
  *       The minimum size of this parameter is 1
  *       The maximum size dictated by cFE platform configuration
- *       parameter  CFE_SB_MAX_PIPE_DEPTH
+ *       parameter  OS_QUEUE_MAX_DEPTH
  */
 #define HK_PIPE_DEPTH 40
 

fsw/src/hk_app.c

@@ -360,7 +360,7 @@ void HK_NoopCmd(const CFE_SB_Buffer_t *BufPtr)
 void HK_ResetCountersCmd(const CFE_SB_Buffer_t *BufPtr)
 {
     HK_ResetHkData();
-    CFE_EVS_SendEvent(HK_RESET_INF_EID, CFE_EVS_EventType_DEBUG, "HK Reset Counters command received");
+    CFE_EVS_SendEvent(HK_RESET_INF_EID, CFE_EVS_EventType_INFORMATION, "HK Reset Counters command received");
 }
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

fsw/src/hk_dispatch.c

@@ -66,7 +66,7 @@ int32 HK_VerifyCmdLength(const CFE_SB_Buffer_t *BufPtr, size_t ExpectedLength)
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /*                                                                 */
-/* Verify Non-Command Msg Length (Event is differnt)               */
+/* Verify Non-Command Msg Length (Event is different)               */
 /*                                                                 */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 int32 HK_VerifyMsgLength(const CFE_SB_Buffer_t *BufPtr, size_t ExpectedLength)

fsw/src/hk_verify.h

@@ -43,10 +43,10 @@
 #endif
 /*
  * JPH 2015-06-29 - Removed check of:
- *  HK_PIPE_DEPTH  >  CFE_SB_MAX_PIPE_DEPTH
+ *  HK_PIPE_DEPTH  >  OS_QUEUE_MAX_DEPTH
  *
  * This is not a valid check anymore, as the HK app does not have knowledge
- * of CFE_SB_MAX_PIPE_DEPTH.  But if the configuration violates this rule it will
+ * of OS_QUEUE_MAX_DEPTH.  But if the configuration violates this rule it will
  * show up as an obvious run-time error so the compile-time check is redundant.
  */
 

unit-test/hk_app_tests.c

@@ -50,7 +50,7 @@ uint8 call_count_CFE_EVS_SendEvent;
  * Function under test: HK_AppMain
  *
  * Case: Tests the "nominal" mode where all dependent calls should be
- *       successful by defaut.
+ *       successful by default.
  */
 void Test_HK_AppMain_Success(void)
 {
@@ -1028,7 +1028,7 @@ void Test_HK_ResetCountersCmd(void)
 
     UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventID, HK_RESET_INF_EID);
 
-    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_DEBUG);
+    UtAssert_INT32_EQ(context_CFE_EVS_SendEvent[0].EventType, CFE_EVS_EventType_INFORMATION);
 
     strCmpResult = strncmp(ExpectedEventString, context_CFE_EVS_SendEvent[0].Spec, CFE_MISSION_EVS_MAX_MESSAGE_LENGTH);
 

unit-test/hk_utils_tests.c

@@ -1950,7 +1950,7 @@ void UtTest_Setup(void)
     UtTest_Add(Test_HK_ProcessIncomingHkData_MessageError, HK_Test_Setup, HK_Test_TearDown,
                "Test_HK_ProcessIncomingHkData_MessageError");
 
-    /* Test functions for HK_VaidateHkCopyTable */
+    /* Test functions for HK_ValidateHkCopyTable */
     UtTest_Add(Test_HK_ValidateHkCopyTable_Success, HK_Test_Setup, HK_Test_TearDown,
                "Test_HK_ValidateHkCopyTable_Success");
     UtTest_Add(Test_HK_ValidateHkCopyTable_Error, HK_Test_Setup, HK_Test_TearDown, "Test_HK_ValidateHkCopyTable_Error");