src/transport/test_transport_api_timeout.c

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