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
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 testbed/test_testbed_api_controllerlink.c
23 * @brief testcase for testing controller to subcontroller linking
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
29 * The controller architecture we try to achieve in this test case:
34 * Slave Controller 1---------Slave Controller 3
41 #include "gnunet_util_lib.h"
42 #include "gnunet_testing_lib.h"
43 #include "gnunet_testbed_service.h"
46 * Generic logging shortcut
48 #define LOG(kind,...) \
49 GNUNET_log (kind, __VA_ARGS__)
52 * Debug logging shorthand
54 #define LOG_DEBUG(...) \
55 LOG(GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
58 * Different stages in testing
69 * Master controller has started
74 * A peer has been created on master
76 MASTER_PEER_CREATE_SUCCESS,
79 * Peer on master controller has been started successfully.
81 MASTER_PEER_START_SUCCESS,
84 * The first slave has been registered at master controller
89 * The second slave has been registered at the master controller
94 * Link from master to slave 1 has been successfully created
99 * Peer create on slave 1 successful
101 SLAVE1_PEER_CREATE_SUCCESS,
104 * Peer startup on slave 1 successful
106 SLAVE1_PEER_START_SUCCESS,
109 * Link from slave 1 to slave 2 has been successfully created.
114 * Peer create on slave 2 successful
116 SLAVE2_PEER_CREATE_SUCCESS,
119 * Peer on slave 1 successfully stopped
121 SLAVE1_PEER_STOP_SUCCESS,
124 * Peer startup on slave 2 successful
126 SLAVE2_PEER_START_SUCCESS,
129 * Try to connect peers on master and slave 2.
131 MASTER_SLAVE2_PEERS_CONNECTED,
134 * Slave 3 has successfully registered
139 * Slave 3 has successfully started
144 * Peer created on slave 3
146 SLAVE3_PEER_CREATE_SUCCESS,
149 * Peer started at slave 3
151 SLAVE3_PEER_START_SUCCESS,
154 * Try to connect peers on slave2 and slave3
156 SLAVE2_SLAVE3_PEERS_CONNECTED,
159 * Peer on slave 2 successfully stopped
161 SLAVE2_PEER_STOP_SUCCESS,
164 * Peer destroy on slave 1 successful
166 SLAVE1_PEER_DESTROY_SUCCESS,
169 * Peer destory on slave 2 successful
171 SLAVE2_PEER_DESTROY_SUCCESS,
174 * The configuration of slave 3 is acquired
176 SLAVE3_GET_CONFIG_SUCCESS,
179 * Slave 1 has linked to slave 3;
184 * Master peer destoryed. Destory slave 3 peer
186 MASTER_PEER_DESTROY_SUCCESS,
189 * Slave 3 peer destroyed. Mark test as success
194 * Marks test as skipped
200 * Host for running master controller
202 static struct GNUNET_TESTBED_Host *host;
205 * The master controller process
207 static struct GNUNET_TESTBED_ControllerProc *cp;
210 * Handle to master controller
212 static struct GNUNET_TESTBED_Controller *mc;
215 * Slave host for running slave controller
217 static struct GNUNET_TESTBED_Host *slave;
220 * Another slave host for running another slave controller
222 static struct GNUNET_TESTBED_Host *slave2;
227 static struct GNUNET_TESTBED_Host *slave3;
230 * Slave host registration handle
232 static struct GNUNET_TESTBED_HostRegistrationHandle *rh;
235 * Handle to global configuration
237 static struct GNUNET_CONFIGURATION_Handle *cfg;
240 * Configuration of slave 3 controller
242 static struct GNUNET_CONFIGURATION_Handle *cfg3;
247 static struct GNUNET_SCHEDULER_Task *abort_task;
250 * Operation handle for linking controllers
252 static struct GNUNET_TESTBED_Operation *op;
255 * Handle to peer started at slave 1
257 static struct GNUNET_TESTBED_Peer *slave1_peer;
260 * Handle to peer started at slave 2
262 static struct GNUNET_TESTBED_Peer *slave2_peer;
265 * Handle to peer started at slave 2
267 static struct GNUNET_TESTBED_Peer *slave3_peer;
270 * Handle to a peer started at master controller
272 static struct GNUNET_TESTBED_Peer *master_peer;
275 * The handle for whether a host is habitable or not
277 static struct GNUNET_TESTBED_HostHabitableCheckHandle *hc_handle;
280 * The task handle for the delay task
282 static struct GNUNET_SCHEDULER_Task *delay_task_id;
287 static uint64_t event_mask;
290 * Global testing status
292 static enum Stage result;
295 * shortcut to exit during failure
297 #define FAIL_TEST(cond) do { \
300 if (NULL != abort_task) \
301 GNUNET_SCHEDULER_cancel (abort_task); \
303 GNUNET_SCHEDULER_shutdown (); \
315 do_shutdown (void *cls)
317 if (NULL != abort_task)
318 GNUNET_SCHEDULER_cancel (abort_task);
319 if (NULL != delay_task_id)
321 GNUNET_SCHEDULER_cancel (delay_task_id);
322 delay_task_id = NULL;
324 if (NULL != hc_handle)
325 GNUNET_TESTBED_is_host_habitable_cancel (hc_handle);
328 GNUNET_TESTBED_operation_done (op);
332 GNUNET_TESTBED_controller_disconnect (mc);
334 GNUNET_TESTBED_controller_stop (cp);
336 GNUNET_TESTBED_host_destroy (slave3);
338 GNUNET_TESTBED_host_destroy (slave2);
340 GNUNET_TESTBED_host_destroy (slave);
342 GNUNET_TESTBED_host_destroy (host);
344 GNUNET_CONFIGURATION_destroy (cfg);
346 GNUNET_CONFIGURATION_destroy (cfg3);
348 GNUNET_TESTBED_cancel_registration (rh);
353 * abort task to run on test timed out
360 LOG (GNUNET_ERROR_TYPE_WARNING,
361 "Aborting in stage %d\n",
364 GNUNET_SCHEDULER_shutdown ();
375 do_abort_now (void *cls)
377 if (NULL != abort_task)
378 GNUNET_SCHEDULER_cancel (abort_task);
379 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
384 * Callback which will be called to after a host registration succeeded or failed
386 * @param cls the host which has been registered
387 * @param emsg the error message; NULL if host registration is successful
390 registration_cont (void *cls, const char *emsg);
394 * Task for inserting delay between tests
400 delay_task (void *cls)
402 delay_task_id = NULL;
405 case SLAVE2_PEER_CREATE_SUCCESS:
406 op = GNUNET_TESTBED_peer_stop (NULL, slave1_peer, NULL, NULL);
407 FAIL_TEST (NULL != op);
409 case MASTER_SLAVE2_PEERS_CONNECTED:
410 slave3 = GNUNET_TESTBED_host_create_with_id (3, "127.0.0.1", NULL, cfg, 0);
411 rh = GNUNET_TESTBED_register_host (mc, slave3, ®istration_cont, NULL);
413 case SLAVE2_SLAVE3_PEERS_CONNECTED:
414 op = GNUNET_TESTBED_peer_stop (NULL, slave2_peer, NULL, NULL);
415 FAIL_TEST (NULL != op);
424 * Functions of this signature are called when a peer has been successfully
427 * @param cls the closure from GNUNET_TESTBED_peer_create()
428 * @param peer the handle for the created peer; NULL on any error during
430 * @param emsg NULL if peer is not NULL; else MAY contain the error description
433 peer_create_cb (void *cls,
434 struct GNUNET_TESTBED_Peer *peer,
437 FAIL_TEST (NULL != peer);
438 FAIL_TEST (NULL == emsg);
442 result = MASTER_PEER_CREATE_SUCCESS;
444 GNUNET_TESTBED_operation_done (op);
445 op = GNUNET_TESTBED_peer_start (NULL, master_peer, NULL, NULL);
447 case SLAVE1_LINK_SUCCESS:
448 result = SLAVE1_PEER_CREATE_SUCCESS;
450 GNUNET_TESTBED_operation_done (op);
451 op = GNUNET_TESTBED_peer_start (NULL, slave1_peer, NULL, NULL);
453 case SLAVE2_LINK_SUCCESS:
454 result = SLAVE2_PEER_CREATE_SUCCESS;
456 GNUNET_TESTBED_operation_done (op);
459 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
460 (GNUNET_TIME_UNIT_SECONDS, 1),
465 result = SLAVE3_PEER_CREATE_SUCCESS;
467 GNUNET_TESTBED_operation_done (op);
468 op = GNUNET_TESTBED_peer_start (NULL, slave3_peer, NULL, NULL);
473 FAIL_TEST (NULL != op);
478 * Checks the event if it is an operation finished event and if indicates a
479 * successfull completion of operation
481 * @param event the event information to check
484 check_operation_success (const struct GNUNET_TESTBED_EventInformation *event)
486 FAIL_TEST (NULL != event);
487 FAIL_TEST (GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type);
488 FAIL_TEST (event->op == op);
489 FAIL_TEST (NULL == event->op_cls);
490 FAIL_TEST (NULL == event->details.operation_finished.emsg);
491 FAIL_TEST (NULL == event->details.operation_finished.generic);
496 * Signature of the event handler function called by the
497 * respective event controller.
500 * @param event information about the event
503 controller_cb (void *cls,
504 const struct GNUNET_TESTBED_EventInformation *event)
508 case SLAVE2_REGISTERED:
509 check_operation_success (event);
510 GNUNET_TESTBED_operation_done (op);
512 result = SLAVE1_LINK_SUCCESS;
513 FAIL_TEST (NULL != slave2);
514 FAIL_TEST (NULL != slave);
515 op = GNUNET_TESTBED_peer_create (mc, slave, cfg, peer_create_cb, NULL);
516 FAIL_TEST (NULL != op);
518 case SLAVE1_PEER_START_SUCCESS:
519 check_operation_success (event);
520 GNUNET_TESTBED_operation_done (op);
521 result = SLAVE2_LINK_SUCCESS;
522 op = GNUNET_TESTBED_peer_create (mc, slave2, cfg, peer_create_cb, NULL);
523 FAIL_TEST (NULL != op);
525 case MASTER_PEER_CREATE_SUCCESS:
526 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
527 FAIL_TEST (event->details.peer_start.host == host);
528 FAIL_TEST (event->details.peer_start.peer == master_peer);
529 GNUNET_TESTBED_operation_done (op);
531 result = MASTER_PEER_START_SUCCESS;
532 slave = GNUNET_TESTBED_host_create_with_id (1, "127.0.0.1", NULL, cfg, 0);
533 FAIL_TEST (NULL != slave);
534 rh = GNUNET_TESTBED_register_host (mc, slave, ®istration_cont, NULL);
535 FAIL_TEST (NULL != rh);
537 case SLAVE1_PEER_CREATE_SUCCESS:
538 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
539 FAIL_TEST (event->details.peer_start.host == slave);
540 FAIL_TEST (event->details.peer_start.peer == slave1_peer);
541 GNUNET_TESTBED_operation_done (op);
542 result = SLAVE1_PEER_START_SUCCESS;
543 op = GNUNET_TESTBED_controller_link (NULL, mc, slave2, slave, GNUNET_YES);
545 case SLAVE2_PEER_CREATE_SUCCESS:
546 FAIL_TEST (GNUNET_TESTBED_ET_PEER_STOP == event->type);
547 FAIL_TEST (event->details.peer_stop.peer == slave1_peer);
548 GNUNET_TESTBED_operation_done (op);
549 result = SLAVE1_PEER_STOP_SUCCESS;
550 op = GNUNET_TESTBED_peer_start (NULL, slave2_peer, NULL, NULL);
551 FAIL_TEST (NULL != op);
553 case SLAVE3_PEER_CREATE_SUCCESS:
554 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
555 FAIL_TEST (event->details.peer_start.host == slave3);
556 FAIL_TEST (event->details.peer_start.peer == slave3_peer);
557 GNUNET_TESTBED_operation_done (op);
558 result = SLAVE3_PEER_START_SUCCESS;
560 LOG_DEBUG ("**************************************\n");
561 op = GNUNET_TESTBED_overlay_connect (mc, NULL, NULL, slave2_peer,
563 FAIL_TEST (NULL != op);
565 case SLAVE3_PEER_START_SUCCESS:
566 FAIL_TEST (NULL != event);
567 FAIL_TEST (GNUNET_TESTBED_ET_CONNECT == event->type);
568 FAIL_TEST (event->details.peer_connect.peer1 == slave2_peer);
569 FAIL_TEST (event->details.peer_connect.peer2 == slave3_peer);
570 result = SLAVE2_SLAVE3_PEERS_CONNECTED;
571 GNUNET_TESTBED_operation_done (op);
574 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
575 (GNUNET_TIME_UNIT_SECONDS, 1), &delay_task,
578 case SLAVE1_PEER_STOP_SUCCESS:
579 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
580 FAIL_TEST (event->details.peer_start.host == slave2);
581 FAIL_TEST (event->details.peer_start.peer == slave2_peer);
582 GNUNET_TESTBED_operation_done (op);
583 result = SLAVE2_PEER_START_SUCCESS;
584 op = GNUNET_TESTBED_overlay_connect (mc, NULL, NULL, master_peer,
587 case SLAVE2_PEER_START_SUCCESS:
588 FAIL_TEST (NULL != event);
589 FAIL_TEST (GNUNET_TESTBED_ET_CONNECT == event->type);
590 FAIL_TEST (event->details.peer_connect.peer1 == master_peer);
591 FAIL_TEST (event->details.peer_connect.peer2 == slave2_peer);
592 result = MASTER_SLAVE2_PEERS_CONNECTED;
593 GNUNET_TESTBED_operation_done (op);
596 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
597 (GNUNET_TIME_UNIT_SECONDS, 1), &delay_task,
600 case SLAVE2_SLAVE3_PEERS_CONNECTED:
601 FAIL_TEST (GNUNET_TESTBED_ET_PEER_STOP == event->type);
602 FAIL_TEST (event->details.peer_stop.peer == slave2_peer);
603 GNUNET_TESTBED_operation_done (op);
604 result = SLAVE2_PEER_STOP_SUCCESS;
605 op = GNUNET_TESTBED_peer_destroy (slave1_peer);
606 FAIL_TEST (NULL != op);
608 case SLAVE2_PEER_STOP_SUCCESS:
609 check_operation_success (event);
610 GNUNET_TESTBED_operation_done (op);
611 result = SLAVE1_PEER_DESTROY_SUCCESS;
612 op = GNUNET_TESTBED_peer_destroy (slave2_peer);
613 FAIL_TEST (NULL != op);
615 case SLAVE1_PEER_DESTROY_SUCCESS:
616 check_operation_success (event);
617 GNUNET_TESTBED_operation_done (op);
619 result = SLAVE2_PEER_DESTROY_SUCCESS;
620 op = GNUNET_TESTBED_get_slave_config (NULL, mc, slave3);
621 FAIL_TEST (NULL != op);
623 case SLAVE2_PEER_DESTROY_SUCCESS:
624 FAIL_TEST (NULL != event);
625 FAIL_TEST (GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type);
626 FAIL_TEST (event->op == op);
627 FAIL_TEST (NULL == event->op_cls);
628 FAIL_TEST (NULL == event->details.operation_finished.emsg);
629 cfg3 = GNUNET_CONFIGURATION_dup (event->details.operation_finished.generic);
630 GNUNET_TESTBED_operation_done (op);
631 result = SLAVE3_GET_CONFIG_SUCCESS;
632 op = GNUNET_TESTBED_controller_link (NULL, mc, slave3, slave, GNUNET_NO);
634 case SLAVE3_REGISTERED:
635 check_operation_success (event);
636 GNUNET_TESTBED_operation_done (op);
637 result = SLAVE3_STARTED;
638 op = GNUNET_TESTBED_peer_create (mc, slave3, cfg, peer_create_cb, NULL);
639 FAIL_TEST (NULL != op);
641 case SLAVE3_GET_CONFIG_SUCCESS:
642 result = SLAVE3_LINK_SUCCESS;
643 GNUNET_TESTBED_operation_done (op);
644 op = GNUNET_TESTBED_peer_destroy (master_peer);
646 case SLAVE3_LINK_SUCCESS:
647 check_operation_success (event);
648 result = MASTER_PEER_DESTROY_SUCCESS;
649 GNUNET_TESTBED_operation_done (op);
650 op = GNUNET_TESTBED_peer_destroy (slave3_peer);
652 case MASTER_PEER_DESTROY_SUCCESS:
654 GNUNET_TESTBED_operation_done (op);
656 GNUNET_SCHEDULER_shutdown ();
665 * Callback which will be called to after a host registration succeeded or failed
667 * @param cls the host which has been registered
668 * @param emsg the error message; NULL if host registration is successful
671 registration_cont (void *cls, const char *emsg)
676 case MASTER_PEER_START_SUCCESS:
677 FAIL_TEST (NULL == emsg);
678 FAIL_TEST (NULL != mc);
679 result = SLAVE1_REGISTERED;
680 slave2 = GNUNET_TESTBED_host_create_with_id (2, "127.0.0.1", NULL, cfg, 0);
681 FAIL_TEST (NULL != slave2);
682 rh = GNUNET_TESTBED_register_host (mc, slave2, ®istration_cont, NULL);
683 FAIL_TEST (NULL != rh);
685 case SLAVE1_REGISTERED:
686 FAIL_TEST (NULL == emsg);
687 FAIL_TEST (NULL != mc);
688 result = SLAVE2_REGISTERED;
689 FAIL_TEST (NULL != cfg);
690 op = GNUNET_TESTBED_controller_link (NULL, mc, slave, NULL, GNUNET_YES);
691 FAIL_TEST (NULL != op);
693 case MASTER_SLAVE2_PEERS_CONNECTED:
694 FAIL_TEST (NULL == emsg);
695 FAIL_TEST (NULL != mc);
696 FAIL_TEST (NULL == op);
697 result = SLAVE3_REGISTERED;
698 op = GNUNET_TESTBED_controller_link (NULL, mc, slave3, NULL, GNUNET_YES);
699 FAIL_TEST (NULL != op);
708 * Callback to signal successfull startup of the controller process
710 * @param cls the closure from GNUNET_TESTBED_controller_start()
711 * @param cfg the configuration with which the controller has been started;
712 * NULL if status is not GNUNET_OK
713 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
714 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
717 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *config,
723 FAIL_TEST (GNUNET_OK == status);
725 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
726 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
727 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
728 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
729 mc = GNUNET_TESTBED_controller_connect (host, event_mask,
730 &controller_cb, NULL);
731 FAIL_TEST (NULL != mc);
732 result = MASTER_STARTED;
733 op = GNUNET_TESTBED_peer_create (mc, host, cfg, peer_create_cb, NULL);
734 FAIL_TEST (NULL != op);
745 * Callbacks of this type are called by #GNUNET_TESTBED_is_host_habitable to
746 * inform whether the given host is habitable or not. The Handle returned by
747 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
750 * @param host the host whose status is being reported; will be NULL if the host
751 * given to GNUNET_TESTBED_is_host_habitable() is NULL
752 * @param status #GNUNET_YES if it is habitable; #GNUNET_NO if not
755 host_habitable_cb (void *cls,
756 const struct GNUNET_TESTBED_Host *_host,
760 if (GNUNET_NO == status)
763 "Unable to run the test as this system is not configured "
764 "to use password less SSH logins to localhost.\n"
766 GNUNET_SCHEDULER_cancel (abort_task);
768 GNUNET_SCHEDULER_shutdown ();
772 cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host, status_cb,
781 * @param args arguments passed to #GNUNET_PROGRAM_run()
782 * @param cfgfile the path to configuration file
783 * @param cfg the configuration file handle
786 run (void *cls, char *const *args, const char *cfgfile,
787 const struct GNUNET_CONFIGURATION_Handle *config)
789 cfg = GNUNET_CONFIGURATION_dup (config);
790 host = GNUNET_TESTBED_host_create (NULL, NULL, cfg, 0);
791 FAIL_TEST (NULL != host);
794 GNUNET_TESTBED_is_host_habitable (host, config, &host_habitable_cb,
797 GNUNET_TESTBED_host_destroy (host);
798 GNUNET_CONFIGURATION_destroy (cfg);
802 "Unable to run the test as this system is not configured "
803 "to use password less SSH logins to localhost.\n"
804 "Marking test as successful\n");
809 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
810 (GNUNET_TIME_UNIT_MINUTES, 5), &do_abort,
812 GNUNET_SCHEDULER_add_shutdown (&do_shutdown,
821 main (int argc, char **argv)
823 char *const argv2[] = { "test_testbed_api_controllerlink",
824 "-c", "test_testbed_api.conf",
827 struct GNUNET_GETOPT_CommandLineOption options[] = {
828 GNUNET_GETOPT_OPTION_END
834 GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
835 "test_testbed_api_controllerlink", "nohelp", options,
837 if (GNUNET_OK != ret)
844 return 77; /* Mark test as skipped */
850 /* end of test_testbed_api_controllerlink.c */