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 %llu seconds \n",
 115                 disconnects, WAIT.rel_value);
 116   }
 117
 118   GNUNET_TRANSPORT_TESTING_done (tth);
 119 }
 120
 121 static void
 122 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 123 {
 124   die_task = GNUNET_SCHEDULER_NO_TASK;
 125
 126   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 127
 128   if (timer_task != GNUNET_SCHEDULER_NO_TASK)
 129   {
 130     GNUNET_SCHEDULER_cancel (timer_task);
 131     timer_task = GNUNET_SCHEDULER_NO_TASK;
 132   }
 133   if (cc != NULL)
 134     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
 135   if (th != NULL)
 136     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 137   th = NULL;
 138   if (p1 != NULL)
 139     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p1);
 140   if (p2 != NULL)
 141     GNUNET_TRANSPORT_TESTING_stop_peer (tth, p2);
 142   ok = GNUNET_SYSERR;
 143
 144   GNUNET_TRANSPORT_TESTING_done (tth);
 145 }
 146
 147
 148 static void
 149 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 150                 const struct GNUNET_MessageHeader *message)
 151 {
 152   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 153               "Received message of type %d from peer %s!\n",
 154               ntohs (message->type), GNUNET_i2s (peer));
 155 }
 156
 157 static void
 158 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
 159 {
 160   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 161               GNUNET_i2s (peer), cls);
 162 }
 163
 164
 165 static void
 166 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 167 {
 168   if (shutdown_flag != GNUNET_YES)
 169   {
 170     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 171                 "FAIL! Peer `%4s' disconnected during waiting period!\n",
 172                 GNUNET_i2s (peer));
 173     disconnects++;
 174   }
 175   if (th != NULL)
 176     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 177   th = NULL;
 178 }
 179
 180
 181 static void
 182 timer (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 183 {
 184   static int percentage;
 185
 186   timer_task = GNUNET_SCHEDULER_NO_TASK;
 187
 188   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 189     return;
 190
 191   percentage += 10;
 192   time_running =
 193       GNUNET_TIME_relative_add (time_running,
 194                                 GNUNET_TIME_relative_divide (WAIT, 10));
 195
 196   if (time_running.rel_value ==
 197       GNUNET_TIME_relative_max (time_running, WAIT).rel_value)
 198   {
 199     FPRINTF (stderr, "%s",  "100%%\n");
 200     shutdown_flag = GNUNET_YES;
 201     GNUNET_SCHEDULER_add_now (&end, NULL);
 202   }
 203   else
 204   {
 205     FPRINTF (stderr, "%u%%..", percentage);
 206     timer_task =
 207         GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_divide (WAIT, 10),
 208                                       &timer, NULL);
 209   }
 210 }
 211
 212 static void
 213 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 214 {
 215   cc = NULL;
 216   char *p1_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 217
 218   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 219               GNUNET_i2s (&p2->id));
 220   GNUNET_free (p1_c);
 221
 222   shutdown_flag = GNUNET_NO;
 223
 224   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Waiting for %llu seconds\n", (WAIT.rel_value) / 1000);
 225
 226   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 227     GNUNET_SCHEDULER_cancel (die_task);
 228   die_task = GNUNET_SCHEDULER_add_delayed (WAIT, &end_badly, NULL);
 229
 230   timer_task = GNUNET_SCHEDULER_add_now (&timer, NULL);
 231 }
 232
 233
 234 static void
 235 start_cb (struct PeerContext *p, void *cls)
 236 {
 237   static int started;
 238
 239   started++;
 240
 241   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer %u (`%s') started\n", p->no,
 242               GNUNET_i2s (&p->id));
 243
 244   if (started != 2)
 245     return;
 246
 247   char *sender_c = GNUNET_strdup (GNUNET_i2s (&p1->id));
 248
 249   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 250               "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
 251               p1->no, sender_c, p2->no, GNUNET_i2s (&p2->id));
 252   GNUNET_free (sender_c);
 253
 254   cc = GNUNET_TRANSPORT_TESTING_connect_peers (tth, p1, p2, &testing_connect_cb,
 255                                                NULL);
 256
 257 }
 258
 259 static void
 260 run (void *cls, char *const *args, const char *cfgfile,
 261      const struct GNUNET_CONFIGURATION_Handle *cfg)
 262 {
 263   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 264
 265   p1 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p1, 1,
 266                                             &notify_receive, &notify_connect,
 267                                             &notify_disconnect, &start_cb,
 268                                             NULL);
 269   p2 = GNUNET_TRANSPORT_TESTING_start_peer (tth, cfg_file_p2, 2,
 270                                             &notify_receive, &notify_connect,
 271                                             &notify_disconnect, &start_cb,
 272                                             NULL);
 273
 274   if ((p1 == NULL) || (p2 == NULL))
 275   {
 276     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 277     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 278       GNUNET_SCHEDULER_cancel (die_task);
 279     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 280     return;
 281   }
 282 }
 283
 284 static int
 285 check ()
 286 {
 287   static char *const argv[] = { "test-transport-api-timeout",
 288     "-c",
 289     "test_transport_api_data.conf",
 290     NULL
 291   };
 292   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 293     GNUNET_GETOPT_OPTION_END
 294   };
 295
 296   timer_task = GNUNET_SCHEDULER_NO_TASK;
 297
 298   ok = 1;
 299   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 300                       "test-transport-api-timeout", "nohelp", options, &run,
 301                       &ok);
 302
 303   return ok;
 304 }
 305
 306 int
 307 main (int argc, char *argv[])
 308 {
 309   int ret;
 310
 311   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 312
 313   GNUNET_log_setup (test_name,
 314                     "WARNING",
 315                     NULL);
 316
 317   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 318   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 319                                                  &test_plugin);
 320
 321   tth = GNUNET_TRANSPORT_TESTING_init ();
 322
 323   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 324   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 325
 326   ret = check ();
 327
 328   GNUNET_free (cfg_file_p1);
 329   GNUNET_free (cfg_file_p2);
 330
 331   GNUNET_free (test_source);
 332   GNUNET_free (test_plugin);
 333   GNUNET_free (test_name);
 334
 335
 336   return ret;
 337 }
 338
 339 /* end of test_transport_api_timeout.c*/