test/rmr_nng_api_static_test.c

   1 // : vi ts=4 sw=4 noet :
   2 /*
   3 ==================================================================================
   4             Copyright (c) 2019 Nokia
   5             Copyright (c) 2018-2019 AT&T Intellectual Property.
   6
   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
  10
  11            http://www.apache.org/licenses/LICENSE-2.0
  12
  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 ==================================================================================
  19 */
  20
  21 /*
  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 will 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.
  28
  29                                 This can be used for both the nng and nanomsg outward facing
  30                                 RMr API functions.
  31
  32                                 The message buffer specific API tests are in a different static
  33                                 module.  API functions tested here are:
  34                                          rmr_close
  35                                          rmr_get_rcvfd
  36                                          rmr_ready
  37                                          rmr_init
  38                                          rmr_set_rtimeout
  39                                          rmr_set_stimeout
  40                                          rmr_rcv_specific
  41                                          rmr_torcv_msg
  42                                          rmr_rcv_msg
  43                                          rmr_call
  44                                          rmr_rts_msg
  45                                          rmr_send_msg
  46                                          rmr_mtosend_msg
  47                                          rmr_free_msg
  48
  49         Author:         E. Scott Daniels
  50         Date:           5 April 2019
  51 */
  52
  53 #include <unistd.h>
  54 #include <stdio.h>
  55 #include <stdlib.h>
  56 #include <strings.h>
  57 #include <errno.h>
  58 #include <string.h>
  59 #include <stdint.h>
  60 #include <pthread.h>
  61 #include <semaphore.h>
  62
  63 #include "rmr.h"
  64 #include "rmr_agnostic.h"
  65
  66 /*
  67         Send a 'burst' of messages to drive some send retry failures to increase RMr coverage
  68         by handling the retry caee.
  69 */
  70 static void send_n_msgs( void* ctx, int n ) {
  71         rmr_mbuf_t*     msg;                    // message buffers
  72         int i;
  73
  74         msg = rmr_alloc_msg( ctx,  1024 );
  75         if( ! msg ) {
  76                 return;
  77         }
  78
  79         for( i = 0; i < n; i++ ) {
  80                 //fprintf( stderr, "mass send\n" );
  81                 msg->len = 100;
  82                 msg->mtype = 1;
  83                 msg->state = 999;
  84                 errno = 999;
  85                 msg = rmr_send_msg( ctx, msg );
  86         }
  87 }
  88
  89 /*
  90         Refresh or allocate a message with some default values
  91 */
  92 static rmr_mbuf_t* fresh_msg( void* ctx, rmr_mbuf_t* msg ) {
  93         if( ! msg )  {
  94                 msg = rmr_alloc_msg( ctx, 2048 );
  95         }
  96
  97         msg->mtype = 0;
  98         msg->sub_id = -1;
  99         msg->state = 0;
 100         msg->len = 100;
 101
 102         return msg;
 103 }
 104
 105 static int rmr_api_test( ) {
 106         int             errors = 0;
 107         void*   rmc;                            // route manager context
 108         void*   rmc2;                           // second context for non-listener init
 109         rmr_mbuf_t*     msg;                    // message buffers
 110         rmr_mbuf_t*     msg2;
 111         int             v = 0;                                  // some value
 112         char    wbuf[128];
 113         int             i;
 114         int             state;
 115
 116         v = rmr_ready( NULL );
 117         errors += fail_if( v != 0, "rmr_ready returned true before initialisation "  );
 118
 119         em_set_long_hostname( 1 );
 120         if( (rmc = rmr_init( "4560", 1024, FL_NOTHREAD )) == NULL ) {
 121                 fail_if_nil( rmc, "rmr_init returned a nil pointer "  );
 122                 return 1;
 123         }
 124
 125         if( (rmc2 = rmr_init( ":6789", 1024, FL_NOTHREAD )) == NULL ) {         // init without starting a thread
 126                 errors += fail_if_nil( rmc, "rmr_init returned a nil pointer for non-threaded init "  );
 127         }
 128
 129         free_ctx( rmc2 );                       // coverage
 130
 131         if( (rmc2 = rmr_init( NULL, 1024, FL_NOTHREAD )) == NULL ) {                    // drive default port selector code
 132                 errors += fail_if_nil( rmc, "rmr_init returned a nil pointer when driving for default port "  );
 133         }
 134
 135
 136         v = rmr_ready( rmc );           // unknown return; not checking at the moment
 137
 138         msg = rmr_alloc_msg( NULL,  1024 );                                                                     // should return nil pointer
 139         errors += fail_not_nil( msg, "rmr_alloc_msg didn't return nil when given nil context "  );
 140
 141
 142         msg = rmr_alloc_msg( rmc, 2048 );                               // allocate larger than default size given on init
 143         errors += fail_if_nil( msg, "rmr_alloc_msg returned nil msg pointer "  );
 144         if( msg ) {
 145                 rmr_get_srcip( msg, wbuf );
 146                 errors += fail_if_equal( 0, strlen( wbuf ), "rmr_get_srcip did not did not return string with length (b) after alloc_msg" );
 147                 fprintf( stderr, "<INFO> ip: %s\n", wbuf );
 148         }
 149
 150
 151         v = rmr_payload_size( NULL );
 152         errors += fail_if( v >= 0, "rmr_payload_size returned valid size for nil message "  );
 153         errors += fail_if( errno == 0, "rmr_payload_size did not set errno on failure "  );
 154
 155         v = rmr_payload_size( msg );
 156         if( v >= 0 ) {
 157                 errors += fail_not_equal( v, 2048, "rmr_payload_size returned invalid size (a) instead of expected size (b) "  );
 158                 errors += fail_if( errno != 0, "rmr_payload_size did not clear errno on success "  );
 159         } else {
 160                 errors += fail_if( v < 0, "rmr_payload_size returned invalid size for good message "  );
 161         }
 162
 163 #ifdef EMULATE_NNG
 164         // this is only supported in nng, so behavour is different depending on the underlying library being tested
 165         v = rmr_get_rcvfd( NULL );
 166         errors += fail_if( v >= 0, "rmr_get_rcvfd returned a valid file descriptor when given nil context "  );
 167         v = rmr_get_rcvfd( rmc );
 168         errors += fail_if( v < 0, "rmr_get_rcvfd did not return a valid file descriptor "  );
 169 #else
 170         v = rmr_get_rcvfd( NULL );
 171         errors += fail_if( v >= 0, "rmr_get_rcvfd returned a valid file descriptor when given nil context "  );
 172         v = rmr_get_rcvfd( rmc );
 173         errors += fail_if( v >= 0, "rmr_get_rcvfd returned a valid file descriptor (not supported in nanomsg)"  );
 174 #endif
 175
 176         msg2 = rmr_send_msg( NULL, NULL );                      // drive for coverage
 177         errors += fail_not_nil( msg2, "send_msg returned msg pointer when given a nil message and context "  );
 178
 179         msg->state = 0;
 180         msg = rmr_send_msg( NULL, msg );
 181         errors += fail_if( msg->state == 0, "rmr_send_msg did not set msg state when msg given with nil context "  );
 182
 183         // --- sends will fail with a no endpoint error until a dummy route table is set, so we test fail case first.
 184         msg->len = 100;
 185         msg->mtype = 1;
 186         msg->state = 999;
 187         errno = 999;
 188         msg = rmr_send_msg( rmc, msg );
 189         errors += fail_if_nil( msg, "send_msg_ did not return a message on send "  );
 190         if( msg ) {
 191                 errors += fail_not_equal( msg->state, RMR_ERR_NOENDPT, "send_msg did not return no endpoints before rtable added "  );
 192                 errors += fail_if( errno == 0, "send_msg did not set errno "  );
 193         }
 194
 195         gen_rt( rmc );          // --- after this point there is a dummy route table so send and rts calls should be ok
 196
 197         msg->len = 100;
 198         msg->mtype = 1;
 199         msg->state = 999;
 200         errno = 999;
 201         msg = rmr_send_msg( rmc, msg );
 202         errors += fail_if_nil( msg, "send_msg_ did not return a message on send "  );
 203         if( msg ) {
 204                 errors += fail_not_equal( msg->state, RMR_OK, "send_msg returned bad status for send that should work "  );
 205                 errors += fail_if( errno != 0, "send_msg set errno for send that should work "  );
 206                 v = rmr_payload_size( msg );
 207                 errors += fail_if( v != 2048, "send_msg did not allocate new buffer with correct size "  );
 208         }
 209
 210         rmr_set_stimeout( NULL, 0 );
 211         rmr_set_stimeout( rmc, 20 );
 212         rmr_set_stimeout( rmc, -1 );
 213         rmr_set_rtimeout( NULL, 0 );
 214         rmr_set_rtimeout( rmc, 20 );
 215         rmr_set_rtimeout( rmc, -1 );
 216
 217         msg2 = rmr_rcv_msg( NULL, NULL );
 218         errors += fail_if( msg2 != NULL, "rmr_rcv_msg returned msg when given nil context and msg "  );
 219
 220         msg2 = rmr_rcv_msg( rmc, NULL );
 221         errors += fail_if( msg2 == NULL, "rmr_rcv_msg returned nil msg when given nil msg "  );
 222         if( msg2 ) {
 223                 if( msg2->state != RMR_ERR_EMPTY ) {
 224                         errors += fail_not_equal( msg2->state, RMR_OK, "receive given nil message did not return msg with good state (not empty) "  );
 225                 }
 226         }
 227
 228
 229         msg = rmr_rcv_msg( rmc, msg );
 230         if( msg ) {
 231                 errors += fail_not_equal( msg->state, RMR_OK, "rmr_rcv_msg did not return an ok state "  );
 232                 errors += fail_not_equal( msg->len, 220, "rmr_rcv_msg returned message with invalid len "  );
 233         } else {
 234                 errors += fail_if_nil( msg, "rmr_rcv_msg returned a nil pointer "  );
 235         }
 236
 237         rmr_rts_msg( NULL, NULL );                      // drive for coverage
 238         rmr_rts_msg( rmc, NULL );
 239         errors += fail_if( errno == 0, "rmr_rts_msg did not set errno when given a nil message "  );
 240
 241         msg->state = 0;
 242         msg = rmr_rts_msg( NULL, msg );                 // should set state in msg
 243         if( msg ) {
 244                 errors += fail_if_equal( msg->state, 0, "rmr_rts_msg did not set state when given valid message but no context "  );
 245         } else {
 246                 errors += fail_if_nil( msg,  "rmr_rts_msg returned a nil msg when given a good one" );
 247         }
 248
 249
 250         msg = rmr_rts_msg( rmc, msg );                  // return the buffer to the sender
 251         errors += fail_if_nil( msg, "rmr_rts_msg did not return a message pointer "  );
 252         errors += fail_not_equal( msg->state, 0, "rts_msg did not return a good state (a) when expected" );
 253         errors += fail_not_equal( errno, 0, "rmr_rts_msg did not reset errno (a) expected (b)"  );
 254
 255
 256
 257         msg->state = 0;
 258         msg = rmr_call( NULL, msg );
 259         errors += fail_if( msg->state == 0, "rmr_call did not set message state when given message with nil context "  );
 260
 261         snprintf( msg->xaction, 17, "%015d", 16 );              // dummy transaction id (emulation generates, this should arrive after a few calls to recv)
 262         msg->mtype = 0;
 263         msg->sub_id = -1;
 264         msg = rmr_call( rmc, msg );                                             // dummy nng/nano function will sequentually add xactions and should match or '16'
 265         errors += fail_if_nil( msg, "rmr_call returned a nil message on call expected to succeed "  );
 266         if( msg ) {
 267                 errors += fail_not_equal( msg->state, RMR_OK, "rmr_call did not properly set state on successful return "  );
 268                 errors += fail_not_equal( errno, 0, "rmr_call did not properly set errno (a) on successful return "  );
 269         }
 270
 271         snprintf( wbuf, 17, "%015d", 14 );                              // while waiting, the queued messages should have #14, so issue a few receives looking for it
 272         for( i = 0; i < 16; i++ ) {                                             // it should be in the first 15
 273                 msg = rmr_rcv_msg( rmc, msg );
 274                 if( msg ) {
 275                         if( strcmp( wbuf, msg->xaction ) == 0 ) {               // found the queued message
 276                                 break;
 277                         }
 278                         fprintf( stderr, "<INFO> msg: %s\n", msg->xaction );
 279                 } else {
 280                         errors += fail_if_nil( msg, "receive returnd nil msg while looking for queued message "  );
 281                 }
 282         }
 283
 284         errors += fail_if( i >= 16, "did not find expected message on queue "  );
 285
 286         if( ! msg ) {
 287                 msg = rmr_alloc_msg( rmc, 2048 );                               // something buggered above; get a new one
 288         }
 289         msg->mtype = 0;
 290         msg->sub_id = -1;
 291         msg = rmr_call( rmc, msg );                                                     // make a call that we never expect a response on (nil pointer back)
 292         errors += fail_not_nil( msg, "rmr_call returned a nil message on call expected not to receive a response "  );
 293         errors += fail_if( errno == 0, "rmr_call did not set errno on failure "  );
 294
 295         rmr_free_msg( NULL );                   // drive for coverage; nothing to check
 296         rmr_free_msg( msg2 );
 297
 298
 299         msg2 = rmr_torcv_msg( NULL, NULL, 10 );
 300         errors += fail_not_nil( msg2, "rmr_torcv_msg returned a pointer when given nil information "  );
 301         msg2 = rmr_torcv_msg( rmc, NULL, 10 );
 302         errors += fail_if_nil( msg2, "rmr_torcv_msg did not return a message pointer when given a nil old msg "  );
 303
 304         // ---  test timeout receive; our dummy epoll function will return 1 ready on first call and 0 ready (timeout emulation) on second
 305         //              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.
 306         msg = NULL;
 307         for( i = 0; i < 40; i++ ) {
 308                 msg = rmr_torcv_msg( rmc, msg, 10 );
 309                 errors += fail_if_nil( msg, "torcv_msg returned nil msg when message expected "  );
 310                 if( msg ) {
 311                         if( msg->state == RMR_ERR_TIMEOUT || msg->state == RMR_ERR_EMPTY ) {            // queue drained and we've seen both states from poll if we get a timeout
 312                                 break;
 313                         }
 314                 }
 315         }
 316         errors += fail_if( i >= 40, "torcv_msg never returned a timeout "  );
 317
 318
 319         // ---- trace things that are not a part of the mbuf_api functions and thus must be tested here -------
 320         state = rmr_init_trace( NULL, 37 );                                             // coverage test nil context
 321         errors += fail_not_equal( state, 0, "attempt to initialise trace with nil context returned non-zero state (a) "  );
 322         errors += fail_if_equal( errno, 0, "attempt to initialise trace with nil context did not set errno as expected "  );
 323
 324         state = rmr_init_trace( rmc, 37 );
 325         errors += fail_if_equal( state, 0, "attempt to set trace len in context was not successful "  );
 326         errors += fail_not_equal( errno, 0, "attempt to set trace len in context did not clear errno "  );
 327
 328         msg = rmr_tralloc_msg( rmc, 1024, 17, "1904308620110417" );
 329         errors += fail_if_nil( msg, "attempt to allocate message with trace data returned nil message "  );
 330         state = rmr_get_trace( msg, wbuf, 17 );
 331         errors += fail_not_equal( state, 17, "len of trace data (a) returned after msg allocation was not expected size (b) "  );
 332         state = strcmp( wbuf, "1904308620110417" );
 333         errors += fail_not_equal( state, 0, "trace data returned after tralloc was not correct "  );
 334
 335         em_send_failures = 1;
 336         send_n_msgs( rmc, 30 );                 // send 30 messages with emulation failures
 337         em_send_failures = 0;
 338
 339
 340         ((uta_ctx_t *)rmc)->shutdown = 1;
 341         rmr_close( NULL );                      // drive for coverage
 342         rmr_close( rmc );                       // no return to check; drive for coverage
 343
 344
 345         // -- allocate a new context for mt-call and drive that stuff -----------------------------------------
 346 #ifdef EMULATE_NNG
 347         msg = fresh_msg( rmc, msg );                                                    // ensure we have one with known contents
 348
 349         msg->state = 0;
 350         msg = rmr_mt_call( rmc, msg, 3, 10 );                                                   // drive when not in mt setup
 351         if( msg ) {
 352                 errors += fail_not_equal( msg->state, RMR_ERR_NOTSUPP, "rmr_mt_call did not set not supported error when not mt initialised" );
 353         } else {
 354                 errors += fail_if_nil( msg, "rmr_mt_call returned nil pointer when not mt initialised" );
 355         }
 356         msg = fresh_msg( rmc, msg );
 357
 358         msg = rmr_mt_rcv( rmc, msg, 10 );                                                               // gen not supported error if ctx not set for mt
 359         if( msg ) {
 360                 errors += fail_not_equal( msg->state, RMR_ERR_NOTSUPP, "rmr_mt_rcv did not return not supported state when mt not initialised" );
 361         } else {
 362                 errors += fail_if_nil( msg, "nil pointer from rmr_mt_rcv when mt not initialised\n" );
 363         }
 364         msg = fresh_msg( rmc, msg );
 365
 366         msg->state = 0;
 367         if( msg ) {
 368                 msg = rmr_mt_call( rmc, msg, 1000, 10 );                                                        // thread id out of range
 369                 errors += fail_if_equal( msg->state, 0, "rmr_mt_call did not set an error when given an invalid call-id" );
 370         } else {
 371                 errors += fail_if_nil( msg, "rmr_mt_call returned a nil pointer when given an invalid call-id" );
 372         }
 373         msg = fresh_msg( rmc, msg );
 374
 375         state = init_mtcall( NULL );                                    // drive for coverage
 376         errors += fail_not_equal( state, 0, "init_mtcall did not return false (a) when given a nil context pointer" );
 377
 378
 379         if( (rmc = rmr_init( NULL, 1024, FL_NOTHREAD | RMRFL_MTCALL )) == NULL ) {                      // drive multi-call setup code without rtc thread
 380                 errors += fail_if_nil( rmc, "rmr_init returned a nil pointer when driving for mt-call setup "  );
 381         }
 382
 383         gen_rt( rmc );                                                                  // must attach a route table so sends succeed
 384
 385         fprintf( stderr, "<INFO> enabling mt messages\n" );
 386         em_set_rcvdelay( 1 );                                                   // force slow msg rate during mt testing
 387         em_set_mtc_msgs( 1 );                                                   // emulated nngrcv will now generate messages with call-id and call flag
 388
 389         msg->state = 0;
 390         msg = rmr_mt_call( NULL, msg, 3, 10 );                  // should timeout
 391         if( msg ) {
 392                 errors += fail_if( msg->state == 0, "rmr_mt_call did not set message state when given message with nil context "  );
 393         }
 394         msg = fresh_msg( rmc, msg );
 395
 396         fprintf( stderr, "<INFO> invoking mt_call with timout == 2999\n" );
 397         msg = rmr_mt_call( rmc, msg, 2, 2999 );                 // long timeout to drive time building code, should receive
 398         if( msg ) {
 399                 if( msg->state != RMR_OK ) {
 400                         fprintf( stderr, "<INFO> rmr_mt_call returned error in mbuf: %d\n", msg->state );
 401                 } else {
 402                         errors += fail_not_nil( msg, "rmr_mt_call did not return a nil pointer on read timeout" );
 403                 }
 404         }
 405         msg = fresh_msg( rmc, msg );
 406
 407         msg = rmr_mt_rcv( NULL, NULL, 10 );
 408         errors += fail_not_nil( msg, "rmr_mt_rcv returned a non-nil message when given nil message and nil context" );
 409
 410         fprintf( stderr, "<INFO> invoking mt_rcv with timout == 2999\n" );
 411         msg = fresh_msg( rmc, msg );
 412         msg = rmr_mt_rcv( rmc, msg, 2999 );
 413         if( !msg ) {
 414                 errors += fail_if_nil( msg, "rmr_mt_rcv returned a nil message when given valid message and timeout of 29999" );
 415         }
 416         msg = fresh_msg( rmc, msg );
 417
 418         msg = rmr_mt_rcv( rmc, msg, -1 );
 419         if( !msg ) {
 420                 errors += fail_if_nil( msg, "rmr_mt_rcv returned a nil message when given valid message unlimited timeout" );
 421         }
 422         msg = fresh_msg( rmc, msg );
 423
 424         fprintf( stderr, "<INFO> waiting 20.0 seconds for a known call xaction to arrive (%ld)\n", time( NULL ) );
 425         snprintf( msg->xaction, 17, "%015d", 5 );               // we'll reset receive counter before calling mt_call so this will arrive again
 426         em_set_rcvcount( 0 );
 427         msg = rmr_mt_call( rmc, msg, 2, 15000 );                // we need about 10s to get the message with the 'slow rate'
 428         if( msg ) {
 429                 errors += fail_not_equal( msg->state, RMR_OK, "mt_call with known xaction id bad state (a)" );
 430         } else {
 431                 errors += fail_if_nil( msg, "mt_call with known xaction id returned nil message" );
 432         }
 433         fprintf( stderr, "<INFO> time check: %ld\n", time( NULL ) );
 434
 435
 436         em_set_mtc_msgs( 0 );                                                   // turn off
 437         em_set_rcvdelay( 0 );                                                   // full speed receive rate
 438         ((uta_ctx_t *)rmc)->shutdown = 1;                               // force the mt-reciver attached to the context to stop
 439 #endif
 440
 441
 442         // --------------- phew, done ------------------------------------------------------------------------------
 443
 444         if( ! errors ) {
 445                 fprintf( stderr, "<INFO> all RMr API tests pass\n" );
 446         }
 447         return !!errors;
 448 }