src/transport/test_transport_api_timeout.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_timeout.c
  22  * @brief test case for transport plugin implementations complying timeout
  23  * settings
  24  *
  25  *
  26  * This test case serves ensures that no peer disconnect events occurs
  27  * while plugins are idle
  28  */
  29
  30 #include "platform.h"
  31 #include "gnunet_transport_service.h"
  32 #include "transport-testing.h"
  33
  34 /**
  35  * How long until we give up on transmitting the message?
  36  */
  37 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  38
  39 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 90)
  40
  41 #define MTYPE 12345
  42
  43 static char *test_source;
  44
  45 static char *test_plugin;
  46
  47 static char *test_name;
  48
  49 static int ok;
  50
  51 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  52
  53 static GNUNET_SCHEDULER_TaskIdentifier timer_task;
  54
  55 static struct GNUNET_TRANSPORT_TESTING_handle *tth;
  56
  57 static struct PeerContext *p1;
  58
  59 static struct PeerContext *p2;
  60
  61 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
  62
  63 static struct GNUNET_TRANSPORT_TransmitHandle *th;
  64
  65 static char *cfg_file_p1;
  66
  67 static char *cfg_file_p2;
  68
  69 static struct GNUNET_TIME_Relative time_running;
  70
  71 static int shutdown_flag;
  72
  73 static int disconnects;
  74
  75
  76 #if VERBOSE
  77 #define OKPP do { ok++; FPRINTF (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  78 #else
  79 #define OKPP do { ok++; } while (0)
  80 #endif
  81
  82
  83 static void
  84 end ()
  85 {
  86   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
  87
  88   if (timer_task != GNUNET_SCHEDULER_NO_TASK)
  89   {
  90     GNUNET_SCHEDULER_cancel (timer_task);
  91     timer_task = GNUNET_SCHEDULER_NO_TASK;
  92   }
  93
  94   if (die_task != GNUNET_SCHEDULER_NO_TASK)
  95   {
  96     GNUNET_SCHEDULER_cancel (die_task);
  97     die_task = GNUNET_SCHEDULER_NO_TASK;
  98   }
  99
 100   if (th != NULL)
 101     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 102   th = NULL;
 103
 104
 105   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 106   GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 107
 108   if (disconnects == 0)
 109     ok = 0;
 110   else
 111   {
 112     ok = disconnects;
 113     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 114                 "Fail! Had %u disconnects while waiting %s\n",
 115                 disconnects,
 116                 GNUNET_STRINGS_relative_time_to_string (WAIT,
 117                                                         GNUNET_YES));
 118   }
 119
 120   GNUNET_TRANSPORT_TESTING_done (tth);
 121 }
 122
 123 static void
 124 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 125 {
 126   die_task = GNUNET_SCHEDULER_NO_TASK;
 127
 128   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 129
 130   if (timer_task != GNUNET_SCHEDULER_NO_TASK)
 131   {
 132     GNUNET_SCHEDULER_cancel (timer_task);
 133     timer_task = GNUNET_SCHEDULER_NO_TASK;
 134   }
 135   if (cc != NULL)
 136     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 137   if (th != NULL)
 138     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 139   th = NULL;
 140   if (p1 != NULL)
 141     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 142   if (p2 != NULL)
 143     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 144   ok = GNUNET_SYSERR;
 145
 146   GNUNET_TRANSPORT_TESTING_done (tth);
 147 }
 148
 149
 150 static void
 151 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 152                 const struct GNUNET_MessageHeader *message)
 153 {
 154   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 155               "Received message of type %d from peer %s!\n",
 156               ntohs (message->type), GNUNET_i2s (peer));
 157 }
 158
 159 static void
 160 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
 161 {
 162   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 163               GNUNET_i2s (peer), cls);
 164 }
 165
 166
 167 static void
 168 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 169 {
 170   if (shutdown_flag != GNUNET_YES)
 171   {
 172     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 173                 "FAIL! Peer `%4s' disconnected during waiting period!\n",
 174                 GNUNET_i2s (peer));
 175     disconnects++;
 176   }
 177   if (th != NULL)
 178     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 179   th = NULL;
 180 }
 181
 182
 183 static void
 184 timer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 185 {
 186   static int percentage;
 187
 188   timer_task = GNUNET_SCHEDULER_NO_TASK;
 189
 190   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 191     return;
 192
 193   percentage += 10;
 194   time_running =
 195       GNUNET_TIME_relative_add (time_running,
 196                                 GNUNET_TIME_relative_divide (WAIT, 10));
 197
 198   if (time_running.rel_value_us ==
 199       GNUNET_TIME_relative_max (time_running, WAIT).rel_value_us)
 200   {
 201     FPRINTF (stderr, "%s",  "100%%\n");
 202     shutdown_flag = GNUNET_YES;
 203     GNUNET_SCHEDULER_add_now (&end, NULL);
 204   }
 205   else
 206   {
 207     FPRINTF (stderr, "%u%%..", percentage);
 208     timer_task =
 209         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_divide (WAIT, 10),
 210                                       &timer, NULL);
 211   }
 212 }
 213
 214 static void
 215 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 216 {
 217   cc = NULL;
 218   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 219
 220   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 221               GNUNET_i2s (&p2->id));
 222   GNUNET_free (p1_c);
 223
 224   shutdown_flag = GNUNET_NO;
 225
 226   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 227               "Waiting for %s\n",
 228               GNUNET_STRINGS_relative_time_to_string (WAIT,
 229                                                       GNUNET_YES));
 230
 231   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 232     GNUNET_SCHEDULER_cancel (die_task);
 233   die_task = GNUNET_SCHEDULER_add_delayed (WAIT, &end_badly, NULL);
 234
 235   timer_task = GNUNET_SCHEDULER_add_now (&timer, NULL);
 236 }
 237
 238
 239 static void
 240 start_cb (struct PeerContext *p, void *cls)
 241 {
 242   static int started;
 243
 244   started++;
 245
 246   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
 247               GNUNET_i2s (&p->id));
 248
 249   if (started != 2)
 250     return;
 251
 252   char *sender_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 253
 254   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 255               "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 256               p1->no, sender_c, p2->no, GNUNET_i2s (&p2->id));
 257   GNUNET_free (sender_c);
 258
 259   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 260                                                NULL);
 261
 262 }
 263
 264 static void
 265 run (void *cls, char *const *args, const char *cfgfile,
 266      const struct GNUNET_CONFIGURATION_Handle *cfg)
 267 {
 268   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 269
 270   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 271                                             &notify_receive, &notify_connect,
 272                                             &notify_disconnect, &start_cb,
 273                                             NULL);
 274   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 275                                             &notify_receive, &notify_connect,
 276                                             &notify_disconnect, &start_cb,
 277                                             NULL);
 278
 279   if ((p1 == NULL) || (p2 == NULL))
 280   {
 281     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 282     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 283       GNUNET_SCHEDULER_cancel (die_task);
 284     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 285     return;
 286   }
 287 }
 288
 289 static int
 290 check ()
 291 {
 292   static char *const argv[] = { "test-transport-api-timeout",
 293     "-c",
 294     "test_transport_api_data.conf",
 295     NULL
 296   };
 297   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 298     GNUNET_GETOPT_OPTION_END
 299   };
 300
 301   timer_task = GNUNET_SCHEDULER_NO_TASK;
 302
 303   ok = 1;
 304   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 305                       "test-transport-api-timeout", "nohelp", options, &run,
 306                       &ok);
 307
 308   return ok;
 309 }
 310
 311 int
 312 main (int argc, char *argv[])
 313 {
 314   int ret;
 315
 316   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 317
 318   GNUNET_log_setup (test_name,
 319                     "WARNING",
 320                     NULL);
 321
 322   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 323   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 324                                                  &test_plugin);
 325
 326   tth = GNUNET_TRANSPORT_TESTING_init ();
 327
 328   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 329   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 330
 331   ret = check ();
 332
 333   GNUNET_free (cfg_file_p1);
 334   GNUNET_free (cfg_file_p2);
 335
 336   GNUNET_free (test_source);
 337   GNUNET_free (test_plugin);
 338   GNUNET_free (test_name);
 339
 340
 341   return ret;
 342 }
 343
 344 /* end of test_transport_api_timeout.c*/