Add UT coverage for vReleaseSinglePacketFromUDPSocket

Author: tony-josi-aws

test/unit-test/FreeRTOS_IP_Utils/FreeRTOS_IP_Utils_stubs.c

@@ -42,6 +42,9 @@
 
 /* =========================== EXTERN VARIABLES =========================== */
 
+#define RELEASE_UDP_SOCKET_NETWORK_BUFFER_ADDRESS       ((uint8_t *) 0xABCD1234)
+#define RELEASE_UDP_SOCKET_NETWORK_BUFFER_SIZE          256
+
 NetworkInterface_t xInterfaces[ 1 ];
 
 BaseType_t xCallEventHook;
@@ -145,3 +148,43 @@ BaseType_t prvChecksumIPv4Checks_InvalidLength( uint8_t * pucEthernetBuffer,
 
     return xReturn;
 }
+
+static int32_t FreeRTOS_recvfrom_StubHappyPath( const ConstSocket_t xSocket,
+                                                void * pvBuffer,
+                                                size_t uxBufferLength,
+                                                BaseType_t xFlags,
+                                                struct freertos_sockaddr * pxSourceAddress,
+                                                socklen_t * pxSourceAddressLength,
+                                                int callbacks )
+{
+    configASSERT(uxBufferLength == 0);
+    configASSERT(xFlags == FREERTOS_ZERO_COPY);
+    configASSERT(pxSourceAddress == NULL);
+    configASSERT(pxSourceAddressLength == NULL);
+
+    (void) callbacks;
+
+    *( ( uint8_t ** ) pvBuffer ) = RELEASE_UDP_SOCKET_NETWORK_BUFFER_ADDRESS;
+
+    return RELEASE_UDP_SOCKET_NETWORK_BUFFER_SIZE;
+}
+
+static int32_t FreeRTOS_recvfrom_StubNonHappyPath( const ConstSocket_t xSocket,
+                                                    void * pvBuffer,
+                                                    size_t uxBufferLength,
+                                                    BaseType_t xFlags,
+                                                    struct freertos_sockaddr * pxSourceAddress,
+                                                    socklen_t * pxSourceAddressLength,
+                                                    int callbacks )
+{
+    configASSERT(uxBufferLength == 0);
+    configASSERT(xFlags == FREERTOS_ZERO_COPY);
+    configASSERT(pxSourceAddress == NULL);
+    configASSERT(pxSourceAddressLength == NULL);
+
+    (void) callbacks;
+
+    *( ( uint8_t ** ) pvBuffer ) = NULL;
+
+    return -pdFREERTOS_ERRNO_EAGAIN;
+}

test/unit-test/FreeRTOS_IP_Utils/FreeRTOS_IP_Utils_utest.c

@@ -51,6 +51,7 @@
 #include "mock_FreeRTOS_DHCP.h"
 #include "mock_FreeRTOS_DHCPv6.h"
 #include "mock_FreeRTOS_Routing.h"
+#include "mock_FreeRTOS_Sockets.h"
 #include "mock_FreeRTOS_IPv4_Utils.h"
 #include "mock_FreeRTOS_IPv6_Utils.h"
 #include "mock_NetworkBufferManagement.h"
@@ -3332,3 +3333,37 @@ void test_eGetDHCPState( void )
         TEST_ASSERT_EQUAL( i, eReturn );
     }
 }
+
+/**
+ * @brief Test vReleaseSinglePacketFromUDPSocket
+ * To validate if vReleaseSinglePacketFromUDPSocket
+ * releases the buffer in happy path case.
+ */
+void test_vReleaseSinglePacketFromUDPSocket_HappyPath( void )
+{
+
+    Socket_t xSocket;
+
+    /* Get a stub. */
+    FreeRTOS_recvfrom_Stub( FreeRTOS_recvfrom_StubHappyPath );
+
+    FreeRTOS_ReleaseUDPPayloadBuffer_Expect(RELEASE_UDP_SOCKET_NETWORK_BUFFER_ADDRESS);
+
+    vReleaseSinglePacketFromUDPSocket(xSocket);
+
+}
+
+/**
+ * @brief Test vReleaseSinglePacketFromUDPSocket
+ * To validate if vReleaseSinglePacketFromUDPSocket does not try to
+ * release the buffer if receive from fails.
+ */
+void test_vReleaseSinglePacketFromUDPSocket_NonHappyPath( void )
+{
+    Socket_t xSocket;
+    /* Get a stub. */
+    FreeRTOS_recvfrom_Stub( FreeRTOS_recvfrom_StubNonHappyPath );
+
+    vReleaseSinglePacketFromUDPSocket(xSocket);
+
+}

test/unit-test/FreeRTOS_IP_Utils/ut.cmake

@@ -21,6 +21,7 @@ list(APPEND mock_list
             "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_ND.h"
             "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_DHCP.h"
             "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_DHCPv6.h"
+            "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_Sockets.h"
             "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_Routing.h"
             "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_IPv4_Utils.h"
             "${CMAKE_BINARY_DIR}/Annexed_TCP/FreeRTOS_IPv6_Utils.h"