src/transport/test_transport_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file transport/test_transport_api.c
  22  * @brief base test case for transport implementations
  23  *
  24  * This test case serves as a base for tcp, udp, and udp-nat
  25  * transport test cases.  Based on the executable being run
  26  * the correct test case will be performed.  Conservation of
  27  * C code apparently.
  28  */
  29 #include "platform.h"
  30 #include "gnunet_common.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_getopt_lib.h"
  33 #include "gnunet_os_lib.h"
  34 #include "gnunet_program_lib.h"
  35 #include "gnunet_scheduler_lib.h"
  36 #include "gnunet_transport_service.h"
  37 #include "transport.h"
  38 #include "transport-testing.h"
  39
  40 #define VERBOSE GNUNET_NO
  41
  42 #define VERBOSE_ARM GNUNET_NO
  43
  44 #define START_ARM GNUNET_YES
  45
  46 /**
  47  * How long until we give up on transmitting the message?
  48  */
  49 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 300)
  50
  51 /**
  52  * How long until we give up on transmitting the message?
  53  */
  54 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 60)
  55
  56 #define MTYPE 12345
  57
  58 static int ok;
  59
  60 static  GNUNET_SCHEDULER_TaskIdentifier die_task;
  61
  62 struct PeerContext * p1;
  63
  64 struct PeerContext * p2;
  65
  66 struct GNUNET_TRANSPORT_TransmitHandle * th;
  67
  68 char * cfg_file_p1;
  69
  70 char * cfg_file_p2;
  71
  72 #if VERBOSE
  73 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  74 #else
  75 #define OKPP do { ok++; } while (0)
  76 #endif
  77
  78
  79 static void
  80 end ()
  81 {
  82   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
  83
  84   if (die_task != GNUNET_SCHEDULER_NO_TASK)
  85     GNUNET_SCHEDULER_cancel(die_task);
  86
  87   GNUNET_TRANSPORT_TESTING_stop_peer(p1);
  88   GNUNET_TRANSPORT_TESTING_stop_peer(p2);
  89
  90   ok = 0;
  91 }
  92
  93 static void
  94 end_badly ()
  95 {
  96   die_task = GNUNET_SCHEDULER_NO_TASK;
  97   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
  98
  99   if (p1 != NULL)
 100     GNUNET_TRANSPORT_TESTING_stop_peer(p1);
 101   if (p2 != NULL)
 102     GNUNET_TRANSPORT_TESTING_stop_peer(p2);
 103
 104   ok = GNUNET_SYSERR;
 105 }
 106
 107
 108 static void
 109 notify_receive (void *cls,
 110                 const struct GNUNET_PeerIdentity *peer,
 111                 const struct GNUNET_MessageHeader *message,
 112                 const struct GNUNET_TRANSPORT_ATS_Information *ats,
 113                 uint32_t ats_count)
 114 {
 115   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 116               "Received message of type %d from peer %s!\n",
 117               ntohs(message->type),
 118               GNUNET_i2s (peer));
 119
 120   GNUNET_assert (MTYPE == ntohs (message->type));
 121   GNUNET_assert (sizeof (struct GNUNET_MessageHeader) ==
 122                  ntohs (message->size));
 123   end ();
 124 }
 125
 126
 127 static size_t
 128 notify_ready (void *cls, size_t size, void *buf)
 129 {
 130   struct PeerContext *p = cls;
 131   struct GNUNET_MessageHeader *hdr;
 132
 133   th = NULL;
 134
 135   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 136               "Transmitting message with %u bytes to peer %s\n",
 137               sizeof (struct GNUNET_MessageHeader),
 138               GNUNET_i2s (&p->id));
 139   GNUNET_assert (size >= 256);
 140
 141   if (buf != NULL)
 142   {
 143     hdr = buf;
 144     hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
 145     hdr->type = htons (MTYPE);
 146   }
 147   return sizeof (struct GNUNET_MessageHeader);
 148 }
 149
 150
 151 static void
 152 notify_connect (void *cls,
 153                 const struct GNUNET_PeerIdentity *peer,
 154                 const struct GNUNET_TRANSPORT_ATS_Information *ats,
 155                 uint32_t ats_count)
 156 {
 157   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 158               "Peer `%4s' connected to us (%p)!\n",
 159               GNUNET_i2s (peer),
 160               cls);
 161 }
 162
 163
 164 static void
 165 notify_disconnect (void *cls,
 166                    const struct GNUNET_PeerIdentity *peer)
 167 {
 168   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 169               "Peer `%4s' disconnected (%p)!\n",
 170               GNUNET_i2s (peer), cls);
 171 }
 172
 173 static void
 174 sendtask ()
 175 {
 176   th = GNUNET_TRANSPORT_notify_transmit_ready (p1->th,
 177                                               &p2->id,
 178                                               256, 0, TIMEOUT, &notify_ready,
 179                                               &p1);
 180 }
 181
 182 static void
 183 testing_connect_cb (struct PeerContext * p1, struct PeerContext * p2, void *cls)
 184 {
 185   char * p1_c = strdup (GNUNET_i2s(&p1->id));
 186   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n",
 187        p1_c,
 188        GNUNET_i2s (&p2->id));
 189   GNUNET_free (p1_c);
 190
 191   // FIXME: THIS IS REQUIRED! SEEMS TO BE A BUG!
 192   GNUNET_SCHEDULER_add_delayed(GNUNET_TIME_UNIT_SECONDS, &sendtask, NULL);
 193 }
 194
 195 static void
 196 run (void *cls,
 197      char *const *args,
 198      const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
 199 {
 200   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
 201                                            &end_badly, NULL);
 202
 203   p1 = GNUNET_TRANSPORT_TESTING_start_peer(cfg_file_p1,
 204       &notify_receive,
 205       &notify_connect,
 206       &notify_disconnect,
 207       NULL);
 208   p2 = GNUNET_TRANSPORT_TESTING_start_peer(cfg_file_p2,
 209       &notify_receive,
 210       &notify_connect,
 211       &notify_disconnect,
 212       NULL);
 213
 214   GNUNET_TRANSPORT_TESTING_connect_peers(p1, p2, &testing_connect_cb, NULL);
 215 }
 216
 217 static int
 218 check ()
 219 {
 220   static char *const argv[] = { "test-transport-api",
 221     "-c",
 222     "test_transport_api_data.conf",
 223 #if VERBOSE
 224     "-L", "DEBUG",
 225 #endif
 226     NULL
 227   };
 228   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 229     GNUNET_GETOPT_OPTION_END
 230   };
 231
 232 #if WRITECONFIG
 233   setTransportOptions("test_transport_api_data.conf");
 234 #endif
 235   ok = 1;
 236   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 237                       argv, "test-transport-api", "nohelp",
 238                       options, &run, &ok);
 239
 240   return ok;
 241 }
 242
 243 /**
 244  * Return the actual path to a file found in the current
 245  * PATH environment variable.
 246  *
 247  * @param binary the name of the file to find
 248  */
 249 static char *
 250 get_path_from_PATH (char *binary)
 251 {
 252   char *path;
 253   char *pos;
 254   char *end;
 255   char *buf;
 256   const char *p;
 257
 258   p = getenv ("PATH");
 259   if (p == NULL)
 260     {
 261       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 262                   _("PATH environment variable is unset.\n"));
 263       return NULL;
 264     }
 265   path = GNUNET_strdup (p);     /* because we write on it */
 266   buf = GNUNET_malloc (strlen (path) + 20);
 267   pos = path;
 268
 269   while (NULL != (end = strchr (pos, PATH_SEPARATOR)))
 270     {
 271       *end = '\0';
 272       sprintf (buf, "%s/%s", pos, binary);
 273       if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
 274         {
 275           GNUNET_free (path);
 276           return buf;
 277         }
 278       pos = end + 1;
 279     }
 280   sprintf (buf, "%s/%s", pos, binary);
 281   if (GNUNET_DISK_file_test (buf) == GNUNET_YES)
 282     {
 283       GNUNET_free (path);
 284       return buf;
 285     }
 286   GNUNET_free (buf);
 287   GNUNET_free (path);
 288   return NULL;
 289 }
 290
 291 /**
 292  * Check whether the suid bit is set on a file.
 293  * Attempts to find the file using the current
 294  * PATH environment variable as a search path.
 295  *
 296  * @param binary the name of the file to check
 297  *
 298  * @return GNUNET_YES if the binary is found and
 299  *         can be run properly, GNUNET_NO otherwise
 300  */
 301 static int
 302 check_gnunet_nat_binary(char *binary)
 303 {
 304   struct stat statbuf;
 305   char *p;
 306 #ifdef MINGW
 307   SOCKET rawsock;
 308 #endif
 309
 310 #ifdef MINGW
 311   char *binaryexe;
 312   GNUNET_asprintf (&binaryexe, "%s.exe", binary);
 313   p = get_path_from_PATH (binaryexe);
 314   free (binaryexe);
 315 #else
 316   p = get_path_from_PATH (binary);
 317 #endif
 318   if (p == NULL)
 319     {
 320       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 321                   _("Could not find binary `%s' in PATH!\n"),
 322                   binary);
 323       return GNUNET_NO;
 324     }
 325   if (0 != STAT (p, &statbuf))
 326     {
 327       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 328                   _("stat (%s) failed: %s\n"),
 329                   p,
 330                   STRERROR (errno));
 331       GNUNET_free (p);
 332       return GNUNET_SYSERR;
 333     }
 334   GNUNET_free (p);
 335 #ifndef MINGW
 336   if ( (0 != (statbuf.st_mode & S_ISUID)) &&
 337        (statbuf.st_uid == 0) )
 338     return GNUNET_YES;
 339   return GNUNET_NO;
 340 #else
 341   rawsock = socket (AF_INET, SOCK_RAW, IPPROTO_ICMP);
 342   if (INVALID_SOCKET == rawsock)
 343     {
 344       DWORD err = GetLastError ();
 345       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 346                   "socket (AF_INET, SOCK_RAW, IPPROTO_ICMP) have failed! GLE = %d\n", err);
 347       return GNUNET_NO; /* not running as administrator */
 348     }
 349   closesocket (rawsock);
 350   return GNUNET_YES;
 351 #endif
 352 }
 353
 354 int
 355 main (int argc, char *argv[])
 356 {
 357   int ret;
 358
 359   GNUNET_log_setup ("test-transport-api",
 360 #if VERBOSE
 361                     "DEBUG",
 362 #else
 363                     "WARNING",
 364 #endif
 365                     NULL);
 366
 367   char * pch = strdup(argv[0]);
 368   char * backup = pch;
 369   char * filename = NULL;
 370   char *dotexe;
 371
 372   /* get executable filename */
 373   pch = strtok (pch,"/");
 374   while (pch != NULL)
 375   {
 376     pch = strtok (NULL, "/");
 377     if (pch != NULL)
 378       filename = pch;
 379   }
 380   /* remove "lt-" */
 381   filename = strstr(filename, "tes");
 382   if (NULL != (dotexe = strstr (filename, ".exe")))
 383     dotexe[0] = '\0';
 384
 385   /* create cfg filename */
 386   GNUNET_asprintf(&cfg_file_p1, "%s_peer1.conf",filename);
 387   GNUNET_asprintf(&cfg_file_p2, "%s_peer2.conf", filename);
 388   GNUNET_free (backup);
 389
 390   if (strstr(argv[0], "tcp_nat") != NULL)
 391     {
 392       if (GNUNET_YES != check_gnunet_nat_binary("gnunet-nat-server"))
 393         {
 394           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 395                       "`%s' not properly installed, cannot run NAT test!\n",
 396                       "gnunet-nat-server");
 397           return 0;
 398         }
 399     }
 400   else if (strstr(argv[0], "udp_nat") != NULL)
 401     {
 402       if (GNUNET_YES != check_gnunet_nat_binary("gnunet-nat-server"))
 403         {
 404           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 405                       "`%s' not properly installed, cannot run NAT test!\n",
 406                       "gnunet-nat-server");
 407           return 0;
 408         }
 409     }
 410
 411
 412   ret = check ();
 413
 414   GNUNET_free (cfg_file_p1);
 415   GNUNET_free (cfg_file_p2);
 416
 417
 418   return ret;
 419 }
 420
 421 /* end of test_transport_api.c */