2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file testbed/test_testbed_api.c
23 * @brief testcases for the testbed api
24 * @author Sree Harsha Totakura
28 #include "gnunet_util_lib.h"
29 #include "gnunet_arm_service.h"
30 #include "gnunet_testing_lib.h"
31 #include "gnunet_testbed_service.h"
34 * Generic logging shortcut
36 #define LOG(kind, ...) \
37 GNUNET_log (kind, __VA_ARGS__)
40 * Relative time seconds shorthand
42 #define TIME_REL_SECS(sec) \
43 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
48 static struct GNUNET_TESTBED_Host *host;
51 * The controller process
53 static struct GNUNET_TESTBED_ControllerProc *cp;
56 * The controller handle
58 static struct GNUNET_TESTBED_Controller *controller;
63 static struct GNUNET_TESTBED_Host *neighbour;
66 * Handle for neighbour registration
68 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
73 static struct GNUNET_TESTBED_Peer *peer;
76 * Handle to configuration
78 static struct GNUNET_CONFIGURATION_Handle *cfg;
83 static struct GNUNET_TESTBED_Operation *operation;
86 * Handle to peer's ARM service
88 static struct GNUNET_ARM_Handle *arm_handle;
91 * Abort task identifier
93 static struct GNUNET_SCHEDULER_Task *abort_task;
102 * Enumeration of sub testcases
107 * Test cases which are not covered by the below ones
112 * Test where we get a peer config from controller
117 * Test where we connect to a service running on the peer
119 PEER_SERVICE_CONNECT,
122 * Test where we get a peer's identity from controller
130 static enum Test sub_test;
136 * @param tc the task context
139 do_shutdown (void *cls)
141 LOG (GNUNET_ERROR_TYPE_DEBUG, "Shutting down...\n");
142 if (NULL != abort_task)
143 GNUNET_SCHEDULER_cancel (abort_task);
144 if (NULL != reg_handle)
145 GNUNET_TESTBED_cancel_registration (reg_handle);
146 if (NULL != controller)
147 GNUNET_TESTBED_controller_disconnect (controller);
149 GNUNET_CONFIGURATION_destroy (cfg);
151 GNUNET_TESTBED_controller_stop (cp);
152 if (NULL != neighbour)
153 GNUNET_TESTBED_host_destroy (neighbour);
155 GNUNET_TESTBED_host_destroy (host);
160 * shortcut to exit during failure
162 #define FAIL_TEST(cond, ret) do { \
165 if (NULL != abort_task) \
166 GNUNET_SCHEDULER_cancel (abort_task); \
168 GNUNET_SCHEDULER_add_now (do_shutdown, NULL); \
175 * abort task to run on test timed out
178 * @param tc the task context
183 LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
190 * Adapter function called to establish a connection to
194 * @param cfg configuration of the peer to connect to; will be available until
195 * GNUNET_TESTBED_operation_done() is called on the operation returned
196 * from GNUNET_TESTBED_service_connect()
197 * @return service handle to return in 'op_result', NULL on error
200 arm_connect_adapter (void *cls,
201 const struct GNUNET_CONFIGURATION_Handle *cfg)
203 FAIL_TEST (NULL == cls, return NULL);
204 FAIL_TEST (OTHER == sub_test, return NULL);
205 sub_test = PEER_SERVICE_CONNECT;
206 arm_handle = GNUNET_ARM_connect (cfg, NULL, NULL);
212 * Adapter function called to destroy a connection to
216 * @param op_result service handle returned from the connect adapter
219 arm_disconnect_adapter (void *cls,
222 FAIL_TEST (NULL != op_result, return );
223 FAIL_TEST (op_result == arm_handle, return );
224 GNUNET_ARM_disconnect (arm_handle);
226 FAIL_TEST (PEER_SERVICE_CONNECT == sub_test, return );
227 FAIL_TEST (NULL != operation, return );
228 operation = GNUNET_TESTBED_peer_stop (NULL, peer, NULL, NULL);
229 FAIL_TEST (NULL != operation, return );
234 * Callback to be called when a service connect operation is completed
236 * @param cls the callback closure from functions generating an operation
237 * @param op the operation that has been finished
238 * @param ca_result the service handle returned from GNUNET_TESTBED_ConnectAdapter()
239 * @param emsg error message in case the operation has failed; will be NULL if
240 * operation has executed successfully.
243 service_connect_comp_cb (void *cls,
244 struct GNUNET_TESTBED_Operation *op,
250 case PEER_SERVICE_CONNECT:
251 FAIL_TEST (operation == op, return );
252 FAIL_TEST (NULL == emsg, return );
253 FAIL_TEST (NULL == cls, return );
254 FAIL_TEST (ca_result == arm_handle, return );
255 GNUNET_TESTBED_operation_done (operation); /* This results in call to
256 * disconnect adapter */
260 FAIL_TEST (0, return );
266 * Callback to be called when the requested peer information is available
268 * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
269 * @param op the operation this callback corresponds to
270 * @param pinfo the result; will be NULL if the operation has failed
271 * @param emsg error message if the operation has failed; will be NULL if the
272 * operation is successfull
275 peerinfo_cb (void *cb_cls,
276 struct GNUNET_TESTBED_Operation *op,
277 const struct GNUNET_TESTBED_PeerInformation *pinfo,
283 FAIL_TEST (NULL != pinfo, return );
284 FAIL_TEST (NULL == emsg, return );
285 FAIL_TEST (NULL == cb_cls, return );
286 FAIL_TEST (operation == op, return );
287 FAIL_TEST (GNUNET_TESTBED_PIT_CONFIGURATION == pinfo->pit, return );
288 FAIL_TEST (NULL != pinfo->result.cfg, return );
289 sub_test = PEER_DESTROY;
290 GNUNET_TESTBED_operation_done (operation);
291 operation = GNUNET_TESTBED_peer_destroy (peer);
295 FAIL_TEST (0, return );
301 * Signature of the event handler function called by the
302 * respective event controller.
305 * @param event information about the event
308 controller_cb (void *cls,
309 const struct GNUNET_TESTBED_EventInformation *event)
313 case GNUNET_TESTBED_ET_OPERATION_FINISHED:
317 FAIL_TEST (event->op == operation, return );
318 FAIL_TEST (NULL == event->op_cls, return );
319 FAIL_TEST (NULL == event->details.operation_finished.emsg, return );
320 FAIL_TEST (NULL == event->details.operation_finished.generic, return );
321 GNUNET_TESTBED_operation_done (operation);
322 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
325 case PEER_SERVICE_CONNECT:
326 FAIL_TEST (event->op == operation, return );
327 FAIL_TEST (NULL == event->op_cls, return );
328 FAIL_TEST (NULL == event->details.operation_finished.emsg, return );
329 FAIL_TEST (NULL != arm_handle, return );
330 FAIL_TEST (event->details.operation_finished.generic == arm_handle,
335 FAIL_TEST (0, return );
340 case GNUNET_TESTBED_ET_PEER_START:
341 FAIL_TEST (event->details.peer_start.host == host, return );
342 FAIL_TEST (event->details.peer_start.peer == peer, return );
343 FAIL_TEST (OTHER == sub_test, return );
344 GNUNET_TESTBED_operation_done (operation);
346 GNUNET_TESTBED_service_connect (NULL, peer, "dht",
347 &service_connect_comp_cb, NULL,
348 &arm_connect_adapter,
349 &arm_disconnect_adapter, NULL);
350 FAIL_TEST (NULL != operation, return );
353 case GNUNET_TESTBED_ET_PEER_STOP:
354 FAIL_TEST (event->details.peer_stop.peer == peer, return );
355 FAIL_TEST (PEER_SERVICE_CONNECT == sub_test, return );
357 sub_test = PEER_GETCONFIG;
358 GNUNET_TESTBED_operation_done (operation);
360 GNUNET_TESTBED_peer_get_information (peer,
361 GNUNET_TESTBED_PIT_CONFIGURATION,
366 FAIL_TEST (0, return ); /* We should never reach this state */
372 * Functions of this signature are called when a peer has been successfully
375 * @param cls the closure from GNUNET_TESTBED_peer_create()
376 * @param peer the handle for the created peer; NULL on any error during
378 * @param emsg NULL if peer is not NULL; else MAY contain the error description
381 peer_create_cb (void *cls,
382 struct GNUNET_TESTBED_Peer *peer,
385 struct GNUNET_TESTBED_Peer **peer_ptr;
388 FAIL_TEST (NULL != peer, return );
389 FAIL_TEST (NULL != peer_ptr, return );
391 GNUNET_TESTBED_operation_done (operation);
392 operation = GNUNET_TESTBED_peer_start (NULL,
396 FAIL_TEST (NULL != operation, return );
401 * Callback which will be called to after a host registration succeeded or failed
403 * @param cls the host which has been registered
404 * @param emsg the error message; NULL if host registration is successful
407 registration_comp (void *cls,
410 FAIL_TEST (cls == neighbour, return );
413 GNUNET_TESTBED_peer_create (controller,
418 FAIL_TEST (NULL != operation, return );
423 * Callback to signal successfull startup of the controller process
425 * @param cls the closure from GNUNET_TESTBED_controller_start()
426 * @param cfg the configuration with which the controller has been started;
427 * NULL if status is not #GNUNET_OK
428 * @param status #GNUNET_OK if the startup is successfull; #GNUNET_SYSERR if not,
429 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
432 status_cb (void *cls,
433 const struct GNUNET_CONFIGURATION_Handle *cfg_,
438 if (GNUNET_OK != status)
441 FAIL_TEST (0, return );
445 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
446 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
447 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
448 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
450 GNUNET_TESTBED_controller_connect (host, event_mask, &controller_cb,
452 FAIL_TEST (NULL != controller, return );
453 neighbour = GNUNET_TESTBED_host_create ("localhost", NULL, cfg, 0);
454 FAIL_TEST (NULL != neighbour, return );
456 GNUNET_TESTBED_register_host (controller, neighbour, ®istration_comp,
458 FAIL_TEST (NULL != reg_handle, return );
466 * @param args arguments passed to #GNUNET_PROGRAM_run()
467 * @param cfgfile the path to configuration file
468 * @param cfg the configuration file handle
474 const struct GNUNET_CONFIGURATION_Handle *config)
476 cfg = GNUNET_CONFIGURATION_dup (config);
477 host = GNUNET_TESTBED_host_create (NULL, NULL, cfg, 0);
478 FAIL_TEST (NULL != host, return );
479 cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host,
483 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
484 (GNUNET_TIME_UNIT_MINUTES, 5),
494 main (int argc, char **argv)
498 char *const argv2[] = { "test_testbed_api",
499 "-c", "test_testbed_api.conf",
501 struct GNUNET_GETOPT_CommandLineOption options[] = {
502 GNUNET_GETOPT_OPTION_END
505 result = GNUNET_SYSERR;
507 GNUNET_PROGRAM_run ((sizeof(argv2) / sizeof(char *)) - 1, argv2,
508 "test_testbed_api", "nohelp", options, &run, NULL);
509 if ((GNUNET_OK != ret) || (GNUNET_OK != result))
515 /* end of test_testbed_api.c */