src/transport/transport-testing.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2006, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file transport-testing.h
  23  * @brief testing lib for transport service
  24  *
  25  * @author Matthias Wachs
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_common.h"
  30 #include "gnunet_getopt_lib.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_os_lib.h"
  33 #include "gnunet_program_lib.h"
  34 #include "gnunet_transport_service.h"
  35
  36 #define GNUNET_TRANSPORT_TESTING_ConnectRequest void *
  37
  38 /**
  39  * Context for a single peer
  40  */
  41 struct PeerContext
  42 {
  43   struct GNUNET_CONFIGURATION_Handle *cfg;
  44
  45   struct GNUNET_TRANSPORT_Handle *th;
  46
  47   struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
  48
  49   struct GNUNET_PeerIdentity id;
  50
  51   struct GNUNET_OS_Process *arm_proc;
  52
  53   GNUNET_TRANSPORT_ReceiveCallback rec;
  54
  55   GNUNET_TRANSPORT_NotifyConnect nc;
  56
  57   GNUNET_TRANSPORT_NotifyDisconnect nd;
  58
  59   void *cb_cls;
  60
  61   char *servicehome;
  62 };
  63
  64 /**
  65  * Callback when two peers are connected and both have called the connect callback
  66  * to notify clients about a new peer
  67  */
  68 typedef void (*GNUNET_TRANSPORT_TESTING_connect_cb) (struct PeerContext * p1,
  69                                                      struct PeerContext * p2,
  70                                                      void *cls);
  71
  72
  73 /**
  74  * Start a peer with the given configuration
  75  * @param rec receive callback
  76  * @param nc connect callback
  77  * @param nd disconnect callback
  78  * @param cb_cls closure for callback
  79  *   if NULL passed the PeerContext * will be used!
  80  * @return the peer context
  81  */
  82 struct PeerContext *
  83 GNUNET_TRANSPORT_TESTING_start_peer (const char *cfgname,
  84                                      GNUNET_TRANSPORT_ReceiveCallback rec,
  85                                      GNUNET_TRANSPORT_NotifyConnect nc,
  86                                      GNUNET_TRANSPORT_NotifyDisconnect nd,
  87                                      void *cb_cls);
  88
  89
  90 /**
  91  * shutdown the given peer
  92  * @param p the peer
  93  */
  94
  95 void
  96 GNUNET_TRANSPORT_TESTING_stop_peer (struct PeerContext *pc);
  97
  98
  99 /**
 100  * Connect the given peers and call the callback when both peers report the
 101  * inbound connection. Remarks: start_peer's notify_connect callback can be called
 102  * before.
 103  * @param p1 peer 1
 104  * @param p2 peer 2
 105  * @param cb the callback to call
 106  * @param cb_cls callback cls
 107  * @return a connect request handle
 108  */
 109 GNUNET_TRANSPORT_TESTING_ConnectRequest
 110 GNUNET_TRANSPORT_TESTING_connect_peers (struct PeerContext *p1,
 111                                         struct PeerContext *p2,
 112                                         GNUNET_TRANSPORT_TESTING_connect_cb cb,
 113                                         void *cls);
 114
 115 /**
 116  * Cancel the request to connect two peers
 117  * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
 118  * @param cc a connect request handle
 119  */
 120 void
 121 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (void *cc);
 122
 123 /*
 124  * Some utility functions
 125  */
 126
 127 /**
 128  * Extracts the test filename from an absolute file name and removes the extension
 129  * @param file absolute file name
 130  * @param dest where to store result
 131  */
 132 void
 133 GNUNET_TRANSPORT_TESTING_get_test_name (const char *file, char **dest);
 134
 135 /**
 136  * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
 137  * if existing ".exe"-prefix and adds the peer-number
 138  * @param file filename of the test, e.g. argv[0]
 139  * @param cfgname where to write the result
 140  * @param count peer number
 141  */
 142 void
 143 GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **cfgname,
 144                                           int count);
 145
 146
 147 /**
 148  * Extracts the plugin anme from an absolute file name and the test name
 149  * @param file absolute file name
 150  * @param test test name
 151  * @param dest where to store result
 152  */
 153 void
 154 GNUNET_TRANSPORT_TESTING_get_test_plugin_name (const char *executable,
 155                                                const char *testname,
 156                                                char **pluginname);
 157
 158
 159 /**
 160  * Extracts the filename from an absolute file name and removes the extenstion
 161  * @param file absolute file name
 162  * @param dest where to store result
 163  */
 164 void
 165 GNUNET_TRANSPORT_TESTING_get_test_source_name (const char *file,
 166                                                char **testname);
 167
 168 /* end of transport_testing.h */