Merge pull request nasa#1939 from nasa/integration-candidate

cFE Integration candidate: 2021-09-07
jphickey · Sep 10, 2021 · d56bd0a · d56bd0a
2 parents e5d4ed9 + 98f0cba
commit d56bd0a
Show file tree

Hide file tree

Showing 18 changed files with 1,019 additions and 135 deletions.
diff --git a/.github/workflows/code-coverage.yml b/.github/workflows/code-coverage.yml
@@ -94,4 +94,21 @@ jobs:
         run: |
           lcov --capture --rc lcov_branch_coverage=1 --directory build --output-file coverage_test.info
           lcov --rc lcov_branch_coverage=1 --add-tracefile coverage_base.info --add-tracefile coverage_test.info --output-file coverage_total.info
-          genhtml coverage_total.info --branch-coverage --output-directory lcov
+          genhtml coverage_total.info --branch-coverage --output-directory lcov | tee lcov_out.txt
+
+      - name: Confirm Minimum Coverage
+        run: |
+          missed_branches=76
+          missed_lines=33
+          branch_nums=$(grep -A 3 "Overall coverage rate" lcov_out.txt | grep branches | grep -oP "[0-9]+[0-9]*")
+          line_nums=$(grep -A 3 "Overall coverage rate" lcov_out.txt | grep lines | grep -oP "[0-9]+[0-9]*")
+
+          branch_diff=$(echo $branch_nums | awk '{ print $4 - $3 }')
+          line_diff=$(echo $line_nums | awk '{ print $4 - $3 }')
+          if [ $branch_diff -gt $missed_branches ] || [ $line_diff -gt $missed_lines ]
+          then
+            grep -A 3 "Overall coverage rate" lcov_out.txt
+            echo "$branch_diff branches missed, $missed_branches allowed"
+            echo "$line_diff lines missed, $missed_lines allowed"
+            exit -1
+          fi
diff --git a/README.md b/README.md
@@ -10,6 +10,16 @@ The detailed cFE user's guide can be viewed at <https://github.com/nasa/cFS/blob
 
 ## Version History
 
+### Development Build: v6.8.0-rc1+dev994
+
+- Update directory diagrams in cFE Application Developers Guide 
+- Improve SB coverage
+- Improve ES code coverage
+- Update cFE Application Developers Guide for message module
+- Update documentation for message map hash implementation 
+- Update SB/MSG tests to verify "Not Implemented" functions
+- See <https://github.com/nasa/cFE/pull/1939> and <https://github.com/nasa/cFS/pull/351>
+
 ### Development Build: v6.8.0-rc1+dev980
 
 - Add SB API test cases

diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md
diff --git a/docs/media/cFE_Application_Developers_Guide_image10.png b/docs/media/cFE_Application_Developers_Guide_image10.png
diff --git a/docs/media/cFE_Application_Developers_Guide_image11.png b/docs/media/cFE_Application_Developers_Guide_image11.png
diff --git a/docs/media/cFE_Application_Developers_Guide_image5.png b/docs/media/cFE_Application_Developers_Guide_image5.png
diff --git a/docs/media/cFE_Application_Developers_Guide_image6.png b/docs/media/cFE_Application_Developers_Guide_image6.png
diff --git a/docs/media/cFE_Application_Developers_Guide_image7.png b/docs/media/cFE_Application_Developers_Guide_image7.png
diff --git a/docs/media/cFE_Application_Developers_Guide_image8.png b/docs/media/cFE_Application_Developers_Guide_image8.png
diff --git a/docs/media/cFE_Application_Developers_Guide_image9.png b/docs/media/cFE_Application_Developers_Guide_image9.png
diff --git a/modules/cfe_testcase/src/msg_api_test.c b/modules/cfe_testcase/src/msg_api_test.c
@@ -184,6 +184,7 @@ void TestMsgHeaderSecondaryApi(void)
     CFE_TIME_SysTime_t      msgTime;
     bool                    isValid     = true;
     CFE_TIME_SysTime_t      currentTime = {1000, 0xFFFF0000};
+    CFE_Status_t            status;
 
     memset(&cmd, 0, sizeof(cmd));
     memset(&cmdTlm, 0xFF, sizeof(cmdTlm));
@@ -203,17 +204,25 @@ void TestMsgHeaderSecondaryApi(void)
     UtAssert_INT32_EQ(CFE_MSG_SetType(&cmd2.Msg, CFE_MSG_Type_Cmd), CFE_SUCCESS);
 
     /* test generate-checksum */
-    UtAssert_INT32_EQ(CFE_MSG_GenerateChecksum(NULL), CFE_MSG_BAD_ARGUMENT);
-    UtAssert_INT32_EQ(CFE_MSG_GenerateChecksum(&cmdTlm.Msg), CFE_MSG_WRONG_MSG_TYPE);
-    UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmdTlm.Msg, &isValid), CFE_MSG_WRONG_MSG_TYPE);
-    UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(NULL, &isValid), CFE_MSG_BAD_ARGUMENT);
-    UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmdTlm.Msg, NULL), CFE_MSG_BAD_ARGUMENT);
-
-    UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmd.Msg, &isValid), CFE_SUCCESS);
-    UtAssert_True(!isValid, "Checksum isValid (%d) = false", isValid);
-    UtAssert_INT32_EQ(CFE_MSG_GenerateChecksum(&cmd.Msg), CFE_SUCCESS);
-    UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmd.Msg, &isValid), CFE_SUCCESS);
-    UtAssert_True(isValid, "Checksum isValid (%d) = true", isValid);
+    status = CFE_MSG_GenerateChecksum(NULL);
+    if (status == CFE_MSG_NOT_IMPLEMENTED)
+    {
+        UtAssert_NA("CFE_MSG_GenerateChecksum not implemented");
+    }
+    else
+    {
+        UtAssert_INT32_EQ(CFE_MSG_GenerateChecksum(NULL), CFE_MSG_BAD_ARGUMENT);
+        UtAssert_INT32_EQ(CFE_MSG_GenerateChecksum(&cmdTlm.Msg), CFE_MSG_WRONG_MSG_TYPE);
+        UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmdTlm.Msg, &isValid), CFE_MSG_WRONG_MSG_TYPE);
+        UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(NULL, &isValid), CFE_MSG_BAD_ARGUMENT);
+        UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmdTlm.Msg, NULL), CFE_MSG_BAD_ARGUMENT);
+
+        UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmd.Msg, &isValid), CFE_SUCCESS);
+        UtAssert_True(!isValid, "Checksum isValid (%d) = false", isValid);
+        UtAssert_INT32_EQ(CFE_MSG_GenerateChecksum(&cmd.Msg), CFE_SUCCESS);
+        UtAssert_INT32_EQ(CFE_MSG_ValidateChecksum(&cmd.Msg, &isValid), CFE_SUCCESS);
+        UtAssert_True(isValid, "Checksum isValid (%d) = true", isValid);
+    }
 
     /* test get/set-fcn-code */
     UtAssert_INT32_EQ(CFE_MSG_SetFcnCode(NULL, 4), CFE_MSG_BAD_ARGUMENT);
@@ -232,10 +241,20 @@ void TestMsgHeaderSecondaryApi(void)
 
     UtAssert_INT32_EQ(CFE_MSG_GetMsgTime(NULL, &msgTime), CFE_MSG_BAD_ARGUMENT);
     UtAssert_INT32_EQ(CFE_MSG_GetMsgTime(&cmd.Msg, NULL), CFE_MSG_BAD_ARGUMENT);
-    UtAssert_INT32_EQ(CFE_MSG_GetMsgTime(&cmd2.Msg, &msgTime), CFE_MSG_WRONG_MSG_TYPE);
+
+    CFE_Assert_STATUS_STORE(CFE_MSG_GetMsgTime(&cmd2.Msg, &msgTime));
+    if (!CFE_Assert_STATUS_MAY_BE(CFE_SUCCESS))
+    {
+        CFE_Assert_STATUS_MUST_BE(CFE_MSG_WRONG_MSG_TYPE);
+    }
 
     UtAssert_INT32_EQ(CFE_MSG_SetMsgTime(NULL, currentTime), CFE_MSG_BAD_ARGUMENT);
-    UtAssert_INT32_EQ(CFE_MSG_SetMsgTime(&cmd2.Msg, currentTime), CFE_MSG_WRONG_MSG_TYPE);
+
+    CFE_Assert_STATUS_STORE(CFE_MSG_SetMsgTime(&cmd2.Msg, currentTime));
+    if (!CFE_Assert_STATUS_MAY_BE(CFE_SUCCESS))
+    {
+        CFE_Assert_STATUS_MUST_BE(CFE_MSG_WRONG_MSG_TYPE);
+    }
 
     UtAssert_INT32_EQ(CFE_MSG_SetMsgTime(&cmd.Msg, currentTime), CFE_SUCCESS);
     UtAssert_INT32_EQ(CFE_MSG_GetMsgTime(&cmd.Msg, &msgTime), CFE_SUCCESS);

diff --git a/modules/cfe_testcase/src/sb_sendrecv_test.c b/modules/cfe_testcase/src/sb_sendrecv_test.c
@@ -122,7 +122,12 @@ void TestBasicTransmitRecv(void)
     /* Attempt to send a msg which does not have a valid msgid  */
     memset(&CFE_FT_BigMsg, 0xFF, sizeof(CFE_FT_BigMsg));
     CFE_MSG_SetSize(&CFE_FT_BigMsg.Hdr, sizeof(CFE_MSG_Message_t) + 4);
-    UtAssert_INT32_EQ(CFE_SB_TransmitMsg(&CFE_FT_BigMsg.Hdr, true), CFE_SB_BAD_ARGUMENT);
+
+    CFE_Assert_STATUS_STORE(CFE_SB_TransmitMsg(&CFE_FT_BigMsg.Hdr, true));
+    if (!CFE_Assert_STATUS_MAY_BE(CFE_SUCCESS))
+    {
+        CFE_Assert_STATUS_MUST_BE(CFE_SB_BAD_ARGUMENT);
+    }
 
     /* Attempt to send a msg which is too big */
     CFE_MSG_SetSize(&CFE_FT_BigMsg.Hdr, sizeof(CFE_FT_BigMsg));

diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h
@@ -28,7 +28,7 @@
 #define CFE_VERSION_H
 
 /* Development Build Macro Definitions */
-#define CFE_BUILD_NUMBER   980          /**< @brief Development: Number of development commits since baseline */
+#define CFE_BUILD_NUMBER   994          /**< @brief Development: Number of development commits since baseline */
 #define CFE_BUILD_BASELINE "v6.8.0-rc1" /**< @brief Development: Reference git tag for build number */
 
 /* Version Macro Definitions updated for official releases only */

diff --git a/modules/core_private/ut-stubs/inc/ut_osprintf_stubs.h b/modules/core_private/ut-stubs/inc/ut_osprintf_stubs.h
@@ -105,5 +105,6 @@
 #define UT_OSP_PUTPOOL_BAD_HANDLE         77
 #define UT_OSP_FORMAT_VOLATILE            78
 #define UT_OSP_RELOAD_NO_FILE             79
+#define UT_OSP_EXTERNAL_APP_EXIT          80
 
 #endif /* UT_OSPRINTF_STUBS_H */
diff --git a/modules/core_private/ut-stubs/src/ut_osprintf_stubs.c b/modules/core_private/ut-stubs/src/ut_osprintf_stubs.c
@@ -110,4 +110,5 @@ const char *UT_OSP_MESSAGES[] = {
     [UT_OSP_PUTPOOL_BAD_HANDLE]         = "%s: Err:Invalid Memory Handle (0x%08lX).\n",
     [UT_OSP_FORMAT_VOLATILE]            = "%s: Formatting Volatile(RAM) Volume.\n",
     [UT_OSP_RELOAD_NO_FILE]             = "%s: Cannot Reload Application %s, File %s does not exist.\n",
+    [UT_OSP_EXTERNAL_APP_EXIT]          = "%s: Application %s called CFE_ES_ExitApp\n",
 };