guix-env: some update.
[oweals/gnunet.git] / src / testing / gnunet-testing.c
index b7e115761c850683fb9b706382e9bddb18563e6b..3dbe6588345951a3ac67e9e6f2b8a489048f62d3 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 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
 
      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.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
- * @file testing_old/gnunet-testing.c
+ * @file testing/gnunet-testing.c
  * @brief tool to use testing functionality from cmd line
  * @author Christian Grothoff
  */
 #include "platform.h"
 #include "gnunet_util_lib.h"
-#include "gnunet_testing_lib-new.h"
+#include "gnunet_testing_lib.h"
+
+
+#define LOG(kind,...)                                           \
+  GNUNET_log_from (kind, "gnunet-testing", __VA_ARGS__)
 
-#define HOSTKEYFILESIZE 914
 
 /**
  * Final status code.
  */
 static int ret;
 
-static unsigned int create_hostkey;
+/**
+ * Filename of the hostkey file we should write,
+ * null if we should not write a hostkey file.
+ */
+static char *create_hostkey;
 
-static unsigned int create_cfg;
+/**
+ * Non-zero if we should create config files.
+ */
+static int create_cfg;
+
+/**
+ * Number of config files to create.
+ */
+static unsigned int create_no;
+
+/**
+ * Filename of the config template to be written.
+ */
+static char *create_cfg_template;
 
-static int create_no;
+/**
+ * Service we are supposed to run.
+ */
+static char *run_service_name;
 
-static char * create_cfg_template;
+/**
+ * File handle to STDIN, for reading restart/quit commands.
+ */
+static struct GNUNET_DISK_FileHandle *fh;
+
+/**
+ * Temporary filename, used with '-r' to write the configuration to.
+ */
+static char *tmpfilename;
+
+/**
+ * Task identifier of the task that waits for stdin.
+ */
+static struct GNUNET_SCHEDULER_Task *tid;
+
+/**
+ * Peer started for '-r'.
+ */
+static struct GNUNET_TESTING_Peer *my_peer;
 
-static char * create_hostkey_file;
 
 
 static int
@@ -66,19 +106,21 @@ create_unique_cfgs (const char * template, const unsigned int no)
   if ((create_cfg_template != NULL) && (GNUNET_OK != GNUNET_CONFIGURATION_load(cfg_tmpl, create_cfg_template)))
   {
     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not load template `%s'\n", create_cfg_template);
-    GNUNET_CONFIGURATION_destroy(cfg_tmpl);
+    GNUNET_CONFIGURATION_destroy (cfg_tmpl);
 
     return 1;
   }
   /* load defaults */
   if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg_tmpl,  NULL))
   {
-    GNUNET_break (0);
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Could not load template `%s'\n", create_cfg_template);
+    GNUNET_CONFIGURATION_destroy (cfg_tmpl);
     return 1;
   }
 
   fail = GNUNET_NO;
-  system = GNUNET_TESTING_system_create ("testing", NULL /* controller */);
+  system = GNUNET_TESTING_system_create ("testing", NULL /* controller */,
+                                         NULL, NULL);
   for (cur = 0; cur < no; cur++)
   {
     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating configuration no. %u \n", cur);
@@ -105,7 +147,7 @@ create_unique_cfgs (const char * template, const unsigned int no)
     }
     GNUNET_CONFIGURATION_destroy (cfg_new);
     GNUNET_free (cur_file);
-    if (fail == GNUNET_YES)
+    if (GNUNET_YES == fail)
       break;
   }
   GNUNET_CONFIGURATION_destroy(cfg_tmpl);
@@ -119,87 +161,143 @@ create_unique_cfgs (const char * template, const unsigned int no)
 static int
 create_hostkeys (const unsigned int no)
 {
+  struct GNUNET_TESTING_System *system;
+  struct GNUNET_PeerIdentity id;
   struct GNUNET_DISK_FileHandle *fd;
-  int cur = 0;
-  uint64_t fs;
-  uint64_t total_hostkeys;
-  char *hostkey_data;
-  char *hostkey_src_file;
-  char *hostkey_dest_file;
-
-  /* prepare hostkeys */
-  if (create_hostkey_file == NULL)
-    hostkey_src_file = "../../contrib/testing_hostkeys.dat";
-  else
+  struct GNUNET_CRYPTO_EddsaPrivateKey *pk;
+
+  system = GNUNET_TESTING_system_create ("testing", NULL, NULL, NULL);
+  pk = GNUNET_TESTING_hostkey_get (system, create_no, &id);
+  if (NULL == pk)
   {
-    hostkey_src_file = create_hostkey_file;
+    fprintf (stderr, _("Could not extract hostkey %u (offset too large?)\n"), create_no);
+    GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+    return 1;
   }
+  (void) GNUNET_DISK_directory_create_for_file (create_hostkey);
+  fd = GNUNET_DISK_file_open (create_hostkey,
+                             GNUNET_DISK_OPEN_READWRITE |
+                             GNUNET_DISK_OPEN_CREATE,
+                             GNUNET_DISK_PERM_USER_READ |
+                             GNUNET_DISK_PERM_USER_WRITE);
+  GNUNET_assert (fd != NULL);
+  ret = GNUNET_DISK_file_write (fd, pk,
+                               sizeof (struct GNUNET_CRYPTO_EddsaPrivateKey));
+  GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fd));
+  GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
+                  "Wrote hostkey to file: `%s'\n", create_hostkey);
+  GNUNET_free (pk);
+  GNUNET_TESTING_system_destroy (system, GNUNET_YES);
+  return 0;
+}
+
 
-  if (GNUNET_YES != GNUNET_DISK_file_test (hostkey_src_file))
+/**
+ * Cleanup called by signal handlers and when stdin is closed.
+ * Removes the temporary file.
+ *
+ * @param cls unused
+ */
+static void
+cleanup (void *cls)
+{
+  if (NULL != tmpfilename)
   {
-    if (create_hostkey_file == NULL)
-      GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Could not read hostkeys file, specify hostkey file with -H!\n"));
-    else
-      GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Specified hostkey file `%s' not found!\n"), create_hostkey_file);
-    return 1;
+    if (0 != UNLINK (tmpfilename))
+      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", tmpfilename);
   }
-  else
+  if (NULL != tid)
   {
-    /* Check hostkey file size, read entire thing into memory */
-    fd = GNUNET_DISK_file_open (hostkey_src_file, GNUNET_DISK_OPEN_READ,
-                                GNUNET_DISK_PERM_NONE);
-    if (NULL == fd)
-    {
-      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", hostkey_src_file);
-      return 1;
-    }
+    GNUNET_SCHEDULER_cancel (tid);
+    tid = NULL;
+  }
+  if (NULL != fh)
+  {
+    GNUNET_DISK_file_close (fh);
+    fh = NULL;
+  }
+}
 
-    if (GNUNET_OK != GNUNET_DISK_file_size (hostkey_src_file, &fs, GNUNET_YES, GNUNET_YES))
-      fs = 0;
 
-    if (0 != (fs % HOSTKEYFILESIZE))
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                  "File size %llu seems incorrect for hostkeys...\n", fs);
-    }
-    else
-    {
-      total_hostkeys = fs / HOSTKEYFILESIZE;
-      hostkey_data = GNUNET_malloc_large (fs);
-      GNUNET_assert (fs == GNUNET_DISK_file_read (fd, hostkey_data, fs));
-      GNUNET_log  (GNUNET_ERROR_TYPE_DEBUG,
-                       "Read %llu hostkeys from file\n", total_hostkeys);
-    }
-    GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fd));
-  }
+/**
+ * Called whenever we can read stdin non-blocking
+ *
+ * @param cls unused
+ */
+static void
+stdin_cb (void *cls)
+{
+  int c;
 
-  while (cur < no)
+  tid = NULL;
+  c = getchar ();
+  switch (c)
   {
-    GNUNET_asprintf (&hostkey_dest_file, "%04u-hostkey",cur);
-    GNUNET_assert (GNUNET_OK ==
-                   GNUNET_DISK_directory_create_for_file (hostkey_dest_file));
-    fd = GNUNET_DISK_file_open (hostkey_dest_file,
-                                GNUNET_DISK_OPEN_READWRITE |
-                                GNUNET_DISK_OPEN_CREATE,
-                                GNUNET_DISK_PERM_USER_READ |
-                                GNUNET_DISK_PERM_USER_WRITE);
-    GNUNET_assert (fd != NULL);
-    GNUNET_assert (HOSTKEYFILESIZE ==
-                   GNUNET_DISK_file_write (fd, &hostkey_data[cur * HOSTKEYFILESIZE], HOSTKEYFILESIZE));
-    GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fd));
-    GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
-                     "Wrote hostkey to file: `%s' \n", hostkey_dest_file);
-    GNUNET_free (hostkey_dest_file);
-    cur ++;
+  case EOF:
+  case 'q':
+    GNUNET_SCHEDULER_shutdown ();
+    return;
+  case 'r':
+    if (GNUNET_OK != GNUNET_TESTING_peer_stop (my_peer))
+      LOG (GNUNET_ERROR_TYPE_ERROR, "Failed to stop the peer\n");
+    if (GNUNET_OK != GNUNET_TESTING_peer_start (my_peer))
+      LOG (GNUNET_ERROR_TYPE_ERROR, "Failed to start the peer\n");
+    printf ("restarted\n");
+    fflush (stdout);
+    break;
+  case '\n':
+  case '\r':
+    /* ignore whitespace */
+    break;
+  default:
+    fprintf (stderr, _("Unknown command, use 'q' to quit or 'r' to restart peer\n"));
+    break;
   }
+  tid = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+                                       fh,
+                                        &stdin_cb, NULL);
+}
 
-  GNUNET_free (hostkey_data);
 
-  return 0;
+/**
+ * Main function called by the testing library.
+ * Executed inside a running scheduler.
+ *
+ * @param cls unused
+ * @param cfg configuration of the peer that was started
+ * @param peer handle to the peer
+ */
+static void
+testing_main (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg,
+              struct GNUNET_TESTING_Peer *peer)
+{
+  my_peer = peer;
+  if (NULL == (tmpfilename = GNUNET_DISK_mktemp ("gnunet-testing")))
+  {
+    GNUNET_break (0);
+    GNUNET_SCHEDULER_shutdown ();
+    return;
+  }
+  if (GNUNET_SYSERR ==
+      GNUNET_CONFIGURATION_write ((struct GNUNET_CONFIGURATION_Handle *) cfg,
+                                  tmpfilename))
+  {
+    GNUNET_break (0);
+    return;
+  }
+  printf("ok\n%s\n", tmpfilename);
+  fflush(stdout);
+  GNUNET_SCHEDULER_add_shutdown (&cleanup, NULL);
+  fh = GNUNET_DISK_get_handle_from_native (stdin);
+  tid = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+                                       fh,
+                                        &stdin_cb, NULL);
 }
 
+
+
 /**
- * Main function that will be run by the scheduler.
+ * Main function that will be running without scheduler.
  *
  * @param cls closure
  * @param args remaining command-line arguments
@@ -207,15 +305,22 @@ create_hostkeys (const unsigned int no)
  * @param cfg configuration
  */
 static void
-run (void *cls, char *const *args, const char *cfgfile,
+run_no_scheduler (void *cls, char *const *args, const char *cfgfile,
      const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
-  /* main code here */
-  if (create_cfg == GNUNET_YES)
+  if (NULL != run_service_name)
+  {
+    ret = GNUNET_TESTING_service_run ("gnunet_service_test", run_service_name,
+                                      cfgfile, &testing_main, NULL);
+    return;
+  }
+
+  if (GNUNET_YES == create_cfg)
   {
     if (create_no > 0)
     {
-      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating %u configuration files based on template `%s'\n", create_no, create_cfg_template);
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                 "Creating %u configuration files based on template `%s'\n", create_no, create_cfg_template);
       ret = create_unique_cfgs (create_cfg_template, create_no);
     }
     else
@@ -224,21 +329,11 @@ run (void *cls, char *const *args, const char *cfgfile,
       ret = 1;
     }
   }
-
-  if (create_hostkey == GNUNET_YES)
+  if (NULL != create_hostkey)
   {
-    if  (create_no > 0)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating %u hostkeys \n", create_no);
-      ret = create_hostkeys (create_no);
-    }
-    else
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Missing arguments! \n");
-      ret = 1;
-    }
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Extracting hostkey %u\n", create_no);
+    ret = create_hostkeys (create_no);
   }
-
   GNUNET_free_non_null (create_cfg_template);
 }
 
@@ -253,27 +348,50 @@ run (void *cls, char *const *args, const char *cfgfile,
 int
 main (int argc, char *const *argv)
 {
-  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
-    {'C', "cfg", NULL, gettext_noop ("create unique configuration files"),
-     GNUNET_NO, &GNUNET_GETOPT_set_one, &create_cfg},
-     {'k', "key", NULL, gettext_noop ("create hostkey files from pre-computed hostkey list"),
-     GNUNET_NO, &GNUNET_GETOPT_set_one, &create_hostkey},
-     {'H', "hostkeys", NULL, gettext_noop ("host key file"),
-     GNUNET_YES, &GNUNET_GETOPT_set_string, &create_hostkey_file},
-    {'n', "number", NULL, gettext_noop ("number of unique configuration files or hostkeys to create"),
-     GNUNET_YES, &GNUNET_GETOPT_set_uint, &create_no},
-    {'t', "template", NULL, gettext_noop ("configuration template"),
-     GNUNET_YES, &GNUNET_GETOPT_set_string, &create_cfg_template},
+  struct GNUNET_GETOPT_CommandLineOption options[] = {
+    GNUNET_GETOPT_option_flag ('C',
+                                  "cfg",
+                                  gettext_noop ("create unique configuration files"),
+                                  &create_cfg),
+    GNUNET_GETOPT_option_string ('k',
+                                 "key",
+                                 "FILENAME",
+                                 gettext_noop ("extract hostkey file from pre-computed hostkey list"),
+                                 &create_hostkey),
+
+    GNUNET_GETOPT_option_uint ('n',
+                                   "number",
+                                   "NUMBER",
+                                   gettext_noop ("number of unique configuration files to create, or number of the hostkey to extract"),
+                                   &create_no),
+
+
+    GNUNET_GETOPT_option_string ('t',
+                                 "template",
+                                 "FILENAME",
+                                 gettext_noop ("configuration template"),
+                                 &create_cfg_template),
+
+    GNUNET_GETOPT_option_string ('r',
+                                 "run",
+                                 "SERVICE",
+                                 gettext_noop ("run the given service, wait on stdin for 'r' (restart) or 'q' (quit)"),
+                                 &run_service_name),
     GNUNET_GETOPT_OPTION_END
   };
-
   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
     return 2;
 
-  return (GNUNET_OK ==
-          GNUNET_PROGRAM_run (argc, argv, "gnunet-testing",
-                              gettext_noop ("Command line tool to access the testing library"), options, &run,
-                              NULL)) ? ret : 1;
+  /* Run without scheduler, because we may want to call
+   * GNUNET_TESTING_service_run, which starts the scheduler on its own.
+   * Furthermore, the other functionality currently does not require the scheduler, too,
+   * but beware when extending gnunet-testing. */
+  ret = (GNUNET_OK ==
+        GNUNET_PROGRAM_run2 (argc, argv, "gnunet-testing",
+                            gettext_noop ("Command line tool to access the testing library"), options, &run_no_scheduler,
+                            NULL, GNUNET_YES)) ? ret : 1;
+  GNUNET_free ((void*) argv);
+  return ret;
 }
 
 /* end of gnunet-testing.c */