src/cadet/cadet_test_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2012,2017 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file cadet/cadet_test_lib.h
  22  * @author Bartlomiej Polot
  23  * @brief library for writing CADET tests
  24  */
  25 #ifndef CADET_TEST_LIB_H
  26 #define CADET_TEST_LIB_H
  27
  28 #ifdef __cplusplus
  29 extern "C"
  30 {
  31 #if 0                           /* keep Emacsens' auto-indent happy */
  32 }
  33 #endif
  34 #endif
  35
  36 #include "gnunet_testbed_service.h"
  37 #include "gnunet_cadet_service.h"
  38
  39 /**
  40  * Test context for a CADET Test.
  41  */
  42 struct GNUNET_CADET_TEST_Context;
  43
  44
  45 /**
  46  * Main function of a CADET test.
  47  *
  48  * @param cls Closure.
  49  * @param ctx Argument to give to GNUNET_CADET_TEST_cleanup on test end.
  50  * @param num_peers Number of peers that are running.
  51  * @param peers Array of peers.
  52  * @param cadets Handle to each of the CADETs of the peers.
  53  */
  54 typedef void (*GNUNET_CADET_TEST_AppMain) (void *cls,
  55                                           struct GNUNET_CADET_TEST_Context *ctx,
  56                                           unsigned int num_peers,
  57                                           struct GNUNET_TESTBED_Peer **peers,
  58                                           struct GNUNET_CADET_Handle **cadets);
  59
  60
  61 /**
  62  * Run a test using the given name, configuration file and number of peers.
  63  * All cadet callbacks will receive the peer number (long) as the closure.
  64  *
  65  * @param testname Name of the test (for logging).
  66  * @param cfgfile Name of the configuration file.
  67  * @param num_peers Number of peers to start.
  68  * @param tmain Main function to run once the testbed is ready.
  69  * @param tmain_cls Closure for @a tmain.
  70  * @param connects Handler for incoming channels.
  71  * @param window_changes Handler for the window size change notification.
  72  * @param disconnects Cleaner for destroyed incoming channels.
  73  * @param handlers Message handlers.
  74  * @param ports Ports the peers offer, NULL-terminated.
  75  */
  76 void
  77 GNUNET_CADET_TEST_ruN (const char *testname,
  78                        const char *cfgfile,
  79                        unsigned int num_peers,
  80                        GNUNET_CADET_TEST_AppMain tmain,
  81                        void *tmain_cls,
  82                        GNUNET_CADET_ConnectEventHandler connects,
  83                        GNUNET_CADET_WindowSizeEventHandler window_changes,
  84                        GNUNET_CADET_DisconnectEventHandler disconnects,
  85                        struct GNUNET_MQ_MessageHandler *handlers,
  86                        const struct GNUNET_HashCode **ports);
  87
  88 /**
  89  * Clean up the testbed.
  90  *
  91  * @param ctx handle for the testbed
  92  */
  93 void
  94 GNUNET_CADET_TEST_cleanup (struct GNUNET_CADET_TEST_Context *ctx);
  95
  96
  97 #if 0                           /* keep Emacsens' auto-indent happy */
  98 {
  99 #endif
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104
 105 /* ifndef CADET_TEST_LIB_H */
 106 #endif