src/transport/test_plugin_transport.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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 2, 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 testcase for transport_api.c
  23  * @author Sailor Siraj
  24  */
  25
  26 #include "platform.h"
  27 #include "gnunet_constants.h"
  28 #include "gnunet_getopt_lib.h"
  29 #include "gnunet_hello_lib.h"
  30 #include "gnunet_os_lib.h"
  31 #include "gnunet_peerinfo_service.h"
  32 #include "gnunet_plugin_lib.h"
  33 #include "gnunet_protocols.h"
  34 #include "gnunet_program_lib.h"
  35 #include "gnunet_signatures.h"
  36 #include "plugin_transport.h"
  37 #include "transport.h"
  38
  39 #define VERBOSE GNUNET_YES
  40
  41 /**
  42  * How long until we give up on transmitting the message?
  43  */
  44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  45
  46 /**
  47  * Our public key.
  48  */
  49 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
  50
  51 /**
  52  * Our identity.
  53  */
  54 static struct GNUNET_PeerIdentity my_identity;
  55
  56 /**
  57  * Our private key.
  58  */
  59 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
  60
  61 /**
  62  * Our scheduler.
  63  */
  64 struct GNUNET_SCHEDULER_Handle *sched;
  65
  66 /**
  67  * Our configuration.
  68  */
  69 struct GNUNET_CONFIGURATION_Handle *cfg;
  70
  71 /**
  72  * Number of neighbours we'd like to have.
  73  */
  74 static uint32_t max_connect_per_transport;
  75
  76 /**
  77  * Environment for this plugin.
  78  */
  79 struct GNUNET_TRANSPORT_PluginEnvironment env;
  80
  81 /**
  82  *handle for the api provided by this plugin
  83  */
  84 struct GNUNET_TRANSPORT_PluginFunctions *api;
  85
  86 /**
  87  * Did the test pass or fail?
  88  */
  89 static int ok;
  90
  91 /**
  92  * Initialize Environment for this plugin
  93  */
  94 struct ReadyList *
  95 receive(void *cls,void *plugin_context,
  96         struct ReadyList *
  97         service_context,
  98         struct GNUNET_TIME_Relative
  99         latency,
 100         const struct GNUNET_PeerIdentity
 101         * peer,
 102         const struct GNUNET_MessageHeader
 103         * message)
 104 {
 105   return NULL;
 106 }
 107
 108 void notify_address(void *cls,
 109                     const char *name,
 110                     const void *addr,
 111                     size_t addrlen,
 112                     struct
 113                     GNUNET_TIME_Relative
 114                     expires)
 115 {
 116 }
 117
 118 void lookup (void *cls,
 119              struct GNUNET_TIME_Relative
 120              timeout,
 121              const struct
 122              GNUNET_PeerIdentity * target,
 123              GNUNET_TRANSPORT_AddressCallback
 124              iter, void *iter_cls)
 125 {
 126 }
 127
 128
 129 /**
 130  * Function called when the service shuts
 131  * down.  Unloads our plugins.
 132  *
 133  * @param cls closure
 134  * @param cfg configuration to use
 135  */
 136 static void
 137 unload_plugins (void *cls, struct GNUNET_CONFIGURATION_Handle *cfg)
 138 {
 139   GNUNET_assert (NULL == GNUNET_PLUGIN_unload ("libgnunet_plugin_transport_tcp",api));
 140   if (my_private_key != NULL)
 141     GNUNET_CRYPTO_rsa_key_free (my_private_key);
 142
 143 }
 144
 145
 146 static GNUNET_SCHEDULER_TaskIdentifier validation_timeout_task;
 147
 148
 149 static void
 150 validation_notification (void *cls,
 151                          const char *name,
 152                          const struct GNUNET_PeerIdentity *peer,
 153                          uint32_t challenge,
 154                          const char *sender_addr)
 155 {
 156   /* Sailor: 'test_validation' should get here
 157      if the validation worked; so we cancel the
 158      "delayed" task that will cause failure */
 159   if (validation_timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
 160     {
 161       GNUNET_SCHEDULER_cancel (sched, validation_timeout_task);
 162       validation_timeout_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
 163     }
 164
 165   GNUNET_assert (challenge == 42);
 166
 167   /* Sailor: if this is the last test, calling this function
 168      here will end the process. */
 169   ok = 0; /* if the last test succeeded, report success */
 170   unload_plugins (NULL, cfg);
 171 }
 172
 173
 174 static void
 175 validation_failed (void *cls,
 176                    const struct GNUNET_SCHEDULER_TaskContext *tc)
 177 {
 178   validation_timeout_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
 179   GNUNET_break (0); /* output error */
 180   /* the "validation_notification" was not called
 181      in a timely fashion; we should set an error
 182      code for main and shut down */
 183   unload_plugins (NULL, cfg);
 184 }
 185
 186
 187 /**
 188  * Simple example test that invokes
 189  * the "validate" function of the plugin
 190  * and tries to see if the plugin would
 191  * succeed to validate its own address.
 192  * (This test is not well-written since
 193  *  we hand-compile the address which
 194  *  kind-of works for TCP but would not
 195  *  work for other plugins; we should ask
 196  *  the plugin about its address instead...).
 197  */
 198 static void
 199 test_validation ()
 200 {
 201   struct sockaddr_in soaddr;
 202
 203   memset (&soaddr, 0, sizeof(soaddr));
 204   soaddr.sin_family = AF_INET;
 205   /* Sailor: set this port to 2367 to see the
 206      testcase fail after 30s (because validation
 207      fails); obviously the test should be
 208      modified to test both successful and
 209      unsuccessful validation in the end... */
 210   soaddr.sin_port = htons(2368 /* FIXME: get from config! */);
 211   soaddr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 212   api->validate (api->cls,
 213                  &my_identity,
 214                  42,
 215                  TIMEOUT,
 216                  &soaddr,
 217                  sizeof(soaddr));
 218   /* add job to catch failure (timeout) */
 219   validation_timeout_task =
 220     GNUNET_SCHEDULER_add_delayed (sched,
 221                                   GNUNET_NO,
 222                                   GNUNET_SCHEDULER_PRIORITY_KEEP,
 223                                   GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
 224                                   TIMEOUT,
 225                                   &validation_failed,
 226                                   NULL);
 227 }
 228
 229
 230 static void setup_plugin_environment()
 231 {
 232   env.cfg  = cfg;
 233   env.sched = sched;
 234   env.my_public_key = &my_public_key;
 235   env.my_private_key = my_private_key;
 236   env.my_identity = &my_identity;
 237   env.cls=&env;
 238   env.receive=&receive;
 239   env.lookup=&lookup;
 240   env.notify_address=&notify_address;
 241   env.notify_validation = &validation_notification;
 242   env.max_connections = max_connect_per_transport;
 243 }
 244
 245
 246 /**
 247  * Runs the test.
 248  *
 249  * @param cls closure
 250  * @param s scheduler to use
 251  * @param c configuration to use
 252  */
 253 static void
 254 run (void *cls,
 255      struct GNUNET_SCHEDULER_Handle *s,
 256      char *const *args,
 257      const char *cfgfile,
 258      struct GNUNET_CONFIGURATION_Handle *c)
 259 {
 260   unsigned long long tneigh;
 261   char *keyfile;
 262   char *libname;
 263
 264   sched = s;
 265   cfg = c;
 266   /* parse configuration */
 267   if ((GNUNET_OK !=
 268        GNUNET_CONFIGURATION_get_value_number (c,
 269                                               "TRANSPORT",
 270                                               "NEIGHBOUR_LIMIT",
 271                                               &tneigh)) ||
 272       (GNUNET_OK !=
 273        GNUNET_CONFIGURATION_get_value_filename (c,
 274                                                 "GNUNETD",
 275                                                 "HOSTKEY", &keyfile)))
 276     {
 277       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 278                   _("Transport service is lacking key configuration settings.  Exiting.\n"));
 279       GNUNET_SCHEDULER_shutdown (s);
 280       return;
 281     }
 282   max_connect_per_transport = (uint32_t) tneigh;
 283   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
 284   GNUNET_free (keyfile);
 285   if (my_private_key == NULL)
 286     {
 287       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 288                   _("Transport service could not access hostkey.  Exiting.\n"));
 289       GNUNET_SCHEDULER_shutdown (s);
 290       return;
 291     }
 292   GNUNET_CRYPTO_rsa_key_get_public (my_private_key,
 293                                     &my_public_key);
 294   GNUNET_CRYPTO_hash (&my_public_key,
 295                       sizeof (my_public_key),
 296                       &my_identity.hashPubKey);
 297
 298
 299
 300   /* load plugins... */
 301   setup_plugin_environment();
 302   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 303               _("Loading tcp transport plugin\n"));
 304   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_tcp");
 305
 306   api = GNUNET_PLUGIN_load(libname, &env);
 307   if (api == NULL)
 308     {
 309       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 310                   _("Failed to load transport plugin for tcp\n"));
 311       /* FIXME: set some error code for main */
 312       return;
 313     }
 314   /* Sailor: if we had no real tests, we
 315      could call this function
 316      here to end the process; instead, I'll
 317      show how one could run a single test below.
 318      Note that the test is not particularly well-written,
 319      it just serves to illustrate (also,
 320      the "validation_notification" function above is
 321      part of the test.*/
 322   if (0)
 323     unload_plugins (NULL, cfg);
 324   else
 325     test_validation ();
 326 }
 327
 328
 329 /**
 330  * The main function for the transport service.
 331  *
 332  * @param argc number of arguments from the command line
 333  * @param argv command line arguments
 334  * @return 0 ok, 1 on error
 335  */
 336 int
 337 main (int argc, char *const *argv)
 338 {
 339   static struct GNUNET_GETOPT_CommandLineOption options[] = {
 340     GNUNET_GETOPT_OPTION_END
 341   };
 342   char *const argv_prog[] = {
 343     "test_plugin_transport",
 344     "-c",
 345     "test_plugin_transport_data.conf",
 346     "-L",
 347 #if VERBOSE
 348     "DEBUG",
 349 #else
 350     "WARNING",
 351 #endif
 352     NULL
 353   };
 354   GNUNET_log_setup ("test-plugin-transport",
 355 #if VERBOSE
 356                     "DEBUG",
 357 #else
 358                     "WARNING",
 359 #endif
 360                     NULL);
 361   ok = 1; /* set to fail */
 362   return (GNUNET_OK ==
 363           GNUNET_PROGRAM_run (5,
 364                               argv_prog,
 365                               "test-plugin-transport",
 366                               "testcase",
 367                               options,
 368                               &run, NULL)) ? ok : 1;
 369 }
 370
 371 /* end of test_plugin_transport.c */