2 This file is part of GNUnet
3 (C) 2008--2013 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 testbed/test_testbed_api_2peers_1controller.c
23 * @brief testcases for the testbed api: 2 peers are configured, started and
24 * connected together. The 2 peer reside on a single controller.
25 * @author Sree Harsha Totakura
29 #include "gnunet_util_lib.h"
30 #include "gnunet_testing_lib.h"
31 #include "gnunet_testbed_service.h"
35 * Generic logging shortcut
37 #define LOG(kind,...) \
38 GNUNET_log (kind, __VA_ARGS__)
41 * Relative time seconds shorthand
43 #define TIME_REL_SECS(sec) \
44 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
54 struct GNUNET_TESTBED_Peer *peer;
57 * Operations involving this peer
59 struct GNUNET_TESTBED_Operation *operation;
62 * set to GNUNET_YES when peer is started
70 static struct GNUNET_TESTBED_Host *host;
73 * The controller process
75 static struct GNUNET_TESTBED_ControllerProc *cp;
78 * The controller handle
80 static struct GNUNET_TESTBED_Controller *controller;
85 static struct GNUNET_TESTBED_Host *neighbour;
88 * Handle for neighbour registration
90 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
95 static struct PeerContext peer1;
100 static struct PeerContext peer2;
103 * Handle to configuration
105 static struct GNUNET_CONFIGURATION_Handle *cfg;
108 * Handle to operations involving both peers
110 static struct GNUNET_TESTBED_Operation *common_operation;
113 * Abort task identifier
115 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
118 * Delayed connect job identifier
120 static GNUNET_SCHEDULER_TaskIdentifier delayed_connect_task;
123 * Different stages in testing
144 * peers are connected
149 * Peers are connected once again (this should not fail as they are already connected)
159 * Final success stage
167 static enum Stage result;
171 * shortcut to exit during failure
173 #define FAIL_TEST(cond) do { \
176 if (GNUNET_SCHEDULER_NO_TASK != abort_task) \
177 GNUNET_SCHEDULER_cancel (abort_task); \
178 abort_task = GNUNET_SCHEDULER_NO_TASK; \
179 GNUNET_SCHEDULER_add_now (do_shutdown, NULL); \
189 * @param tc the task context
192 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
194 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
195 GNUNET_SCHEDULER_cancel (abort_task);
196 if (GNUNET_SCHEDULER_NO_TASK != delayed_connect_task)
197 GNUNET_SCHEDULER_cancel (delayed_connect_task);
198 if (NULL != reg_handle)
199 GNUNET_TESTBED_cancel_registration (reg_handle);
200 GNUNET_TESTBED_controller_disconnect (controller);
201 GNUNET_CONFIGURATION_destroy (cfg);
203 GNUNET_TESTBED_controller_stop (cp);
204 GNUNET_TESTBED_host_destroy (neighbour);
205 GNUNET_TESTBED_host_destroy (host);
210 * abort task to run on test timed out
213 * @param tc the task context
216 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
218 LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
219 abort_task = GNUNET_SCHEDULER_NO_TASK;
220 do_shutdown (cls, tc);
225 * Callback to be called when an operation is completed
227 * @param cls the callback closure from functions generating an operation
228 * @param op the operation that has been finished
229 * @param emsg error message in case the operation has failed; will be NULL if
230 * operation has executed successfully.
233 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg);
237 * task for delaying a connect
240 * @param tc the task context
243 do_delayed_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
245 delayed_connect_task = GNUNET_SCHEDULER_NO_TASK;
246 FAIL_TEST (NULL == common_operation);
248 GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peer1.peer,
254 * Callback to be called when an operation is completed
256 * @param cls the callback closure from functions generating an operation
257 * @param op the operation that has been finished
258 * @param emsg error message in case the operation has failed; will be NULL if
259 * operation has executed successfully.
262 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg)
264 FAIL_TEST (common_operation == op);
268 FAIL_TEST (NULL == peer1.operation);
269 FAIL_TEST (NULL == peer2.operation);
270 FAIL_TEST (NULL != common_operation);
272 case PEERS_CONNECTED:
273 FAIL_TEST (NULL == peer1.operation);
274 FAIL_TEST (NULL == peer2.operation);
275 FAIL_TEST (NULL != common_operation);
284 * Signature of the event handler function called by the
285 * respective event controller.
288 * @param event information about the event
291 controller_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
295 case GNUNET_TESTBED_ET_OPERATION_FINISHED: /* Will be reached when we destroy peers */
296 FAIL_TEST (PEERS_STOPPED == result);
297 FAIL_TEST (NULL == event->op_cls);
298 FAIL_TEST (NULL == event->details.operation_finished.emsg);
299 FAIL_TEST (NULL == event->details.operation_finished.generic);
300 if (event->op == peer1.operation)
302 GNUNET_TESTBED_operation_done (peer1.operation);
303 peer1.operation = NULL;
306 else if (event->op == peer2.operation)
308 GNUNET_TESTBED_operation_done (peer2.operation);
309 peer2.operation = NULL;
314 if ((NULL == peer1.peer) && (NULL == peer2.peer))
317 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
320 case GNUNET_TESTBED_ET_PEER_START:
321 FAIL_TEST (INIT == result);
322 FAIL_TEST (event->details.peer_start.host == host);
323 if (event->details.peer_start.peer == peer1.peer)
325 peer1.is_running = GNUNET_YES;
326 GNUNET_TESTBED_operation_done (peer1.operation);
327 peer1.operation = NULL;
329 else if (event->details.peer_start.peer == peer2.peer)
331 peer2.is_running = GNUNET_YES;
332 GNUNET_TESTBED_operation_done (peer2.operation);
333 peer2.operation = NULL;
337 if ((GNUNET_YES == peer1.is_running) && (GNUNET_YES == peer2.is_running))
339 result = PEERS_STARTED;
341 GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peer1.peer,
345 case GNUNET_TESTBED_ET_PEER_STOP:
346 FAIL_TEST (PEERS_CONNECTED_2 == result);
347 if (event->details.peer_stop.peer == peer1.peer)
349 peer1.is_running = GNUNET_NO;
350 GNUNET_TESTBED_operation_done (peer1.operation);
351 peer1.operation = GNUNET_TESTBED_peer_destroy (peer1.peer);
353 else if (event->details.peer_stop.peer == peer2.peer)
355 peer2.is_running = GNUNET_NO;
356 GNUNET_TESTBED_operation_done (peer2.operation);
357 peer2.operation = GNUNET_TESTBED_peer_destroy (peer2.peer);
361 if ((GNUNET_NO == peer1.is_running) && (GNUNET_NO == peer2.is_running))
362 result = PEERS_STOPPED;
364 case GNUNET_TESTBED_ET_CONNECT:
368 FAIL_TEST (NULL == peer1.operation);
369 FAIL_TEST (NULL == peer2.operation);
370 FAIL_TEST (NULL != common_operation);
371 FAIL_TEST ((event->details.peer_connect.peer1 == peer1.peer) &&
372 (event->details.peer_connect.peer2 == peer2.peer));
373 GNUNET_TESTBED_operation_done (common_operation);
374 common_operation = NULL;
375 result = PEERS_CONNECTED;
376 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected\n");
377 delayed_connect_task =
378 GNUNET_SCHEDULER_add_delayed (TIME_REL_SECS (3), &do_delayed_connect,
381 case PEERS_CONNECTED:
382 FAIL_TEST (NULL == peer1.operation);
383 FAIL_TEST (NULL == peer2.operation);
384 FAIL_TEST (NULL != common_operation);
385 GNUNET_TESTBED_operation_done (common_operation);
386 common_operation = NULL;
387 result = PEERS_CONNECTED_2;
388 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected again\n");
389 peer1.operation = GNUNET_TESTBED_peer_stop (NULL, peer1.peer, NULL, NULL);
390 peer2.operation = GNUNET_TESTBED_peer_stop (NULL, peer2.peer, NULL, NULL);
403 * Functions of this signature are called when a peer has been successfully
406 * @param cls the closure from GNUNET_TESTBED_peer_create()
407 * @param peer the handle for the created peer; NULL on any error during
409 * @param emsg NULL if peer is not NULL; else MAY contain the error description
412 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
414 struct PeerContext *pc = cls;
416 FAIL_TEST (NULL != pc->operation);
417 FAIL_TEST (NULL != peer);
418 FAIL_TEST (NULL == pc->peer);
420 GNUNET_TESTBED_operation_done (pc->operation);
421 pc->operation = GNUNET_TESTBED_peer_start (NULL, pc->peer, NULL, NULL);
426 * Callback which will be called to after a host registration succeeded or failed
428 * @param cls the host which has been registered
429 * @param emsg the error message; NULL if host registration is successful
432 registration_comp (void *cls, const char *emsg)
434 FAIL_TEST (cls == neighbour);
437 GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
440 GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
442 FAIL_TEST (NULL != peer1.operation);
443 FAIL_TEST (NULL != peer2.operation);
448 * Callback to signal successfull startup of the controller process
450 * @param cls the closure from GNUNET_TESTBED_controller_start()
451 * @param cfg the configuration with which the controller has been started;
452 * NULL if status is not GNUNET_OK
453 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
454 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
457 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg_, int status)
461 if (GNUNET_OK != status)
467 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
468 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
469 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
470 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
472 GNUNET_TESTBED_controller_connect (host, event_mask, &controller_cb,
474 FAIL_TEST (NULL != controller);
475 neighbour = GNUNET_TESTBED_host_create ("localhost", NULL, cfg, 0);
476 FAIL_TEST (NULL != neighbour);
478 GNUNET_TESTBED_register_host (controller, neighbour, ®istration_comp,
480 FAIL_TEST (NULL != reg_handle);
489 * @param args arguments passed to GNUNET_PROGRAM_run
490 * @param cfgfile the path to configuration file
491 * @param cfg the configuration file handle
494 run (void *cls, char *const *args, const char *cfgfile,
495 const struct GNUNET_CONFIGURATION_Handle *config)
497 cfg = GNUNET_CONFIGURATION_dup (config);
498 host = GNUNET_TESTBED_host_create (NULL, NULL, cfg, 0);
499 FAIL_TEST (NULL != host);
500 cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host, cfg, status_cb,
503 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
504 (GNUNET_TIME_UNIT_MINUTES, 3), &do_abort,
513 main (int argc, char **argv)
517 char *const argv2[] = { "test_testbed_api_2peers_1controller",
518 "-c", "test_testbed_api.conf",
521 struct GNUNET_GETOPT_CommandLineOption options[] = {
522 GNUNET_GETOPT_OPTION_END
526 GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
527 "test_testbed_api_2peers_1controller", "nohelp",
528 options, &run, NULL);
529 if ((GNUNET_OK != ret) || (SUCCESS != result))
534 /* end of test_testbed_api_2peers_1controller.c */