Update the FreeRTOS-Kernel submodule to v10.6.0, update the tests to account for this, include the manifest checker as well

Author: Soren Ptak

.github/workflows/ci.yml

@@ -86,6 +86,27 @@ jobs:
         with:
           path: ./
 
+  verify-manifest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      # At time of writing the gitmodules are set not to pull
+      # Even when using fetch submodules. Need to run this command
+      # To force it to grab them.
+      - name: Perform Recursive Clone
+        shell: bash
+        run: git submodule update --checkout --init --recursive
+
+      - name: Run manifest verifier
+        uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@v2
+        with:
+          path: ./
+          fail-on-incorrect-version: true
+
   build-checks:
     runs-on: ubuntu-latest
     steps:
@@ -192,6 +213,7 @@ jobs:
         run: |
           git-secrets --register-aws
           git-secrets --scan
+
   proof_ci:
     runs-on: cbmc_ubuntu-latest_16-core
     steps:

lexicon.txt

@@ -134,6 +134,7 @@ chextochar
 cli
 clk
 cmd
+cmock
 co
 col
 com
@@ -2073,6 +2074,7 @@ xtaskcreate
 xtaskcreatestatic
 xtaskgenericnotify
 xtaskgetcurrenttaskhandle
+xtaskgetmpusettings
 xtaskgettickcount
 xtaskhandle
 xtasknotifygive

manifest.yml

@@ -1,6 +1,8 @@
-name : "FreeRTOS-Plus-TCP"
+name: "FreeRTOS-Plus-TCP"
 version: "V4.0.0"
-description: "Thread safe FreeRTOS TCP/IP stack working on top of the FreeRTOS-Kernel to implement the TCP/IP protocol. Suitable for microcontrollers."
+description:
+  "Thread safe FreeRTOS TCP/IP stack working on top of the FreeRTOS-Kernel to
+  implement the TCP/IP protocol. Suitable for microcontrollers."
 license: "MIT"
 dependencies:
   - name: "FreeRTOS-Kernel"
@@ -11,3 +13,10 @@ dependencies:
       url: "https://github.com/FreeRTOS/FreeRTOS-Kernel.git"
       path: "test/FreeRTOS-Kernel"
       branch: "main"
+
+  - name: "CMock"
+    version: "afa2949"
+    repository:
+        type: "git"
+        url: " https://github.com/ThrowTheSwitch/CMock.git"
+        path: "tools/CMock"

test/FreeRTOS-Kernel

@@ -113,6 +113,16 @@
     #define portTASK_FUNCTION( vFunction, pvParameters )               void vFunction( void * pvParameters )
 /*-----------------------------------------------------------*/
 
+/** We need to define it here because CMock does not recognize the
+ * #if ( portUSING_MPU_WRAPPERS == 1 ) guard around xTaskGetMPUSettings
+ * and then complains about the missing xMPU_SETTINGS type in the
+ * generated mocks. */
+    typedef struct MPU_SETTINGS
+    {
+        uint32_t ulDummy;
+    } xMPU_SETTINGS;
+
+
 /*
  * Tasks run in their own pthreads and context switches between them
  * are always a full memory barrier. ISRs are emulated as signals

test/unit-test/ConfigFiles/portmacro.h

@@ -27,8 +27,8 @@ list(APPEND mock_include_list
             .
             ${TCP_INCLUDE_DIRS}
             ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/include
-            ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/portable/ThirdParty/GCC/Posix
             ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
+            ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/portable/ThirdParty/GCC/Posix
         )
 
 #list the definitions of your mocks to control what to be included
@@ -58,6 +58,7 @@ list(APPEND real_include_directories
 list(APPEND test_include_directories
             .
             ${CMOCK_DIR}/vendor/unity/src
+            ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
             ${TCP_INCLUDE_DIRS}
         )
 

test/unit-test/FreeRTOS_ARP/ut.cmake

@@ -23,8 +23,8 @@ list(APPEND mock_include_list
             .
             ${TCP_INCLUDE_DIRS}
             ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/include
-            ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/portable/ThirdParty/GCC/Posix
             ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
+            ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/portable/ThirdParty/GCC/Posix
             ${MODULE_ROOT_DIR}/test/unit-test/${project_name}
         )
 
@@ -61,6 +61,7 @@ set(test_include_directories "")
 list(APPEND test_include_directories
             .
             ${CMOCK_DIR}/vendor/unity/src
+            ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
             ${TCP_INCLUDE_DIRS}
             ${MODULE_ROOT_DIR}/test/unit-test/${project_name}
             ${CMAKE_BINARY_DIR}/Annexed_TCP_Sources

test/unit-test/FreeRTOS_BitConfig/ut.cmake

@@ -55,6 +55,7 @@ list(APPEND real_include_directories
 list(APPEND test_include_directories
             .
             ${CMOCK_DIR}/vendor/unity/src
+            ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
             ${TCP_INCLUDE_DIRS}
             ${MODULE_ROOT_DIR}/test/unit-test/${project_name}
         )

test/unit-test/FreeRTOS_DHCP/ut.cmake

@@ -33,6 +33,8 @@
 #include <string.h>
 #include <stdint.h>
 
+#include "portmacro.h"
+
 #include "mock_task.h"
 #include "mock_list.h"
 #include "mock_FreeRTOS_Sockets.h"

test/unit-test/FreeRTOS_DHCPv6/FreeRTOS_DHCPv6_utest.c

@@ -32,8 +32,8 @@ list(APPEND mock_include_list
             .
             ${TCP_INCLUDE_DIRS}
             ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/include
-            ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/portable/ThirdParty/GCC/Posix
             ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
+            ${MODULE_ROOT_DIR}/test/FreeRTOS-Kernel/portable/ThirdParty/GCC/Posix
             ${MODULE_ROOT_DIR}/test/unit-test/${project_name}
         )
 
@@ -71,6 +71,7 @@ set(test_include_directories "")
 list(APPEND test_include_directories
             .
             ${CMOCK_DIR}/vendor/unity/src
+            ${MODULE_ROOT_DIR}/test/unit-test/ConfigFiles
             ${TCP_INCLUDE_DIRS}
             ${MODULE_ROOT_DIR}/test/unit-test/${project_name}
             ${CMAKE_BINARY_DIR}/Annexed_TCP_Sources