[GNUnet-SVN] r25530 - gnunet/src/mesh

[gnunet]

Author: bartpolot
Date: 2012-12-18 19:26:26 +0100 (Tue, 18 Dec 2012)
New Revision: 25530

Added:
   gnunet/src/mesh/mesh_test_lib.c
   gnunet/src/mesh/mesh_test_lib.h
Log:
- added mesh testing library

Added: gnunet/src/mesh/mesh_test_lib.c
===================================================================
--- gnunet/src/mesh/mesh_test_lib.c                             (rev 0)
+++ gnunet/src/mesh/mesh_test_lib.c     2012-12-18 18:26:26 UTC (rev 25530)
@@ -0,0 +1,291 @@
+/*
+     This file is part of GNUnet.
+     (C) 2012 Christian Grothoff (and other contributing authors)
+
+     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 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.
+
+     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.
+*/
+/**
+ * @file mesh/mesh_test_lib.c
+ * @author Bartlomiej Polot
+ * @brief library for writing MESH tests
+ */
+#include "platform.h"
+#include "mesh_test_lib.h"
+
+/**
+ * Test context for a MESH Test.
+ */
+struct GNUNET_MESH_TEST_Context
+{
+  /**
+   * Array of running peers.
+   */
+  struct GNUNET_TESTBED_Peer **peers;
+
+  /**
+   * Array of handles to the MESH for each peer.
+   */
+  struct GNUNET_MESH_Handle **meshes;
+
+  /**
+   * Operation associated with the connection to the MESH.
+   */
+  struct GNUNET_TESTBED_Operation **ops;
+
+  /**
+   * Main function of the test to run once all MESHs are available.
+   */
+  GNUNET_MESH_TEST_AppMain app_main;
+  
+  /**
+   * Closure for 'app_main'.
+   */
+  void *app_main_cls;
+
+  /**
+   * Number of peers running, size of the arrays above.
+   */
+  unsigned int num_peers;
+
+  /**
+   * Handler for incoming tunnels.
+   */
+  GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel;
+
+  /**
+   * Cleaner for destroyed incoming tunnels.
+   */
+  GNUNET_MESH_TunnelEndHandler cleaner;
+
+  /**
+   * Message handlers.
+   */
+  GNUNET_MESH_MessageHandler* handlers;
+
+  /**
+   * Application types.
+   */
+  const GNUNET_MESH_ApplicationType* stypes;
+
+};
+
+
+/**
+ * Context for a mesh adapter callback.
+ */
+struct GNUNET_MESH_TEST_AdapterContext
+{
+  /**
+   * Peer number for the particular peer.
+   */
+  unsigned int peer;
+
+  /**
+   * General context.
+   */
+  struct GNUNET_MESH_TEST_Context *ctx;
+};
+
+
+/**
+ * Adapter function called to establish a connection to
+ * the MESH service.
+ *
+ * @param cls closure
+ * @param cfg configuration of the peer to connect to; will be available until
+ *          GNUNET_TESTBED_operation_done() is called on the operation returned
+ *          from GNUNET_TESTBED_service_connect()
+ * @return service handle to return in 'op_result', NULL on error
+ */
+static void *
+mesh_connect_adapter (void *cls,
+                      const struct GNUNET_CONFIGURATION_Handle *cfg)
+{
+  struct GNUNET_MESH_TEST_AdapterContext *actx = cls;
+  struct GNUNET_MESH_TEST_Context *ctx = actx->ctx;
+  struct GNUNET_MESH_Handle *h;
+
+  h = GNUNET_MESH_connect (cfg,
+                           (void *) (long) actx->peer,
+                           ctx->new_tunnel,
+                           ctx->cleaner,
+                           ctx->handlers,
+                           ctx->stypes);
+  return h;
+}
+
+
+/**
+ * Adapter function called to destroy a connection to
+ * the MESH service.
+ *
+ * @param cls closure
+ * @param op_result service handle returned from the connect adapter
+ */
+static void 
+mesh_disconnect_adapter (void *cls,
+                         void *op_result)
+{
+  struct GNUNET_MESH_Handle *mesh = op_result;
+  struct GNUNET_MESH_TEST_AdapterContext *actx = cls;
+
+  GNUNET_free (actx);
+  GNUNET_MESH_disconnect (mesh);
+}
+
+
+/**
+ * Callback to be called when a service connect operation is completed.
+ *
+ * @param cls The callback closure from functions generating an operation.
+ * @param op The operation that has been finished.
+ * @param ca_result The service handle returned from 
+ *                  GNUNET_TESTBED_ConnectAdapter() (mesh handle).
+ * @param emsg Error message in case the operation has failed.
+ *             NULL if operation has executed successfully.
+ */
+static void 
+mesh_connect_cb (void *cls,
+                 struct GNUNET_TESTBED_Operation *op,
+                 void *ca_result,
+                 const char *emsg)
+{
+  struct GNUNET_MESH_TEST_Context *ctx = cls;
+  unsigned int i;
+ 
+  if (NULL != emsg)
+  {
+    fprintf (stderr, "Failed to connect to MESH service: %s\n",
+             emsg);
+    GNUNET_SCHEDULER_shutdown ();
+    return;
+  }
+  for (i = 0; i < ctx->num_peers; i++)
+    if (op == ctx->ops[i])
+      ctx->meshes[i] = ca_result;
+  for (i = 0; i < ctx->num_peers; i++)
+    if (NULL == ctx->meshes[i])
+      return; /* still some MESH connections missing */
+  /* all MESH connections ready! */
+  ctx->app_main (ctx->app_main_cls,
+                 ctx,
+                 ctx->num_peers,
+                 ctx->peers,
+                 ctx->meshes);
+}
+
+
+/**
+ * Clean up the testbed.
+ *
+ * @param ctx handle for the testbed
+ */
+void
+GNUNET_MESH_TEST_cleanup (struct GNUNET_MESH_TEST_Context *ctx)
+{
+  unsigned int i;
+
+  for (i = 0; i < ctx->num_peers; i++)
+    GNUNET_TESTBED_operation_done (ctx->ops[i]);
+  GNUNET_free (ctx->ops);
+  GNUNET_free (ctx->meshes);
+  GNUNET_free (ctx);
+  GNUNET_SCHEDULER_shutdown ();
+}
+
+
+/**
+ * Callback run when the testbed is ready (peers running and connected to
+ * each other)
+ * 
+ * @param cls Closure (context).
+ * @param num_peers Number of peers that are running.
+ * @param peers Handles to each one of the @c num_peers peers.
+ */
+static void
+mesh_test_run (void *cls,
+               unsigned int num_peers,
+               struct GNUNET_TESTBED_Peer **peers)
+{
+  struct GNUNET_MESH_TEST_Context *ctx = cls;
+  unsigned int i;
+
+  GNUNET_assert (num_peers == ctx->num_peers);
+  ctx->peers = peers;
+  for (i = 0; i < num_peers; i++)
+  {
+    struct GNUNET_MESH_TEST_AdapterContext *newctx;
+    newctx = GNUNET_malloc (sizeof (struct GNUNET_MESH_TEST_AdapterContext));
+    newctx->peer = i;
+    newctx->ctx = ctx;
+    ctx->ops[i] = GNUNET_TESTBED_service_connect (ctx,
+                                                  peers[i],
+                                                  "mesh",
+                                                  &mesh_connect_cb,
+                                                  ctx,
+                                                  &mesh_connect_adapter,
+                                                  &mesh_disconnect_adapter,
+                                                  newctx);
+  }
+}
+
+
+/**
+ * Run a test using the given name, configuration file and number of
+ * peers.
+ * All mesh callbacks will receive the peer number as the closure.
+ *
+ * @param testname Name of the test (for logging).
+ * @param cfgname Name of the configuration file.
+ * @param num_peers Number of peers to start.
+ * @param tmain Main function to run once the testbed is ready.
+ * @param tmain_cls Closure for 'tmain'.
+ * @param new_tunnel Handler for incoming tunnels.
+ * @param cleaner Cleaner for destroyed incoming tunnels.
+ * @param handlers Message handlers.
+ * @param stypes Application types.
+ */
+void 
+GNUNET_MESH_TEST_run (const char *testname,
+                      const char *cfgname,
+                      unsigned int num_peers,
+                      GNUNET_MESH_TEST_AppMain tmain,
+                      void *tmain_cls,
+                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
+                      GNUNET_MESH_TunnelEndHandler cleaner,
+                      GNUNET_MESH_MessageHandler* handlers,
+                      const GNUNET_MESH_ApplicationType* stypes)
+{
+  struct GNUNET_MESH_TEST_Context *ctx;
+  
+  ctx = GNUNET_malloc (sizeof (struct GNUNET_MESH_TEST_Context));
+  ctx->num_peers = num_peers;
+  ctx->ops = GNUNET_malloc (num_peers * sizeof (struct 
GNUNET_TESTBED_Operation *));
+  ctx->meshes = GNUNET_malloc (num_peers * sizeof (struct GNUNET_MESH_Handle 
*));
+  ctx->app_main = tmain;
+  ctx->app_main_cls = tmain_cls;
+  ctx->new_tunnel = new_tunnel;
+  ctx->cleaner = cleaner;
+  ctx->handlers = handlers;
+  ctx->stypes = stypes;
+  GNUNET_TESTBED_test_run (testname,
+                           cfgname,
+                           num_peers,
+                           0LL, NULL, NULL,
+                           &mesh_test_run, ctx);
+}
+
+/* end of mesh_test_lib.c */

Added: gnunet/src/mesh/mesh_test_lib.h
===================================================================
--- gnunet/src/mesh/mesh_test_lib.h                             (rev 0)
+++ gnunet/src/mesh/mesh_test_lib.h     2012-12-18 18:26:26 UTC (rev 25530)
@@ -0,0 +1,89 @@
+/*
+     This file is part of GNUnet.
+     (C) 2012 Christian Grothoff (and other contributing authors)
+
+     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 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.
+
+     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.
+*/
+/**
+ * @file mesh/mesh_test_lib.h
+ * @author Bartlomiej Polot
+ * @brief library for writing MESH tests
+ */
+#ifndef MESH_TEST_LIB_H
+#define MESH_TEST_LIB_H
+
+#include "gnunet_testbed_service.h"
+#include "gnunet_mesh_service.h"
+
+/**
+ * Test context for a MESH Test.
+ */
+struct GNUNET_MESH_TEST_Context;
+
+
+/**
+ * Main function of a MESH test.
+ *
+ * @param cls Closure.
+ * @param ctx Argument to give to GNUNET_MESH_TEST_cleanup on test end.
+ * @param num_peers Number of peers that are running.
+ * @param peers Array of peers.
+ * @param meshes Handle to each of the MESHs of the peers.
+ */
+typedef void (*GNUNET_MESH_TEST_AppMain) (void *cls,
+                                          struct GNUNET_MESH_TEST_Context *ctx,
+                                          unsigned int num_peers,
+                                          struct GNUNET_TESTBED_Peer **peers,
+                                          struct GNUNET_MESH_Handle **meshes);
+
+
+/**
+ * Run a test using the given name, configuration file and number of
+ * peers.
+ * All mesh callbacks will receive the peer number as the closure.
+ *
+ * @param testname Name of the test (for logging).
+ * @param cfgname Name of the configuration file.
+ * @param num_peers Number of peers to start.
+ * @param tmain Main function to run once the testbed is ready.
+ * @param tmain_cls Closure for 'tmain'.
+ * @param new_tunnel Handler for incoming tunnels.
+ * @param cleaner Cleaner for destroyed incoming tunnels.
+ * @param handlers Message handlers.
+ * @param stypes Application types.
+ */
+void 
+GNUNET_MESH_TEST_run (const char *testname,
+                      const char *cfgname,
+                      unsigned int num_peers,
+                      GNUNET_MESH_TEST_AppMain tmain,
+                      void *tmain_cls,
+                      GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
+                      GNUNET_MESH_TunnelEndHandler cleaner,
+                      GNUNET_MESH_MessageHandler* handlers,
+                      const GNUNET_MESH_ApplicationType* stypes);
+
+
+/**
+ * Clean up the testbed.
+ *
+ * @param ctx handle for the testbed
+ */
+void
+GNUNET_MESH_TEST_cleanup (struct GNUNET_MESH_TEST_Context *ctx);
+
+
+#endif