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, 120)
  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 char *test_source;
  59
  60 static char *test_plugin;
  61
  62 static char *test_name;
  63
  64 static int ok;
  65
  66 static GNUNET_SCHEDULER_TaskIdentifier die_task;
  67
  68 static GNUNET_SCHEDULER_TaskIdentifier send_task;
  69
  70 struct PeerContext *p1;
  71
  72 struct PeerContext *p2;
  73
  74 static GNUNET_TRANSPORT_TESTING_ConnectRequest cc;
  75
  76 struct GNUNET_TRANSPORT_TransmitHandle *th;
  77
  78 char *cfg_file_p1;
  79
  80 char *cfg_file_p2;
  81
  82 #if VERBOSE
  83 #define OKPP do { ok++; fprintf (stderr, "Now at stage %u at %s:%u\n", ok, __FILE__, __LINE__); } while (0)
  84 #else
  85 #define OKPP do { ok++; } while (0)
  86 #endif
  87
  88
  89 static void
  90 end ()
  91 {
  92   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping peers\n");
  93
  94   if (send_task != GNUNET_SCHEDULER_NO_TASK)
  95     GNUNET_SCHEDULER_cancel (send_task);
  96
  97   if (die_task != GNUNET_SCHEDULER_NO_TASK)
  98     GNUNET_SCHEDULER_cancel (die_task);
  99
 100   if (th != NULL)
 101     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 102   th = NULL;
 103
 104   GNUNET_TRANSPORT_TESTING_stop_peer (p1);
 105   GNUNET_TRANSPORT_TESTING_stop_peer (p2);
 106 }
 107
 108 static void
 109 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 110 {
 111   die_task = GNUNET_SCHEDULER_NO_TASK;
 112
 113   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Fail! Stopping peers\n");
 114
 115   if (send_task != GNUNET_SCHEDULER_NO_TASK)
 116     GNUNET_SCHEDULER_cancel (send_task);
 117
 118   if (cc != NULL)
 119   {
 120     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Fail! Could not connect peers\n"));
 121     GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
 122   }
 123
 124   if (th != NULL)
 125     GNUNET_TRANSPORT_notify_transmit_ready_cancel (th);
 126   th = NULL;
 127
 128   if (p1 != NULL)
 129     GNUNET_TRANSPORT_TESTING_stop_peer (p1);
 130   if (p2 != NULL)
 131     GNUNET_TRANSPORT_TESTING_stop_peer (p2);
 132
 133   ok = GNUNET_SYSERR;
 134 }
 135
 136
 137 static void
 138 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
 139                 const struct GNUNET_MessageHeader *message,
 140                 const struct GNUNET_TRANSPORT_ATS_Information *ats,
 141                 uint32_t ats_count)
 142 {
 143   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 144               "Received message of type %d from peer %s!\n",
 145               ntohs (message->type), GNUNET_i2s (peer));
 146
 147   if ((MTYPE == ntohs (message->type)) &&
 148       (sizeof (struct GNUNET_MessageHeader) == ntohs (message->size)))
 149   {
 150     ok = 0;
 151     end ();
 152   }
 153   else
 154   {
 155     GNUNET_break (0);
 156     ok = 1;
 157     end ();
 158   }
 159 }
 160
 161
 162 static size_t
 163 notify_ready (void *cls, size_t size, void *buf)
 164 {
 165   struct PeerContext *p = cls;
 166   struct GNUNET_MessageHeader *hdr;
 167
 168   th = NULL;
 169
 170   if (buf == NULL)
 171   {
 172     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 173                 "Timeout occurred while waiting for transmit_ready\n");
 174     if (GNUNET_SCHEDULER_NO_TASK != die_task)
 175       GNUNET_SCHEDULER_cancel (die_task);
 176     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 177     ok = 42;
 178     return 0;
 179   }
 180
 181   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 182               "Transmitting message with %u bytes to peer %s\n",
 183               sizeof (struct GNUNET_MessageHeader), GNUNET_i2s (&p->id));
 184   GNUNET_assert (size >= 256);
 185
 186   if (buf != NULL)
 187   {
 188     hdr = buf;
 189     hdr->size = htons (sizeof (struct GNUNET_MessageHeader));
 190     hdr->type = htons (MTYPE);
 191   }
 192   return sizeof (struct GNUNET_MessageHeader);
 193 }
 194
 195
 196 static void
 197 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
 198                 const struct GNUNET_TRANSPORT_ATS_Information *ats,
 199                 uint32_t ats_count)
 200 {
 201   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' connected to us (%p)!\n",
 202               GNUNET_i2s (peer), cls);
 203 }
 204
 205
 206 static void
 207 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
 208 {
 209   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%4s' disconnected (%p)!\n",
 210               GNUNET_i2s (peer), cls);
 211 }
 212
 213 static void
 214 sendtask (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 215 {
 216   send_task = GNUNET_SCHEDULER_NO_TASK;
 217
 218   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
 219     return;
 220
 221   th = GNUNET_TRANSPORT_notify_transmit_ready (p1->th, &p2->id, 256, 0,
 222                                                TIMEOUT_TRANSMIT, &notify_ready,
 223                                                &p1);
 224 }
 225
 226 static void
 227 testing_connect_cb (struct PeerContext *p1, struct PeerContext *p2, void *cls)
 228 {
 229   cc = NULL;
 230   char *p1_c = strdup (GNUNET_i2s (&p1->id));
 231
 232   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peers connected: %s <-> %s\n", p1_c,
 233               GNUNET_i2s (&p2->id));
 234   GNUNET_free (p1_c);
 235
 236   // FIXME: THIS IS REQUIRED! SEEMS TO BE A BUG!
 237   send_task =
 238       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &sendtask, NULL);
 239 }
 240
 241 static void
 242 run (void *cls, char *const *args, const char *cfgfile,
 243      const struct GNUNET_CONFIGURATION_Handle *cfg)
 244 {
 245   die_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &end_badly, NULL);
 246
 247   p1 = GNUNET_TRANSPORT_TESTING_start_peer (cfg_file_p1, &notify_receive,
 248                                             &notify_connect, &notify_disconnect,
 249                                             NULL);
 250   p2 = GNUNET_TRANSPORT_TESTING_start_peer (cfg_file_p2, &notify_receive,
 251                                             &notify_connect, &notify_disconnect,
 252                                             NULL);
 253
 254   if ((p1 == NULL) || (p2 == NULL))
 255   {
 256     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Fail! Could not start peers!\n");
 257     if (die_task != GNUNET_SCHEDULER_NO_TASK)
 258       GNUNET_SCHEDULER_cancel (die_task);
 259     die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 260     return;
 261   }
 262
 263   cc = GNUNET_TRANSPORT_TESTING_connect_peers (p1, p2, &testing_connect_cb,
 264                                                NULL);
 265 }
 266
 267
 268 static int
 269 check ()
 270 {
 271   static char *const argv[] = { "test-transport-api",
 272     "-c",
 273     "test_transport_api_data.conf",
 274 #if VERBOSE
 275     "-L", "DEBUG",
 276 #endif
 277     NULL
 278   };
 279   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 280     GNUNET_GETOPT_OPTION_END
 281   };
 282
 283 #if WRITECONFIG
 284   setTransportOptions ("test_transport_api_data.conf");
 285 #endif
 286   send_task = GNUNET_SCHEDULER_NO_TASK;
 287
 288   ok = 1;
 289   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv, test_name,
 290                       "nohelp", options, &run, &ok);
 291
 292   return ok;
 293 }
 294
 295 int
 296 main (int argc, char *argv[])
 297 {
 298   int ret;
 299   int nat_res;
 300
 301   GNUNET_TRANSPORT_TESTING_get_test_source_name (__FILE__, &test_source);
 302   GNUNET_TRANSPORT_TESTING_get_test_plugin_name (argv[0], test_source,
 303                                                  &test_plugin);
 304   GNUNET_TRANSPORT_TESTING_get_test_name (argv[0], &test_name);
 305
 306   GNUNET_log_setup (test_name,
 307 #if VERBOSE
 308                     "DEBUG",
 309 #else
 310                     "WARNING",
 311 #endif
 312                     NULL);
 313
 314   if ((strcmp (test_plugin, "tcp_nat") == 0) ||
 315       (strcmp (test_plugin, "udp_nat") == 0))
 316   {
 317     nat_res = GNUNET_OS_check_helper_binary ("gnunet-nat-server");
 318     if (GNUNET_NO == nat_res)
 319     {
 320       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 321                   "gnunet-nat-server", "SUID not set");
 322       return 0;
 323     }
 324     if (GNUNET_SYSERR == nat_res)
 325     {
 326       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Cannot run NAT test: `%s' %s \n",
 327                   "gnunet-nat-server", "file not found");
 328       return 0;
 329     }
 330   }
 331
 332   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p1, 1);
 333   GNUNET_TRANSPORT_TESTING_get_config_name (argv[0], &cfg_file_p2, 2);
 334
 335   ret = check ();
 336
 337   GNUNET_free (cfg_file_p1);
 338   GNUNET_free (cfg_file_p2);
 339
 340   GNUNET_free (test_source);
 341   GNUNET_free (test_plugin);
 342   GNUNET_free (test_name);
 343
 344
 345   return ret;
 346 }
 347
 348 /* end of test_transport_api.c */