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