src/hostlist/test_gnunet_daemon_hostlist_learning.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2009, 2010, 2011, 2012 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_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_INTERVALL 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 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
  68
  69 static GNUNET_SCHEDULER_TaskIdentifier 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 != GNUNET_SCHEDULER_NO_TASK)
  87   {
  88     GNUNET_SCHEDULER_cancel (timeout_task);
  89     timeout_task = GNUNET_SCHEDULER_NO_TASK;
  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 != GNUNET_SCHEDULER_NO_TASK)
 117   {
 118     GNUNET_SCHEDULER_cancel (check_task);
 119     check_task = GNUNET_SCHEDULER_NO_TASK;
 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, SIGTERM))
 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, SIGTERM))
 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, const struct GNUNET_SCHEDULER_TaskContext *tc)
 170 {
 171   timeout_task = GNUNET_SCHEDULER_NO_TASK;
 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              const struct GNUNET_SCHEDULER_TaskContext *tc)
 189 {
 190   shutdown_testcase ();
 191 }
 192
 193
 194 static int
 195 process_downloads (void *cls, const char *subsystem, const char *name,
 196                    uint64_t value, int is_persistent)
 197 {
 198   if ((value >= 2) && (learned_hostlist_downloaded == GNUNET_NO))
 199   {
 200     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 201                 "Peer has successfully downloaded advertised URI\n");
 202     learned_hostlist_downloaded = GNUNET_YES;
 203     if ((learned_hostlist_saved == GNUNET_YES) && (adv_sent == GNUNET_YES))
 204     {
 205       GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 206     }
 207   }
 208   return GNUNET_OK;
 209 }
 210
 211
 212 static void
 213 process_uris_recv_done (void *cls, int success)
 214 {
 215   urisrecv_stat = NULL;
 216 }
 217
 218
 219 static int
 220 process_uris_recv (void *cls, const char *subsystem, const char *name,
 221                    uint64_t value, int is_persistent)
 222 {
 223   if (((struct PeerContext *) cls == &learn_peer) && (value == 1) &&
 224       (learned_hostlist_saved == GNUNET_NO))
 225   {
 226     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 227                 "Peer has successfully saved advertised URI\n");
 228     learned_hostlist_saved = GNUNET_YES;
 229     if ((learned_hostlist_downloaded == GNUNET_YES) && (adv_sent == GNUNET_YES))
 230     {
 231       GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 232     }
 233   }
 234   return GNUNET_OK;
 235 }
 236
 237
 238 static void
 239 process_adv_sent_done (void *cls, int success)
 240 {
 241   advsent_stat = NULL;
 242 }
 243
 244
 245 static int
 246 process_adv_sent (void *cls, const char *subsystem, const char *name,
 247                   uint64_t value, int is_persistent)
 248 {
 249   if ((value >= 1) && (adv_sent == GNUNET_NO))
 250   {
 251     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 252                 "Server has successfully sent advertisement\n");
 253     adv_sent = GNUNET_YES;
 254     if ((learned_hostlist_downloaded == GNUNET_YES) &&
 255         (learned_hostlist_saved == GNUNET_YES))
 256     {
 257       GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 258     }
 259   }
 260   return GNUNET_OK;
 261 }
 262
 263
 264 /**
 265  * Check the server statistics regularly
 266  */
 267 static void
 268 check_statistics (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 269 {
 270   char *stat;
 271
 272   check_task = GNUNET_SCHEDULER_NO_TASK;
 273   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 274     return;
 275   GNUNET_asprintf (&stat, 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_INTERVALL, &check_statistics, NULL);
 308 }
 309
 310
 311 /**
 312  * Core handler for p2p hostlist advertisements
 313  */
 314 static int
 315 ad_arrive_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
 316                    const struct GNUNET_MessageHeader *message,
 317                    const struct GNUNET_ATS_Information *atsi,
 318                    unsigned int atsi_count)
 319 {
 320   char *hostname;
 321   char *expected_uri;
 322   unsigned long long port;
 323   const struct GNUNET_MessageHeader *incoming;
 324   const char *end;
 325
 326   if (-1 ==
 327       GNUNET_CONFIGURATION_get_value_number (adv_peer.cfg, "HOSTLIST",
 328                                              "HTTPPORT", &port))
 329   {
 330     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 331                 "Could not read advertising server's configuration\n");
 332     return GNUNET_SYSERR;
 333   }
 334
 335   if (GNUNET_SYSERR ==
 336       GNUNET_CONFIGURATION_get_value_string (adv_peer.cfg, "HOSTLIST",
 337                                              "EXTERNAL_DNS_NAME", &hostname))
 338     hostname = GNUNET_RESOLVER_local_fqdn_get ();
 339   GNUNET_asprintf (&expected_uri, "http://%s:%u/",
 340                    hostname != NULL ? hostname : "localhost",
 341                    (unsigned int) port);
 342   incoming = (const struct GNUNET_MessageHeader *) message;
 343   end = (const char *) &incoming[1];
 344   if ('\0' !=
 345       end[ntohs (message->size) - sizeof (struct GNUNET_MessageHeader) - 1])
 346   {
 347     GNUNET_break (0);
 348     GNUNET_free (expected_uri);
 349     GNUNET_free_non_null (hostname);
 350     return GNUNET_SYSERR;
 351   }
 352   current_adv_uri = GNUNET_strdup (end);
 353   if (0 == strcmp (expected_uri, current_adv_uri))
 354   {
 355     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 356                 "Received hostlist advertisement with URI `%s' as expected\n",
 357                 current_adv_uri);
 358     adv_arrived = GNUNET_YES;
 359     adv_sent = GNUNET_YES;
 360   }
 361   else
 362     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 363                 "Expected URI `%s' and recieved URI `%s' differ\n",
 364                 expected_uri, current_adv_uri);
 365   GNUNET_free (expected_uri);
 366   GNUNET_free_non_null (hostname);
 367   return GNUNET_OK;
 368 }
 369
 370
 371 /**
 372  * List of handlers if we are learning.
 373  */
 374 static struct GNUNET_CORE_MessageHandler learn_handlers[] = {
 375   {&ad_arrive_handler, GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT, 0},
 376   {NULL, 0, 0}
 377 };
 378
 379
 380 static void
 381 setup_learn_peer (struct PeerContext *p, const char *cfgname)
 382 {
 383   char *filename;
 384   unsigned int result;
 385
 386   p->cfg = GNUNET_CONFIGURATION_create ();
 387   p->arm_proc =
 388     GNUNET_OS_start_process (GNUNET_YES, GNUNET_OS_INHERIT_STD_OUT_AND_ERR, NULL, NULL, "gnunet-service-arm",
 389                                "gnunet-service-arm",
 390                                "-c", cfgname, NULL);
 391   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 392   if (GNUNET_OK ==
 393       GNUNET_CONFIGURATION_get_value_string (p->cfg, "HOSTLIST", "HOSTLISTFILE",
 394                                              &filename))
 395   {
 396     if (GNUNET_YES == GNUNET_DISK_file_test (filename))
 397     {
 398       result = UNLINK (filename);
 399       if (result == 0)
 400         GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 401                     _("Hostlist file `%s' was removed\n"), filename);
 402     }
 403     GNUNET_free (filename);
 404   }
 405   p->core =
 406       GNUNET_CORE_connect (p->cfg, NULL, NULL, NULL, NULL, NULL, GNUNET_NO,
 407                            NULL, GNUNET_NO, learn_handlers);
 408   GNUNET_assert (NULL != p->core);
 409   p->stats = GNUNET_STATISTICS_create ("hostlist", p->cfg);
 410   GNUNET_assert (NULL != p->stats);
 411 }
 412
 413
 414 static void
 415 setup_adv_peer (struct PeerContext *p, const char *cfgname)
 416 {
 417   p->cfg = GNUNET_CONFIGURATION_create ();
 418   p->arm_proc =
 419     GNUNET_OS_start_process (GNUNET_YES, GNUNET_OS_INHERIT_STD_OUT_AND_ERR, NULL, NULL, "gnunet-service-arm",
 420                                "gnunet-service-arm",
 421                                "-c", cfgname, NULL);
 422   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
 423   p->stats = GNUNET_STATISTICS_create ("hostlist", p->cfg);
 424   GNUNET_assert (NULL != p->stats);
 425 }
 426
 427
 428 static void
 429 run (void *cls, char *const *args, const char *cfgfile,
 430      const struct GNUNET_CONFIGURATION_Handle *c)
 431 {
 432   timeout = GNUNET_NO;
 433   adv_sent = GNUNET_NO;
 434
 435   adv_arrived = 0;
 436   learned_hostlist_saved = GNUNET_NO;
 437   learned_hostlist_downloaded = GNUNET_NO;
 438
 439   cfg = c;
 440
 441   setup_adv_peer (&adv_peer, "test_learning_adv_peer.conf");
 442   setup_learn_peer (&learn_peer, "test_learning_learn_peer.conf");
 443   timeout_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, &timeout_error, NULL);
 444
 445   check_task =
 446       GNUNET_SCHEDULER_add_delayed (CHECK_INTERVALL, &check_statistics, NULL);
 447 }
 448
 449
 450 static int
 451 check ()
 452 {
 453   unsigned int failed;
 454
 455   char *const argv[] = {
 456     "test-gnunet-daemon-hostlist-learning",
 457     "-c", "learning_data.conf",
 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, argv,
 465                       "test-gnunet-daemon-hostlist-learning", "nohelp", options,
 466                       &run, NULL);
 467   failed = GNUNET_NO;
 468   if (timeout == GNUNET_YES)
 469   {
 470     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Testcase timeout\n");
 471     failed = GNUNET_YES;
 472   }
 473   if (adv_arrived != GNUNET_YES)
 474   {
 475     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 476                 "Learning peer did not receive advertisement from server\n");
 477     failed = GNUNET_YES;
 478   }
 479   if (learned_hostlist_saved == GNUNET_NO)
 480   {
 481     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 482                 "Advertised hostlist was not saved in datastore\n");
 483     failed = GNUNET_YES;
 484   }
 485   if (learned_hostlist_downloaded == GNUNET_NO)
 486   {
 487     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 488                 "Advertised hostlist could not be downloaded from server\n");
 489     failed = GNUNET_YES;
 490   }
 491   if (adv_sent == GNUNET_NO)
 492   {
 493     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 494                 "Advertised was not sent from server to client\n");
 495     failed = GNUNET_YES;
 496   }
 497   if (GNUNET_YES == failed)
 498     return GNUNET_YES;
 499   return GNUNET_NO;
 500 }
 501
 502
 503 int
 504 main (int argc, char *argv[])
 505 {
 506   int ret;
 507
 508   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-hostlist-peer-1");
 509   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-hostlist-peer-2");
 510   GNUNET_log_setup ("test-gnunet-daemon-hostlist",
 511                     "WARNING",
 512                     NULL);
 513 #if !WINDOWS
 514   system ("gnunet-peerinfo -s -c test_learning_adv_peer.conf > /dev/null");
 515   system ("gnunet-peerinfo -s -c test_learning_learn_peer.conf > /dev/null");
 516 #else
 517   system ("gnunet-peerinfo -s -c test_learning_adv_peer.conf > NUL");
 518   system ("gnunet-peerinfo -s -c test_learning_learn_peer.conf > NUL");
 519 #endif
 520   ret = check ();
 521   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-hostlist-peer-1");
 522   GNUNET_DISK_directory_remove ("/tmp/test-gnunet-hostlist-peer-2");
 523   if (GNUNET_YES == GNUNET_DISK_file_test ("hostlists_learn_peer.file"))
 524   {
 525     if (0 == UNLINK ("hostlists_learn_peer.file"))
 526       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 527                   "Hostlist file hostlists_learn_peer.file was removed\n");
 528   }
 529   return ret;
 530 }
 531
 532 /* end of test_gnunet_daemon_hostlist.c */