Fix #444, Adds JSC 2.1 Static Analysis comments and exposes CF_strnlen

This commit addresses issues flagged during static analysis by:
- Adding JSC 2.1 disposition comments.
- Making CF_strnlen publicly accessible and replacing strlen with it.

fsw/src/cf_cfdp.c

@@ -299,22 +299,6 @@ CF_Logical_PduBuffer_t *CF_CFDP_ConstructPduHeader(const CF_Transaction_t *txn,
     return ph;
 }
 
-/*----------------------------------------------------------------
- *
- * Internal helper routine only, not part of API.
- *
- *-----------------------------------------------------------------*/
-static inline size_t CF_strnlen(const char *str, size_t maxlen)
-{
-    const char *end = memchr(str, 0, maxlen);
-    if (end != NULL)
-    {
-        /* actual length of string is difference */
-        maxlen = end - str;
-    }
-    return maxlen;
-}
-
 /*----------------------------------------------------------------
  *
  * Application-scope internal function

fsw/src/cf_utils.c

@@ -184,20 +184,23 @@ CFE_Status_t CF_WriteHistoryEntryToFile(osal_id_t fd, const CF_History_t *histor
         {
             case 0:
                 CF_Assert(history->dir < CF_Direction_NUM);
+                /* SAD: No need to check snprintf return; buffer size is sufficient for the formatted output */
                 snprintf(linebuf, sizeof(linebuf), "SEQ (%lu, %lu)\tDIR: %s\tPEER %lu\tSTAT: %d\t",
                          (unsigned long)history->src_eid, (unsigned long)history->seq_num, CF_DSTR[history->dir],
                          (unsigned long)history->peer_eid, (int)history->txn_stat);
                 break;
             case 1:
+                /* SAD: No need to check snprintf return; buffer size is sufficient for the formatted output */
                 snprintf(linebuf, sizeof(linebuf), "SRC: %s\t", history->fnames.src_filename);
                 break;
             case 2:
             default:
+                /* SAD: No need to check snprintf return; buffer size is sufficient for the formatted output */
                 snprintf(linebuf, sizeof(linebuf), "DST: %s\n", history->fnames.dst_filename);
                 break;
         }
 
-        len = strlen(linebuf);
+        len = CF_strnlen(linebuf, (CF_FILENAME_MAX_LEN * 2) + 128);
         ret = CF_WrappedWrite(fd, linebuf, len);
         if (ret != len)
         {
@@ -588,3 +591,22 @@ CF_TxnStatus_t CF_TxnStatus_From_ConditionCode(CF_CFDP_ConditionCode_t cc)
     /* All CFDP CC values directly correspond to a Transaction Status of the same numeric value */
     return (CF_TxnStatus_t)cc;
 }
+
+/*----------------------------------------------------------------
+ *
+ * Function: CF_strnlen
+ *
+ * Application-scope internal function
+ * See description in cf_utils.h for argument/return detail
+ *
+ *-----------------------------------------------------------------*/
+size_t CF_strnlen(const char *str, size_t maxlen)
+{
+    const char *end = memchr(str, 0, maxlen);
+    if (end != NULL)
+    {
+        /* actual length of string is difference */
+        maxlen = end - str;
+    }
+    return maxlen;
+}

fsw/src/cf_utils.h

@@ -518,4 +518,21 @@ CF_TxnStatus_t CF_TxnStatus_From_ConditionCode(CF_CFDP_ConditionCode_t cc);
  */
 bool CF_TxnStatus_IsError(CF_TxnStatus_t txn_stat);
 
+/************************************************************************/
+/** @brief Calculates the length of a string up to a maximum length
+ *
+ * Purpose: Provides a local OSAL routine to get the functionality
+ *          of the (non-C99) "strnlen()" function, via the
+ *          C89/C99 standard "memchr()" function instead.
+ *
+ * @par Assumptions, External Events, and Notes:
+ *       None
+ *
+ * @param str     Pointer to the input string
+ * @param maxlen  Maximum number of characters to check
+ *
+ * @returns Length of the string up to `maxlen` characters
+ */
+size_t CF_strnlen(const char *str, size_t maxlen);
+
 #endif /* !CF_UTILS_H */

unit-test/cf_cfdp_tests.c

@@ -611,6 +611,8 @@ void Test_CF_CFDP_SendMd(void)
     strncpy(history->fnames.src_filename, "src1", sizeof(history->fnames.src_filename));
     txn->state = CF_TxnState_S1;
     txn->fsize = 1234;
+    UT_SetDefaultReturnValue(UT_KEY(CF_strnlen), strlen(history->fnames.src_filename));
+    UT_SetDeferredRetcode(UT_KEY(CF_strnlen), 1, strlen(history->fnames.dst_filename));
     UtAssert_INT32_EQ(CF_CFDP_SendMd(txn), CFE_SUCCESS);
     UtAssert_UINT32_EQ(md->size, txn->fsize);
     UtAssert_STRINGBUF_EQ(md->dest_filename.data_ptr, md->dest_filename.length, history->fnames.dst_filename,
@@ -625,6 +627,8 @@ void Test_CF_CFDP_SendMd(void)
     strncpy(history->fnames.src_filename, "src2", sizeof(history->fnames.src_filename));
     txn->state = CF_TxnState_S2;
     txn->fsize = 5678;
+    UT_SetDefaultReturnValue(UT_KEY(CF_strnlen), strlen(history->fnames.src_filename));
+    UT_SetDeferredRetcode(UT_KEY(CF_strnlen), 2, strlen(history->fnames.dst_filename));
     UtAssert_INT32_EQ(CF_CFDP_SendMd(txn), CFE_SUCCESS);
     UtAssert_UINT32_EQ(md->size, txn->fsize);
     UtAssert_UINT32_EQ(md->dest_filename.length, sizeof(history->fnames.dst_filename));

unit-test/cf_utils_tests.c

@@ -1142,6 +1142,42 @@ void Test_CF_TxnStatus_From_ConditionCode(void)
     }
 }
 
+/*******************************************************************************
+**
+**  CF_strnlen tests
+**
+*******************************************************************************/
+void Test_CF_strnlen_null_character_found(void)
+{
+    /* Arrange */
+    size_t result;
+    char   str[CF_FILENAME_MAX_LEN];
+
+    memset(str, 0xFF, sizeof(str) - 1);
+    str[CF_FILENAME_MAX_LEN - 1] = '\0';
+
+    /* Act */
+    result = CF_strnlen(str, sizeof(str));
+
+    /* Assert */
+    UtAssert_INT32_EQ(result, sizeof(str) - 1);
+}
+
+void Test_CF_strnlen_null_character_not_found(void)
+{
+    /* Arrange */
+    size_t result;
+    char   str[CF_FILENAME_MAX_LEN];
+
+    memset(str, 0xFF, sizeof(str));
+
+    /* Act */
+    result = CF_strnlen(str, sizeof(str));
+
+    /* Assert */
+    UtAssert_INT32_EQ(result, sizeof(str));
+}
+
 /*******************************************************************************
 **
 **  cf_utils_tests UtTest_Add groups
@@ -1291,6 +1327,13 @@ void add_CF_WrappedLseek_tests(void)
                cf_utils_tests_Teardown, "Test_CF_WrappedLseek_Call_OS_lseek_WithGivenArgumentsAndReturnItsReturnValue");
 }
 
+void add_CF_strnlen_tests(void)
+{
+    UtTest_Add(Test_CF_strnlen_null_character_found, cf_utils_tests_Setup, cf_utils_tests_Teardown,
+               "Test_CF_strnlen_null_character_found");
+    UtTest_Add(Test_CF_strnlen_null_character_not_found, cf_utils_tests_Setup, cf_utils_tests_Teardown,
+               "Test_CF_strnlen_null_character_not_found");
+}
 /*******************************************************************************
 **
 **  cf_utils_tests UtTest_Setup
@@ -1330,4 +1373,6 @@ void UtTest_Setup(void)
     add_CF_WrappedWrite_tests();
 
     add_CF_WrappedLseek_tests();
+
+    add_CF_strnlen_tests();
 }

unit-test/stubs/cf_utils_stubs.c

@@ -41,7 +41,7 @@ void UT_DefaultHandler_CF_WriteTxnQueueDataToFile(void *, UT_EntryKey_t, const U
  * Generated stub function for CF_FindTransactionBySequenceNumber()
  * ----------------------------------------------------
  */
-CF_Transaction_t *CF_FindTransactionBySequenceNumber(CF_Channel_t       *chan,
+CF_Transaction_t *CF_FindTransactionBySequenceNumber(CF_Channel_t *      chan,
                                                      CF_TransactionSeq_t transaction_sequence_number,
                                                      CF_EntityId_t       src_eid)
 {
@@ -416,3 +416,20 @@ CFE_Status_t CF_WriteTxnQueueDataToFile(osal_id_t fd, CF_Channel_t *chan, CF_Que
 
     return UT_GenStub_GetReturnValue(CF_WriteTxnQueueDataToFile, CFE_Status_t);
 }
+
+/*
+ * ----------------------------------------------------
+ * Generated stub function for CF_strnlen()
+ * ----------------------------------------------------
+ */
+size_t CF_strnlen(const char *str, size_t maxlen)
+{
+    UT_GenStub_SetupReturnBuffer(CF_strnlen, size_t);
+
+    UT_GenStub_AddParam(CF_strnlen, const char *, str);
+    UT_GenStub_AddParam(CF_strnlen, size_t, maxlen);
+
+    UT_GenStub_Execute(CF_strnlen, Basic, NULL);
+
+    return UT_GenStub_GetReturnValue(CF_strnlen, size_t);
+}