2 This file is part of GNUnet.
3 Copyright (C) 2006, 2009, 2015 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 3, 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport-testing.h
23 * @brief testing lib for transport service
25 * @author Matthias Wachs
28 #include "gnunet_util_lib.h"
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_transport_service.h"
31 #include "gnunet_testing_lib.h"
34 struct GNUNET_TRANSPORT_TESTING_ConnectRequest;
38 * Context for a single peer
43 * Callback when two peers are connected and both have called the connect callback
44 * to notify clients about a new peer
47 (*GNUNET_TRANSPORT_TESTING_start_cb) (struct PeerContext *p,
51 * Callback when two peers are connected and both have called the connect callback
52 * to notify clients about a new peer
55 (*GNUNET_TRANSPORT_TESTING_connect_cb) (struct PeerContext *p1,
56 struct PeerContext *p2,
61 * Definition for a transport testing handle
63 struct GNUNET_TRANSPORT_TESTING_handle;
66 * Context for a single peer
71 * Next element in the DLL
73 struct PeerContext *next;
76 * Previous element in the DLL
78 struct PeerContext *prev;
81 * Transport testing handle this peer belongs to
83 struct GNUNET_TRANSPORT_TESTING_handle *tth;
86 * Peer's configuration
88 struct GNUNET_CONFIGURATION_Handle *cfg;
91 * Peer's transport service handle
93 struct GNUNET_TRANSPORT_Handle *th;
98 struct GNUNET_ATS_ConnectivityHandle *ats;
101 * Peer's transport get hello handle to retrieve peer's HELLO message
103 struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
106 * Peer's testing handle
108 struct GNUNET_TESTING_Peer *peer;
113 struct GNUNET_PeerIdentity id;
116 * Handle for the peer's ARM process
118 struct GNUNET_OS_Process *arm_proc;
123 GNUNET_TRANSPORT_ReceiveCallback rec;
126 * Notify connect callback
128 GNUNET_TRANSPORT_NotifyConnect nc;
131 * Notify disconnect callback
133 GNUNET_TRANSPORT_NotifyDisconnect nd;
136 * Startup completed callback
138 GNUNET_TRANSPORT_TESTING_start_cb start_cb;
141 * Peers HELLO Message
143 struct GNUNET_HELLO_Message *hello;
146 * Closure for the callbacks
151 * An unique number to identify the peer
157 struct GNUNET_TRANSPORT_TESTING_ConnectRequest
159 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *next;
160 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *prev;
161 struct PeerContext *p1;
162 struct PeerContext *p2;
163 struct GNUNET_SCHEDULER_Task *tct;
164 struct GNUNET_ATS_ConnectivitySuggestHandle *ats_sh;
165 struct GNUNET_TRANSPORT_OfferHelloHandle *oh;
166 GNUNET_TRANSPORT_TESTING_connect_cb cb;
172 struct GNUNET_TRANSPORT_TESTING_handle
175 * Testing library system handle
177 struct GNUNET_TESTING_System *tl_system;
180 * head DLL of connect contexts
182 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc_head;
185 * head DLL of connect contexts
187 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc_tail;
192 struct PeerContext *p_head;
197 struct PeerContext *p_tail;
202 * Start a peer with the given configuration
204 * @param tth the testing handle
205 * @param cfgname configuration file
206 * @param peer_id the peer_id
207 * @param rec receive callback
208 * @param nc connect callback
209 * @param nd disconnect callback
210 * @param start_cb start callback
211 * @param cb_cls closure for callback
212 * @return the peer context
215 GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth,
218 GNUNET_TRANSPORT_ReceiveCallback rec,
219 GNUNET_TRANSPORT_NotifyConnect nc,
220 GNUNET_TRANSPORT_NotifyDisconnect nd,
221 GNUNET_TRANSPORT_TESTING_start_cb start_cb,
226 * shutdown the given peer
228 * @param tth the testing handle
232 GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth,
233 struct PeerContext *pc);
237 * Restart the given peer
240 * @param cfgname the cfg file used to restart
241 * @param restart_cb restart callback
242 * @param cb_cls callback closure
243 * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
246 GNUNET_TRANSPORT_TESTING_restart_peer (struct PeerContext *p,
248 GNUNET_TRANSPORT_TESTING_start_cb restart_cb,
253 * Connect the given peers and call the callback when both peers report the
254 * inbound connection. Remarks: start_peer's notify_connect callback can be called
257 * @param tth transport testing handle
260 * @param cb the callback to call when both peers notified that they are connected
261 * @param cls callback cls
262 * @return a connect request handle
264 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *
265 GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_handle *tth,
266 struct PeerContext *p1,
267 struct PeerContext *p2,
268 GNUNET_TRANSPORT_TESTING_connect_cb cb,
273 * Cancel the request to connect two peers
274 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
276 * @param cc a connect request handle
279 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct GNUNET_TRANSPORT_TESTING_handle *tth,
280 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc);
283 * Clean up the transport testing
284 * @param tth transport testing handle
287 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_handle *tth);
290 * Initialize the transport testing
291 * @return transport testing handle
293 struct GNUNET_TRANSPORT_TESTING_handle *
294 GNUNET_TRANSPORT_TESTING_init (void);
297 * Some utility functions
301 * Extracts the test filename from an absolute file name and removes the extension
302 * @param file absolute file name
303 * @param dest where to store result
306 GNUNET_TRANSPORT_TESTING_get_test_name (const char *file,
310 * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
311 * if existing ".exe"-prefix and adds the peer-number
313 * @param file filename of the test, e.g. argv[0]
314 * @param dest where to write the filename
315 * @param count peer number
318 GNUNET_TRANSPORT_TESTING_get_config_name (const char *file,
324 * Extracts the plugin anme from an absolute file name and the test name
325 * @param file absolute file name
326 * @param test test name
327 * @param dest where to store result
330 GNUNET_TRANSPORT_TESTING_get_test_plugin_name (const char *executable,
331 const char *testname,
336 * Extracts the filename from an absolute file name and removes the extenstion
337 * @param file absolute file name
338 * @param dest where to store result
341 GNUNET_TRANSPORT_TESTING_get_test_source_name (const char *file,
344 /* end of transport_testing.h */