test/tools_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 /*
  23         Mnemonic:       tools_static_test.c
  24         Abstract:       Unit tests for the RMr tools module. This file is a static include
  25                                 that is pulle in at compile time by the test driver.  The driver is
  26                                 expected to include necessary rmr*.h and test_support files before
  27                                 including this file.  In addition, a context struct, or dummy, must
  28                                 be provided based on the type of testing being done.
  29
  30         Author:         E. Scott Daniels
  31         Date:           3 April 2019
  32 */
  33
  34 /*
  35         Returns an interface name that is valid in this environment (keeps us from
  36         having to know/guess a name to test with.
  37 */
  38 static char* get_ifname( ) {
  39         if_addrs_t* l;
  40         struct  ifaddrs *ifs;           // pointer to head
  41         struct  ifaddrs *ele;           // pointer into the list
  42         char*   rstr = NULL;            // return string
  43
  44
  45         if( (l = (if_addrs_t *) malloc( sizeof( if_addrs_t ) )) == NULL ) {
  46                 return NULL;
  47         }
  48         memset( l, 0, sizeof( if_addrs_t ) );
  49         l->addrs = (char **) malloc( sizeof( char* ) * 128 );
  50         if( l->addrs == NULL ) {
  51                 free( l );
  52                 return NULL;
  53         }
  54
  55         getifaddrs( &ifs );
  56         for( ele = ifs; ele; ele = ele->ifa_next ) {
  57                 if( ele && strcmp( ele->ifa_name, "lo" ) ) {
  58                         rstr = strdup( ele->ifa_name );
  59                         break;
  60                 }
  61         }
  62
  63         free( l );
  64         return rstr;
  65 }
  66
  67 static int tools_test( ) {
  68         int i;
  69         int j;
  70         int errors = 0;
  71         char* tokens[127];
  72         char* buf = "2,Fred,Wilma,Barney,Betty,Dino,Pebbles,Bambam,Mr. Slate,Gazoo";
  73         char*   dbuf;                           // duplicated buf since C marks a const string is unumtable
  74         char*   hname;
  75         char*   ip;                                     // ip address string
  76         uta_ctx_t ctx;                          // context for uta_lookup test
  77         void*   if_list;
  78
  79
  80         uta_dump_env();
  81
  82         // ------------------ tokenise tests -----------------------------------------------------------
  83         dbuf = strdup( buf );
  84         i = uta_tokenise( dbuf, tokens, 127, ',' );
  85         errors += fail_not_equal( i, 10, "unexpected number of tokens returned (comma sep)" );
  86         for( j = 0; j < i; j++ ) {
  87                 //fprintf( stderr, ">>>> [%d] (%s)\n", j, tokens[j] );
  88                 errors += fail_if_nil( tokens[j], "token from buffer" );
  89         }
  90         errors += fail_not_equal( strcmp( tokens[4], "Betty" ), 0, "4th token wasn't 'Betty'" );
  91
  92         free( dbuf );
  93         dbuf = strdup( buf );
  94         i = uta_tokenise( dbuf, tokens, 127, '|' );
  95         errors += fail_not_equal( i, 1, "unexpected number of tokens returned (bar sep)" );
  96         free( dbuf );
  97
  98         // ------------ has str tests -----------------------------------------------------------------
  99         j = uta_has_str( buf, "Mr. Slate", ',', 1 );                    // should fail (-1) because user should use strcmp in this situation
 100         errors += fail_if_true( j >= 0, "test to ensure has str rejects small max" );
 101
 102         j = uta_has_str( buf, "Mr. Slate", ',', 27 );
 103         errors += fail_if_true( j < 0, "has string did not find Mr. Slate" );
 104
 105         j = uta_has_str( buf, "Mrs. Slate", ',', 27 );
 106         errors += fail_if_true( j >= 0, "has string not found Mrs. Slate" );
 107
 108         // ------------ host name 2 ip tests ---------------------------------------------------------
 109         hname = uta_h2ip( "192.168.1.2" );
 110         errors += fail_not_equal( strcmp( hname, "192.168.1.2" ), 0, "h2ip did not return IP address when given address" );
 111         errors += fail_if_nil( hname, "h2ip did not return a pointer" );
 112         free( hname );
 113
 114         hname = uta_h2ip( "yahoo.com" );
 115         errors += fail_if_nil( hname, "h2ip did not return a pointer" );
 116         free( hname );
 117
 118         hname = uta_h2ip( "yahoo.com:1234" );                                                   // should ignore the port
 119         errors += fail_if_nil( hname, "h2ip did not return a pointer" );
 120         free( hname );
 121
 122         // ------------ rtg lookup test -------------------------------------------------------------
 123         ctx.rtg_port = 0;
 124         ctx.rtg_addr = NULL;
 125
 126         i = uta_lookup_rtg( NULL );                                             // ensure it handles a nil context
 127         errors += fail_if_true( i, "rtg lookup returned that it found something when not expected to (nil context)" );
 128
 129         setenv( "RMR_RTG_SVC", "localhost:1234", 1);
 130         i = uta_lookup_rtg( &ctx );
 131         errors += fail_if_false( i, "rtg lookup returned that it did not find something when expected to" );
 132         errors += fail_if_nil( ctx.rtg_addr, "rtg lookup did not return a pointer (with port)" );
 133         errors += fail_not_equal( ctx.rtg_port, 1234, "rtg lookup did not capture the port" );
 134
 135         setenv( "RMR_RTG_SVC", "localhost", 1);                 // test ability to generate default port
 136         uta_lookup_rtg( &ctx );
 137         errors += fail_if_nil( ctx.rtg_addr, "rtg lookup did not return a pointer (no port)" );
 138         errors += fail_not_equal( ctx.rtg_port, 5656, "rtg lookup did not return default port" );
 139
 140         unsetenv( "RMR_RTG_SVC" );                                              // this should fail as the default name (rtg) will be unknown during testing
 141         i = uta_lookup_rtg( &ctx );
 142         errors += fail_if_true( i, "rtg lookup returned that it found something when not expected to" );
 143
 144         // ------------ my_ip stuff -----------------------------------------------------------------
 145
 146         if_list = mk_ip_list( "1235" );
 147         errors += fail_if_nil( if_list, "mk_ip_list returned nil pointer" );
 148
 149         i = has_myip( NULL, NULL, ',', 128 );           // should be false if pointers are nil
 150         errors += fail_if_true( i, "has_myip returned true when given nil buffer" );
 151
 152         i = has_myip( "buffer contents not valid", NULL, ',', 128 );            // should be false if pointers are nil
 153         errors += fail_if_true( i, "has_myip returned true when given nil list" );
 154
 155         i = has_myip( "buffer contents not valid", NULL, ',', 1 );                      // should be false if max < 2
 156         errors += fail_if_true( i, "has_myip returned true when given small max value" );
 157
 158         i = has_myip( "buffer.contents.not.valid", if_list, ',', 128 );         // should be false as there is nothing valid in the list
 159         errors += fail_if_true( i, "has_myip returned true when given a buffer with no valid info" );
 160
 161
 162         setenv( "RMR_BIND_IF", "192.168.4.30", 1 );                     // drive the case where we have a hard set interface; and set known interface in list
 163         if_list = mk_ip_list( "1235" );
 164         errors += fail_if_nil( if_list, "mk_ip_list with env set returned nil pointer" );
 165
 166         i = has_myip( "192.168.1.2:1235,192.168.4.30:1235,192.168.2.19:4567", if_list, ',', 128 );              // should find our ip in middle
 167         errors += fail_if_false( i, "has_myip did not find IP in middle of list" );
 168
 169         i = has_myip( "192.168.4.30:1235,192.168.2.19:4567,192.168.2.19:2222", if_list, ',', 128 );             // should find our ip at head
 170         errors += fail_if_false( i, "has_myip did not find IP at head of list" );
 171
 172         i = has_myip( "192.168.23.45:4444,192.168.1.2:1235,192.168.4.30:1235", if_list, ',', 128 );             // should find our ip at end
 173         errors += fail_if_false( i, "has_myip did not find IP at tail of list" );
 174
 175         i = has_myip( "192.168.4.30:1235", if_list, ',', 128 );                                                                                 // should find our ip when only in list
 176         errors += fail_if_false( i, "has_myip did not find IP when only one in list" );
 177
 178         ip = get_default_ip( NULL );
 179         errors += fail_not_nil( ip, "get_default_ip returned non-nil pointer when given nil information" );
 180
 181         ip = get_default_ip( if_list );
 182         if( ip ) {
 183                 free( ip );
 184         } else {
 185                 errors += fail_if_nil( ip, "get_defaul_ip returned nil pointer when valid pointer expected" );
 186         }
 187
 188         ip = get_ifname();                                                      // suss out a valid interface name (not lo)
 189         if( ip ) {
 190                 setenv( "RMR_BIND_IF", ip, 1 );                 // drive the case where we have a hard set interface; and set known interface in list
 191                 free( ip );
 192                 if_list = mk_ip_list( "1235" );
 193                 if( if_list ) {
 194                         ip = get_default_ip( if_list );
 195                         errors += fail_if_nil( ip, "get_default_ip did not return valid pointer when list created from interface name" );
 196                 } else {
 197                         errors += fail_if_nil( if_list, "mk_ip_list with a specific interface name returned a nil list" );
 198                 }
 199
 200                 free( ip );
 201         }
 202
 203 // -------------------------------------------------------------------------------------------------
 204
 205         return !!errors;                        // 1 or 0 regardless of count
 206 }