2 This file is part of GNUnet.
3 (C) 2010 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
32 #include "gnunet_util_lib.h"
33 #include "gnunet_fs_service.h"
36 * Handle for a daemon started for testing FS.
38 struct GNUNET_FS_TestDaemon;
42 * Start daemons for testing.
44 * @param sched scheduler to use
45 * @param template_cfg_file configuration template to use
46 * @param timeout if this operation cannot be completed within the
47 * given period, call the continuation with an error code
48 * @param total number of daemons to start
49 * @param daemons array of 'total' entries to be initialized
50 * (array must already be allocated, will be filled)
51 * @param cont function to call when done
52 * @param cont_cls closure for cont
55 GNUNET_FS_TEST_daemons_start (struct GNUNET_SCHEDULER_Handle *sched,
56 const char *template_cfg_file,
57 struct GNUNET_TIME_Relative timeout,
59 struct GNUNET_FS_TestDaemon **daemons,
60 GNUNET_SCHEDULER_Task cont,
65 * Connect two daemons for testing.
67 * @param sched scheduler to use
68 * @param daemon1 first daemon to connect
69 * @param daemon2 second first daemon to connect
70 * @param timeout if this operation cannot be completed within the
71 * given period, call the continuation with an error code
72 * @param cont function to call when done
73 * @param cont_cls closure for cont
76 GNUNET_FS_TEST_daemons_connect (struct GNUNET_SCHEDULER_Handle *sched,
77 struct GNUNET_FS_TestDaemon *daemon1,
78 struct GNUNET_FS_TestDaemon *daemon2,
79 struct GNUNET_TIME_Relative timeout,
80 GNUNET_SCHEDULER_Task cont,
85 * Obtain peer group used for testing.
87 * @param daemons array with the daemons (must contain at least one)
90 struct GNUNET_TESTING_PeerGroup *
91 GNUNET_FS_TEST_get_group (struct GNUNET_FS_TestDaemon **daemons);
96 * Stop daemons used for testing.
98 * @param sched scheduler to use
99 * @param total number of daemons to stop
100 * @param daemons array with the daemons (values will be clobbered)
103 GNUNET_FS_TEST_daemons_stop (struct GNUNET_SCHEDULER_Handle *sched,
105 struct GNUNET_FS_TestDaemon **daemons);
109 * Function signature.
111 * @param cls closure (user defined)
112 * @param uri a URI, NULL for errors
115 (*GNUNET_FS_TEST_UriContinuation)(void *cls,
116 const struct GNUNET_FS_Uri *uri);
120 * Publish a file at the given daemon.
122 * @param sched scheduler to use
123 * @param daemon where to publish
124 * @param timeout if this operation cannot be completed within the
125 * given period, call the continuation with an error code
126 * @param anonymity option for publication
127 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
128 * GNUNET_SYSERR for simulation
129 * @param size size of the file to publish
130 * @param seed seed to use for file generation
131 * @param verbose how verbose to be in reporting
132 * @param cont function to call when done
133 * @param cont_cls closure for cont
136 GNUNET_FS_TEST_publish (struct GNUNET_SCHEDULER_Handle *sched,
137 struct GNUNET_FS_TestDaemon *daemon,
138 struct GNUNET_TIME_Relative timeout,
143 unsigned int verbose,
144 GNUNET_FS_TEST_UriContinuation cont,
149 * Perform test download.
151 * @param sched scheduler to use
152 * @param daemon which peer to download from
153 * @param timeout if this operation cannot be completed within the
154 * given period, call the continuation with an error code
155 * @param anonymity option for download
156 * @param seed used for file validation
157 * @param uri URI of file to download (CHK/LOC only)
158 * @param verbose how verbose to be in reporting
159 * @param cont function to call when done
160 * @param cont_cls closure for cont
163 GNUNET_FS_TEST_download (struct GNUNET_SCHEDULER_Handle *sched,
164 struct GNUNET_FS_TestDaemon *daemon,
165 struct GNUNET_TIME_Relative timeout,
168 const struct GNUNET_FS_Uri *uri,
169 unsigned int verbose,
170 GNUNET_SCHEDULER_Task cont,