src/include/gnunet_testing_lib.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2008, 2009, 2012 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 3, 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 include/gnunet_testing_lib.h
  23  * @brief convenience API for writing testcases for GNUnet;
  24  *        can start/stop one or more peers on a system;
  25  *        testing is responsible for managing private keys,
  26  *        ports and paths; it is a low-level library that
  27  *        does not support higher-level functions such as
  28  *        P2P connection, topology management or distributed
  29  *        testbed maintenance (those are in gnunet_testbed_service.h)
  30  * @author Christian Grothoff
  31  */
  32
  33 #ifndef GNUNET_TESTING_LIB_H
  34 #define GNUNET_TESTING_LIB_H
  35
  36 #include "gnunet_util_lib.h"
  37 #include "gnunet_statistics_service.h"
  38 #include "gnunet_arm_service.h"
  39
  40 #ifdef __cplusplus
  41 extern "C"
  42 {
  43 #if 0                           /* keep Emacsens' auto-indent happy */
  44 }
  45 #endif
  46 #endif
  47
  48 /**
  49  * Size of each hostkey in the hostkey file (in BYTES).
  50  */
  51 #define GNUNET_TESTING_HOSTKEYFILESIZE sizeof (struct GNUNET_CRYPTO_EccPrivateKey)
  52
  53 /**
  54  * Handle for a system on which GNUnet peers are executed;
  55  * a system is used for reserving unique paths and ports.
  56  */
  57 struct GNUNET_TESTING_System;
  58
  59
  60 /**
  61  * Handle for a GNUnet peer controlled by testing.
  62  */
  63 struct GNUNET_TESTING_Peer;
  64
  65
  66 /**
  67  * Specification of a service that is to be shared among peers
  68  */
  69 struct GNUNET_TESTING_SharedService
  70 {
  71   /**
  72    * The name of the service.
  73    */
  74   const char *service;
  75
  76   /**
  77    * The configuration template for the service.  Cannot be NULL
  78    */
  79   const struct GNUNET_CONFIGURATION_Handle *cfg;
  80
  81   /**
  82    * The number of peers which share an instance of the service.  0 for sharing
  83    * among all peers
  84    */
  85   unsigned int share;
  86 };
  87
  88
  89 /**
  90  * Create a system handle.  There must only be one system handle per operating
  91  * system.  Uses a default range for allowed ports.  Ports are still tested for
  92  * availability.
  93  *
  94  * @param testdir only the directory name without any path. This is used for all
  95  *          service homes; the directory will be created in a temporary location
  96  *          depending on the underlying OS
  97  * @param trusted_ip the ip address which will be set as TRUSTED HOST in all
  98  *          service configurations generated to allow control connections from
  99  *          this ip. This can either be a single ip address or a network address
 100  *          in CIDR notation.
 101  * @param hostname the hostname of the system we are using for testing; NULL for
 102  *          localhost
 103  * @param shared_services NULL terminated array describing services that are to
 104  *          be shared among peers
 105  * @return handle to this system, NULL on error
 106  */
 107 struct GNUNET_TESTING_System *
 108 GNUNET_TESTING_system_create (const char *testdir,
 109                               const char *trusted_ip,
 110                               const char *hostname,
 111                               const struct GNUNET_TESTING_SharedService *
 112                               shared_services);
 113
 114
 115 /**
 116  * Create a system handle.  There must only be one system
 117  * handle per operating system.  Use this function directly
 118  * if multiple system objects are created for the same host
 119  * (only really useful when testing --- or to make the port
 120  * range configureable).
 121  *
 122  * @param testdir only the directory name without any path. This is used for
 123  *          all service homes; the directory will be created in a temporary
 124  *          location depending on the underlying OS
 125  * @param trusted_ip the ip address which will be set as TRUSTED HOST in all
 126  *          service configurations generated to allow control connections from
 127  *          this ip. This can either be a single ip address or a network address
 128  *          in CIDR notation.
 129  * @param hostname the hostname of the system we are using for testing; NULL for
 130  *          localhost
 131  * @param shared_services NULL terminated array describing services that are to
 132  *          be shared among peers
 133  * @param lowport lowest port number this system is allowed to allocate (inclusive)
 134  * @param highport highest port number this system is allowed to allocate (exclusive)
 135  * @return handle to this system, NULL on error
 136  */
 137 struct GNUNET_TESTING_System *
 138 GNUNET_TESTING_system_create_with_portrange (const char *testdir,
 139                                              const char *trusted_ip,
 140                                              const char *hostname,
 141                                              const struct
 142                                              GNUNET_TESTING_SharedService *
 143                                              shared_services,
 144                                              uint16_t lowport,
 145                                              uint16_t highport);
 146
 147
 148 /**
 149  * Free system resources.
 150  *
 151  * @param system system to be freed
 152  * @param remove_paths should the 'testdir' and all subdirectories
 153  *        be removed (clean up on shutdown)?
 154  */
 155 void
 156 GNUNET_TESTING_system_destroy (struct GNUNET_TESTING_System *system,
 157                                int remove_paths);
 158
 159
 160 /**
 161  * Testing includes a number of pre-created hostkeys for
 162  * faster peer startup.  This function can be used to
 163  * access the n-th key of those pre-created hostkeys; note
 164  * that these keys are ONLY useful for testing and not
 165  * secure as the private keys are part of the public
 166  * GNUnet source code.
 167  *
 168  * This is primarily a helper function used internally
 169  * by 'GNUNET_TESTING_peer_configure'.
 170  *
 171  * @param system the testing system handle
 172  * @param key_number desired pre-created hostkey to obtain
 173  * @param id set to the peer's identity (hash of the public
 174  *        key; if NULL, GNUNET_SYSERR is returned immediately
 175  * @return NULL on error (not enough keys)
 176  */
 177 struct GNUNET_CRYPTO_EccPrivateKey *
 178 GNUNET_TESTING_hostkey_get (const struct GNUNET_TESTING_System *system,
 179                             uint32_t key_number,
 180                             struct GNUNET_PeerIdentity *id);
 181
 182
 183 /**
 184  * Reserve a TCP or UDP port for a peer.
 185  *
 186  * @param system system to use for reservation tracking
 187  * @param is_tcp GNUNET_YES for TCP ports, GNUNET_NO for UDP
 188  * @return 0 if no free port was available
 189  */
 190 uint16_t
 191 GNUNET_TESTING_reserve_port (struct GNUNET_TESTING_System *system,
 192                              int is_tcp);
 193
 194
 195 /**
 196  * Release reservation of a TCP or UDP port for a peer
 197  * (used during GNUNET_TESTING_peer_destroy).
 198  *
 199  * @param system system to use for reservation tracking
 200  * @param is_tcp GNUNET_YES for TCP ports, GNUNET_NO for UDP
 201  * @param port reserved port to release
 202  */
 203 void
 204 GNUNET_TESTING_release_port (struct GNUNET_TESTING_System *system,
 205                              int is_tcp,
 206                              uint16_t port);
 207
 208
 209 /**
 210  * Create a new configuration using the given configuration as a template;
 211  * ports and paths will be modified to select available ports on the local
 212  * system. The default configuration will be available in PATHS section under
 213  * the option DEFAULTCONFIG after the call. SERVICE_HOME is also set in PATHS
 214  * section to the temporary directory specific to this configuration. If we run
 215  * out of "*port" numbers, return SYSERR.
 216  *
 217  * This is primarily a helper function used internally
 218  * by 'GNUNET_TESTING_peer_configure'.
 219  *
 220  * @param system system to use to coordinate resource usage
 221  * @param cfg template configuration to update
 222  * @return GNUNET_OK on success, GNUNET_SYSERR on error - the configuration will
 223  *           be incomplete and should not be used there upon
 224  */
 225 int
 226 GNUNET_TESTING_configuration_create (struct GNUNET_TESTING_System *system,
 227                                      struct GNUNET_CONFIGURATION_Handle *cfg);
 228 // FIXME: add dual to 'release' ports again...
 229
 230
 231 /**
 232  * Configure a GNUnet peer.  GNUnet must be installed on the local
 233  * system and available in the PATH.
 234  *
 235  * @param system system to use to coordinate resource usage
 236  * @param cfg configuration to use; will be UPDATED (to reflect needed
 237  *            changes in port numbers and paths)
 238  * @param key_number number of the hostkey to use for the peer
 239  * @param id identifier for the daemon, will be set, can be NULL
 240  * @param emsg set to freshly allocated error message (set to NULL on success),
 241  *          can be NULL
 242  * @return handle to the peer, NULL on error
 243  */
 244 struct GNUNET_TESTING_Peer *
 245 GNUNET_TESTING_peer_configure (struct GNUNET_TESTING_System *system,
 246                                struct GNUNET_CONFIGURATION_Handle *cfg,
 247                                uint32_t key_number,
 248                                struct GNUNET_PeerIdentity *id,
 249                                char **emsg);
 250
 251
 252 /**
 253  * Obtain the peer identity from a peer handle.
 254  *
 255  * @param peer peer handle for which we want the peer's identity
 256  * @param id identifier for the daemon, will be set
 257  */
 258 void
 259 GNUNET_TESTING_peer_get_identity (struct GNUNET_TESTING_Peer *peer,
 260                                   struct GNUNET_PeerIdentity *id);
 261
 262
 263 /**
 264  * Start the peer.
 265  *
 266  * @param peer peer to start
 267  * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer already running)
 268  */
 269 int
 270 GNUNET_TESTING_peer_start (struct GNUNET_TESTING_Peer *peer);
 271
 272
 273 /**
 274  * Stop the peer. This call is blocking as it kills the peer's main ARM process
 275  * by sending a SIGTERM and waits on it.  For asynchronous shutdown of peer, see
 276  * GNUNET_TESTING_peer_stop_async().
 277  *
 278  * @param peer peer to stop
 279  * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer not running)
 280  */
 281 int
 282 GNUNET_TESTING_peer_stop (struct GNUNET_TESTING_Peer *peer);
 283
 284
 285 /**
 286  * Destroy the peer.  Releases resources locked during peer configuration.
 287  * If the peer is still running, it will be stopped AND a warning will be
 288  * printed (users of the API should stop the peer explicitly first).
 289  *
 290  * @param peer peer to destroy
 291  */
 292 void
 293 GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer *peer);
 294
 295
 296 /**
 297  * Sends SIGTERM to the peer's main process
 298  *
 299  * @param peer the handle to the peer
 300  * @return GNUNET_OK if successful; GNUNET_SYSERR if the main process is NULL
 301  *           or upon any error while sending SIGTERM
 302  */
 303 int
 304 GNUNET_TESTING_peer_kill (struct GNUNET_TESTING_Peer *peer);
 305
 306
 307 /**
 308  * Waits for a peer to terminate. The peer's main process will also be destroyed.
 309  *
 310  * @param peer the handle to the peer
 311  * @return GNUNET_OK if successful; GNUNET_SYSERR if the main process is NULL
 312  *           or upon any error while waiting
 313  */
 314 int
 315 GNUNET_TESTING_peer_wait (struct GNUNET_TESTING_Peer *peer);
 316
 317
 318 /**
 319  * Callback to inform whether the peer is running or stopped.
 320  *
 321  * @param cls the closure given to GNUNET_TESTING_peer_stop_async()
 322  * @param peer the respective peer whose status is being reported
 323  * @param success GNUNET_YES if the peer is stopped; GNUNET_SYSERR upon any
 324  *          error
 325  */
 326 typedef void (*GNUNET_TESTING_PeerStopCallback) (void *cls,
 327                                                  struct GNUNET_TESTING_Peer *
 328                                                  peer,
 329                                                  int success);
 330
 331
 332 /**
 333  * Stop a peer asynchronously using ARM API.  Peer's shutdown is signaled
 334  * through the GNUNET_TESTING_PeerStopCallback().
 335  *
 336  * @param peer the peer to stop
 337  * @param cb the callback to signal peer shutdown
 338  * @param cb_cls closure for the above callback
 339  * @return GNUNET_OK upon successfully giving the request to the ARM API (this
 340  *           does not mean that the peer is successfully stopped); GNUNET_SYSERR
 341  *           upon any error.
 342  */
 343 int
 344 GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer,
 345                                 GNUNET_TESTING_PeerStopCallback cb,
 346                                 void *cb_cls);
 347
 348
 349 /**
 350  * Cancel a previous asynchronous peer stop request.
 351  * GNUNET_TESTING_peer_stop_async() should have been called before on the given
 352  * peer.  It is an error to call this function if the peer stop callback was
 353  * already called
 354  *
 355  * @param peer the peer on which GNUNET_TESTING_peer_stop_async() was called
 356  *          before.
 357  */
 358 void
 359 GNUNET_TESTING_peer_stop_async_cancel (struct GNUNET_TESTING_Peer *peer);
 360
 361
 362 /**
 363  * Signature of the 'main' function for a (single-peer) testcase that
 364  * is run using 'GNUNET_TESTING_peer_run'.
 365  *
 366  * @param cls closure
 367  * @param cfg configuration of the peer that was started
 368  * @param peer identity of the peer that was created
 369  */
 370 typedef void (*GNUNET_TESTING_TestMain) (void *cls,
 371                                          const struct GNUNET_CONFIGURATION_Handle *cfg,
 372                                          struct GNUNET_TESTING_Peer *peer);
 373
 374
 375 /**
 376  * Start a single peer and run a test using the testing library.
 377  * Starts a peer using the given configuration and then invokes the
 378  * given callback.  This function ALSO initializes the scheduler loop
 379  * and should thus be called directly from "main".  The testcase
 380  * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
 381  *
 382  * @param testdir only the directory name without any path. This is used for
 383  *          all service homes; the directory will be created in a temporary
 384  *          location depending on the underlying OS
 385  * @param cfgfilename name of the configuration file to use;
 386  *         use NULL to only run with defaults
 387  * @param tm main function of the testcase
 388  * @param tm_cls closure for 'tm'
 389  * @return 0 on success, 1 on error
 390  */
 391 int
 392 GNUNET_TESTING_peer_run (const char *testdir,
 393                          const char *cfgfilename,
 394                          GNUNET_TESTING_TestMain tm,
 395                          void *tm_cls);
 396
 397
 398 /**
 399  * Start a single service (no ARM, except of course if the given
 400  * service name is 'arm') and run a test using the testing library.
 401  * Starts a service using the given configuration and then invokes the
 402  * given callback.  This function ALSO initializes the scheduler loop
 403  * and should thus be called directly from "main".  The testcase
 404  * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
 405  *
 406  * This function is useful if the testcase is for a single service
 407  * and if that service doesn't itself depend on other services.
 408  *
 409  * @param testdir only the directory name without any path. This is used for
 410  *          all service homes; the directory will be created in a temporary
 411  *          location depending on the underlying OS
 412  * @param service_name name of the service to run
 413  * @param cfgfilename name of the configuration file to use;
 414  *         use NULL to only run with defaults
 415  * @param tm main function of the testcase
 416  * @param tm_cls closure for 'tm'
 417  * @return 0 on success, 1 on error
 418  */
 419 int
 420 GNUNET_TESTING_service_run (const char *testdir,
 421                             const char *service_name,
 422                             const char *cfgfilename,
 423                             GNUNET_TESTING_TestMain tm,
 424                             void *tm_cls);
 425
 426
 427 /**
 428  * Sometimes we use the binary name to determine which specific
 429  * test to run.  In those cases, the string after the last "_"
 430  * in 'argv[0]' specifies a string that determines the configuration
 431  * file or plugin to use.
 432  *
 433  * This function returns the respective substring, taking care
 434  * of issues such as binaries ending in '.exe' on W32.
 435  *
 436  * @param argv0 the name of the binary
 437  * @return string between the last '_' and the '.exe' (or the end of the string),
 438  *         NULL if argv0 has no '_'
 439  */
 440 char *
 441 GNUNET_TESTING_get_testname_from_underscore (const char *argv0);
 442
 443
 444 #if 0                           /* keep Emacsens' auto-indent happy */
 445 {
 446 #endif
 447 #ifdef __cplusplus
 448 }
 449 #endif
 450
 451 #endif