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