xref: /FreeRTOS-Plus-TCP-v4.0.0/test/unit-test/FreeRTOS_ICMP/FreeRTOS_ICMP_utest.c (revision 2d3f4daa567ffe71aeda2e0f6d0bc02850db0627) 
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * http://aws.amazon.com/freertos
25  * http://www.FreeRTOS.org
26  */
27 
28 
29 /* Include Unity header */
30 #include "unity.h"
31 
32 /* Include standard libraries */
33 #include <stdlib.h>
34 #include <string.h>
35 #include <stdint.h>
36 
37 #include "mock_task.h"
38 #include "mock_list.h"
39 
40 /* This must come after list.h is included (in this case, indirectly
41  * by mock_list.h). */
42 #include "mock_ICMP_list_macros.h"
43 #include "mock_queue.h"
44 #include "mock_event_groups.h"
45 
46 #include "mock_FreeRTOS_IP_Private.h"
47 #include "mock_FreeRTOS_IP_Utils.h"
48 #include "mock_FreeRTOS_IP_Timers.h"
49 #include "mock_FreeRTOS_TCP_IP.h"
50 #include "mock_FreeRTOS_IP.h"
51 #include "mock_FreeRTOS_ARP.h"
52 #include "mock_NetworkBufferManagement.h"
53 #include "mock_NetworkInterface.h"
54 #include "mock_FreeRTOS_DHCP.h"
55 #include "mock_FreeRTOS_Sockets.h"
56 #include "mock_FreeRTOS_DNS.h"
57 #include "mock_FreeRTOS_Stream_Buffer.h"
58 #include "mock_FreeRTOS_TCP_WIN.h"
59 #include "mock_FreeRTOS_UDP_IP.h"
60 
61 #include "FreeRTOS_ICMP.h"
62 
63 #include "FreeRTOS_ICMP_stubs.c"
64 #include "catch_assert.h"
65 
66 #include "FreeRTOSIPConfig.h"
67 
test_ProcessICMPPacket_CatchAssert(void)68 void test_ProcessICMPPacket_CatchAssert( void )
69 {
70     eFrameProcessingResult_t eResult;
71     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
72 
73     pxNetworkBuffer = &xNetworkBuffer;
74     pxNetworkBuffer->xDataLength = sizeof( ICMPPacket_t ) - 1;
75 
76     catch_assert( ProcessICMPPacket( pxNetworkBuffer ) );
77 }
78 
test_ProcessICMPPacket_AllZeroData(void)79 void test_ProcessICMPPacket_AllZeroData( void )
80 {
81     eFrameProcessingResult_t eResult;
82     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
83     uint8_t ucEthBuffer[ ipconfigTCP_MSS ];
84 
85     pxNetworkBuffer = &xNetworkBuffer;
86     pxNetworkBuffer->pucEthernetBuffer = ucEthBuffer;
87     pxNetworkBuffer->xDataLength = ipconfigTCP_MSS;
88 
89     memset( ucEthBuffer, 0, ipconfigTCP_MSS );
90 
91     vApplicationPingReplyHook_Expect( eInvalidData, 0 );
92 
93     eResult = ProcessICMPPacket( pxNetworkBuffer );
94 
95     TEST_ASSERT_EQUAL( eReleaseBuffer, eResult );
96 }
97 
test_ProcessICMPPacket_EchoRequest(void)98 void test_ProcessICMPPacket_EchoRequest( void )
99 {
100     eFrameProcessingResult_t eResult;
101     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
102     uint8_t ucEthBuffer[ ipconfigTCP_MSS ];
103     IPHeader_t * pxIPHeader;
104     ICMPPacket_t * pxICMPPacket;
105     ICMPHeader_t * pxICMPHeader;
106 
107     pxNetworkBuffer = &xNetworkBuffer;
108     pxNetworkBuffer->pucEthernetBuffer = ucEthBuffer;
109     pxNetworkBuffer->xDataLength = ipconfigTCP_MSS;
110 
111     memset( ucEthBuffer, 0, ipconfigTCP_MSS );
112 
113     pxICMPPacket = ( ICMPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer;
114     pxICMPHeader = ( ( ICMPHeader_t * ) &( pxICMPPacket->xICMPHeader ) );
115     pxIPHeader = &( pxICMPPacket->xIPHeader );
116 
117     pxICMPPacket->xICMPHeader.ucTypeOfMessage = ipICMP_ECHO_REQUEST;
118 
119     uxIPHeaderSizePacket_ExpectAnyArgsAndReturn( 0 );
120 
121     usGenerateChecksum_ExpectAnyArgsAndReturn( 0xAA );
122 
123     usGenerateProtocolChecksum_ExpectAnyArgsAndReturn( 0 );
124 
125     eResult = ProcessICMPPacket( pxNetworkBuffer );
126 
127     TEST_ASSERT_EQUAL( eReturnEthernetFrame, eResult );
128     TEST_ASSERT_EQUAL( ( uint8_t ) ipICMP_ECHO_REPLY, pxICMPHeader->ucTypeOfMessage );
129     TEST_ASSERT_EQUAL( pxIPHeader->ulSourceIPAddress, pxIPHeader->ulDestinationIPAddress );
130     TEST_ASSERT_EQUAL( *ipLOCAL_IP_ADDRESS_POINTER, pxIPHeader->ulSourceIPAddress );
131     TEST_ASSERT_EQUAL( ipconfigICMP_TIME_TO_LIVE, pxIPHeader->ucTimeToLive );
132     TEST_ASSERT_EQUAL( 0, pxIPHeader->usFragmentOffset );
133     TEST_ASSERT_EQUAL( ( uint16_t ) ~FreeRTOS_htons( 0xAA ), pxIPHeader->usHeaderChecksum );
134 }
135 
test_ProcessICMPPacket_UnknownICMPPacket(void)136 void test_ProcessICMPPacket_UnknownICMPPacket( void )
137 {
138     eFrameProcessingResult_t eResult;
139     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
140     uint8_t ucEthBuffer[ ipconfigTCP_MSS ];
141     ICMPPacket_t * pxICMPPacket;
142 
143     pxNetworkBuffer = &xNetworkBuffer;
144     pxNetworkBuffer->pucEthernetBuffer = ucEthBuffer;
145     pxNetworkBuffer->xDataLength = ipconfigTCP_MSS;
146 
147     memset( ucEthBuffer, 0, ipconfigTCP_MSS );
148 
149     pxICMPPacket = ( ICMPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer;
150 
151     /* Unknown ICMP Packet. */
152     pxICMPPacket->xICMPHeader.ucTypeOfMessage = ipICMP_ECHO_REQUEST + 2;
153 
154     eResult = ProcessICMPPacket( pxNetworkBuffer );
155 
156     TEST_ASSERT_EQUAL( eReleaseBuffer, eResult );
157 }
158 
test_ProcessICMPPacket_ICMPEchoReply_NULLData(void)159 void test_ProcessICMPPacket_ICMPEchoReply_NULLData( void )
160 {
161     eFrameProcessingResult_t eResult;
162     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
163     uint8_t ucEthBuffer[ ipconfigTCP_MSS ];
164     ICMPPacket_t * pxICMPPacket;
165 
166     pxNetworkBuffer = &xNetworkBuffer;
167     pxNetworkBuffer->pucEthernetBuffer = ucEthBuffer;
168     pxNetworkBuffer->xDataLength = ipconfigTCP_MSS;
169 
170     memset( ucEthBuffer, 0, ipconfigTCP_MSS );
171 
172     pxICMPPacket = ( ICMPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer;
173 
174     pxICMPPacket->xIPHeader.usLength = FreeRTOS_htons( ipSIZE_OF_IPv4_HEADER + ipSIZE_OF_ICMPv4_HEADER );
175 
176     /* ICMP Reply. */
177     pxICMPPacket->xICMPHeader.ucTypeOfMessage = ipICMP_ECHO_REPLY;
178 
179     vApplicationPingReplyHook_Expect( eSuccess, 0 );
180 
181     eResult = ProcessICMPPacket( pxNetworkBuffer );
182 
183     TEST_ASSERT_EQUAL( eReleaseBuffer, eResult );
184 }
185 
test_ProcessICMPPacket_ICMPEchoReply_ProperData(void)186 void test_ProcessICMPPacket_ICMPEchoReply_ProperData( void )
187 {
188     eFrameProcessingResult_t eResult;
189     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
190     uint8_t ucEthBuffer[ ipconfigTCP_MSS ];
191     ICMPPacket_t * pxICMPPacket;
192     uint8_t * pucByte;
193 
194     pxNetworkBuffer = &xNetworkBuffer;
195     pxNetworkBuffer->pucEthernetBuffer = ucEthBuffer;
196     pxNetworkBuffer->xDataLength = ipconfigTCP_MSS;
197 
198     memset( ucEthBuffer, 0, ipconfigTCP_MSS );
199 
200     pxICMPPacket = ( ICMPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer;
201 
202     pxICMPPacket->xIPHeader.usLength = FreeRTOS_htons( ipSIZE_OF_IPv4_HEADER + ipSIZE_OF_ICMPv4_HEADER + 10 );
203 
204     /* ICMP Reply. */
205     pxICMPPacket->xICMPHeader.ucTypeOfMessage = ipICMP_ECHO_REPLY;
206 
207     pucByte = ( uint8_t * ) pxICMPPacket;
208     pucByte = &( pucByte[ sizeof( ICMPPacket_t ) ] );
209     memset( pucByte, ipECHO_DATA_FILL_BYTE, 10 );
210 
211     vApplicationPingReplyHook_Expect( eSuccess, 0 );
212 
213     eResult = ProcessICMPPacket( pxNetworkBuffer );
214 
215     TEST_ASSERT_EQUAL( eReleaseBuffer, eResult );
216 }
217 
test_ProcessICMPPacket_ICMPEchoReply_ImproperData(void)218 void test_ProcessICMPPacket_ICMPEchoReply_ImproperData( void )
219 {
220     eFrameProcessingResult_t eResult;
221     NetworkBufferDescriptor_t * pxNetworkBuffer, xNetworkBuffer;
222     uint8_t ucEthBuffer[ ipconfigTCP_MSS ];
223     ICMPPacket_t * pxICMPPacket;
224     uint8_t * pucByte;
225 
226     pxNetworkBuffer = &xNetworkBuffer;
227     pxNetworkBuffer->pucEthernetBuffer = ucEthBuffer;
228     pxNetworkBuffer->xDataLength = ipconfigTCP_MSS;
229 
230     memset( ucEthBuffer, 0, ipconfigTCP_MSS );
231 
232     pxICMPPacket = ( ICMPPacket_t * ) pxNetworkBuffer->pucEthernetBuffer;
233 
234     pxICMPPacket->xIPHeader.usLength = FreeRTOS_htons( ipSIZE_OF_IPv4_HEADER + ipSIZE_OF_ICMPv4_HEADER + 10 );
235 
236     /* ICMP Reply. */
237     pxICMPPacket->xICMPHeader.ucTypeOfMessage = ipICMP_ECHO_REPLY;
238 
239     pucByte = ( uint8_t * ) pxICMPPacket;
240     pucByte = &( pucByte[ sizeof( ICMPPacket_t ) ] );
241     memset( pucByte, ipECHO_DATA_FILL_BYTE, 5 );
242 
243     vApplicationPingReplyHook_Expect( eInvalidData, 0 );
244 
245     eResult = ProcessICMPPacket( pxNetworkBuffer );
246 
247     TEST_ASSERT_EQUAL( eSuccess, eResult );
248 }
249 
test_CastingFunctions(void)250 void test_CastingFunctions( void )
251 {
252     void * pvTemp;
253 
254     const ICMPHeader_t * pxICMPHeader = ( ( const ICMPHeader_t * ) pvTemp );
255 }
256