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_transport_service.h"
  31 #include "transport-testing.h"
  32
  33 /**
  34  * How long until we give up on transmitting the message?
  35  */
  36 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 120)
  37
  38 /**
  39  * How long until we give up on transmitting the message?
  40  */
  41 #define TIMEOUT_TRANSMIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  42
  43 #define TEST_MESSAGE_SIZE 2600
  44
  45 #define TEST_MESSAGE_TYPE 12345
  46
  47 static char *test_source;
  48
  49 static char *test_plugin;
  50
  51 static char *test_name;
  52
  53 static int ok;
  54
  55 static int s_started;
  56
  57 static int s_connected;
  58
  59 static int s_sending;
  60
  61 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  62
  63 static GNUNET_SCHEDULER_TaskIdentifier send_task;
  64
  65 static struct PeerContext *p1;
  66
  67 static struct PeerContext *p2;
  68
  69 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
  70
  71 static struct GNUNET_TRANSPORT_TransmitHandle *th;
  72
  73 static struct GNUNET_TRANSPORT_TESTING_handle *tth;
  74
  75 static char *cfg_file_p1;
  76
  77 static char *cfg_file_p2;
  78
  79
  80 static void
  81 end ()
  82 {
  83   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
  84
  85   if (send_task != GNUNET_SCHEDULER_NO_TASK)
  86     GNUNET_SCHEDULER_cancel (send_task);
  87
  88   if (die_task != GNUNET_SCHEDULER_NO_TASK)
  89     GNUNET_SCHEDULER_cancel (die_task);
  90
  91   if (th != NULL)
  92     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
  93   th = NULL;
  94
  95   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
  96   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
  97 }
  98
  99 static void
 100 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 101 {
 102   die_task = GNUNET_SCHEDULER_NO_TASK;
 103
 104   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 105
 106
 107   if (send_task != GNUNET_SCHEDULER_NO_TASK)
 108     GNUNET_SCHEDULER_cancel (send_task);
 109
 110   if (cc != NULL)
 111   {
 112     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Fail! Could not connect peers\n"));
 113     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 114     cc = NULL;
 115   }
 116
 117   if (th != NULL)
 118     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 119   else
 120     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were not ready to send data\n"));
 121
 122   if (s_started == GNUNET_NO)
 123     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peers were not started \n"));
 124   else
 125     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peers were started \n"));
 126
 127   if (s_connected == GNUNET_NO)
 128     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were not connected\n"));
 129   else
 130     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were connected\n"));
 131
 132   if (s_sending == GNUNET_NO)
 133     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were not ready to send data\n"));
 134   else
 135     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer were ready to send data\n"));
 136
 137   th = NULL;
 138
 139   if (p1 != NULL)
 140     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 141   else
 142     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer 1 was not started\n"));
 143   if (p2 != NULL)
 144     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 145   else
 146     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Peer 2 was not started\n"));
 147
 148   ok = GNUNET_SYSERR;
 149 }
 150
 151
 152 static void
 153 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 154                 const struct GNUNET_MessageHeader *message,
 155                 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
 156 {
 157   struct PeerContext *p = cls;
 158   struct PeerContext *t = NULL;
 159
 160   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
 161     t = p1;
 162   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
 163     t = p2;
 164   GNUNET_assert (t != NULL);
 165
 166   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 167
 168   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 169               "Peer %u (`%4s') received message of type %d and size %u size from peer %u (`%4s')!\n",
 170               p->no, ps, ntohs (message->type), ntohs (message->size), t->no,
 171               GNUNET_i2s (&t->id));
 172   GNUNET_free (ps);
 173
 174   if ((TEST_MESSAGE_TYPE == ntohs (message->type)) &&
 175       (TEST_MESSAGE_SIZE == ntohs (message->size)))
 176   {
 177     ok = 0;
 178     end ();
 179   }
 180   else
 181   {
 182     GNUNET_break (0);
 183     ok = 1;
 184     end ();
 185   }
 186 }
 187
 188
 189 static size_t
 190 notify_ready (void *cls, size_t size, void *buf)
 191 {
 192   struct PeerContext *p = cls;
 193   struct GNUNET_MessageHeader *hdr;
 194
 195   th = NULL;
 196
 197   if (buf == NULL)
 198   {
 199     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 200                 "Timeout occurred while waiting for transmit_ready\n");
 201     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 202       GNUNET_SCHEDULER_cancel (die_task);
 203     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 204     ok = 42;
 205     return 0;
 206   }
 207
 208   GNUNET_assert (size >= TEST_MESSAGE_SIZE);
 209   if (buf != NULL)
 210   {
 211     memset (buf, '\0', TEST_MESSAGE_SIZE);
 212     hdr = buf;
 213     hdr->size = htons (TEST_MESSAGE_SIZE);
 214     hdr->type = htons (TEST_MESSAGE_TYPE);
 215   }
 216
 217   char *ps = GNUNET_strdup (GNUNET_i2s (&p2->id));
 218   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 219               "Peer %u (`%4s') sending message with type %u and size %u bytes to peer %u (`%4s')\n",
 220               p2->no, ps, ntohs (hdr->type), ntohs (hdr->size), p->no,
 221               GNUNET_i2s (&p->id));
 222   GNUNET_free (ps);
 223
 224   return TEST_MESSAGE_SIZE;
 225 }
 226
 227
 228 static void
 229 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 230 {
 231   send_task = GNUNET_SCHEDULER_NO_TASK;
 232
 233   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 234     return;
 235   char *receiver_s = GNUNET_strdup (GNUNET_i2s (&p1->id));
 236
 237   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 238               "Sending message from peer %u (`%4s') -> peer %u (`%s') !\n",
 239               p2->no, GNUNET_i2s (&p2->id), p1->no, receiver_s);
 240   GNUNET_free (receiver_s);
 241   s_sending = GNUNET_YES;
 242   th = GNUNET_TRANSPORT_notify_transmit_ready (p2->th, &p1->id, TEST_MESSAGE_SIZE, 0,
 243                                                TIMEOUT_TRANSMIT, &notify_ready,
 244                                                p1);
 245 }
 246
 247
 248 static void
 249 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 250                 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
 251 {
 252   static int c;
 253
 254   c++;
 255   struct PeerContext *p = cls;
 256   struct PeerContext *t = NULL;
 257
 258   if (0 == memcmp (peer, &p1->id, sizeof (struct GNUNET_PeerIdentity)))
 259     t = p1;
 260   if (0 == memcmp (peer, &p2->id, sizeof (struct GNUNET_PeerIdentity)))
 261     t = p2;
 262   GNUNET_assert (t != NULL);
 263
 264   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 265
 266   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 267               "Peer %u (`%4s'): peer %u (`%s') connected to me!\n", p->no, ps,
 268               t->no, GNUNET_i2s (peer));
 269   GNUNET_free (ps);
 270 }
 271
 272
 273 static void
 274 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 275 {
 276   struct PeerContext *p = cls;
 277   char *ps = GNUNET_strdup (GNUNET_i2s (&p->id));
 278
 279   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 280               "Peer %u (`%4s'): peer (`%s') disconnected from me!\n", p->no, ps,
 281               GNUNET_i2s (peer));
 282
 283   GNUNET_free (ps);
 284
 285   if (th != NULL)
 286     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 287   th = NULL;
 288 }
 289
 290
 291 static void
 292 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 293 {
 294   cc = NULL;
 295   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 296
 297   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %u (%s) <-> %u (%s)\n",
 298               p1->no, p1_c, p2->no, GNUNET_i2s (&p2->id));
 299   GNUNET_free (p1_c);
 300
 301   s_connected = GNUNET_YES;
 302   send_task = GNUNET_SCHEDULER_add_now (&sendtask, NULL);
 303 }
 304
 305
 306 static void
 307 start_cb (struct PeerContext *p, void *cls)
 308 {
 309   static int started;
 310
 311   started++;
 312
 313   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
 314               GNUNET_i2s (&p->id));
 315
 316   if (started != 2)
 317     return;
 318   else
 319     s_started = GNUNET_YES;
 320   char *sender_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 321
 322   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 323               "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 324               p1->no, sender_c, p2->no, GNUNET_i2s (&p2->id));
 325   GNUNET_free (sender_c);
 326
 327   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 328                                                NULL);
 329
 330 }
 331
 332
 333 static void
 334 run (void *cls, char *const *args, const char *cfgfile,
 335      const struct GNUNET_CONFIGURATION_Handle *cfg)
 336 {
 337   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 338
 339   s_started = GNUNET_NO;
 340   s_connected = GNUNET_NO;
 341   s_sending = GNUNET_NO;
 342
 343   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 344                                             &notify_receive, &notify_connect,
 345                                             &notify_disconnect, &start_cb,
 346                                             NULL);
 347
 348   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 349                                             &notify_receive, &notify_connect,
 350                                             &notify_disconnect, &start_cb,
 351                                             NULL);
 352
 353   if ((p1 == NULL) || (p2 == NULL))
 354   {
 355     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 356     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 357       GNUNET_SCHEDULER_cancel (die_task);
 358     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 359     return;
 360   }
 361 }
 362
 363
 364 static int
 365 check ()
 366 {
 367   static char *const argv[] = { "test-transport-api",
 368     "-c",
 369     "test_transport_api_data.conf",
 370     NULL
 371   };
 372   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 373     GNUNET_GETOPT_OPTION_END
 374   };
 375
 376   send_task = GNUNET_SCHEDULER_NO_TASK;
 377
 378   ok = 1;
 379   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 380                       "nohelp", options, &run, &ok);
 381
 382   return ok;
 383 }
 384
 385 int
 386 main (int argc, char *argv[])
 387 {
 388   int ret;
 389
 390   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 391   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 392   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 393                                                  &test_plugin);
 394
 395   GNUNET_log_setup (test_name,
 396                     "WARNING",
 397                     NULL);
 398   tth = GNUNET_TRANSPORT_TESTING_init ();
 399
 400   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 401   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 402
 403   ret = check ();
 404
 405   GNUNET_free (cfg_file_p1);
 406   GNUNET_free (cfg_file_p2);
 407
 408   GNUNET_free (test_source);
 409   GNUNET_free (test_plugin);
 410   GNUNET_free (test_name);
 411
 412   GNUNET_TRANSPORT_TESTING_done (tth);
 413
 414   return ret;
 415 }
 416
 417 /* end of test_transport_api.c */