3 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9 * the Software, and to permit persons to whom the Software is furnished to do so,
10 * subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * https://www.FreeRTOS.org
23 * https://github.com/FreeRTOS
26 /*! @file queue_trace_utest.c */
28 /* C runtime includes. */
33 #include "../queue_utest_common.h"
37 #include "FreeRTOSConfig.h"
41 /* ============================ GLOBAL VARIABLES =========================== */
43 /* ========================== CALLBACK FUNCTIONS =========================== */
45 /* ============================= Unity Fixtures ============================= */
62 int suiteTearDown( int numFailures )
64 return commonSuiteTearDown( numFailures );
67 /* ========================== Helper functions =========================== */
70 * @brief Test vQueueSetQueueNumber and uxQueueGetQueueNumber
71 * @details Verify that the queue number set with vQueueSetQueueNumber is returned
72 * by a subsequent call to uxQueueGetQueueNumber.
73 * @coverage vQueueSetQueueNumber uxQueueGetQueueNumber
75 void test_vQueueSetQueueNumber_uxQueueGetQueueNumber( void )
77 QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) );
79 vQueueSetQueueNumber( xQueue, getNextMonotonicTestValue() );
81 TEST_ASSERT_EQUAL( getLastMonotonicTestValue(), uxQueueGetQueueNumber( xQueue ) );
82 vQueueDelete( xQueue );
86 * @brief Test vQueueSetQueueNumber and uxQueueGetQueueNumber with UINT64_MAX
87 * @details Verify that the queue number of UINT64_MAX set with
88 * vQueueSetQueueNumber is returned by a subsequent call to uxQueueGetQueueNumber.
89 * @coverage vQueueSetQueueNumber uxQueueGetQueueNumber
91 void test_vQueueSetQueueNumber_uxQueueGetQueueNumber_max( void )
93 QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) );
95 vQueueSetQueueNumber( xQueue, UINT64_MAX );
97 TEST_ASSERT_EQUAL( UINT64_MAX, uxQueueGetQueueNumber( xQueue ) );
98 vQueueDelete( xQueue );
102 * @brief Test vQueueSetQueueNumber and uxQueueGetQueueNumber with 0
103 * @details Verify that the queue number of 0 set with vQueueSetQueueNumber
104 * is returned by a subsequent call to uxQueueGetQueueNumber.
105 * @coverage vQueueSetQueueNumber uxQueueGetQueueNumber
107 void test_vQueueSetQueueNumber_uxQueueGetQueueNumber_zero( void )
109 QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) );
111 vQueueSetQueueNumber( xQueue, 0 );
113 TEST_ASSERT_EQUAL( 0, uxQueueGetQueueNumber( xQueue ) );
114 vQueueDelete( xQueue );
118 * @brief Test ucQueueGetQueueType with a Queue
119 * @details Verify that ucQueueGetQueueType returns queueQUEUE_TYPE_BASE for a normal queue.
120 * @coverage ucQueueGetQueueType prvInitialiseNewQueue
122 void test_ucQueueGetQueueType_queue( void )
124 QueueHandle_t xQueue = xQueueCreate( 1, sizeof( uint32_t ) );
126 TEST_ASSERT_EQUAL( queueQUEUE_TYPE_BASE, ucQueueGetQueueType( xQueue ) );
127 vQueueDelete( xQueue );
131 * @brief Test ucQueueGetQueueType with a QueueSet
132 * @details Verify that ucQueueGetQueueType returns queueQUEUE_TYPE_SET for a QueueSet.
133 * @coverage ucQueueGetQueueType prvInitialiseNewQueue
135 void test_ucQueueGetQueueType_queue_set( void )
137 QueueSetHandle_t xQueueSet = xQueueCreateSet( 1 );
139 TEST_ASSERT_EQUAL( queueQUEUE_TYPE_SET, ucQueueGetQueueType( xQueueSet ) );
140 vQueueDelete( xQueueSet );
144 * @brief Test ucQueueGetQueueType with a Mutex
145 * @details Verify that ucQueueGetQueueType returns queueQUEUE_TYPE_MUTEX for a Mutex.
146 * @coverage ucQueueGetQueueType prvInitialiseNewQueue
148 void test_ucQueueGetQueueType_mutex( void )
150 xTaskPriorityDisinherit_ExpectAndReturn( NULL, pdFALSE );
151 SemaphoreHandle_t xSemaphore = xSemaphoreCreateMutex();
153 TEST_ASSERT_EQUAL( queueQUEUE_TYPE_MUTEX, ucQueueGetQueueType( xSemaphore ) );
154 vSemaphoreDelete( xSemaphore );
158 * @brief Test ucQueueGetQueueType with a Counting Semaphore
159 * @details Verify that ucQueueGetQueueType returns queueQUEUE_TYPE_COUNTING_SEMAPHORE for a Counting Semaphore.
160 * @coverage ucQueueGetQueueType prvInitialiseNewQueue
162 void test_ucQueueGetQueueType_counting_semaphore( void )
164 SemaphoreHandle_t xSemaphore = xSemaphoreCreateCounting( 1, 0 );
166 TEST_ASSERT_EQUAL( queueQUEUE_TYPE_COUNTING_SEMAPHORE, ucQueueGetQueueType( xSemaphore ) );
167 vSemaphoreDelete( xSemaphore );
171 * @brief Test ucQueueGetQueueType with a Binary Semaphore
172 * @details Verify that ucQueueGetQueueType returns queueQUEUE_TYPE_BINARY_SEMAPHORE for a Binary Semaphore.
173 * @coverage ucQueueGetQueueType prvInitialiseNewQueue
175 void test_ucQueueGetQueueType_binary_semaphore( void )
177 SemaphoreHandle_t xSemaphore = xSemaphoreCreateBinary();
179 TEST_ASSERT_EQUAL( queueQUEUE_TYPE_BINARY_SEMAPHORE, ucQueueGetQueueType( xSemaphore ) );
180 vSemaphoreDelete( xSemaphore );
184 * @brief Test ucQueueGetQueueType with a Recursive Mutex
185 * @details Verify that ucQueueGetQueueType returns queueQUEUE_TYPE_RECURSIVE_MUTEX for a Recursive Mutex.
186 * @coverage ucQueueGetQueueType prvInitialiseNewQueue
188 void test_ucQueueGetQueueType_recursive_mutex( void )
190 xTaskPriorityDisinherit_ExpectAndReturn( NULL, pdFALSE );
191 SemaphoreHandle_t xSemaphore = xSemaphoreCreateRecursiveMutex();
193 TEST_ASSERT_EQUAL( queueQUEUE_TYPE_RECURSIVE_MUTEX, ucQueueGetQueueType( xSemaphore ) );
194 vSemaphoreDelete( xSemaphore );