src/hostlist/test_gnunet_daemon_hostlist_learning.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 hostlist/test_gnunet_daemon_hostlist.c
  22  * @brief test for gnunet_daemon_hostslist.c
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_util_lib.h"
  27 #include "gnunet_arm_service.h"
  28 #include "gnunet_core_service.h"
  29 #include "gnunet_transport_service.h"
  30 #include "gnunet_resolver_service.h"
  31 #include "gnunet_statistics_service.h"
  32
  33 #define VERBOSE GNUNET_YES
  34
  35 #define START_ARM GNUNET_YES
  36 #define MAX_URL_LEN 1000
  37
  38 /**
  39  * How long until wait until testcases fails
  40  */
  41 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  42 #define CHECK_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
  43
  44 static int timeout;
  45 static int adv_sent;
  46 static int adv_arrived;
  47
  48 static int learned_hostlist_saved;
  49 static int learned_hostlist_downloaded;
  50
  51 static char * current_adv_uri;
  52
  53 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  54 static struct GNUNET_SCHEDULER_Handle *sched;
  55
  56 static GNUNET_SCHEDULER_TaskIdentifier timeout_task;
  57 static GNUNET_SCHEDULER_TaskIdentifier check_task;
  58
  59 struct PeerContext
  60 {
  61   struct GNUNET_CONFIGURATION_Handle *cfg;
  62   struct GNUNET_TRANSPORT_Handle *th;
  63   struct GNUNET_MessageHeader *hello;
  64   struct GNUNET_CORE_Handle *core;
  65   struct GNUNET_STATISTICS_Handle *stats;
  66 #if START_ARM
  67   pid_t arm_pid;
  68 #endif
  69 };
  70
  71 static struct PeerContext adv_peer;
  72
  73 static struct PeerContext learn_peer;
  74
  75 static struct GNUNET_STATISTICS_GetHandle * download_stats;
  76 static struct GNUNET_STATISTICS_GetHandle * urisrecv_stat;
  77 static struct GNUNET_STATISTICS_GetHandle * advsent_stat;
  78
  79 static void shutdown_testcase()
  80 {
  81   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown testcase....\n");
  82   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping Timeout Task.\n");
  83   if (timeout_task != GNUNET_SCHEDULER_NO_TASK)
  84   {
  85     GNUNET_SCHEDULER_cancel (sched, timeout_task);
  86     timeout_task = GNUNET_SCHEDULER_NO_TASK;
  87   }
  88
  89   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping Statistics Task.\n");
  90 /*
  91   if ((NULL != learn_peer.stats) && (NULL != download_stats))
  92     GNUNET_STATISTICS_get_cancel (download_stats);
  93   if ((NULL != learn_peer.stats) && (NULL != urisrecv_stat))
  94     GNUNET_STATISTICS_get_cancel (urisrecv_stat);
  95   if ((NULL != adv_peer.stats) && (NULL != advsent_stat))
  96     GNUNET_STATISTICS_get_cancel (advsent_stat);
  97 */
  98   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stopping Statistics Check Task.\n");
  99   if ((check_task != GNUNET_SCHEDULER_NO_TASK) && (sched !=NULL))
 100   {
 101     GNUNET_SCHEDULER_cancel (sched, check_task);
 102     check_task = GNUNET_SCHEDULER_NO_TASK;
 103   }
 104
 105   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Freeing uri\n");
 106   if ( NULL != current_adv_uri ) GNUNET_free (current_adv_uri);
 107   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from Transport.\n");
 108   if (adv_peer.th != NULL)
 109   {
 110     GNUNET_TRANSPORT_disconnect (adv_peer.th);
 111     adv_peer.th = NULL;
 112   }
 113   if (learn_peer.th != NULL)
 114   {
 115     GNUNET_TRANSPORT_disconnect (learn_peer.th);
 116     learn_peer.th = NULL;
 117   }
 118
 119   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from Core.\n");
 120   if (adv_peer.core != NULL)
 121   {
 122     GNUNET_CORE_disconnect (adv_peer.core);
 123     adv_peer.core = NULL;
 124   }
 125   if (learn_peer.core != NULL)
 126   {
 127     GNUNET_CORE_disconnect (learn_peer.core);
 128     learn_peer.core = NULL;
 129   }
 130   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 131               "Asking ARM to stop core services\n");
 132
 133
 134 #if START_ARM
 135   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 136               "Killing hostlist server ARM process.\n");
 137   if (0 != PLIBC_KILL (adv_peer.arm_pid, SIGTERM))
 138     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 139   if (GNUNET_OS_process_wait(adv_peer.arm_pid) != GNUNET_OK)
 140     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 141   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 142               "Hostlist server ARM process %u stopped\n", adv_peer.arm_pid);
 143 #endif
 144
 145
 146 #if START_ARM
 147   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 148               "Killing hostlist client ARM process.\n");
 149   if (0 != PLIBC_KILL (learn_peer.arm_pid, SIGTERM))
 150     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 151   if (GNUNET_OS_process_wait(learn_peer.arm_pid) != GNUNET_OK)
 152     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
 153   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 154               "Hostlist client ARM process %u stopped\n", learn_peer.arm_pid);
 155 #endif
 156
 157   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutting down scheduler\n");
 158   GNUNET_SCHEDULER_shutdown (sched);
 159   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown complete....\n");
 160
 161 }
 162
 163 /**
 164  * Timeout, give up.
 165  */
 166 static void
 167 timeout_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 168 {
 169   timeout_task = GNUNET_SCHEDULER_NO_TASK;
 170   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 171     return;
 172   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 173               "Timeout while executing testcase, test failed.\n");
 174   timeout = GNUNET_YES;
 175   shutdown_testcase();
 176 }
 177
 178 static int
 179 process_downloads (void *cls,
 180               const char *subsystem,
 181               const char *name,
 182               uint64_t value,
 183               int is_persistent)
 184 {
 185   download_stats = NULL;
 186   if ( ((struct PeerContext *) cls == &learn_peer) && (value == 2) && (learned_hostlist_downloaded == GNUNET_NO) )
 187   {
 188     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 189                 _("Peer has successfully downloaded advertised URI \n"));
 190     learned_hostlist_downloaded = GNUNET_YES;
 191   }
 192   if (GNUNET_NO != learned_hostlist_downloaded)
 193     shutdown_testcase();
 194   return GNUNET_OK;
 195 }
 196
 197 static int
 198 process_uris_recv (void *cls,
 199               const char *subsystem,
 200               const char *name,
 201               uint64_t value,
 202               int is_persistent)
 203 {
 204   urisrecv_stat = NULL;
 205   if ( ((struct PeerContext *) cls == &learn_peer) && (value == 1) && (learned_hostlist_saved == GNUNET_NO))
 206   {
 207     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 208                 _("Peer has successfully saved advertised URI \n"));
 209     learned_hostlist_saved = GNUNET_YES;
 210   }
 211   return GNUNET_OK;
 212 }
 213
 214 static int
 215 process_adv_sent (void *cls,
 216               const char *subsystem,
 217               const char *name,
 218               uint64_t value,
 219               int is_persistent)
 220 {
 221   advsent_stat = NULL;
 222   if ( (value >= 1) && (adv_sent == GNUNET_NO))
 223   {
 224     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 225                 _("Server has successfully sent advertisement\n"));
 226     adv_sent = GNUNET_YES;
 227   }
 228   return GNUNET_OK;
 229 }
 230
 231
 232 /**
 233  * Check the server statistics regularly
 234  */
 235 static void
 236 check_statistics (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 237 {
 238   char *stat;
 239
 240   check_task = GNUNET_SCHEDULER_NO_TASK;
 241     if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 242       return;
 243
 244   GNUNET_asprintf (&stat,
 245                    gettext_noop("# advertised URI `%s' downloaded"),
 246                    current_adv_uri);
 247   if ( NULL != learn_peer.stats)
 248   {
 249     download_stats = GNUNET_STATISTICS_get (learn_peer.stats,
 250                            "hostlist",
 251                            stat,
 252                            GNUNET_TIME_UNIT_MINUTES,
 253                            NULL,
 254                            &process_downloads,
 255                            &learn_peer);
 256
 257     urisrecv_stat = GNUNET_STATISTICS_get (learn_peer.stats,
 258                            "hostlist",
 259                            gettext_noop("# advertised hostlist URIs"),
 260                            GNUNET_TIME_UNIT_MINUTES,
 261                            NULL,
 262                            &process_uris_recv,
 263                            &learn_peer);
 264   }
 265   GNUNET_free (stat);
 266   if ( NULL != adv_peer.stats)
 267   {
 268     advsent_stat = GNUNET_STATISTICS_get (adv_peer.stats,
 269                            "hostlist",
 270                            gettext_noop("# hostlist advertisements send"),
 271                            GNUNET_TIME_UNIT_MINUTES,
 272                            NULL,
 273                            &process_adv_sent,
 274                            NULL);
 275   }
 276   check_task = GNUNET_SCHEDULER_add_delayed (sched,
 277                                 CHECK_INTERVALL,
 278                                 &check_statistics,
 279                                 NULL);
 280 }
 281
 282 /**
 283  * Core handler for p2p hostlist advertisements
 284  */
 285 static int ad_arrive_handler (void *cls,
 286                              const struct GNUNET_PeerIdentity * peer,
 287                              const struct GNUNET_MessageHeader * message,
 288                              struct GNUNET_TIME_Relative latency,
 289                              uint32_t distance)
 290 {
 291   char *hostname;
 292   char *expected_uri = GNUNET_malloc (MAX_URL_LEN);
 293
 294   unsigned long long port;
 295   size_t size;
 296   const struct GNUNET_MessageHeader * incoming;
 297
 298   if (-1 == GNUNET_CONFIGURATION_get_value_number (adv_peer.cfg,
 299                                                    "HOSTLIST",
 300                                                    "HTTPPORT",
 301                                                    &port))
 302     {
 303     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 304                 "Could not read advertising server's configuration\n" );
 305     if ( NULL != expected_uri ) GNUNET_free ( expected_uri );
 306     return GNUNET_SYSERR;
 307     }
 308
 309   if ( GNUNET_SYSERR  == GNUNET_CONFIGURATION_get_value_string (adv_peer.cfg,
 310                                                    "HOSTLIST",
 311                                                    "EXTERNAL_DNS_NAME",
 312                                                    &hostname))
 313     hostname = GNUNET_RESOLVER_local_fqdn_get ();
 314
 315   if (NULL != hostname)
 316     {
 317       size = strlen (hostname);
 318       if (size + 15 > MAX_URL_LEN)
 319         {
 320           GNUNET_break (0);
 321         }
 322       else
 323         {
 324           GNUNET_asprintf (&expected_uri,
 325                            "http://%s:%u/",
 326                            hostname,
 327                            (unsigned int) port);
 328         }
 329     }
 330
 331   incoming = (const struct GNUNET_MessageHeader *) message;
 332   current_adv_uri = strdup ((char*) &incoming[1]);
 333   if ( 0 == strcmp( expected_uri, current_adv_uri ) )
 334   {
 335     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 336                 "Recieved hostlist advertisement with URI `%s' as expected\n", current_adv_uri);
 337     adv_arrived = GNUNET_YES;
 338     adv_sent = GNUNET_YES;
 339   }
 340   else
 341     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 342                 "Expected URI `%s' and recieved URI `%s' differ\n", expected_uri, current_adv_uri);
 343   GNUNET_free_non_null (expected_uri);
 344   GNUNET_free_non_null (hostname);
 345   return GNUNET_OK;
 346 }
 347
 348 /**
 349  * List of handlers if we are learning.
 350  */
 351 static struct GNUNET_CORE_MessageHandler learn_handlers[] = {
 352   { &ad_arrive_handler, GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT, 0},
 353   { NULL, 0, 0 }
 354 };
 355
 356 static void
 357 setup_learn_peer (struct PeerContext *p, const char *cfgname)
 358 {
 359   char * filename;
 360   unsigned int result;
 361   p->cfg = GNUNET_CONFIGURATION_create ();
 362 #if START_ARM
 363   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 364                                         "gnunet-service-arm",
 365 #if VERBOSE
 366                                         "-L", "DEBUG",
 367 #endif
 368                                         "-c", cfgname, NULL);
 369 #endif
 370   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 371   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (p->cfg,
 372                                                           "HOSTLIST",
 373                                                           "HOSTLISTFILE",
 374                                                           &filename))
 375   {
 376   if ( GNUNET_YES == GNUNET_DISK_file_test (filename) )
 377     {
 378       result = remove (filename);
 379       if (result == 0)
 380       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 381             _("Hostlist file `%s' was removed\n"),filename);
 382     }
 383   }
 384   if ( NULL != filename)  GNUNET_free ( filename );
 385
 386   p->core = GNUNET_CORE_connect (sched, p->cfg,
 387                               GNUNET_TIME_UNIT_FOREVER_REL,
 388                               NULL,
 389                               NULL,
 390                               NULL, NULL,
 391                               NULL, GNUNET_NO,
 392                               NULL, GNUNET_NO,
 393                               learn_handlers );
 394   GNUNET_assert ( NULL != p->core );
 395   p->stats = GNUNET_STATISTICS_create (sched, "hostlist", p->cfg);
 396   GNUNET_assert ( NULL != p->stats );
 397 }
 398
 399
 400 static void
 401 setup_adv_peer (struct PeerContext *p, const char *cfgname)
 402 {
 403
 404   p->cfg = GNUNET_CONFIGURATION_create ();
 405 #if START_ARM
 406   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 407                                         "gnunet-service-arm",
 408 #if VERBOSE
 409                                         "-L", "DEBUG",
 410 #endif
 411                                         "-c", cfgname, NULL);
 412 #endif
 413   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 414   p->stats = GNUNET_STATISTICS_create (sched, "hostlist", p->cfg);
 415   GNUNET_assert ( NULL != p->stats );
 416
 417 }
 418
 419 static void
 420 run (void *cls,
 421      struct GNUNET_SCHEDULER_Handle *s,
 422      char *const *args,
 423      const char *cfgfile,
 424      const struct GNUNET_CONFIGURATION_Handle *c)
 425 {
 426   timeout = GNUNET_NO;
 427   adv_sent =GNUNET_NO;
 428
 429   adv_arrived = 0;
 430   learned_hostlist_saved = GNUNET_NO;
 431   learned_hostlist_downloaded = GNUNET_NO;
 432
 433   cfg = c;
 434   sched = s;
 435
 436   setup_adv_peer (&adv_peer, "test_learning_adv_peer.conf");
 437   setup_learn_peer (&learn_peer, "test_learning_learn_peer.conf");
 438   timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
 439                                                TIMEOUT,
 440                                                &timeout_error,
 441                                                NULL);
 442
 443   check_task = GNUNET_SCHEDULER_add_delayed (sched,
 444                                 CHECK_INTERVALL,
 445                                 &check_statistics,
 446                                 NULL);
 447 }
 448
 449 static int
 450 check ()
 451 {
 452   unsigned int failed;
 453   char *const argv[] = { "test-gnunet-daemon-hostlist-learning",
 454     "-c", "learning_data.conf",
 455 #if VERBOSE
 456     "-L", "DEBUG",
 457 #endif
 458     NULL
 459   };
 460   struct GNUNET_GETOPT_CommandLineOption options[] = {
 461     GNUNET_GETOPT_OPTION_END
 462   };
 463
 464   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 465                       argv, "test-gnunet-daemon-hostlist-learning",
 466                       "nohelp", options, &run, NULL);
 467
 468   failed = GNUNET_NO;
 469
 470   if (timeout == GNUNET_YES)
 471   {
 472     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 473                 "Testcase could not set up two communicating peers, timeout\n");
 474     failed = GNUNET_YES;
 475   }
 476   if (adv_arrived != GNUNET_YES)
 477   {
 478     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 479                 "Learning peer did not receive advertisement from server\n");
 480     failed = GNUNET_YES;
 481   }
 482   if ( learned_hostlist_saved == GNUNET_NO )
 483     {
 484       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 485                   "Peer1: Advertised hostlist was not saved in datastore\n");
 486       failed = GNUNET_YES;
 487     }
 488   if (learned_hostlist_downloaded == GNUNET_NO)
 489   {
 490     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 491                 "Peer1: Advertised hostlist could not be downloaded from server\n");
 492     failed = GNUNET_YES;
 493   }
 494   if (adv_sent == GNUNET_NO)
 495   {
 496     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 497                 "Advertised was not sent from server to client\n");
 498     failed = GNUNET_YES;
 499   }
 500   if ( GNUNET_YES == failed )
 501     return GNUNET_YES;
 502   else
 503     return GNUNET_NO;
 504 }
 505
 506 int
 507 main (int argc, char *argv[])
 508 {
 509
 510   int ret;
 511
 512   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-1");
 513   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-2");
 514   GNUNET_log_setup ("test-gnunet-daemon-hostlist",
 515 #if VERBOSE
 516                     "DEBUG",
 517 #else
 518                     "WARNING",
 519 #endif
 520                     NULL);
 521   ret = check ();
 522   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-1");
 523   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-2");
 524   if ( GNUNET_YES == GNUNET_DISK_file_test ("hostlists_learn_peer.file") )
 525     {
 526       if ( remove ("hostlists_learn_peer.file")  == 0)
 527       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 528             _("Hostlist file hostlists_learn_peer.file was removed\n"));
 529     }
 530   return ret;
 531 }
 532
 533 /* end of test_gnunet_daemon_hostlist.c */