src/hostlist/test_gnunet_daemon_hostlist_learning.c

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