2 This file is part of GNUnet
3 (C) 2008--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 testbed/test_testbed_api_controllerlink.c
23 * @brief testcase for testing controller to subcontroller linking
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
28 #include "gnunet_util_lib.h"
29 #include "gnunet_testing_lib-new.h"
30 #include "gnunet_testbed_service.h"
33 * Generic logging shortcut
35 #define LOG(kind,...) \
36 GNUNET_log (kind, __VA_ARGS__)
39 * Debug logging shorthand
41 #define LOG_DEBUG(...) \
42 LOG(GNUNET_ERROR_TYPE_DEBUG, __VA_ARGS__)
45 * Different stages in testing
56 * Master controller has started
61 * The first slave has been registered at master controller
66 * The second slave has been registered at the master controller
71 * Link from master to slave 1 has been successfully created
76 * Link from slave 1 to slave 2 has been successfully created.
81 * Peer create on slave 1 successful
83 SLAVE1_PEER_CREATE_SUCCESS,
86 * Peer create on slave 2 successful
88 SLAVE2_PEER_CREATE_SUCCESS,
91 * Peer startup on slave 1 successful
93 SLAVE1_PEER_START_SUCCESS,
96 * Peer on slave 1 successfully stopped
98 SLAVE1_PEER_STOP_SUCCESS,
101 * Peer startup on slave 2 successful
103 SLAVE2_PEER_START_SUCCESS,
106 * Peer on slave 2 successfully stopped
108 SLAVE2_PEER_STOP_SUCCESS,
111 * Peer destroy on slave 1 successful
113 SLAVE1_PEER_DESTROY_SUCCESS,
116 * Peer destory on slave 2 successful; Marks test as successful
122 * Host for running master controller
124 static struct GNUNET_TESTBED_Host *host;
127 * The master controller process
129 static struct GNUNET_TESTBED_ControllerProc *cp;
132 * Handle to master controller
134 static struct GNUNET_TESTBED_Controller *mc;
137 * Slave host for running slave controller
139 static struct GNUNET_TESTBED_Host *slave;
142 * Another slave host for running another slave controller
144 static struct GNUNET_TESTBED_Host *slave2;
147 * Slave host registration handle
149 static struct GNUNET_TESTBED_HostRegistrationHandle *rh;
152 * Handle to global configuration
154 static struct GNUNET_CONFIGURATION_Handle *cfg;
159 static GNUNET_SCHEDULER_TaskIdentifier abort_task;
162 * Operation handle for linking controllers
164 static struct GNUNET_TESTBED_Operation *op;
167 * Handle to peer started at slave 1
169 static struct GNUNET_TESTBED_Peer *slave1_peer;
172 * Handle to peer started at slave 2
174 static struct GNUNET_TESTBED_Peer *slave2_peer;
182 * Global testing status
184 static enum Stage result;
191 * @param tc the task context
194 do_shutdown (void *cls, const const struct GNUNET_SCHEDULER_TaskContext *tc)
196 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
197 GNUNET_SCHEDULER_cancel (abort_task);
199 GNUNET_TESTBED_host_destroy (slave2);
201 GNUNET_TESTBED_host_destroy (slave);
203 GNUNET_TESTBED_host_destroy (host);
205 GNUNET_TESTBED_controller_disconnect (mc);
207 GNUNET_CONFIGURATION_destroy (cfg);
209 GNUNET_TESTBED_controller_stop (cp);
211 GNUNET_TESTBED_cancel_registration (rh);
217 * abort task to run on test timed out
220 * @param tc the task context
223 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
225 LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
226 abort_task = GNUNET_SCHEDULER_NO_TASK;
227 do_shutdown (cls, tc);
232 * Task for inserting delay between tests
238 delay_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
242 case SLAVE1_PEER_START_SUCCESS:
243 op = GNUNET_TESTBED_peer_stop (slave1_peer);
244 GNUNET_assert (NULL != op);
246 case SLAVE2_PEER_START_SUCCESS:
247 op = GNUNET_TESTBED_peer_stop (slave2_peer);
248 GNUNET_assert (NULL != op);
257 * Functions of this signature are called when a peer has been successfully
260 * @param cls the closure from GNUNET_TESTBED_peer_create()
261 * @param peer the handle for the created peer; NULL on any error during
263 * @param emsg NULL if peer is not NULL; else MAY contain the error description
266 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
270 case SLAVE2_LINK_SUCCESS:
271 GNUNET_assert (NULL != peer);
272 GNUNET_assert (NULL == emsg);
273 result = SLAVE1_PEER_CREATE_SUCCESS;
275 GNUNET_TESTBED_operation_done (op);
276 op = GNUNET_TESTBED_peer_create (mc, slave2, cfg, peer_create_cb, NULL);
277 GNUNET_assert (NULL != op);
279 case SLAVE1_PEER_CREATE_SUCCESS:
280 GNUNET_assert (NULL != peer);
281 GNUNET_assert (NULL == emsg);
282 result = SLAVE2_PEER_CREATE_SUCCESS;
284 GNUNET_TESTBED_operation_done (op);
285 op = GNUNET_TESTBED_peer_start (slave1_peer);
286 GNUNET_assert (NULL != op);
295 * Checks the event if it is an operation finished event and if indicates a
296 * successfull completion of operation
298 * @param event the event information to check
301 check_operation_success (const struct GNUNET_TESTBED_EventInformation *event)
303 GNUNET_assert (NULL != event);
304 GNUNET_assert (GNUNET_TESTBED_ET_OPERATION_FINISHED == event->type);
305 GNUNET_assert (event->details.operation_finished.operation == op);
306 GNUNET_assert (NULL == event->details.operation_finished.op_cls);
307 GNUNET_assert (NULL == event->details.operation_finished.emsg);
308 GNUNET_assert (GNUNET_TESTBED_PIT_GENERIC ==
309 event->details.operation_finished.pit);
310 GNUNET_assert (NULL == event->details.operation_finished.op_result.generic);
315 * Signature of the event handler function called by the
316 * respective event controller.
319 * @param event information about the event
322 controller_cb(void *cls, const struct GNUNET_TESTBED_EventInformation *event)
326 case SLAVE2_REGISTERED:
327 check_operation_success (event);
328 GNUNET_TESTBED_operation_done (op);
330 result = SLAVE1_LINK_SUCCESS;
331 GNUNET_assert (NULL != slave2);
332 GNUNET_assert (NULL != slave);
333 op = GNUNET_TESTBED_controller_link (mc, slave2, slave, cfg, GNUNET_YES);
334 GNUNET_assert (NULL != op);
336 case SLAVE1_LINK_SUCCESS:
337 check_operation_success (event);
338 GNUNET_TESTBED_operation_done (op);
340 result = SLAVE2_LINK_SUCCESS;
341 op = GNUNET_TESTBED_peer_create (mc, slave, cfg, peer_create_cb, NULL);
342 GNUNET_assert (NULL != op);
344 case SLAVE2_PEER_CREATE_SUCCESS:
345 GNUNET_assert (GNUNET_TESTBED_ET_PEER_START == event->type);
346 GNUNET_assert (event->details.peer_start.host == slave);
347 GNUNET_assert (event->details.peer_start.peer == slave1_peer);
348 GNUNET_TESTBED_operation_done (op);
349 result = SLAVE1_PEER_START_SUCCESS;
350 GNUNET_SCHEDULER_add_delayed
351 (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1),
354 case SLAVE1_PEER_START_SUCCESS:
355 GNUNET_assert (GNUNET_TESTBED_ET_PEER_STOP == event->type);
356 GNUNET_assert (event->details.peer_stop.peer == slave1_peer);
357 GNUNET_TESTBED_operation_done (op);
358 result = SLAVE1_PEER_STOP_SUCCESS;
359 op = GNUNET_TESTBED_peer_start (slave2_peer);
360 GNUNET_assert (NULL != op);
362 case SLAVE1_PEER_STOP_SUCCESS:
363 GNUNET_assert (GNUNET_TESTBED_ET_PEER_START == event->type);
364 GNUNET_assert (event->details.peer_start.host == slave2);
365 GNUNET_assert (event->details.peer_start.peer == slave2_peer);
366 GNUNET_TESTBED_operation_done (op);
367 result = SLAVE2_PEER_START_SUCCESS;
368 GNUNET_SCHEDULER_add_delayed
369 (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1),
372 case SLAVE2_PEER_START_SUCCESS:
373 GNUNET_assert (GNUNET_TESTBED_ET_PEER_STOP == event->type);
374 GNUNET_assert (event->details.peer_stop.peer == slave2_peer);
375 GNUNET_TESTBED_operation_done (op);
376 result = SLAVE2_PEER_STOP_SUCCESS;
377 op = GNUNET_TESTBED_peer_destroy (slave1_peer);
378 GNUNET_assert (NULL != op);
380 case SLAVE2_PEER_STOP_SUCCESS:
381 check_operation_success (event);
382 GNUNET_TESTBED_operation_done (op);
383 result = SLAVE1_PEER_DESTROY_SUCCESS;
384 op = GNUNET_TESTBED_peer_destroy (slave2_peer);
385 GNUNET_assert (NULL != op);
387 case SLAVE1_PEER_DESTROY_SUCCESS:
388 check_operation_success (event);
389 GNUNET_TESTBED_operation_done (op);
391 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
400 * Callback which will be called to after a host registration succeeded or failed
402 * @param cls the host which has been registered
403 * @param emsg the error message; NULL if host registration is successful
406 registration_cont (void *cls, const char *emsg)
412 GNUNET_assert (NULL == emsg);
413 GNUNET_assert (NULL != mc);
414 result = SLAVE1_REGISTERED;
415 slave2 = GNUNET_TESTBED_host_create_with_id (2, "127.0.0.1", NULL, 0);
416 GNUNET_assert (NULL != slave2);
417 rh = GNUNET_TESTBED_register_host (mc, slave2, ®istration_cont, NULL);
418 GNUNET_assert (NULL != rh);
420 case SLAVE1_REGISTERED:
421 GNUNET_assert (NULL == emsg);
422 GNUNET_assert (NULL != mc);
423 result = SLAVE2_REGISTERED;
424 GNUNET_assert (NULL != cfg);
425 op = GNUNET_TESTBED_controller_link (mc, slave, NULL, cfg, GNUNET_YES);
426 GNUNET_assert (NULL != op);
434 * Callback to signal successfull startup of the controller process
436 * @param cls the closure from GNUNET_TESTBED_controller_start()
437 * @param cfg the configuration with which the controller has been started;
438 * NULL if status is not GNUNET_OK
439 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
440 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
443 status_cb (void *cls,
444 const struct GNUNET_CONFIGURATION_Handle *config, int status)
449 GNUNET_assert (GNUNET_OK == status);
451 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
452 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
453 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
454 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
455 mc = GNUNET_TESTBED_controller_connect (config, host, event_mask,
456 &controller_cb, NULL);
457 GNUNET_assert (NULL != mc);
458 result = MASTER_STARTED;
459 slave = GNUNET_TESTBED_host_create_with_id (1, "127.0.0.1", NULL, 0);
460 GNUNET_assert (NULL != slave);
461 rh = GNUNET_TESTBED_register_host (mc, slave, ®istration_cont, NULL);
462 GNUNET_assert (NULL != rh);
474 * @param args arguments passed to GNUNET_PROGRAM_run
475 * @param cfgfile the path to configuration file
476 * @param cfg the configuration file handle
479 run (void *cls, char *const *args, const char *cfgfile,
480 const struct GNUNET_CONFIGURATION_Handle *config)
482 host = GNUNET_TESTBED_host_create (NULL, NULL, 0);
483 GNUNET_assert (NULL != host);
484 cfg = GNUNET_CONFIGURATION_dup (config);
486 GNUNET_TESTBED_controller_start ("127.0.0.1", host, cfg, status_cb, NULL);
487 abort_task = GNUNET_SCHEDULER_add_delayed
488 (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5),
496 int main (int argc, char **argv)
499 char *const argv2[] = { "test_testbed_api_controllerlink",
500 "-c", "test_testbed_api.conf",
503 struct GNUNET_GETOPT_CommandLineOption options[] = {
504 GNUNET_GETOPT_OPTION_END
506 char *const remote_args[] = {
507 "ssh", "-o", "BatchMode=yes", "127.0.0.1", "echo", "Hello", "World", NULL
509 struct GNUNET_OS_Process *auxp;
510 enum GNUNET_OS_ProcessStatusType type;
513 auxp = GNUNET_OS_start_process_vap (GNUNET_NO, GNUNET_OS_INHERIT_STD_ALL,
514 NULL, NULL, "ssh", remote_args);
515 GNUNET_assert (NULL != auxp);
518 ret = GNUNET_OS_process_status (auxp, &type, &code);
519 GNUNET_assert (GNUNET_SYSERR != ret);
521 } while (GNUNET_NO == ret);
522 GNUNET_OS_process_destroy (auxp);
525 (void) printf ("Unable to run the test as this system is not configured "
526 "to use password less SSH logins to localhost.\n"
527 "Marking test as successful\n");
531 ret = GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
532 "test_testbed_api_controllerlink", "nohelp", options, &run,
534 if ((GNUNET_OK != ret) || (SUCCESS != result))