1 // : vi ts=4 sw=4 noet :
3 ==================================================================================
4 Copyright (c) 2019 Nokia
5 Copyright (c) 2018-2019 AT&T Intellectual Property.
7 Licensed under the Apache License, Version 2.0 (the "License");
8 you may not use this file except in compliance with the License.
9 You may obtain a copy of the License at
11 http://www.apache.org/licenses/LICENSE-2.0
13 Unless required by applicable law or agreed to in writing, software
14 distributed under the License is distributed on an "AS IS" BASIS,
15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 See the License for the specific language governing permissions and
17 limitations under the License.
18 ==================================================================================
22 Mmemonic: rmr_api_static_test.c
23 Abstract: Specific tests related to the API functions in rmr_nng.c/rmr.c.
24 This should be included by a driver, but only the main RMr
25 driver and there likely not be a specific stand alone driver
26 for just this small set of tests because of the depth of the
27 library needed to test at this level.
29 The message buffer specific API tests are in a different static
30 module. API functions tested here are:
46 Author: E. Scott Daniels
58 #include "../src/common/include/rmr.h"
59 #include "../src/common/include/rmr_agnostic.h"
60 //#include "../src/common/src/ring_static.c"
63 Send a 'burst' of messages to drive some send retry failures to increase RMr coverage
64 by handling the retry caee.
66 static void send_n_msgs( void* ctx, int n ) {
67 rmr_mbuf_t* msg; // message buffers
70 msg = rmr_alloc_msg( ctx, 1024 );
75 for( i = 0; i < n; i++ ) {
76 //fprintf( stderr, "mass send\n" );
81 msg = rmr_send_msg( ctx, msg );
85 static int rmr_api_test( ) {
87 void* rmc; // route manager context
88 void* rmc2; // second context for non-listener init
89 rmr_mbuf_t* msg; // message buffers
91 int v = 0; // some value
96 v = rmr_ready( NULL );
97 errors += fail_if( v != 0, "rmr_ready returned true before initialisation" );
99 if( (rmc = rmr_init( "4560", 1024, FL_NOTHREAD )) == NULL ) {
100 fail_if_nil( rmc, "rmr_init returned a nil pointer" );
104 if( (rmc2 = rmr_init( ":6789", 1024, FL_NOTHREAD )) == NULL ) { // init without starting a thread
105 errors += fail_if_nil( rmc, "rmr_init returned a nil pointer for non-threaded init" );
108 free_ctx( rmc2 ); // coverage
110 if( (rmc2 = rmr_init( NULL, 1024, FL_NOTHREAD )) == NULL ) { // drive default port selector code
111 errors += fail_if_nil( rmc, "rmr_init returned a nil pointer when driving for default port" );
114 v = rmr_ready( rmc ); // unknown return; not checking at the moment
116 msg = rmr_alloc_msg( NULL, 1024 ); // should return nil pointer
117 errors += fail_not_nil( msg, "rmr_alloc_msg didn't return nil when given nil context" );
119 msg = rmr_alloc_msg( rmc, 2048 ); // allocate larger than default size given on init
120 errors += fail_if_nil( msg, "rmr_alloc_msg returned nil msg pointer" );
122 v = rmr_payload_size( NULL );
123 errors += fail_if( v >= 0, "rmr_payload_size returned valid size for nil message" );
124 errors += fail_if( errno == 0, "rmr_payload_size did not set errno on failure" );
126 v = rmr_payload_size( msg );
128 errors += fail_not_equal( v, 2048, "rmr_payload_size returned invalid size (a) instead of expected size (b)" );
129 errors += fail_if( errno != 0, "rmr_payload_size did not clear errno on success" );
131 errors += fail_if( v < 0, "rmr_payload_size returned invalid size for good message" );
134 v = rmr_get_rcvfd( NULL );
135 errors += fail_if( v >= 0, "rmr_get_rcvfd returned a valid file descriptor when given nil context" );
136 v = rmr_get_rcvfd( rmc );
137 errors += fail_if( v < 0, "rmr_get_rcvfd did not return a valid file descriptor" );
139 msg2 = rmr_send_msg( NULL, NULL ); // drive for coverage
140 errors += fail_not_nil( msg2, "send_msg returned msg pointer when given a nil message and context" );
142 // --- sends will fail with a no endpoint error until a dummy route table is set, so we test fail case first.
147 msg = rmr_send_msg( rmc, msg );
148 errors += fail_if_nil( msg, "send_msg_ did not return a message on send" );
150 errors += fail_not_equal( msg->state, RMR_ERR_NOENDPT, "send_msg did not return no endpoints before rtable added" );
151 errors += fail_if( errno == 0, "send_msg did not set errno" );
154 gen_rt( rmc ); // --- after this point there is a dummy route table so send and rts calls should be ok
160 msg = rmr_send_msg( rmc, msg );
161 errors += fail_if_nil( msg, "send_msg_ did not return a message on send" );
163 errors += fail_not_equal( msg->state, RMR_OK, "send_msg returned bad status for send that should work" );
164 errors += fail_if( errno != 0, "send_msg set errno for send that should work" );
165 v = rmr_payload_size( msg );
166 errors += fail_if( v != 2048, "send_msg did not allocate new buffer with correct size" );
169 rmr_set_stimeout( NULL, 0 );
170 rmr_set_stimeout( rmc, 20 );
171 rmr_set_stimeout( rmc, -1 );
172 rmr_set_rtimeout( NULL, 0 );
173 rmr_set_rtimeout( rmc, 20 );
174 rmr_set_rtimeout( rmc, -1 );
176 msg2 = rmr_rcv_msg( NULL, NULL );
177 errors += fail_if( msg2 != NULL, "rmr_rcv_msg returned msg when given nil context and msg" );
179 msg2 = rmr_rcv_msg( rmc, NULL );
180 errors += fail_if( msg2 == NULL, "rmr_rcv_msg returned nil msg when given nil msg" );
182 errors += fail_not_equal( msg2->state, RMR_OK, "receive given nil message did not return msg with good state" );
185 msg = rmr_rcv_msg( rmc, msg );
187 errors += fail_if( msg->state != RMR_OK, "rmr_rcv_msg did not return an ok state" );
188 errors += fail_not_equal( msg->len, 129, "rmr_rcv_msg returned message with invalid len" );
190 errors += fail_if_nil( msg, "rmr_rcv_msg returned a nil pointer" );
193 rmr_rts_msg( NULL, NULL ); // drive for coverage
194 rmr_rts_msg( rmc, NULL );
195 errors += fail_if( errno == 0, "rmr_rts_msg did not set errno when given a nil message" );
197 msg = rmr_rts_msg( rmc, msg ); // return the buffer to the sender
198 errors += fail_if_nil( msg, "rmr_rts_msg did not return a message pointer" );
199 errors += fail_if( errno != 0, "rmr_rts_msg did not reset errno" );
202 snprintf( msg->xaction, 17, "%015d", 16 ); // dummy transaction id (emulation generates, this should arrive after a few calls to recv)
203 msg = rmr_call( rmc, msg ); // this call should return a message as we can anticipate a dummy message in
204 errors += fail_if_nil( msg, "rmr_call returned a nil message on call expected to succeed" );
206 errors += fail_not_equal( msg->state, RMR_OK, "rmr_call did not properly set state on successful return" );
207 errors += fail_if( errno != 0, "rmr_call did not properly set errno on successful return" );
210 snprintf( wbuf, 17, "%015d", 14 ); // if we call receive we should find this in the first 15 tries
211 for( i = 0; i < 16; i++ ) {
212 msg = rmr_rcv_msg( rmc, msg );
214 if( strcmp( wbuf, msg->xaction ) == 0 ) { // found the queued message
217 fprintf( stderr, "<INFO> msg: %s\n", msg->xaction );
219 errors += fail_if_nil( msg, "receive returnd nil msg while looking for queued message" );
223 errors += fail_if( i >= 16, "did not find expected message on queue" );
226 msg = rmr_alloc_msg( rmc, 2048 ); // something buggered above; get a new one
228 msg = rmr_call( rmc, msg ); // make a call that we never expect a response on
229 errors += fail_not_nil( msg, "rmr_call returned a non-nil message on call expected not to receive a response" );
231 errors += fail_not_equal( msg->state, RMR_OK, "rmr_call did not properly set state on queued message receive" );
232 errors += fail_if( errno != 0, "rmr_call did not properly set errno on queued message receivesuccessful" );
235 msg = rmr_call( rmc, msg ); // this should "timeout" because the message xaction id won't ever appear again
236 errors += fail_not_nil( msg, "rmr_call returned a non-nil message on call expected to fail" );
237 errors += fail_if( errno == 0, "rmr_call did not set errno on failure" );
239 rmr_free_msg( NULL ); // drive for coverage; nothing to check
240 rmr_free_msg( msg2 );
243 // --- test timeout receive; our dummy epoll function will return 1 ready on first call and 0 ready (timeout emulation) on second
244 // however we must drain the swamp (queue) first, so run until we get a timeout error, or 20 and report error if we get to 20.
246 for( i = 0; i < 40; i++ ) {
247 msg = rmr_torcv_msg( rmc, msg, 10 );
248 errors += fail_if_nil( msg, "torcv_msg returned nil msg when message expected" );
250 if( msg->state == RMR_ERR_TIMEOUT ) { // queue drained and we've seen both states from poll if we get a timeout
255 errors += fail_if( i >= 40, "torcv_msg never returned a timeout" );
258 // ---- trace things that are not a part of the mbuf_api functions and thus must be tested here
259 state = rmr_init_trace( NULL, 37 ); // coverage test nil context
260 errors += fail_not_equal( state, 0, "attempt to initialise trace with nil context returned non-zero state (a)" );
261 errors += fail_if_equal( errno, 0, "attempt to initialise trace with nil context did not set errno as expected" );
263 state = rmr_init_trace( rmc, 37 );
264 errors += fail_if_equal( state, 0, "attempt to set trace len in context was not successful" );
265 errors += fail_not_equal( errno, 0, "attempt to set trace len in context did not clear errno" );
267 msg = rmr_tralloc_msg( rmc, 1024, 17, "1904308620110417" );
268 errors += fail_if_nil( msg, "attempt to allocate message with trace data returned nil message" );
269 state = rmr_get_trace( msg, wbuf, 17 );
270 errors += fail_not_equal( state, 17, "len of trace data (a) returned after msg allocation was not expected size (b)" );
271 state = strcmp( wbuf, "1904308620110417" );
272 errors += fail_not_equal( state, 0, "trace data returned after tralloc was not correct" );
274 em_send_failures = 1;
275 send_n_msgs( rmc, 30 ); // send 30 messages with emulation failures
276 em_send_failures = 0;
279 rmr_close( NULL ); // drive for coverage
280 rmr_close( rmc ); // no return to check; drive for coverage
284 fprintf( stderr, "<INFO> all RMr API tests pass\n" );