Merge pull request #2042 from paulober/fix-2039-replace-with-invalid-…

…macro Fix #2039, Replace CFE_SB_ValueToMsgId(0) with CFE_SB_INVALID_MSG_ID
nasa · Feb 3, 2022 · b3cdc34 · b3cdc34
2 parents 94fc960 + df5d2c0
commit b3cdc34
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 17 deletions.
diff --git a/modules/cfe_testcase/src/message_id_test.c b/modules/cfe_testcase/src/message_id_test.c
@@ -67,7 +67,7 @@ void TestMsgId(void)
 void TestGetTypeFromMsgId(void)
 {
     UtPrintf("Testing: CFE_MSG_GetTypeFromMsgId");
-    CFE_SB_MsgId_t msgid = CFE_SB_ValueToMsgId(0);
+    CFE_SB_MsgId_t msgid = CFE_SB_INVALID_MSG_ID;
     CFE_MSG_Type_t msgtype;
     int32          status;
 

diff --git a/modules/cfe_testcase/src/msg_api_test.c b/modules/cfe_testcase/src/msg_api_test.c
@@ -53,7 +53,7 @@ void TestMsgApiBasic(void)
     msgId = CFE_SB_ValueToMsgId(1);
 
     /* test msg-init */
-    UtAssert_INT32_EQ(CFE_MSG_Init(NULL, CFE_SB_ValueToMsgId(0), sizeof(cmd)), CFE_MSG_BAD_ARGUMENT);
+    UtAssert_INT32_EQ(CFE_MSG_Init(NULL, CFE_SB_INVALID_MSG_ID, sizeof(cmd)), CFE_MSG_BAD_ARGUMENT);
     UtAssert_INT32_EQ(CFE_MSG_Init(CFE_MSG_PTR(cmd), msgId, 0), CFE_MSG_BAD_ARGUMENT);
     UtAssert_INT32_EQ(
         CFE_MSG_Init(CFE_MSG_PTR(cmd), CFE_SB_ValueToMsgId(CFE_PLATFORM_SB_HIGHEST_VALID_MSGID + 1), sizeof(cmd)),
@@ -139,7 +139,7 @@ void TestMsgApiAdvanced(void)
     CFE_MSG_SequenceCount_t    seqCnt;
 
     memset(&cmd, 0xFF, sizeof(cmd));
-    msgId = CFE_SB_ValueToMsgId(0);
+    msgId = CFE_SB_INVALID_MSG_ID;
 
     UtAssert_INT32_EQ(CFE_MSG_Init(CFE_MSG_PTR(cmd), msgId, sizeof(cmd)), CFE_SUCCESS);
 

diff --git a/modules/msg/ut-coverage/test_cfe_msg_ccsdsext.c b/modules/msg/ut-coverage/test_cfe_msg_ccsdsext.c
@@ -61,7 +61,7 @@ void Test_MSG_Init_Ext(void)
 
     /* Get msgid version by checking if msgid sets "has secondary" field*/
     memset(&msg, 0xFF, sizeof(msg));
-    CFE_UtAssert_SUCCESS(CFE_MSG_SetMsgId(&msg, CFE_SB_ValueToMsgId(0)));
+    CFE_UtAssert_SUCCESS(CFE_MSG_SetMsgId(&msg, CFE_SB_INVALID_MSG_ID));
     CFE_UtAssert_SUCCESS(CFE_MSG_GetHasSecondaryHeader(&msg, &hassec));
     is_v1 = !hassec;
 

diff --git a/modules/msg/ut-coverage/test_cfe_msg_init.c b/modules/msg/ut-coverage/test_cfe_msg_init.c
@@ -54,8 +54,8 @@ void Test_MSG_Init(void)
     bool                       is_v1;
 
     UtPrintf("Bad parameter tests, Null pointer, invalid size, invalid msgid");
-    UtAssert_INT32_EQ(CFE_MSG_Init(NULL, CFE_SB_ValueToMsgId(0), sizeof(cmd)), CFE_MSG_BAD_ARGUMENT);
-    UtAssert_INT32_EQ(CFE_MSG_Init(CFE_MSG_PTR(cmd), CFE_SB_ValueToMsgId(0), 0), CFE_MSG_BAD_ARGUMENT);
+    UtAssert_INT32_EQ(CFE_MSG_Init(NULL, CFE_SB_INVALID_MSG_ID, sizeof(cmd)), CFE_MSG_BAD_ARGUMENT);
+    UtAssert_INT32_EQ(CFE_MSG_Init(CFE_MSG_PTR(cmd), CFE_SB_INVALID_MSG_ID, 0), CFE_MSG_BAD_ARGUMENT);
     UtAssert_INT32_EQ(
         CFE_MSG_Init(CFE_MSG_PTR(cmd), CFE_SB_ValueToMsgId(CFE_PLATFORM_SB_HIGHEST_VALID_MSGID + 1), sizeof(cmd)),
         CFE_MSG_BAD_ARGUMENT);

diff --git a/modules/msg/ut-coverage/test_cfe_msg_msgid_shared.c b/modules/msg/ut-coverage/test_cfe_msg_msgid_shared.c
@@ -37,7 +37,7 @@
 void Test_MSG_GetTypeFromMsgId(void)
 {
     CFE_MSG_Message_t msg;
-    CFE_SB_MsgId_t    msgid  = CFE_SB_ValueToMsgId(0);
+    CFE_SB_MsgId_t    msgid  = CFE_SB_INVALID_MSG_ID;
     CFE_MSG_Type_t    actual = CFE_MSG_Type_Invalid;
 
     UtPrintf("Bad parameter tests, Null pointer");

diff --git a/modules/sbr/ut-coverage/test_cfe_sbr_map_direct.c b/modules/sbr/ut-coverage/test_cfe_sbr_map_direct.c
@@ -48,8 +48,8 @@ void Test_SBR_Map_Direct(void)
     uint32              i;
 
     UtPrintf("Invalid msg checks");
-    UtAssert_INT32_EQ(CFE_SBR_SetRouteId(CFE_SB_ValueToMsgId(0), CFE_SBR_ValueToRouteId(0)), 0);
-    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_GetRouteId(CFE_SB_ValueToMsgId(0))));
+    UtAssert_INT32_EQ(CFE_SBR_SetRouteId(CFE_SB_INVALID_MSG_ID, CFE_SBR_ValueToRouteId(0)), 0);
+    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_GetRouteId(CFE_SB_INVALID_MSG_ID)));
 
     UtPrintf("Initialize map");
     CFE_SBR_Init_Map();
@@ -83,7 +83,7 @@ void Test_SBR_Map_Direct(void)
 
     UtPrintf("Set/Get a range of ids ");
     routeid = CFE_SBR_ValueToRouteId(CFE_PLATFORM_SB_MAX_MSG_IDS + 1);
-    msgid   = CFE_SB_ValueToMsgId(0);
+    msgid   = CFE_SB_INVALID_MSG_ID;
     UtAssert_INT32_EQ(CFE_SBR_SetRouteId(msgid, routeid), 0);
     UtAssert_INT32_EQ(CFE_SBR_GetRouteId(msgid).RouteId, routeid.RouteId);
 

diff --git a/modules/sbr/ut-coverage/test_cfe_sbr_map_hash.c b/modules/sbr/ut-coverage/test_cfe_sbr_map_hash.c
@@ -67,8 +67,8 @@ void Test_SBR_Map_Hash(void)
     uint32              collisions;
 
     UtPrintf("Invalid msg checks");
-    UtAssert_INT32_EQ(CFE_SBR_SetRouteId(CFE_SB_ValueToMsgId(0), CFE_SBR_ValueToRouteId(0)), 0);
-    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_GetRouteId(CFE_SB_ValueToMsgId(0))));
+    UtAssert_INT32_EQ(CFE_SBR_SetRouteId(CFE_SB_INVALID_MSG_ID, CFE_SBR_ValueToRouteId(0)), 0);
+    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_GetRouteId(CFE_SB_INVALID_MSG_ID)));
 
     UtPrintf("Initialize routing and map");
     CFE_SBR_Init();
@@ -102,7 +102,7 @@ void Test_SBR_Map_Hash(void)
 
     /* Note AddRoute required for hash logic to work since it depends on MsgId in routing table */
     UtPrintf("Add routes and check with a rollover and a skip");
-    msgid[0]   = CFE_SB_ValueToMsgId(0);
+    msgid[0]   = CFE_SB_INVALID_MSG_ID;
     msgid[1]   = Test_SBR_Unhash(0xFFFFFFFF);
     msgid[2]   = Test_SBR_Unhash(0x7FFFFFFF);
     routeid[0] = CFE_SBR_AddRoute(msgid[0], &collisions);

diff --git a/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c b/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c
@@ -51,8 +51,8 @@ void Test_SBR_Route_Unsort_General(void)
     CFE_SBR_Init();
 
     UtPrintf("Invalid msg checks");
-    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_AddRoute(CFE_SB_ValueToMsgId(0), NULL)));
-    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_AddRoute(CFE_SB_ValueToMsgId(0), &collisions)));
+    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_AddRoute(CFE_SB_INVALID_MSG_ID, NULL)));
+    UtAssert_BOOL_FALSE(CFE_SBR_IsValidRouteId(CFE_SBR_AddRoute(CFE_SB_INVALID_MSG_ID, &collisions)));
     UtAssert_INT32_EQ(collisions, 0);
 
     /*
@@ -159,7 +159,7 @@ void Test_SBR_Route_Unsort_GetSet(void)
     UtAssert_INT32_EQ(count, 0);
 
     UtPrintf("Add routes and initialize values for testing");
-    msgid[0] = CFE_SB_ValueToMsgId(0);
+    msgid[0] = CFE_SB_INVALID_MSG_ID;
     msgid[1] = CFE_SB_ValueToMsgId(1);
     msgid[2] = CFE_SB_ValueToMsgId(CFE_PLATFORM_SB_HIGHEST_VALID_MSGID);
 

diff --git a/modules/tbl/fsw/src/cfe_tbl_task.c b/modules/tbl/fsw/src/cfe_tbl_task.c
@@ -245,7 +245,7 @@ void CFE_TBL_InitData(void)
                  sizeof(CFE_TBL_Global.TblRegPacket));
 
     /* Message ID is set when sent, so OK as 0 here */
-    CFE_MSG_Init(CFE_MSG_PTR(CFE_TBL_Global.NotifyMsg.CommandHeader), CFE_SB_ValueToMsgId(0),
+    CFE_MSG_Init(CFE_MSG_PTR(CFE_TBL_Global.NotifyMsg.CommandHeader), CFE_SB_INVALID_MSG_ID,
                  sizeof(CFE_TBL_Global.NotifyMsg));
 }