make clang static analysis happy
[oweals/gnunet.git] / src / hostlist / test_gnunet_daemon_hostlist_learning.c
index 9ed891969eb7961a4946f40b7747dfb1600809fe..f73d96eb026f19b4cd211dedaae56958486cd432 100644 (file)
      Boston, MA 02111-1307, USA.
 */
 /**
- * @file hostlist/test_gnunet_daemon_hostlist_learning.c
+ * @file hostlist/test_gnunet_daemon_hostlist.c
  * @brief test for gnunet_daemon_hostslist.c
- * @author Christian Grothoff, Matthias Wachs
+ * @author Christian Grothoff
  */
 #include "platform.h"
 #include "gnunet_util_lib.h"
 #include "gnunet_arm_service.h"
+#include "gnunet_core_service.h"
 #include "gnunet_transport_service.h"
+#include "gnunet_resolver_service.h"
+#include "gnunet_statistics_service.h"
 
+#define VERBOSE GNUNET_NO
 
 #define START_ARM GNUNET_YES
-
-#define VERBOSE GNUNET_YES
-#define DEBUG GNUNET_YES
+#define MAX_URL_LEN 1000
 
 /**
- * How long until we give up on transmitting the message?
+ * How long until wait until testcases fails
  */
-#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 150)
+#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 20)
+#define CHECK_INTERVALL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
+
+static int timeout;
+static int adv_arrived;
+static int adv_sent;
+static int learned_hostlist_saved;
+static int learned_hostlist_downloaded;
 
-static int ok;
+static char * current_adv_uri;
 
 static struct GNUNET_SCHEDULER_Handle *sched;
 
 static GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+static GNUNET_SCHEDULER_TaskIdentifier check_task;
     
 struct PeerContext
 {
@@ -50,29 +60,102 @@ struct PeerContext
   struct GNUNET_TRANSPORT_Handle *th;
   struct GNUNET_MessageHeader *hello;
   struct GNUNET_ARM_Handle *arm;
+  struct GNUNET_CORE_Handle *core;
+  struct GNUNET_STATISTICS_Handle *stats;
 #if START_ARM
   pid_t arm_pid;
 #endif
 };
 
-static struct PeerContext p1;
+static struct PeerContext adv_peer;
 
-static struct PeerContext p2;
+static struct PeerContext learn_peer;
 
 
 static void
-clean_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+waitpid_task (void *cls,
+              const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
-  if (p1.th != NULL)
-    {
-      GNUNET_TRANSPORT_disconnect (p1.th);
-      p1.th = NULL;
-    }
-  if (p2.th != NULL)
-    {
-      GNUNET_TRANSPORT_disconnect (p2.th);
-      p2.th = NULL;
-    }
+  struct PeerContext *p = cls;
+
+#if START_ARM
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Killing ARM process.\n");
+  if (0 != PLIBC_KILL (p->arm_pid, SIGTERM))
+    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
+  if (GNUNET_OS_process_wait(p->arm_pid) != GNUNET_OK)
+    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "ARM process %u stopped\n", p->arm_pid);
+#endif
+  GNUNET_CONFIGURATION_destroy (p->cfg);
+}
+
+
+static void
+stop_cb (void *cls,
+         int success)
+{
+  struct PeerContext *p = cls;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              success
+              ? "ARM stopped core service\n"
+              : "ARM failed to stop core service\n");
+  GNUNET_ARM_disconnect (p->arm);
+  p->arm = NULL;
+  /* make sure this runs after all other tasks are done */
+  GNUNET_SCHEDULER_add_delayed (sched,
+                                GNUNET_TIME_UNIT_SECONDS,
+                                &waitpid_task, p);
+}
+
+
+static void shutdown_testcase()
+{
+  if (timeout_task != GNUNET_SCHEDULER_NO_TASK)
+  {
+    GNUNET_SCHEDULER_cancel (sched,
+                             timeout_task);
+    timeout_task = GNUNET_SCHEDULER_NO_TASK;
+  }
+  if (check_task != GNUNET_SCHEDULER_NO_TASK)
+  {
+    GNUNET_SCHEDULER_cancel (sched,
+        check_task);
+    check_task = GNUNET_SCHEDULER_NO_TASK;
+  }
+  if ( NULL != current_adv_uri ) GNUNET_free (current_adv_uri);
+
+  if (adv_peer.th != NULL)
+  {
+    GNUNET_TRANSPORT_disconnect (adv_peer.th);
+    adv_peer.th = NULL;
+  }
+  if (learn_peer.th != NULL)
+  {
+    GNUNET_TRANSPORT_disconnect (learn_peer.th);
+    learn_peer.th = NULL;
+  }
+  if (adv_peer.core != NULL)
+  {
+    GNUNET_CORE_disconnect (adv_peer.core);
+    adv_peer.core = NULL;
+  }
+  if (learn_peer.core != NULL)
+  {
+    GNUNET_CORE_disconnect (learn_peer.core);
+    learn_peer.core = NULL;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Asking ARM to stop core services\n");
+  learn_peer.arm = GNUNET_ARM_connect (learn_peer.cfg, sched, NULL);
+  GNUNET_ARM_stop_service (learn_peer.arm, "core", GNUNET_TIME_UNIT_SECONDS,
+                           &stop_cb, &learn_peer);
+  adv_peer.arm = GNUNET_ARM_connect (adv_peer.cfg, sched, NULL);
+  GNUNET_ARM_stop_service (adv_peer.arm, "core", GNUNET_TIME_UNIT_SECONDS,
+                           &stop_cb, &adv_peer);
+
   GNUNET_SCHEDULER_shutdown (sched);
 }
 
@@ -84,58 +167,172 @@ timeout_error (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   timeout_task = GNUNET_SCHEDULER_NO_TASK;
   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-             "Timeout trying to connect peers, test failed.\n");
-  clean_up (NULL, tc);
+              "Timeout while executing testcase, test failed.\n");
+  timeout = GNUNET_YES;
+  shutdown_testcase();
+}
+
+static int
+process_downloads (void *cls,
+              const char *subsystem,
+              const char *name,
+              uint64_t value,
+              int is_persistent)
+{
+  if ( (value == 1) && (learned_hostlist_downloaded == GNUNET_NO) )
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                _("Client has successfully downloaded advertised URI \n"));
+    learned_hostlist_downloaded = GNUNET_YES;
+  }
+  if ( GNUNET_NO != learned_hostlist_downloaded )
+    shutdown_testcase();
+  return GNUNET_OK;
+}
+
+static int
+process_uris_recv (void *cls,
+              const char *subsystem,
+              const char *name,
+              uint64_t value,
+              int is_persistent)
+{
+  if ( (value == 1) && (learned_hostlist_saved == GNUNET_NO))
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                _("Client has successfully saved advertised URI \n"));
+    learned_hostlist_saved = GNUNET_YES;
+  }
+  return GNUNET_OK;
+}
+
+static int
+process_adv_sent (void *cls,
+              const char *subsystem,
+              const char *name,
+              uint64_t value,
+              int is_persistent)
+{
+  if ( (value == 1) && (adv_sent == GNUNET_NO))
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                _("Server has successfully sent advertisement\n"));
+    adv_sent = GNUNET_YES;
+  }
+  return GNUNET_OK;
 }
 
 
 /**
- * Function called to notify transport users that another
- * peer connected to us.
- *
- * @param cls closure
- * @param peer the peer that connected
- * @param latency current latency of the connection
- * @param distance in overlay hops, as given by transport plugin
+ * Check the server statistics regularly
  */
 static void
-notify_connect (void *cls,
-               const struct GNUNET_PeerIdentity * peer,
-               struct GNUNET_TIME_Relative latency,
-               unsigned int distance)
+check_statistics (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
-  if (peer == NULL)
-    return;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Peers connected, shutting down.\n");
-  ok = 0;
-  if (timeout_task != GNUNET_SCHEDULER_NO_TASK)
-    {
-      GNUNET_SCHEDULER_cancel (sched,
-                              timeout_task);
-      timeout_task = GNUNET_SCHEDULER_NO_TASK;
-    }
-  GNUNET_SCHEDULER_add_now (sched,
-                           &clean_up, NULL);
+  char *stat;
+  GNUNET_asprintf (&stat,
+                   gettext_noop("# advertised URI `%s' downloaded"),
+                   current_adv_uri);
+  GNUNET_STATISTICS_get (learn_peer.stats,
+                         "hostlist",
+                         stat,
+                         GNUNET_TIME_UNIT_MINUTES,
+                         NULL,
+                         &process_downloads,
+                         NULL);
+  GNUNET_free (stat);
+  GNUNET_STATISTICS_get (learn_peer.stats,
+                         "hostlist",
+                         gettext_noop("# advertised hostlist URIs"),
+                         GNUNET_TIME_UNIT_MINUTES,
+                         NULL,
+                         &process_uris_recv,
+                         NULL);
+  GNUNET_STATISTICS_get (adv_peer.stats,
+                         "hostlist",
+                         gettext_noop("# hostlist advertisements send"),
+                         GNUNET_TIME_UNIT_MINUTES,
+                         NULL,
+                         &process_adv_sent,
+                         NULL);
+  check_task = GNUNET_SCHEDULER_add_delayed (sched,
+                                CHECK_INTERVALL,
+                                &check_statistics,
+                                NULL);
 }
 
-
-static void
-process_hello (void *cls,
-               const struct GNUNET_MessageHeader *message)
+/**
+ * Core handler for p2p hostlist advertisements
+ */
+static int ad_arrive_handler (void *cls,
+                             const struct GNUNET_PeerIdentity * peer,
+                             const struct GNUNET_MessageHeader * message,
+                             struct GNUNET_TIME_Relative latency,
+                             uint32_t distance)
 {
-  struct PeerContext *p = cls;
+  char *hostname;
+  char *expected_uri = GNUNET_malloc (MAX_URL_LEN);
 
-  GNUNET_TRANSPORT_get_hello_cancel (p->th, &process_hello, p);
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Received HELLO, starting hostlist service.\n");
-  GNUNET_ARM_start_services (p->cfg, sched, "hostlist", NULL);
+  unsigned long long port;
+  size_t size;
+  const struct GNUNET_MessageHeader * incoming;
+
+  if (-1 == GNUNET_CONFIGURATION_get_value_number (adv_peer.cfg,
+                                                   "HOSTLIST",
+                                                   "HTTPPORT",
+                                                   &port))
+    {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Could not read advertising server's configuration\n" );
+    if ( NULL != expected_uri ) GNUNET_free ( expected_uri );
+    return GNUNET_SYSERR;
+    }
+  hostname = GNUNET_RESOLVER_local_hostname_get ();
+  if (NULL != hostname)
+    {
+      size = strlen (hostname);
+      if (size + 15 > MAX_URL_LEN)
+        {
+          GNUNET_break (0);
+        }
+      else
+        {
+          GNUNET_asprintf (&expected_uri,
+                           "http://%s:%u/",
+                           hostname,
+                           (unsigned int) port);
+        }
+    }
+
+  incoming = (const struct GNUNET_MessageHeader *) message;
+  current_adv_uri = strdup ((char*) &incoming[1]);
+  if ( 0 == strcmp( expected_uri, current_adv_uri ) )
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                "Recieved hostlist advertisement with URI `%s'as expected\n", current_adv_uri);
+    adv_arrived = GNUNET_YES;
+  }
+  else
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Expected URI `%s' and recieved URI `%s' differ\n", expected_uri, current_adv_uri);
+  if ( NULL != expected_uri ) GNUNET_free ( expected_uri );
+  if ( NULL != expected_uri )  GNUNET_free ( hostname );
+  return GNUNET_OK;
 }
 
+/**
+ * List of handlers if we are learning.
+ */
+static struct GNUNET_CORE_MessageHandler learn_handlers[] = {
+  { &ad_arrive_handler, GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT, 0},
+  { NULL, 0, 0 }
+};
 
 static void
-setup_peer (struct PeerContext *p, const char *cfgname)
+setup_learn_peer (struct PeerContext *p, const char *cfgname)
 {
+  char * filename;
+  unsigned int result;
   p->cfg = GNUNET_CONFIGURATION_create ();
 #if START_ARM
   p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
@@ -146,75 +343,55 @@ setup_peer (struct PeerContext *p, const char *cfgname)
                                         "-c", cfgname, NULL);
 #endif
   GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
-  GNUNET_ARM_start_services (p->cfg, sched, "core", NULL);
-  p->th = GNUNET_TRANSPORT_connect (sched, p->cfg, p, NULL, 
-                                   &notify_connect, NULL);
-  GNUNET_assert (p->th != NULL);
-  GNUNET_TRANSPORT_get_hello (p->th, &process_hello, p);
-}
-
-
-static void
-waitpid_task (void *cls, 
-             const struct GNUNET_SCHEDULER_TaskContext *tc)
-{
-  struct PeerContext *p = cls;
-
-#if START_ARM 
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Killing ARM process.\n");
-  if (0 != PLIBC_KILL (p->arm_pid, SIGTERM))
-    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
-  if (GNUNET_OS_process_wait(p->arm_pid) != GNUNET_OK)
-    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "waitpid");
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-              "ARM process %u stopped\n", p->arm_pid);
-#endif
-  GNUNET_CONFIGURATION_destroy (p->cfg);
-}
-
-
-static void
-stop_cb (void *cls, 
-        int success)
-{
-  struct PeerContext *p = cls;
-
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             success 
-             ? "ARM stopped core service\n" 
-             : "ARM failed to stop core service\n");
-  GNUNET_ARM_disconnect (p->arm);
-  p->arm = NULL;
-  /* make sure this runs after all other tasks are done */
-  GNUNET_SCHEDULER_add_delayed (sched,
-                               GNUNET_TIME_UNIT_SECONDS,
-                               &waitpid_task, p);
-}
+  if (GNUNET_OK == GNUNET_CONFIGURATION_get_value_string (p->cfg,
+                                                          "HOSTLIST",
+                                                          "HOSTLISTFILE",
+                                                          &filename))
+  {
+  if ( GNUNET_YES == GNUNET_DISK_file_test (filename) )
+    {
+      result = remove (filename);
+      if (result == 0)
+      GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+            _("Hostlist file `%s' was removed\n"),filename);
+    }
+  }
+  if ( NULL != filename)  GNUNET_free ( filename );
 
+  GNUNET_ARM_start_services (p->cfg, sched, "core", NULL);
 
-static void
-stop_arm (struct PeerContext *p)
-{
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Asking ARM to stop core service\n");
-  p->arm = GNUNET_ARM_connect (p->cfg, sched, NULL);
-  GNUNET_ARM_stop_service (p->arm, "core", GNUNET_TIME_UNIT_SECONDS,
-                          &stop_cb, p);
+  p->core = GNUNET_CORE_connect (sched, p->cfg,
+                              GNUNET_TIME_UNIT_FOREVER_REL,
+                              NULL,
+                              NULL,
+                              NULL, NULL,
+                              NULL, GNUNET_NO,
+                              NULL, GNUNET_NO,
+                              learn_handlers );
+  GNUNET_assert ( NULL != p->core );
+  p->stats = GNUNET_STATISTICS_create (sched, "hostlist", p->cfg);
+  GNUNET_assert ( NULL != p->stats );
 }
 
 
-/**
- * Try again to connect to transport service.
- */
 static void
-shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+setup_adv_peer (struct PeerContext *p, const char *cfgname)
 {
-  stop_arm (&p1);
-  stop_arm (&p2);
+  p->cfg = GNUNET_CONFIGURATION_create ();
+#if START_ARM
+  p->arm_pid = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
+                                        "gnunet-service-arm",
+#if VERBOSE
+                                        "-L", "DEBUG",
+#endif
+                                        "-c", cfgname, NULL);
+#endif
+  GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
+  GNUNET_ARM_start_services (p->cfg, sched, "core", NULL);
+  p->stats = GNUNET_STATISTICS_create (sched, "hostlist", p->cfg);
+  GNUNET_assert ( NULL != p->stats );
 }
 
-
 static void
 run (void *cls,
      struct GNUNET_SCHEDULER_Handle *s,
@@ -222,27 +399,30 @@ run (void *cls,
      const char *cfgfile, 
      const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
-  GNUNET_assert (ok == 1);
-  ok++;
+  timeout = GNUNET_NO;
+  adv_arrived = GNUNET_NO;
+  adv_sent =GNUNET_NO;
+  learned_hostlist_downloaded = GNUNET_NO;
   sched = s;
-
   timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
-                                              TIMEOUT,
-                                              &timeout_error,
-                                              NULL);
-  GNUNET_SCHEDULER_add_delayed (sched,
-                               GNUNET_TIME_UNIT_FOREVER_REL,
-                               &shutdown_task,
-                               NULL);
-  setup_peer (&p1, "learning_peer1.conf");
-  setup_peer (&p2, "learning_peer2.conf");
+                                               TIMEOUT,
+                                               &timeout_error,
+                                               NULL);
+  check_task = GNUNET_SCHEDULER_add_delayed (sched,
+                                CHECK_INTERVALL,
+                                &check_statistics,
+                                NULL);
+
+  setup_adv_peer (&adv_peer, "test_learning_adv_peer.conf");
+  setup_learn_peer (&learn_peer, "test_learning_learn_peer.conf");
 }
 
 
 static int
 check ()
 {
-  char *const argv[] = { "test_gnunet_daemon_hostlist_learning",
+  unsigned int failed;
+  char *const argv[] = { "test-gnunet-daemon-hostlist",
     "-c", "learning_data.conf",
 #if VERBOSE
     "-L", "DEBUG",
@@ -252,23 +432,58 @@ check ()
   struct GNUNET_GETOPT_CommandLineOption options[] = {
     GNUNET_GETOPT_OPTION_END
   };
-  ok = 1;
-  GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
-                      argv, "test_gnunet_daemon_hostlist_learning",
-                     "nohelp", options, &run, &ok);
 
-  return ok;
+  GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
+                      argv, "test-gnunet-daemon-hostlist",
+                      "nohelp", options, &run, NULL);
+
+  failed = GNUNET_NO;
+
+  if (timeout == GNUNET_YES)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Testcase could not set up two communicating peers, timeout\n");
+    failed = GNUNET_YES;
+  }
+  if (adv_arrived == GNUNET_NO)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Learning peer did not recieve advertisement from server\n");
+    failed = GNUNET_YES;
+  }
+  if ( learned_hostlist_saved == GNUNET_NO )
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  "Advertised hostlist was not saved in datastore\n");
+      failed = GNUNET_YES;
+    }
+  if (learned_hostlist_downloaded == GNUNET_NO)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Advertised hostlist could not be downloaded from server\n");
+    failed = GNUNET_YES;
+  }
+  if (adv_sent == GNUNET_NO)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Advertised was not sent from server to client\n");
+    failed = GNUNET_YES;
+  }
+  if ( GNUNET_YES == failed )
+    return GNUNET_YES;
+  else
+    return GNUNET_NO;
 }
 
-
 int
 main (int argc, char *argv[])
 {
   
   int ret;
+
   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-1");
   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-hostlist-peer-2");
-  GNUNET_log_setup ("test-gnunet-daemon-hostlist_learning",
+  GNUNET_log_setup ("test-gnunet-daemon-hostlist",
 #if VERBOSE
                     "DEBUG",
 #else