adding test for content migration
[oweals/gnunet.git] / 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 2, 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 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
53  */
54 void
55 GNUNET_FS_TEST_daemons_start (struct GNUNET_SCHEDULER_Handle *sched,
56                               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,
61                               void *cont_cls);
62
63
64 /**
65  * Connect two daemons for testing.
66  *
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
74  */
75 void
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,
81                                 void *cont_cls);
82
83
84 /**
85  * Stop daemons used for testing.
86  *
87  * @param sched scheduler to use
88  * @param total number of daemons to stop
89  * @param daemons array with the daemons (values will be clobbered)
90  */
91 void
92 GNUNET_FS_TEST_daemons_stop (struct GNUNET_SCHEDULER_Handle *sched,
93                              unsigned int total,
94                              struct GNUNET_FS_TestDaemon **daemons);
95
96
97 /**
98  * Function signature.
99  *
100  * @param cls closure (user defined)
101  * @param uri a URI, NULL for errors
102  */
103 typedef void 
104 (*GNUNET_FS_TEST_UriContinuation)(void *cls,
105                                   const struct GNUNET_FS_Uri *uri);
106
107
108 /**
109  * Publish a file at the given daemon.
110  *
111  * @param sched scheduler to use
112  * @param daemon where to publish
113  * @param timeout if this operation cannot be completed within the
114  *                given period, call the continuation with an error code
115  * @param anonymity option for publication
116  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
117  *                GNUNET_SYSERR for simulation
118  * @param size size of the file to publish
119  * @param seed seed to use for file generation
120  * @param verbose how verbose to be in reporting
121  * @param cont function to call when done
122  * @param cont_cls closure for cont
123  */
124 void
125 GNUNET_FS_TEST_publish (struct GNUNET_SCHEDULER_Handle *sched,
126                         struct GNUNET_FS_TestDaemon *daemon,
127                         struct GNUNET_TIME_Relative timeout,
128                         uint32_t anonymity,
129                         int do_index,
130                         uint64_t size,
131                         uint32_t seed,
132                         unsigned int verbose,
133                         GNUNET_FS_TEST_UriContinuation cont,
134                         void *cont_cls);
135
136
137 /**
138  * Perform test download.
139  *
140  * @param sched scheduler to use
141  * @param daemon which peer to download from
142  * @param timeout if this operation cannot be completed within the
143  *                given period, call the continuation with an error code
144  * @param anonymity option for download
145  * @param seed used for file validation
146  * @param uri URI of file to download (CHK/LOC only)
147  * @param verbose how verbose to be in reporting
148  * @param cont function to call when done
149  * @param cont_cls closure for cont
150  */
151 void
152 GNUNET_FS_TEST_download (struct GNUNET_SCHEDULER_Handle *sched,
153                          struct GNUNET_FS_TestDaemon *daemon,
154                          struct GNUNET_TIME_Relative timeout,
155                          uint32_t anonymity,
156                          uint32_t seed,
157                          const struct GNUNET_FS_Uri *uri,
158                          unsigned int verbose,
159                          GNUNET_SCHEDULER_Task cont,
160                          void *cont_cls);
161
162
163
164 #endif