Fix nasa#1258, Return char * from OS_StatusToString

astrogeco · Jun 6, 2022 · d902e37 · d902e37
1 parent bc420d9
commit d902e37
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 14 deletions.
diff --git a/src/os/inc/osapi-error.h b/src/os/inc/osapi-error.h
@@ -189,7 +189,7 @@ int32 OS_GetErrorName(int32 error_num, os_err_name_t *err_name);
  *
  * @return Passed in string pointer
  */
-os_status_string_t *OS_StatusToString(osal_status_t status, os_status_string_t *status_string);
+char *OS_StatusToString(osal_status_t status, os_status_string_t *status_string);
 /**@}*/
 
 #endif /* OSAPI_ERROR_H */
diff --git a/src/os/shared/src/osapi-errors.c b/src/os/shared/src/osapi-errors.c
@@ -106,13 +106,16 @@ static const OS_ErrorTable_Entry_t OS_GLOBAL_ERROR_NAME_TABLE[] = {
  *           See description in API and header file for detail
  *
  *-----------------------------------------------------------------*/
-os_status_string_t *OS_StatusToString(osal_status_t status, os_status_string_t *status_string)
+char *OS_StatusToString(osal_status_t status, os_status_string_t *status_string)
 {
+    char *string = NULL;
+
     if (status_string != NULL)
     {
         snprintf(*status_string, sizeof(*status_string), "%ld", OS_StatusToInteger(status));
+        string = *status_string;
     }
-    return status_string;
+    return string;
 }
 
 /*----------------------------------------------------------------

diff --git a/src/unit-test-coverage/shared/src/coveragetest-errors.c b/src/unit-test-coverage/shared/src/coveragetest-errors.c
@@ -50,14 +50,14 @@ void Test_OS_GetErrorName(void)
 **--------------------------------------------------------------------------------*/
 void Test_OS_StatusToString_Helper(osal_status_t status)
 {
-    os_status_string_t  status_string;
-    os_status_string_t *rtn_addr;
-    char                expected[OS_STATUS_STRING_LENGTH + 1];
+    os_status_string_t status_string;
+    char *             rtn_addr;
+    char               expected[OS_STATUS_STRING_LENGTH + 1];
 
     /* Used oversized string to test for truncation */
     snprintf(expected, sizeof(expected), "%ld", OS_StatusToInteger(status));
     rtn_addr = OS_StatusToString(status, &status_string);
-    UtAssert_ADDRESS_EQ(rtn_addr, &status_string);
+    UtAssert_ADDRESS_EQ(rtn_addr, status_string);
     UtAssert_STRINGBUF_EQ(status_string, sizeof(status_string), expected, sizeof(expected));
 }
 

diff --git a/src/unit-tests/oscore-test/ut_oscore_misc_test.c b/src/unit-tests/oscore-test/ut_oscore_misc_test.c
@@ -414,14 +414,14 @@ void UT_os_geterrorname_test(void)
 **--------------------------------------------------------------------------------*/
 void UT_os_statustostring_test_helper(osal_status_t status)
 {
-    os_status_string_t  status_string;
-    os_status_string_t *rtn_addr;
-    char                expected[OS_STATUS_STRING_LENGTH + 1];
+    os_status_string_t status_string;
+    char *             rtn_addr;
+    char               expected[OS_STATUS_STRING_LENGTH + 1];
 
     /* Used oversized string to test for truncation */
     snprintf(expected, sizeof(expected) - 1, "%ld", OS_StatusToInteger(status));
     rtn_addr = OS_StatusToString(status, &status_string);
-    UtAssert_ADDRESS_EQ(rtn_addr, &status_string);
+    UtAssert_ADDRESS_EQ(rtn_addr, status_string);
     UtAssert_STRINGBUF_EQ(status_string, sizeof(status_string), expected, sizeof(expected));
 }
 

diff --git a/src/ut-stubs/osapi-error-stubs.c b/src/ut-stubs/osapi-error-stubs.c
@@ -49,14 +49,14 @@ int32 OS_GetErrorName(int32 error_num, os_err_name_t *err_name)
  * Generated stub function for OS_StatusToString()
  * ----------------------------------------------------
  */
-os_status_string_t *OS_StatusToString(osal_status_t status, os_status_string_t *status_string)
+char *OS_StatusToString(osal_status_t status, os_status_string_t *status_string)
 {
-    UT_GenStub_SetupReturnBuffer(OS_StatusToString, os_status_string_t *);
+    UT_GenStub_SetupReturnBuffer(OS_StatusToString, char *);
 
     UT_GenStub_AddParam(OS_StatusToString, osal_status_t, status);
     UT_GenStub_AddParam(OS_StatusToString, os_status_string_t *, status_string);
 
     UT_GenStub_Execute(OS_StatusToString, Basic, NULL);
 
-    return UT_GenStub_GetReturnValue(OS_StatusToString, os_status_string_t *);
+    return UT_GenStub_GetReturnValue(OS_StatusToString, char *);
 }