2 This file is part of GNUnet
3 Copyright (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., 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 struct GNUNET_TESTBED_HostHabitableCheckHandle *hc_handle;
280 * The task handle for the delay task
282 struct GNUNET_SCHEDULER_Task * delay_task_id;
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_add_now (do_shutdown, NULL); \
313 * @param tc the task context
316 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
318 if (NULL != abort_task)
319 GNUNET_SCHEDULER_cancel (abort_task);
320 if (NULL != delay_task_id)
322 GNUNET_SCHEDULER_cancel (delay_task_id);
323 delay_task_id = NULL;
325 if (NULL != hc_handle)
326 GNUNET_TESTBED_is_host_habitable_cancel (hc_handle);
328 GNUNET_TESTBED_controller_disconnect (mc);
330 GNUNET_TESTBED_controller_stop (cp);
332 GNUNET_TESTBED_host_destroy (slave3);
334 GNUNET_TESTBED_host_destroy (slave2);
336 GNUNET_TESTBED_host_destroy (slave);
338 GNUNET_TESTBED_host_destroy (host);
340 GNUNET_CONFIGURATION_destroy (cfg);
342 GNUNET_CONFIGURATION_destroy (cfg3);
344 GNUNET_TESTBED_cancel_registration (rh);
349 * abort task to run on test timed out
352 * @param tc the task context
355 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
357 LOG (GNUNET_ERROR_TYPE_WARNING, "Aborting\n");
359 do_shutdown (cls, tc);
370 do_abort_now (void *cls)
372 if (NULL != abort_task)
373 GNUNET_SCHEDULER_cancel (abort_task);
374 abort_task = GNUNET_SCHEDULER_add_now (&do_abort, NULL);
379 * Callback which will be called to after a host registration succeeded or failed
381 * @param cls the host which has been registered
382 * @param emsg the error message; NULL if host registration is successful
385 registration_cont (void *cls, const char *emsg);
389 * Task for inserting delay between tests
395 delay_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
397 delay_task_id = NULL;
400 case SLAVE2_PEER_CREATE_SUCCESS:
401 op = GNUNET_TESTBED_peer_stop (NULL, slave1_peer, NULL, NULL);
402 FAIL_TEST (NULL != op);
404 case MASTER_SLAVE2_PEERS_CONNECTED:
405 slave3 = GNUNET_TESTBED_host_create_with_id (3, "127.0.0.1", NULL, cfg, 0);
406 rh = GNUNET_TESTBED_register_host (mc, slave3, ®istration_cont, NULL);
408 case SLAVE2_SLAVE3_PEERS_CONNECTED:
409 op = GNUNET_TESTBED_peer_stop (NULL, slave2_peer, NULL, NULL);
410 FAIL_TEST (NULL != op);
419 * Functions of this signature are called when a peer has been successfully
422 * @param cls the closure from GNUNET_TESTBED_peer_create()
423 * @param peer the handle for the created peer; NULL on any error during
425 * @param emsg NULL if peer is not NULL; else MAY contain the error description
428 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
430 FAIL_TEST (NULL != peer);
431 FAIL_TEST (NULL == emsg);
435 result = MASTER_PEER_CREATE_SUCCESS;
437 GNUNET_TESTBED_operation_done (op);
438 op = GNUNET_TESTBED_peer_start (NULL, master_peer, NULL, NULL);
440 case SLAVE1_LINK_SUCCESS:
441 result = SLAVE1_PEER_CREATE_SUCCESS;
443 GNUNET_TESTBED_operation_done (op);
444 op = GNUNET_TESTBED_peer_start (NULL, slave1_peer, NULL, NULL);
446 case SLAVE2_LINK_SUCCESS:
447 result = SLAVE2_PEER_CREATE_SUCCESS;
449 GNUNET_TESTBED_operation_done (op);
451 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
452 (GNUNET_TIME_UNIT_SECONDS, 1),
457 result = SLAVE3_PEER_CREATE_SUCCESS;
459 GNUNET_TESTBED_operation_done (op);
460 op = GNUNET_TESTBED_peer_start (NULL, slave3_peer, NULL, NULL);
465 FAIL_TEST (NULL != op);
470 * Checks the event if it is an operation finished event and if indicates a
471 * successfull completion of operation
473 * @param event the event information to check
476 check_operation_success (const struct GNUNET_TESTBED_EventInformation *event)
478 FAIL_TEST (NULL != event);
479 FAIL_TEST (GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type);
480 FAIL_TEST (event->op == op);
481 FAIL_TEST (NULL == event->op_cls);
482 FAIL_TEST (NULL == event->details.operation_finished.emsg);
483 FAIL_TEST (NULL == event->details.operation_finished.generic);
488 * Signature of the event handler function called by the
489 * respective event controller.
492 * @param event information about the event
495 controller_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
499 case SLAVE2_REGISTERED:
500 check_operation_success (event);
501 GNUNET_TESTBED_operation_done (op);
503 result = SLAVE1_LINK_SUCCESS;
504 FAIL_TEST (NULL != slave2);
505 FAIL_TEST (NULL != slave);
506 op = GNUNET_TESTBED_peer_create (mc, slave, cfg, peer_create_cb, NULL);
507 FAIL_TEST (NULL != op);
509 case SLAVE1_PEER_START_SUCCESS:
510 check_operation_success (event);
511 GNUNET_TESTBED_operation_done (op);
512 result = SLAVE2_LINK_SUCCESS;
513 op = GNUNET_TESTBED_peer_create (mc, slave2, cfg, peer_create_cb, NULL);
514 FAIL_TEST (NULL != op);
516 case MASTER_PEER_CREATE_SUCCESS:
517 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
518 FAIL_TEST (event->details.peer_start.host == host);
519 FAIL_TEST (event->details.peer_start.peer == master_peer);
520 GNUNET_TESTBED_operation_done (op);
521 result = MASTER_PEER_START_SUCCESS;
522 slave = GNUNET_TESTBED_host_create_with_id (1, "127.0.0.1", NULL, cfg, 0);
523 FAIL_TEST (NULL != slave);
524 rh = GNUNET_TESTBED_register_host (mc, slave, ®istration_cont, NULL);
525 FAIL_TEST (NULL != rh);
527 case SLAVE1_PEER_CREATE_SUCCESS:
528 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
529 FAIL_TEST (event->details.peer_start.host == slave);
530 FAIL_TEST (event->details.peer_start.peer == slave1_peer);
531 GNUNET_TESTBED_operation_done (op);
532 result = SLAVE1_PEER_START_SUCCESS;
533 op = GNUNET_TESTBED_controller_link (NULL, mc, slave2, slave, GNUNET_YES);
535 case SLAVE2_PEER_CREATE_SUCCESS:
536 FAIL_TEST (GNUNET_TESTBED_ET_PEER_STOP == event->type);
537 FAIL_TEST (event->details.peer_stop.peer == slave1_peer);
538 GNUNET_TESTBED_operation_done (op);
539 result = SLAVE1_PEER_STOP_SUCCESS;
540 op = GNUNET_TESTBED_peer_start (NULL, slave2_peer, NULL, NULL);
541 FAIL_TEST (NULL != op);
543 case SLAVE3_PEER_CREATE_SUCCESS:
544 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
545 FAIL_TEST (event->details.peer_start.host == slave3);
546 FAIL_TEST (event->details.peer_start.peer == slave3_peer);
547 GNUNET_TESTBED_operation_done (op);
548 result = SLAVE3_PEER_START_SUCCESS;
550 LOG_DEBUG ("**************************************\n");
551 op = GNUNET_TESTBED_overlay_connect (mc, NULL, NULL, slave2_peer,
553 FAIL_TEST (NULL != op);
555 case SLAVE3_PEER_START_SUCCESS:
556 FAIL_TEST (NULL != event);
557 FAIL_TEST (GNUNET_TESTBED_ET_CONNECT == event->type);
558 FAIL_TEST (event->details.peer_connect.peer1 == slave2_peer);
559 FAIL_TEST (event->details.peer_connect.peer2 == slave3_peer);
560 result = SLAVE2_SLAVE3_PEERS_CONNECTED;
561 GNUNET_TESTBED_operation_done (op);
564 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
565 (GNUNET_TIME_UNIT_SECONDS, 1), &delay_task,
568 case SLAVE1_PEER_STOP_SUCCESS:
569 FAIL_TEST (GNUNET_TESTBED_ET_PEER_START == event->type);
570 FAIL_TEST (event->details.peer_start.host == slave2);
571 FAIL_TEST (event->details.peer_start.peer == slave2_peer);
572 GNUNET_TESTBED_operation_done (op);
573 result = SLAVE2_PEER_START_SUCCESS;
574 op = GNUNET_TESTBED_overlay_connect (mc, NULL, NULL, master_peer,
577 case SLAVE2_PEER_START_SUCCESS:
578 FAIL_TEST (NULL != event);
579 FAIL_TEST (GNUNET_TESTBED_ET_CONNECT == event->type);
580 FAIL_TEST (event->details.peer_connect.peer1 == master_peer);
581 FAIL_TEST (event->details.peer_connect.peer2 == slave2_peer);
582 result = MASTER_SLAVE2_PEERS_CONNECTED;
583 GNUNET_TESTBED_operation_done (op);
586 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
587 (GNUNET_TIME_UNIT_SECONDS, 1), &delay_task,
590 case SLAVE2_SLAVE3_PEERS_CONNECTED:
591 FAIL_TEST (GNUNET_TESTBED_ET_PEER_STOP == event->type);
592 FAIL_TEST (event->details.peer_stop.peer == slave2_peer);
593 GNUNET_TESTBED_operation_done (op);
594 result = SLAVE2_PEER_STOP_SUCCESS;
595 op = GNUNET_TESTBED_peer_destroy (slave1_peer);
596 FAIL_TEST (NULL != op);
598 case SLAVE2_PEER_STOP_SUCCESS:
599 check_operation_success (event);
600 GNUNET_TESTBED_operation_done (op);
601 result = SLAVE1_PEER_DESTROY_SUCCESS;
602 op = GNUNET_TESTBED_peer_destroy (slave2_peer);
603 FAIL_TEST (NULL != op);
605 case SLAVE1_PEER_DESTROY_SUCCESS:
606 check_operation_success (event);
607 GNUNET_TESTBED_operation_done (op);
609 result = SLAVE2_PEER_DESTROY_SUCCESS;
610 op = GNUNET_TESTBED_get_slave_config (NULL, mc, slave3);
611 FAIL_TEST (NULL != op);
613 case SLAVE2_PEER_DESTROY_SUCCESS:
614 FAIL_TEST (NULL != event);
615 FAIL_TEST (GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type);
616 FAIL_TEST (event->op == op);
617 FAIL_TEST (NULL == event->op_cls);
618 FAIL_TEST (NULL == event->details.operation_finished.emsg);
619 cfg3 = GNUNET_CONFIGURATION_dup (event->details.operation_finished.generic);
620 GNUNET_TESTBED_operation_done (op);
621 result = SLAVE3_GET_CONFIG_SUCCESS;
622 op = GNUNET_TESTBED_controller_link (NULL, mc, slave3, slave, GNUNET_NO);
624 case SLAVE3_REGISTERED:
625 check_operation_success (event);
626 GNUNET_TESTBED_operation_done (op);
628 result = SLAVE3_STARTED;
629 op = GNUNET_TESTBED_peer_create (mc, slave3, cfg, peer_create_cb, NULL);
630 FAIL_TEST (NULL != op);
632 case SLAVE3_GET_CONFIG_SUCCESS:
633 result = SLAVE3_LINK_SUCCESS;
634 GNUNET_TESTBED_operation_done (op);
635 op = GNUNET_TESTBED_peer_destroy (master_peer);
637 case SLAVE3_LINK_SUCCESS:
638 check_operation_success (event);
639 result = MASTER_PEER_DESTROY_SUCCESS;
640 GNUNET_TESTBED_operation_done (op);
641 op = GNUNET_TESTBED_peer_destroy (slave3_peer);
643 case MASTER_PEER_DESTROY_SUCCESS:
645 GNUNET_TESTBED_operation_done (op);
647 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
648 (GNUNET_TIME_UNIT_SECONDS, 1), &do_shutdown,
658 * Callback which will be called to after a host registration succeeded or failed
660 * @param cls the host which has been registered
661 * @param emsg the error message; NULL if host registration is successful
664 registration_cont (void *cls, const char *emsg)
669 case MASTER_PEER_START_SUCCESS:
670 FAIL_TEST (NULL == emsg);
671 FAIL_TEST (NULL != mc);
672 result = SLAVE1_REGISTERED;
673 slave2 = GNUNET_TESTBED_host_create_with_id (2, "127.0.0.1", NULL, cfg, 0);
674 FAIL_TEST (NULL != slave2);
675 rh = GNUNET_TESTBED_register_host (mc, slave2, ®istration_cont, NULL);
676 FAIL_TEST (NULL != rh);
678 case SLAVE1_REGISTERED:
679 FAIL_TEST (NULL == emsg);
680 FAIL_TEST (NULL != mc);
681 result = SLAVE2_REGISTERED;
682 FAIL_TEST (NULL != cfg);
683 op = GNUNET_TESTBED_controller_link (NULL, mc, slave, NULL, GNUNET_YES);
684 FAIL_TEST (NULL != op);
686 case MASTER_SLAVE2_PEERS_CONNECTED:
687 FAIL_TEST (NULL == emsg);
688 FAIL_TEST (NULL != mc);
689 FAIL_TEST (NULL == op);
690 result = SLAVE3_REGISTERED;
691 op = GNUNET_TESTBED_controller_link (NULL, mc, slave3, NULL, GNUNET_YES);
692 FAIL_TEST (NULL != op);
701 * Callback to signal successfull startup of the controller process
703 * @param cls the closure from GNUNET_TESTBED_controller_start()
704 * @param cfg the configuration with which the controller has been started;
705 * NULL if status is not GNUNET_OK
706 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
707 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
710 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *config,
716 FAIL_TEST (GNUNET_OK == status);
718 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
719 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
720 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
721 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
722 mc = GNUNET_TESTBED_controller_connect (host, event_mask,
723 &controller_cb, NULL);
724 FAIL_TEST (NULL != mc);
725 result = MASTER_STARTED;
726 op = GNUNET_TESTBED_peer_create (mc, host, cfg, peer_create_cb, NULL);
727 FAIL_TEST (NULL != op);
738 * Callbacks of this type are called by GNUNET_TESTBED_is_host_habitable to
739 * inform whether the given host is habitable or not. The Handle returned by
740 * GNUNET_TESTBED_is_host_habitable() is invalid after this callback is called
743 * @param host the host whose status is being reported; will be NULL if the host
744 * given to GNUNET_TESTBED_is_host_habitable() is NULL
745 * @param status GNUNET_YES if it is habitable; GNUNET_NO if not
748 host_habitable_cb (void *cls, const struct GNUNET_TESTBED_Host *_host,
752 if (GNUNET_NO == status)
755 "Unable to run the test as this system is not configured "
756 "to use password less SSH logins to localhost.\n"
758 GNUNET_SCHEDULER_cancel (abort_task);
760 (void) GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
764 cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host, status_cb,
773 * @param args arguments passed to GNUNET_PROGRAM_run
774 * @param cfgfile the path to configuration file
775 * @param cfg the configuration file handle
778 run (void *cls, char *const *args, const char *cfgfile,
779 const struct GNUNET_CONFIGURATION_Handle *config)
781 cfg = GNUNET_CONFIGURATION_dup (config);
782 host = GNUNET_TESTBED_host_create (NULL, NULL, cfg, 0);
783 FAIL_TEST (NULL != host);
786 GNUNET_TESTBED_is_host_habitable (host, config, &host_habitable_cb,
789 GNUNET_TESTBED_host_destroy (host);
790 GNUNET_CONFIGURATION_destroy (cfg);
794 "Unable to run the test as this system is not configured "
795 "to use password less SSH logins to localhost.\n"
796 "Marking test as successful\n");
801 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
802 (GNUNET_TIME_UNIT_MINUTES, 5), &do_abort,
811 main (int argc, char **argv)
813 char *const argv2[] = { "test_testbed_api_controllerlink",
814 "-c", "test_testbed_api.conf",
817 struct GNUNET_GETOPT_CommandLineOption options[] = {
818 GNUNET_GETOPT_OPTION_END
824 GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
825 "test_testbed_api_controllerlink", "nohelp", options,
827 if (GNUNET_OK != ret)
834 return 77; /* Mark test as skipped */
840 /* end of test_testbed_api_controllerlink.c */