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