2 This file is part of GNUnet
3 (C) 2008, 2009, 2012 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_testing_lib-new.h
23 * @brief convenience API for writing testcases for GNUnet;
24 * can start/stop one or more peers on a system;
25 * testing is responsible for managing private keys,
26 * ports and paths; it is a low-level library that
27 * does not support higher-level functions such as
28 * P2P connection, topology management or distributed
29 * testbed maintenance (those are in gnunet_testbed_service.h)
30 * @author Christian Grothoff
33 #ifndef GNUNET_TESTING_LIB_NEW_H
34 #define GNUNET_TESTING_LIB_NEW_H
36 #include "gnunet_util_lib.h"
37 #include "gnunet_statistics_service.h"
42 #if 0 /* keep Emacsens' auto-indent happy */
49 * Handle for a system on which GNUnet peers are executed;
50 * a system is used for reserving unique paths and ports.
52 struct GNUNET_TESTING_System;
56 * Handle for a GNUnet peer controlled by testing.
58 struct GNUNET_TESTING_Peer;
62 * Create a system handle. There must only be one system
63 * handle per operating system.
65 ** @param testdir only the directory name without any path. This is used for
66 * all service homes; the directory will be created in a temporary
67 * location depending on the underlying OS
68 * @param controller hostname of the controlling host,
69 * service configurations are modified to allow
70 * control connections from this host; can be NULL
71 * @return handle to this system, NULL on error
73 struct GNUNET_TESTING_System *
74 GNUNET_TESTING_system_create (const char *testdir,
75 const char *controller);
79 * Free system resources.
81 * @param system system to be freed
82 * @param remove_paths should the 'testdir' and all subdirectories
83 * be removed (clean up on shutdown)?
86 GNUNET_TESTING_system_destroy (struct GNUNET_TESTING_System *system,
91 * Testing includes a number of pre-created hostkeys for
92 * faster peer startup. This function can be used to
93 * access the n-th key of those pre-created hostkeys; note
94 * that these keys are ONLY useful for testing and not
95 * secure as the private keys are part of the public
98 * This is primarily a helper function used internally
99 * by 'GNUNET_TESTING_peer_configure'.
101 * @param system the testing system handle
102 * @param key_number desired pre-created hostkey to obtain
103 * @param id set to the peer's identity (hash of the public
104 * key; if NULL, GNUNET_SYSERR is returned immediately
105 * @return GNUNET_SYSERR on error (not enough keys)
108 GNUNET_TESTING_hostkey_get (const struct GNUNET_TESTING_System *system,
110 struct GNUNET_PeerIdentity *id);
114 * Reserve a TCP or UDP port for a peer.
116 * @param system system to use for reservation tracking
117 * @param is_tcp GNUNET_YES for TCP ports, GNUNET_NO for UDP
118 * @return 0 if no free port was available
121 GNUNET_TESTING_reserve_port (struct GNUNET_TESTING_System *system,
126 * Release reservation of a TCP or UDP port for a peer
127 * (used during GNUNET_TESTING_peer_destroy).
129 * @param system system to use for reservation tracking
130 * @param is_tcp GNUNET_YES for TCP ports, GNUNET_NO for UDP
131 * @param port reserved port to release
134 GNUNET_TESTING_release_port (struct GNUNET_TESTING_System *system,
140 * Create a new configuration using the given configuration
141 * as a template; ports and paths will be modified to select
142 * available ports on the local system. If we run
143 * out of "*port" numbers, return SYSERR.
145 * This is primarily a helper function used internally
146 * by 'GNUNET_TESTING_peer_configure'.
148 * @param system system to use to coordinate resource usage
149 * @param cfg template configuration to update
150 * @return GNUNET_OK on success, GNUNET_SYSERR on error - the configuration will
151 * be incomplete and should not be used there upon
154 GNUNET_TESTING_configuration_create (struct GNUNET_TESTING_System *system,
155 struct GNUNET_CONFIGURATION_Handle *cfg);
156 // FIXME: add dual to 'release' ports again...
160 * Configure a GNUnet peer. GNUnet must be installed on the local
161 * system and available in the PATH.
163 * @param system system to use to coordinate resource usage
164 * @param cfg configuration to use; will be UPDATED (to reflect needed
165 * changes in port numbers and paths)
166 * @param key_number number of the hostkey to use for the peer
167 * @param id identifier for the daemon, will be set, can be NULL
168 * @param emsg set to error message (set to NULL on success), can be NULL
169 * @return handle to the peer, NULL on error
171 struct GNUNET_TESTING_Peer *
172 GNUNET_TESTING_peer_configure (struct GNUNET_TESTING_System *system,
173 struct GNUNET_CONFIGURATION_Handle *cfg,
175 struct GNUNET_PeerIdentity *id,
182 * @param peer peer to start
183 * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer already running)
186 GNUNET_TESTING_peer_start (struct GNUNET_TESTING_Peer *peer);
192 * @param peer peer to stop
193 * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer not running)
196 GNUNET_TESTING_peer_stop (struct GNUNET_TESTING_Peer *peer);
200 * Destroy the peer. Releases resources locked during peer configuration.
201 * If the peer is still running, it will be stopped AND a warning will be
202 * printed (users of the API should stop the peer explicitly first).
204 * @param peer peer to destroy
207 GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer *peer);
211 * Signature of the 'main' function for a (single-peer) testcase that
212 * is run using 'GNUNET_TESTING_peer_run'.
215 * @param cfg configuration of the peer that was started
217 typedef void (*GNUNET_TESTING_TestMain)(void *cls,
218 const struct GNUNET_CONFIGURATION_Handle *cfg);
222 * Start a single peer and run a test using the testing library.
223 * Starts a peer using the given configuration and then invokes the
224 * given callback. This function ALSO initializes the scheduler loop
225 * and should thus be called directly from "main". The testcase
226 * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
228 * @param testdir only the directory name without any path. This is used for
229 * all service homes; the directory will be created in a temporary
230 * location depending on the underlying OS
231 * @param cfgfilename name of the configuration file to use;
232 * use NULL to only run with defaults
233 * @param tm main function of the testcase
234 * @param tm_cls closure for 'tm'
235 * @return 0 on success, 1 on error
238 GNUNET_TESTING_peer_run (const char *testdir,
239 const char *cfgfilename,
240 GNUNET_TESTING_TestMain tm,
245 * Start a single service (no ARM, except of course if the given
246 * service name is 'arm') and run a test using the testing library.
247 * Starts a service using the given configuration and then invokes the
248 * given callback. This function ALSO initializes the scheduler loop
249 * and should thus be called directly from "main". The testcase
250 * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
252 * This function is useful if the testcase is for a single service
253 * and if that service doesn't itself depend on other services.
255 * @param testdir only the directory name without any path. This is used for
256 * all service homes; the directory will be created in a temporary
257 * location depending on the underlying OS
258 * @param service_name name of the service to run
259 * @param cfgfilename name of the configuration file to use;
260 * use NULL to only run with defaults
261 * @param tm main function of the testcase
262 * @param tm_cls closure for 'tm'
263 * @return 0 on success, 1 on error
266 GNUNET_TESTING_service_run (const char *testdir,
267 const char *service_name,
268 const char *cfgfilename,
269 GNUNET_TESTING_TestMain tm,
275 * Sometimes we use the binary name to determine which specific
276 * test to run. In those cases, the string after the last "_"
277 * in 'argv[0]' specifies a string that determines the configuration
278 * file or plugin to use.
280 * This function returns the respective substring, taking care
281 * of issues such as binaries ending in '.exe' on W32.
283 * @param argv0 the name of the binary
284 * @return string between the last '_' and the '.exe' (or the end of the string),
285 * NULL if argv0 has no '_'
288 GNUNET_TESTING_get_testname_from_underscore (const char *argv0);
291 #if 0 /* keep Emacsens' auto-indent happy */