REST/NAMESTORE: rework API
[oweals/gnunet.git] / src / transport / test_plugin_transport.c
index e2d178ad0cb2c1eb2f07bccec3d74b2cf278120b..fe0840041201a447cf273b102c53bc78eb643f2a 100644 (file)
@@ -1,21 +1,21 @@
 /*
  This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2018 GNUnet e.V.
 
- GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
 
  GNUnet is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- General Public License for more details.
Affero General Public License for more details.
 
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING.  If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
  */
 /**
  * @file transport/test_plugin_transport.c
@@ -129,8 +129,12 @@ struct AddressWrapper
   struct GNUNET_HELLO_Address *address;
 
   char *addrstring;
+
+  struct GNUNET_SCHEDULER_Task *test_task;
+
 };
 
+
 static void
 end ()
 {
@@ -149,8 +153,9 @@ end ()
   while (NULL != head)
   {
     w = head;
-    GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove address `%s'\n",
-        w->addrstring);
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Plugin did not remove address `%s'\n",
+                w->addrstring);
     GNUNET_CONTAINER_DLL_remove(head, tail, w);
     c++;
     GNUNET_HELLO_address_free(w->address);
@@ -177,8 +182,9 @@ end ()
   }
 }
 
+
 static void
-end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+end_badly (void *cls)
 {
   struct AddressWrapper *w;
   int c = 0;
@@ -221,6 +227,8 @@ end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
     GNUNET_CONTAINER_DLL_remove(head, tail, w);
     c++;
     GNUNET_HELLO_address_free(w->address);
+    if (NULL != w->test_task)
+      GNUNET_SCHEDULER_cancel (w->test_task);
     GNUNET_free(w->addrstring);
     GNUNET_free(w);
   }
@@ -247,7 +255,7 @@ end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 }
 
 static void
-wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+wait_end (void *cls)
 {
   timeout_wait = NULL;
   if (0 == addresses_reported)
@@ -277,7 +285,7 @@ end_badly_now ()
 static struct GNUNET_TIME_Relative
 env_receive (void *cls,
              const struct GNUNET_HELLO_Address *address,
-             struct Session *session,
+             struct GNUNET_ATS_Session *session,
              const struct GNUNET_MessageHeader *message)
 {
   /* do nothing */
@@ -316,6 +324,109 @@ address_pretty_printer_cb (void *cls, const char *address, int res)
 }
 
 
+static void
+test_addr_string (void *cls)
+{
+  struct AddressWrapper *w = cls;
+  void *s2a;
+  size_t s2a_len;
+
+  w->test_task = NULL;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              "Testing: address_to_string \n");
+  w->addrstring = GNUNET_strdup (api->address_to_string (api,
+                                                         w->address->address,
+                                                         w->address->address_length));
+  if (NULL == w->addrstring)
+  {
+    GNUNET_break(0);
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Plugin cannot convert address to string!\n");
+    end_badly_now ();
+    return;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              "Plugin added address `%s'\n",
+              w->addrstring);
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              "Testing address_to_string: OK\n");
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+              "Testing: string_to_address \n");
+  s2a = NULL;
+  s2a_len = 0;
+  if ((GNUNET_OK !=
+       api->string_to_address (api, w->addrstring,
+                               strlen (w->addrstring) + 1,
+                               &s2a, &s2a_len)) ||
+      (NULL == s2a))
+  {
+    GNUNET_break(0);
+    GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
+               "Plugin cannot convert string to address!\n");
+    end_badly_now ();
+    return;
+  }
+
+  /*
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+    "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
+
+    int c1;
+    for (c1 = 0; c1 < s2a_len; c1++ )
+    fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
+  */
+  if (s2a_len != w->address->address_length)
+  {
+    GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
+               "Plugin creates different address length when converting address->string->address: %u != %u\n",
+               (unsigned int) w->address->address_length,
+               (unsigned int) s2a_len);
+  }
+  else if (0 != memcmp (s2a, w->address->address, s2a_len))
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Plugin creates different address length when converting back and forth %i!\n",
+                memcmp (s2a,
+                        w->address->address,
+                        s2a_len));
+  }
+  else
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                "Testing string_to_address: OK\n");
+  }
+  GNUNET_free(s2a);
+
+  pretty_printers_running++;
+  api->address_pretty_printer (api->cls,
+                               w->address->transport_name,
+                               w->address->address,
+                               w->address->address_length,
+                               GNUNET_YES,
+                               GNUNET_TIME_UNIT_MINUTES,
+                               &address_pretty_printer_cb, w);
+
+  if (GNUNET_OK !=
+      api->check_address (api->cls,
+                          w->address->address,
+                          w->address->address_length))
+  {
+    GNUNET_break (0);
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                "Plugin refuses added address!\n");
+    end_badly_now ();
+    return;
+  }
+  if (NULL != timeout_wait)
+  {
+    GNUNET_SCHEDULER_cancel (timeout_wait);
+    timeout_wait = NULL;
+  }
+  timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
+}
+
+
 static void
 env_notify_address (void *cls,
                     int add_remove,
@@ -323,14 +434,13 @@ env_notify_address (void *cls,
 {
   struct AddressWrapper *w;
   struct AddressWrapper *wtmp;
-  void *s2a;
-  size_t s2a_len;
 
   if (GNUNET_YES == add_remove)
   {
     addresses_reported++;
-    GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Adding address of length %u\n",
-        address->address_length);
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+               "Adding address of length %u\n",
+                (unsigned int) address->address_length);
 
     for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
     {
@@ -338,100 +448,25 @@ env_notify_address (void *cls,
           (0 == memcmp (address->address, wtmp->address->address, address->address_length)))
       {
         GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-            "Duplicate address notification .... \n");
+                   "Duplicate address notification .... \n");
         return;
       }
     }
 
     w = GNUNET_new (struct AddressWrapper);
     w->address = GNUNET_HELLO_address_copy (address);
-    GNUNET_CONTAINER_DLL_insert(head, tail, w);
+    GNUNET_CONTAINER_DLL_insert (head, tail, w);
     got_reply = GNUNET_NO;
-    GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing: address_to_string \n");
-    w->addrstring = GNUNET_strdup (
-        api->address_to_string (api, w->address->address,
-            w->address->address_length));
-    if (NULL == w->addrstring)
-    {
-      GNUNET_break(0);
-      GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-          "Plugin cannot convert address to string!\n");
-      end_badly_now ();
-      return;
-    }
-    else
-    {
-      GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Plugin added address `%s'\n",
-          w->addrstring);
-      GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing address_to_string: OK\n");
-    }
-
-    GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing: string_to_address \n");
-    s2a = NULL;
-    s2a_len = 0;
-    if ((GNUNET_OK
-        != api->string_to_address (api, w->addrstring,
-            strlen (w->addrstring) + 1, &s2a, &s2a_len)) || (NULL == s2a))
-    {
-      GNUNET_break(0);
-      GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-          "Plugin cannot convert string to address!\n");
-      end_badly_now ();
-      return;
-    }
-
-    /*
-     GNUNET_log (GNUNET_ERROR_TYPE_INFO,
-     "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
-
-     int c1;
-     for (c1 = 0; c1 < s2a_len; c1++ )
-     fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
-     */
-    if (s2a_len != w->address->address_length)
-    {
-      GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-          "Plugin creates different address length when converting address->string->address: %u != %u\n",
-          w->address->address_length, s2a_len);
-    }
-    else if (0 != memcmp (s2a, w->address->address, s2a_len))
-    {
-      GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-          "Plugin creates different address length when converting back and forth %i!\n",
-          memcmp (s2a, w->address->address, s2a_len));
-    }
-    else
-    {
-      GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing string_to_address: OK\n");
-    }
-    GNUNET_free(s2a);
-
-    pretty_printers_running++;
-    api->address_pretty_printer (api->cls, address->transport_name,
-        address->address, address->address_length, GNUNET_YES,
-        GNUNET_TIME_UNIT_MINUTES, &address_pretty_printer_cb, w);
-
-    if (GNUNET_OK != api->check_address (api->cls, w->address->address, w->address->address_length))
-    {
-      GNUNET_break(0);
-      GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin refuses added address!\n");
-      end_badly_now ();
-      return;
-    }
-    if (NULL != timeout_wait)
-    {
-      GNUNET_SCHEDULER_cancel (timeout_wait);
-      timeout_wait = NULL;
-    }
-
-    timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
-
+    w->test_task = GNUNET_SCHEDULER_add_now (&test_addr_string,
+                                             w);
+    return;
   }
-  else if (GNUNET_NO == add_remove)
-  {
-    GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Removing address of length %u\n",
-        address->address_length);
 
+  if (GNUNET_NO == add_remove)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "Removing address of length %u\n",
+                (unsigned int) address->address_length);
     w = head;
     while (NULL != w)
     {
@@ -443,7 +478,7 @@ env_notify_address (void *cls,
       w = w->next;
     }
 
-    if (w == NULL )
+    if (w == NULL)
     {
       GNUNET_break(0);
       GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
@@ -456,23 +491,22 @@ env_notify_address (void *cls,
     GNUNET_HELLO_address_free (w->address);
     GNUNET_free(w->addrstring);
     GNUNET_free(w);
-  }
-  else
-  {
-    GNUNET_break(0);
-    GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Invalid operation: %u\n", add_remove);
-    end_badly_now ();
     return;
   }
+  GNUNET_break(0);
+  GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+              "Invalid operation: %u\n",
+              add_remove);
+  end_badly_now ();
 }
 
 
-static enum GNUNET_ATS_Network_Type
+static enum GNUNET_NetworkType
 env_get_address_type (void *cls,
                       const struct sockaddr *addr,
                       size_t addrlen)
 {
-  return GNUNET_ATS_NET_LOOPBACK;
+  return GNUNET_NT_LOOPBACK;
 }
 
 
@@ -486,18 +520,16 @@ env_get_our_hello ()
 static void
 env_session_end (void *cls,
                  const struct GNUNET_HELLO_Address *address,
-                 struct Session *session)
+                 struct GNUNET_ATS_Session *session)
 {
 
 }
 
 
 static void
-env_update_metrics (void *cls,
-                    const struct GNUNET_HELLO_Address *address,
-                    struct Session *session,
-                    const struct GNUNET_ATS_Information *ats,
-                    uint32_t ats_count)
+env_update_distance (void *cls,
+                     const struct GNUNET_HELLO_Address *address,
+                     uint32_t distance)
 {
 }
 
@@ -513,14 +545,14 @@ setup_plugin_environment ()
   env.receive = &env_receive;
   env.notify_address = &env_notify_address;
   env.get_address_type = &env_get_address_type;
-  env.update_address_metrics = &env_update_metrics;
+  env.update_address_distance = &env_update_distance;
   env.get_our_hello = &env_get_our_hello;
   env.session_end = &env_session_end;
 }
 
 
 static int
-handle_helper_message (void *cls, void *client,
+handle_helper_message (void *cls,
                        const struct GNUNET_MessageHeader *hdr)
 {
   return GNUNET_OK;
@@ -534,8 +566,10 @@ handle_helper_message (void *cls, void *client,
  * @param c configuration to use
  */
 static void
-run (void *cls, char * const *args, const char *cfgfile,
-    const struct GNUNET_CONFIGURATION_Handle *c)
+run (void *cls,
+     char * const *args,
+     const char *cfgfile,
+     const struct GNUNET_CONFIGURATION_Handle *c)
 {
   char * const *argv = cls;
   unsigned long long tneigh;
@@ -543,26 +577,32 @@ run (void *cls, char * const *args, const char *cfgfile,
   char *plugin;
   char *sep;
 
-  timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
-
+  timeout_endbadly = 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, "PEER", "PRIVATE_KEY",
-              &keyfile)))
+  if ( (GNUNET_OK !=
+        GNUNET_CONFIGURATION_get_value_number (c,
+                                               "TRANSPORT",
+                                               "NEIGHBOUR_LIMIT",
+                                               &tneigh)) ||
+       (GNUNET_OK !=
+        GNUNET_CONFIGURATION_get_value_filename (c,
+                                                 "PEER",
+                                                 "PRIVATE_KEY",
+                                                 &keyfile)))
   {
     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
         "Transport service is lacking key configuration settings.  Exiting.\n");
     return;
   }
 
-  if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
+  if (NULL == (stats = GNUNET_STATISTICS_create ("transport",
+                                                 cfg)))
   {
     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-        "Could not create statistics.  Exiting.\n");
+               "Could not create statistics.  Exiting.\n");
     GNUNET_free(keyfile);
     end_badly_now ();
     return;
@@ -570,27 +610,33 @@ run (void *cls, char * const *args, const char *cfgfile,
 
   if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
   {
-    GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Hostkey `%s' missing.  Exiting.\n",
-        HOSTKEY_FILE);
+    GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
+               "Hostkey `%s' missing.  Exiting.\n",
+               HOSTKEY_FILE);
     GNUNET_free(keyfile);
     end_badly_now ();
     return;
   }
 
-  if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
+  if (GNUNET_OK !=
+      GNUNET_DISK_directory_create_for_file (keyfile))
   {
     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-        "Could not create a directory for hostkey `%s'.  Exiting.\n", keyfile);
+               "Could not create a directory for hostkey `%s'.  Exiting.\n",
+               keyfile);
     GNUNET_free(keyfile);
     end_badly_now ();
     return;
   }
 
-  if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
+  if (GNUNET_OK !=
+      GNUNET_DISK_file_copy (HOSTKEY_FILE,
+                             keyfile))
   {
     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
-        "Could not copy hostkey `%s' to destination `%s'.  Exiting.\n",
-        HOSTKEY_FILE, keyfile);
+               "Could not copy hostkey `%s' to destination `%s'.  Exiting.\n",
+               HOSTKEY_FILE,
+               keyfile);
     GNUNET_free(keyfile);
     end_badly_now ();
     return;
@@ -642,7 +688,7 @@ run (void *cls, char * const *args, const char *cfgfile,
   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
   GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
   api = GNUNET_PLUGIN_load (libname, &env);
-  if (api == NULL )
+  if (NULL == api)
   {
     GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
         "Failed to load transport plugin for %s\n", plugin);
@@ -698,9 +744,9 @@ run (void *cls, char * const *args, const char *cfgfile,
     end_badly_now ();
     return;
   }
-
 }
 
+
 /**
  * The main function for the test
  *
@@ -709,23 +755,32 @@ run (void *cls, char * const *args, const char *cfgfile,
  * @return 0 ok, 1 on error
  */
 int
-main (int argc, char * const *argv)
+main (int argc,
+      char * const *argv)
 {
   static struct GNUNET_GETOPT_CommandLineOption options[] = {
-      GNUNET_GETOPT_OPTION_END };
+    GNUNET_GETOPT_OPTION_END
+  };
   int ret;
-
-  GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
-
-  char * const argv_prog[] = { "test_plugin_transport", "-c",
-      "test_plugin_transport_data.conf", NULL };
-  GNUNET_log_setup ("test-plugin-transport", "WARNING", NULL );
+  char * const argv_prog[] = {
+    "test_plugin_transport",
+    "-c",
+    "test_plugin_transport_data.conf",
+    NULL
+  };
+
+  GNUNET_log_setup ("test-plugin-transport",
+                    "WARNING",
+                    NULL);
+  GNUNET_DISK_purge_cfg_dir ("test_plugin_transport_data.conf",
+                             "GNUNET_TEST_HOME");
   ok = 1; /* set to fail */
   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");
+  GNUNET_DISK_purge_cfg_dir ("test_plugin_transport_data.conf",
+                             "GNUNET_TEST_HOME");
   return ret;
 }