src/fs/fs_test_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010 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 fs/fs_test_lib.h
  23  * @brief library routines for testing FS publishing and downloading
  24  *        with multiple peers; this code is limited to flat files
  25  *        and no keywords (those functions can be tested with
  26  *        single-peer setups; this is for testing routing).
  27  * @author Christian Grothoff
  28  */
  29 #ifndef FS_TEST_LIB_H
  30 #define FS_TEST_LIB_H
  31
  32 #include "gnunet_util_lib.h"
  33 #include "gnunet_fs_service.h"
  34
  35 /**
  36  * Handle for a daemon started for testing FS.
  37  */
  38 struct GNUNET_FS_TestDaemon;
  39
  40
  41 /**
  42  * Start daemons for testing.
  43  *
  44  * @param template_cfg_file configuration template to use
  45  * @param timeout if this operation cannot be completed within the
  46  *                given period, call the continuation with an error code
  47  * @param total number of daemons to start
  48  * @param daemons array of 'total' entries to be initialized
  49  *                (array must already be allocated, will be filled)
  50  * @param cont function to call when done; note that if 'cont'
  51  *             is called with reason "TIMEOUT", then starting the
  52  *             daemons has failed and the client MUST NOT call
  53  *             'GNUNET_FS_TEST_daemons_stop'!
  54  * @param cont_cls closure for cont
  55  */
  56 void GNUNET_FS_TEST_daemons_start (const char *template_cfg_file,
  57                                    struct GNUNET_TIME_Relative timeout,
  58                                    unsigned int total,
  59                                    struct GNUNET_FS_TestDaemon **daemons,
  60                                    GNUNET_SCHEDULER_Task cont, void *cont_cls);
  61
  62
  63 /**
  64  * Connect two daemons for testing.
  65  *
  66  * @param daemon1 first daemon to connect
  67  * @param daemon2 second first daemon to connect
  68  * @param timeout if this operation cannot be completed within the
  69  *                given period, call the continuation with an error code
  70  * @param cont function to call when done
  71  * @param cont_cls closure for cont
  72  */
  73 void GNUNET_FS_TEST_daemons_connect (struct GNUNET_FS_TestDaemon *daemon1,
  74                                      struct GNUNET_FS_TestDaemon *daemon2,
  75                                      struct GNUNET_TIME_Relative timeout,
  76                                      GNUNET_SCHEDULER_Task cont,
  77                                      void *cont_cls);
  78
  79
  80 /**
  81  * Obtain peer group used for testing.
  82  *
  83  * @param daemons array with the daemons (must contain at least one)
  84  * @return peer group
  85  */
  86 struct GNUNET_TESTING_PeerGroup *GNUNET_FS_TEST_get_group (struct
  87                                                            GNUNET_FS_TestDaemon
  88                                                            **daemons);
  89
  90
  91
  92 /**
  93  * Obtain peer configuration used for testing.
  94  *
  95  * @param daemons array with the daemons
  96  * @param off which configuration to get
  97  * @return peer configuration
  98  */
  99 const struct GNUNET_CONFIGURATION_Handle
 100     *GNUNET_FS_TEST_get_configuration (struct GNUNET_FS_TestDaemon **daemons,
 101                                        unsigned int off);
 102
 103 /**
 104  * Stop daemons used for testing.
 105  *
 106  * @param total number of daemons to stop
 107  * @param daemons array with the daemons (values will be clobbered)
 108  */
 109 void GNUNET_FS_TEST_daemons_stop (unsigned int total,
 110                                   struct GNUNET_FS_TestDaemon **daemons);
 111
 112
 113 /**
 114  * Function signature.
 115  *
 116  * @param cls closure (user defined)
 117  * @param uri a URI, NULL for errors
 118  */
 119 typedef void (*GNUNET_FS_TEST_UriContinuation) (void *cls,
 120                                                 const struct GNUNET_FS_Uri *
 121                                                 uri);
 122
 123
 124 /**
 125  * Publish a file at the given daemon.
 126  *
 127  * @param daemon where to publish
 128  * @param timeout if this operation cannot be completed within the
 129  *                given period, call the continuation with an error code
 130  * @param anonymity option for publication
 131  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
 132  *                GNUNET_SYSERR for simulation
 133  * @param size size of the file to publish
 134  * @param seed seed to use for file generation
 135  * @param verbose how verbose to be in reporting
 136  * @param cont function to call when done
 137  * @param cont_cls closure for cont
 138  */
 139 void GNUNET_FS_TEST_publish (struct GNUNET_FS_TestDaemon *daemon,
 140                              struct GNUNET_TIME_Relative timeout,
 141                              uint32_t anonymity, int do_index, uint64_t size,
 142                              uint32_t seed, unsigned int verbose,
 143                              GNUNET_FS_TEST_UriContinuation cont,
 144                              void *cont_cls);
 145
 146
 147 /**
 148  * Perform test download.
 149  *
 150  * @param daemon which peer to download from
 151  * @param timeout if this operation cannot be completed within the
 152  *                given period, call the continuation with an error code
 153  * @param anonymity option for download
 154  * @param seed used for file validation
 155  * @param uri URI of file to download (CHK/LOC only)
 156  * @param verbose how verbose to be in reporting
 157  * @param cont function to call when done
 158  * @param cont_cls closure for cont
 159  */
 160 void GNUNET_FS_TEST_download (struct GNUNET_FS_TestDaemon *daemon,
 161                               struct GNUNET_TIME_Relative timeout,
 162                               uint32_t anonymity, uint32_t seed,
 163                               const struct GNUNET_FS_Uri *uri,
 164                               unsigned int verbose, GNUNET_SCHEDULER_Task cont,
 165                               void *cont_cls);
 166
 167
 168
 169 #endif