hunting bugs
[oweals/gnunet.git] / src / transport / test_plugin_transport.c
index c8aa43f44113f57c4ff2c28ddc43b98cdceaa594..6882f919c341df192599f07793b9391a6d0334a8 100644 (file)
@@ -41,7 +41,7 @@
  * How long until we give up on transmitting the message?
  */
 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
-#define TIMEOUT GNUNET_TIME_relative_multiply (WAIT, 3)
+#define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
 
 /**
  * Our public key.
@@ -88,6 +88,11 @@ struct GNUNET_TRANSPORT_PluginEnvironment env;
  */
 struct GNUNET_TRANSPORT_PluginFunctions *api;
 
+/**
+ * Helper handler
+ */
+struct GNUNET_HELPER_Handle *suid_helper;
+
 /**
  * Timeout task
  */
@@ -130,11 +135,18 @@ struct AddressWrapper
   void *addr;
 
   size_t addrlen;
+
+  char *addrstring;
 };
 
+
 static void
 end ()
 {
+  struct AddressWrapper *w;
+  int c = 0;
+  ok = 0;
+
   if (GNUNET_SCHEDULER_NO_TASK != timeout_task)
   {
       GNUNET_SCHEDULER_cancel (timeout_task);
@@ -142,14 +154,40 @@ end ()
   }
   if (NULL != api)
       GNUNET_PLUGIN_unload (libname, api);
+
+  while (NULL != head)
+  {
+      w = head;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                _("Plugin did not remove address `%s' \n"), w->addrstring);
+      GNUNET_CONTAINER_DLL_remove (head, tail, w);
+      c ++;
+      GNUNET_free (w->addr);
+      GNUNET_free (w->addrstring);
+      GNUNET_free (w);
+  }
+  if (c > 0)
+  {
+    GNUNET_break (0);
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+              _("Plugin did not remove %u addresses \n"), c);
+    ok = 1;
+  }
+
+
   GNUNET_free (libname);
   libname = NULL;
   GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
   stats = NULL;
 
-  ok = 0;
+  if (NULL != suid_helper)
+  {
+    GNUNET_HELPER_stop (suid_helper);
+    suid_helper = NULL;
+  }
 }
 
+
 static void
 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
@@ -161,6 +199,13 @@ end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
       GNUNET_SCHEDULER_cancel (timeout_wait);
       timeout_wait = GNUNET_SCHEDULER_NO_TASK;
   }
+
+  if (NULL != cls)
+  {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                _("Test took too long to execute, timeout .... \n"));
+  }
+
   if (NULL != libname)
   {
     if (NULL != api)
@@ -169,12 +214,15 @@ end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     libname = NULL;
   }
 
-  w = head;
   while (NULL != head)
   {
+      w = head;
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                _("Plugin did not remove address `%s' \n"), w->addrstring);
       GNUNET_CONTAINER_DLL_remove (head, tail, w);
       c ++;
       GNUNET_free (w->addr);
+      GNUNET_free (w->addrstring);
       GNUNET_free (w);
   }
   if (c > 0)
@@ -190,16 +238,23 @@ end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     stats = NULL;
   }
 
+  if (NULL != suid_helper)
+  {
+    GNUNET_HELPER_stop (suid_helper);
+    suid_helper = NULL;
+  }
+
   ok = 1;
 }
 
+
 static void
 wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   timeout_wait = GNUNET_SCHEDULER_NO_TASK;
   if (0 == addresses_reported)
-    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-              _("Plugin did not report any addresses, could not check plugin \n"));
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+              _("Plugin did not report any addresses, could not check address conversion functions\n"));
   end ();
 }
 
@@ -236,11 +291,42 @@ env_receive (void *cls,
 }
 
 
+static int got_reply;
+
+
+/**
+ * Take the given address and append it to the set of results sent back to
+ * the client.
+ *
+ * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
+ * @param buf text to transmit
+ */
+static void
+address_pretty_printer_cb (void *cls, const char *buf)
+{
+  if (NULL != buf)
+  {
+    got_reply = GNUNET_YES;
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                "Pretty address : `%s'\n", buf);
+  }
+  else
+  {
+      if (GNUNET_NO == got_reply)
+      {
+          GNUNET_break (0);
+          end_badly_now ();
+      }
+  }
+}
+
+
 static void
 env_notify_address (void *cls,
                     int add_remove,
                     const void *addr,
-                    size_t addrlen)
+                    size_t addrlen,
+                    const char *plugin)
 {
   struct AddressWrapper *w;
   char *a2s;
@@ -258,6 +344,11 @@ env_notify_address (void *cls,
       w->addrlen = addrlen;
       memcpy (w->addr, addr, addrlen);
       GNUNET_CONTAINER_DLL_insert(head, tail, w);
+      got_reply = GNUNET_NO;
+      api->address_pretty_printer (api->cls, plugin, addr, addrlen,
+                                    GNUNET_YES, GNUNET_TIME_UNIT_MINUTES,
+                                    &address_pretty_printer_cb,
+                                    w);
 
       a2s = strdup (api->address_to_string (api, w->addr, w->addrlen));
       if (NULL == a2s)
@@ -268,11 +359,11 @@ env_notify_address (void *cls,
           end_badly_now();
           return;
       }
-
+      w->addrstring = strdup (api->address_to_string (api, w->addr, w->addrlen));
       GNUNET_log (GNUNET_ERROR_TYPE_INFO,
                   _("Plugin added address `%s'\n"), a2s);
 
-      if (GNUNET_OK != api->string_to_address (api, a2s, strlen (a2s)+1, &s2a, &s2a_len))
+      if ((GNUNET_OK != api->string_to_address (api, a2s, strlen (a2s)+1, &s2a, &s2a_len)) || (NULL == s2a))
       {
           GNUNET_break (0);
           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
@@ -292,7 +383,8 @@ env_notify_address (void *cls,
             GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                         _("Plugin creates different address length when connecting back and forth!\n"));
       }
-
+      GNUNET_free (s2a);
+      GNUNET_free (a2s);
       if (GNUNET_OK != api->check_address (api->cls, w->addr, w->addrlen))
       {
           GNUNET_break (0);
@@ -334,6 +426,7 @@ env_notify_address (void *cls,
 
       GNUNET_CONTAINER_DLL_remove (head, tail, w);
       GNUNET_free (w->addr);
+      GNUNET_free (w->addrstring);
       GNUNET_free (w);
   }
   else
@@ -346,7 +439,8 @@ env_notify_address (void *cls,
   }
 }
 
-struct GNUNET_ATS_Information
+
+static struct GNUNET_ATS_Information
 env_get_address_type (void *cls,
                      const struct sockaddr *addr,
                      size_t addrlen)
@@ -357,19 +451,22 @@ env_get_address_type (void *cls,
   return ats;
 }
 
-const struct GNUNET_MessageHeader *
-env_get_our_hello (void)
+
+static const struct GNUNET_MessageHeader *
+env_get_our_hello ()
 {
   return (const struct GNUNET_MessageHeader *) hello;
 }
 
-void env_session_end (void *cls,
-                      const struct GNUNET_PeerIdentity *peer,
-                      struct Session * session)
-{
 
+static void 
+env_session_end (void *cls,
+                const struct GNUNET_PeerIdentity *peer,
+                struct Session * session)
+{
 }
 
+
 static void
 setup_plugin_environment ()
 {
@@ -386,6 +483,13 @@ setup_plugin_environment ()
   env.session_end = &env_session_end;
 }
 
+static int
+handle_helper_message (void *cls, void *client,
+                       const struct GNUNET_MessageHeader *hdr)
+{
+  return GNUNET_OK;
+}
+
 
 /**
  * Runs the test.
@@ -403,37 +507,35 @@ run (void *cls, char *const *args, const char *cfgfile,
   char *plugin;
   char *sep;
 
-  timeout_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, NULL);
+  timeout_task = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
 
   cfg = c;
   /* parse configuration */
-  if ((GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
-                          "TRANSPORT",
-                          "NEIGHBOUR_LIMIT",
-                          &tneigh)) ||
-      (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
-                          "GNUNETD", "HOSTKEY",
-                          &keyfile)))
+  if ( (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
+                                                           "TRANSPORT",
+                                                           "NEIGHBOUR_LIMIT",
+                                                           &tneigh)) ||
+       (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
+                                                             "GNUNETD", "HOSTKEY",
+                                                             &keyfile)))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                 _("Transport service is lacking key configuration settings.  Exiting.\n"));
-
     return;
   }
 
-  stats = GNUNET_STATISTICS_create ("transport", cfg);
-  if (NULL == stats)
+  if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
   {
-      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                  _("Could not create statistics.  Exiting.\n"));
-      end_badly_now ();
-      return;
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+               _("Could not create statistics.  Exiting.\n"));
+    end_badly_now ();
+    return;
   }
 
   max_connect_per_transport = (uint32_t) tneigh;
   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
   GNUNET_free (keyfile);
-  if (my_private_key == NULL)
+  if (NULL == my_private_key)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                 _("Transport service could not access hostkey.  Exiting.\n"));
@@ -463,6 +565,22 @@ run (void *cls, char *const *args, const char *cfgfile,
   if (NULL != sep)
       sep[0] = '\0';
 
+  /* Hack for WLAN: start a second helper */
+  if (0 == strcmp (plugin, "wlan"))
+  {
+    char * helper_argv[3];
+    helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
+    helper_argv[1] = (char *) "2";
+    helper_argv[2] = NULL;
+    suid_helper = GNUNET_HELPER_start (GNUNET_NO,
+                                      "gnunet-helper-transport-wlan-dummy",
+                                       helper_argv,
+                                       &handle_helper_message,
+                                       NULL,
+                                       NULL);
+  }
+
+
   /* Loading plugin */
   GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading transport plugin %s\n"), plugin);
   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
@@ -527,7 +645,7 @@ run (void *cls, char *const *args, const char *cfgfile,
 
 
 /**
- * The main function for the transport service.
+ * The main function for the test
  *
  * @param argc number of arguments from the command line
  * @param argv command line arguments
@@ -545,20 +663,19 @@ main (int argc, char *const *argv)
     "test_plugin_transport",
     "-c",
     "test_plugin_transport_data.conf",
-    "-L", "WARNING",
     NULL
   };
   GNUNET_log_setup ("test-plugin-transport",
                     "WARNING",
                     NULL);
   ok = 1;                       /* set to fail */
-  ret = (GNUNET_OK == GNUNET_PROGRAM_run (5,
-                           argv_prog,
-                           "test-plugin-transport",
-                           "testcase",
-                           options,
-                           &run,
-                           (void *) argv)) ? ok : 1;
+  ret = (GNUNET_OK == GNUNET_PROGRAM_run (3,
+                                         argv_prog,
+                                         "test-plugin-transport",
+                                         "testcase",
+                                         options,
+                                         &run,
+                                         (void *) argv)) ? ok : 1;
   GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
   return ret;
 }