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 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 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, 180)
  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 ( (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     shutdown_testcase();
 192   }
 193   return GNUNET_OK;
 194 }
 195
 196 static int
 197 process_uris_recv (void *cls,
 198               const char *subsystem,
 199               const char *name,
 200               uint64_t value,
 201               int is_persistent)
 202 {
 203   urisrecv_stat = NULL;
 204   if ( ((struct PeerContext *) cls == &learn_peer) && (value == 1) && (learned_hostlist_saved == GNUNET_NO))
 205   {
 206     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 207                 _("Peer has successfully saved advertised URI \n"));
 208     learned_hostlist_saved = GNUNET_YES;
 209   }
 210   return GNUNET_OK;
 211 }
 212
 213 static int
 214 process_adv_sent (void *cls,
 215               const char *subsystem,
 216               const char *name,
 217               uint64_t value,
 218               int is_persistent)
 219 {
 220   advsent_stat = NULL;
 221   if ( (value >= 1) && (adv_sent == GNUNET_NO))
 222   {
 223     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 224                 _("Server has successfully sent advertisement\n"));
 225     adv_sent = GNUNET_YES;
 226   }
 227   return GNUNET_OK;
 228 }
 229
 230
 231 /**
 232  * Check the server statistics regularly
 233  */
 234 static void
 235 check_statistics (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 236 {
 237   char *stat;
 238
 239   check_task = GNUNET_SCHEDULER_NO_TASK;
 240     if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 241       return;
 242
 243   GNUNET_asprintf (&stat,
 244                    gettext_noop("# advertised URI `%s' downloaded"),
 245                    current_adv_uri);
 246   if ( NULL != learn_peer.stats)
 247   {
 248     download_stats = GNUNET_STATISTICS_get (learn_peer.stats,
 249                            "hostlist",
 250                            stat,
 251                            GNUNET_TIME_UNIT_MINUTES,
 252                            NULL,
 253                            &process_downloads,
 254                            &learn_peer);
 255
 256     urisrecv_stat = GNUNET_STATISTICS_get (learn_peer.stats,
 257                            "hostlist",
 258                            gettext_noop("# advertised hostlist URIs"),
 259                            GNUNET_TIME_UNIT_MINUTES,
 260                            NULL,
 261                            &process_uris_recv,
 262                            &learn_peer);
 263   }
 264   GNUNET_free (stat);
 265   if ( NULL != adv_peer.stats)
 266   {
 267     advsent_stat = GNUNET_STATISTICS_get (adv_peer.stats,
 268                            "hostlist",
 269                            gettext_noop("# hostlist advertisements send"),
 270                            GNUNET_TIME_UNIT_MINUTES,
 271                            NULL,
 272                            &process_adv_sent,
 273                            NULL);
 274   }
 275   check_task = GNUNET_SCHEDULER_add_delayed (sched,
 276                                 CHECK_INTERVALL,
 277                                 &check_statistics,
 278                                 NULL);
 279 }
 280
 281 /**
 282  * Core handler for p2p hostlist advertisements
 283  */
 284 static int ad_arrive_handler (void *cls,
 285                              const struct GNUNET_PeerIdentity * peer,
 286                              const struct GNUNET_MessageHeader * message,
 287                              struct GNUNET_TIME_Relative latency,
 288                              uint32_t distance)
 289 {
 290   char *hostname;
 291   char *expected_uri;
 292   unsigned long long port;
 293   const struct GNUNET_MessageHeader * incoming;
 294
 295   if (-1 == GNUNET_CONFIGURATION_get_value_number (adv_peer.cfg,
 296                                                    "HOSTLIST",
 297                                                    "HTTPPORT",
 298                                                    &port))
 299     {
 300       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 301                   "Could not read advertising server's configuration\n" );
 302       return GNUNET_SYSERR;
 303     }
 304
 305   if ( GNUNET_SYSERR  == GNUNET_CONFIGURATION_get_value_string (adv_peer.cfg,
 306                                                    "HOSTLIST",
 307                                                    "EXTERNAL_DNS_NAME",
 308                                                    &hostname))
 309     hostname = GNUNET_RESOLVER_local_fqdn_get ();
 310
 311   GNUNET_asprintf (&expected_uri,
 312                    "http://%s:%u/",
 313                    hostname != NULL ? hostname : "localhost",
 314                    (unsigned int) port);
 315   incoming = (const struct GNUNET_MessageHeader *) message;
 316   current_adv_uri = strdup ((char*) &incoming[1]);
 317   if ( 0 == strcmp( expected_uri, current_adv_uri ) )
 318     {
 319       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 320                   "Recieved hostlist advertisement with URI `%s' as expected\n", current_adv_uri);
 321       adv_arrived = GNUNET_YES;
 322       adv_sent = GNUNET_YES;
 323     }
 324   else
 325     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 326                 "Expected URI `%s' and recieved URI `%s' differ\n", expected_uri, current_adv_uri);
 327   GNUNET_free (expected_uri);
 328   GNUNET_free_non_null (hostname);
 329   return GNUNET_OK;
 330 }
 331
 332 /**
 333  * List of handlers if we are learning.
 334  */
 335 static struct GNUNET_CORE_MessageHandler learn_handlers[] = {
 336   { &ad_arrive_handler, GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT, 0},
 337   { NULL, 0, 0 }
 338 };
 339
 340 static void
 341 setup_learn_peer (struct PeerContext *p, const char *cfgname)
 342 {
 343   char * filename;
 344   unsigned int result;
 345   p->cfg = GNUNET_CONFIGURATION_create ();
 346 #if START_ARM
 347   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 348                                         "gnunet-service-arm",
 349 #if VERBOSE
 350                                         "-L", "DEBUG",
 351 #endif
 352                                         "-c", cfgname, NULL);
 353 #endif
 354   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 355   if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (p->cfg,
 356                                                           "HOSTLIST",
 357                                                           "HOSTLISTFILE",
 358                                                           &filename))
 359   {
 360   if ( GNUNET_YES == GNUNET_DISK_file_test (filename) )
 361     {
 362       result = remove (filename);
 363       if (result == 0)
 364       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 365             _("Hostlist file `%s' was removed\n"),filename);
 366     }
 367   }
 368   if ( NULL != filename)  GNUNET_free ( filename );
 369
 370   p->core = GNUNET_CORE_connect (sched, p->cfg,
 371                                  GNUNET_TIME_UNIT_FOREVER_REL,
 372                                  NULL,
 373                                  NULL,
 374                                  NULL, NULL, NULL,
 375                                  NULL, GNUNET_NO,
 376                                  NULL, GNUNET_NO,
 377                                  learn_handlers );
 378   GNUNET_assert ( NULL != p->core );
 379   p->stats = GNUNET_STATISTICS_create (sched, "hostlist", p->cfg);
 380   GNUNET_assert ( NULL != p->stats );
 381 }
 382
 383
 384 static void
 385 setup_adv_peer (struct PeerContext *p, const char *cfgname)
 386 {
 387
 388   p->cfg = GNUNET_CONFIGURATION_create ();
 389 #if START_ARM
 390   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 391                                         "gnunet-service-arm",
 392 #if VERBOSE
 393                                         "-L", "DEBUG",
 394 #endif
 395                                         "-c", cfgname, NULL);
 396 #endif
 397   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 398   p->stats = GNUNET_STATISTICS_create (sched, "hostlist", p->cfg);
 399   GNUNET_assert ( NULL != p->stats );
 400
 401 }
 402
 403 static void
 404 run (void *cls,
 405      struct GNUNET_SCHEDULER_Handle *s,
 406      char *const *args,
 407      const char *cfgfile,
 408      const struct GNUNET_CONFIGURATION_Handle *c)
 409 {
 410   timeout = GNUNET_NO;
 411   adv_sent =GNUNET_NO;
 412
 413   adv_arrived = 0;
 414   learned_hostlist_saved = GNUNET_NO;
 415   learned_hostlist_downloaded = GNUNET_NO;
 416
 417   cfg = c;
 418   sched = s;
 419
 420   setup_adv_peer (&adv_peer, "test_learning_adv_peer.conf");
 421   setup_learn_peer (&learn_peer, "test_learning_learn_peer.conf");
 422   timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
 423                                                TIMEOUT,
 424                                                &timeout_error,
 425                                                NULL);
 426
 427   check_task = GNUNET_SCHEDULER_add_delayed (sched,
 428                                 CHECK_INTERVALL,
 429                                 &check_statistics,
 430                                 NULL);
 431 }
 432
 433 static int
 434 check ()
 435 {
 436   unsigned int failed;
 437   char *const argv[] = { "test-gnunet-daemon-hostlist-learning",
 438     "-c", "learning_data.conf",
 439 #if VERBOSE
 440     "-L", "DEBUG",
 441 #endif
 442     NULL
 443   };
 444   struct GNUNET_GETOPT_CommandLineOption options[] = {
 445     GNUNET_GETOPT_OPTION_END
 446   };
 447
 448   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 449                       argv, "test-gnunet-daemon-hostlist-learning",
 450                       "nohelp", options, &run, NULL);
 451
 452   failed = GNUNET_NO;
 453
 454   if (learned_hostlist_downloaded == GNUNET_YES)
 455     return GNUNET_NO;
 456
 457   if (timeout == GNUNET_YES)
 458   {
 459     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 460                 "Testcase could not set up two communicating peers, timeout\n");
 461     failed = GNUNET_YES;
 462   }
 463   if (adv_arrived != GNUNET_YES)
 464   {
 465     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 466                 "Learning peer did not receive advertisement from server\n");
 467     failed = GNUNET_YES;
 468   }
 469   if ( learned_hostlist_saved == GNUNET_NO )
 470     {
 471       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 472                   "Peer1: Advertised hostlist was not saved in datastore\n");
 473       failed = GNUNET_YES;
 474     }
 475   if (learned_hostlist_downloaded == GNUNET_NO)
 476   {
 477     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 478                 "Peer1: Advertised hostlist could not be downloaded from server\n");
 479     failed = GNUNET_YES;
 480   }
 481   if (adv_sent == GNUNET_NO)
 482   {
 483     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 484                 "Advertised was not sent from server to client\n");
 485     failed = GNUNET_YES;
 486   }
 487   if ( GNUNET_YES == failed )
 488     return GNUNET_YES;
 489   else
 490     return GNUNET_NO;
 491 }
 492
 493 int
 494 main (int argc, char *argv[])
 495 {
 496
 497   int ret;
 498
 499   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-1");
 500   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-2");
 501   GNUNET_log_setup ("test-gnunet-daemon-hostlist",
 502 #if VERBOSE
 503                     "DEBUG",
 504 #else
 505                     "WARNING",
 506 #endif
 507                     NULL);
 508   ret = check ();
 509   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-1");
 510   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-2");
 511   if ( GNUNET_YES == GNUNET_DISK_file_test ("hostlists_learn_peer.file") )
 512     {
 513       if ( remove ("hostlists_learn_peer.file")  == 0)
 514       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 515             _("Hostlist file hostlists_learn_peer.file was removed\n"));
 516     }
 517   return ret;
 518 }
 519
 520 /* end of test_gnunet_daemon_hostlist.c */