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_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;
170 * shortcut to exit during failure
172 #define FAIL_TEST(cond) do { \
175 if (GNUNET_SCHEDULER_NO_TASK != abort_task) \
176 GNUNET_SCHEDULER_cancel (abort_task); \
177 abort_task = GNUNET_SCHEDULER_NO_TASK; \
178 GNUNET_SCHEDULER_add_now (do_shutdown, NULL); \
187 * @param tc the task context
190 do_shutdown (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
192 if (GNUNET_SCHEDULER_NO_TASK != abort_task)
193 GNUNET_SCHEDULER_cancel (abort_task);
194 if (GNUNET_SCHEDULER_NO_TASK != delayed_connect_task)
195 GNUNET_SCHEDULER_cancel (delayed_connect_task);
196 if (NULL != reg_handle)
197 GNUNET_TESTBED_cancel_registration (reg_handle);
198 GNUNET_TESTBED_controller_disconnect (controller);
199 GNUNET_CONFIGURATION_destroy (cfg);
201 GNUNET_TESTBED_controller_stop (cp);
202 GNUNET_TESTBED_host_destroy (neighbour);
203 GNUNET_TESTBED_host_destroy (host);
208 * abort task to run on test timed out
211 * @param tc the task context
214 do_abort (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
216 LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
217 abort_task = GNUNET_SCHEDULER_NO_TASK;
218 do_shutdown (cls, tc);
223 * Callback to be called when an operation is completed
225 * @param cls the callback closure from functions generating an operation
226 * @param op the operation that has been finished
227 * @param emsg error message in case the operation has failed; will be NULL if
228 * operation has executed successfully.
231 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg);
235 * task for delaying a connect
238 * @param tc the task context
241 do_delayed_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
243 delayed_connect_task = GNUNET_SCHEDULER_NO_TASK;
244 FAIL_TEST (NULL == common_operation);
245 common_operation = GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL,
246 peer1.peer, peer2.peer);
251 * Callback to be called when an operation is completed
253 * @param cls the callback closure from functions generating an operation
254 * @param op the operation that has been finished
255 * @param emsg error message in case the operation has failed; will be NULL if
256 * operation has executed successfully.
259 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg)
261 FAIL_TEST (common_operation == op);
265 FAIL_TEST (NULL == peer1.operation);
266 FAIL_TEST (NULL == peer2.operation);
267 FAIL_TEST (NULL != common_operation);
268 GNUNET_TESTBED_operation_done (common_operation);
269 common_operation = NULL;
270 result = PEERS_CONNECTED;
271 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected\n");
272 delayed_connect_task =
273 GNUNET_SCHEDULER_add_delayed (TIME_REL_SECS (3),
274 &do_delayed_connect, NULL);
276 case PEERS_CONNECTED:
277 FAIL_TEST (NULL == peer1.operation);
278 FAIL_TEST (NULL == peer2.operation);
279 FAIL_TEST (NULL != common_operation);
280 GNUNET_TESTBED_operation_done (common_operation);
281 common_operation = NULL;
282 result = PEERS_CONNECTED_2;
283 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected again\n");
284 peer1.operation = GNUNET_TESTBED_peer_stop (peer1.peer, NULL, NULL);
285 peer2.operation = GNUNET_TESTBED_peer_stop (peer2.peer, NULL, NULL);
294 * Signature of the event handler function called by the
295 * respective event controller.
298 * @param event information about the event
301 controller_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
305 case GNUNET_TESTBED_ET_OPERATION_FINISHED: /* Will be reached when we destroy peers */
306 FAIL_TEST (PEERS_STOPPED == result);
307 FAIL_TEST (NULL == event->details.operation_finished.op_cls);
308 FAIL_TEST (NULL == event->details.operation_finished.emsg);
309 FAIL_TEST (NULL == event->details.operation_finished.generic);
310 if (event->details.operation_finished.operation == peer1.operation)
312 GNUNET_TESTBED_operation_done (peer1.operation);
313 peer1.operation = NULL;
316 else if (event->details.operation_finished.operation == peer2.operation)
318 GNUNET_TESTBED_operation_done (peer2.operation);
319 peer2.operation = NULL;
324 if ((NULL == peer1.peer) && (NULL == peer2.peer))
327 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
330 case GNUNET_TESTBED_ET_PEER_START:
331 FAIL_TEST (INIT == result);
332 FAIL_TEST (event->details.peer_start.host == host);
333 if (event->details.peer_start.peer == peer1.peer)
335 peer1.is_running = GNUNET_YES;
336 GNUNET_TESTBED_operation_done (peer1.operation);
337 peer1.operation = NULL;
339 else if (event->details.peer_start.peer == peer2.peer)
341 peer2.is_running = GNUNET_YES;
342 GNUNET_TESTBED_operation_done (peer2.operation);
343 peer2.operation = NULL;
347 if ((GNUNET_YES == peer1.is_running) && (GNUNET_YES == peer2.is_running))
349 result = PEERS_STARTED;
351 GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peer1.peer,
355 case GNUNET_TESTBED_ET_PEER_STOP:
356 FAIL_TEST (PEERS_CONNECTED_2 == result);
357 if (event->details.peer_stop.peer == peer1.peer)
359 peer1.is_running = GNUNET_NO;
360 GNUNET_TESTBED_operation_done (peer1.operation);
361 peer1.operation = GNUNET_TESTBED_peer_destroy (peer1.peer);
363 else if (event->details.peer_stop.peer == peer2.peer)
365 peer2.is_running = GNUNET_NO;
366 GNUNET_TESTBED_operation_done (peer2.operation);
367 peer2.operation = GNUNET_TESTBED_peer_destroy (peer2.peer);
371 if ((GNUNET_NO == peer1.is_running) && (GNUNET_NO == peer2.is_running))
372 result = PEERS_STOPPED;
374 case GNUNET_TESTBED_ET_CONNECT:
378 case PEERS_CONNECTED:
379 FAIL_TEST (NULL == peer1.operation);
380 FAIL_TEST (NULL == peer2.operation);
381 FAIL_TEST (NULL != common_operation);
382 FAIL_TEST ((event->details.peer_connect.peer1 == peer1.peer) &&
383 (event->details.peer_connect.peer2 == peer2.peer));
396 * Functions of this signature are called when a peer has been successfully
399 * @param cls the closure from GNUNET_TESTBED_peer_create()
400 * @param peer the handle for the created peer; NULL on any error during
402 * @param emsg NULL if peer is not NULL; else MAY contain the error description
405 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
407 struct PeerContext *pc = cls;
409 FAIL_TEST (NULL != pc->operation);
410 FAIL_TEST (NULL != peer);
411 FAIL_TEST (NULL == pc->peer);
413 GNUNET_TESTBED_operation_done (pc->operation);
414 pc->operation = GNUNET_TESTBED_peer_start (NULL, pc->peer, NULL, NULL);
419 * Callback which will be called to after a host registration succeeded or failed
421 * @param cls the host which has been registered
422 * @param emsg the error message; NULL if host registration is successful
425 registration_comp (void *cls, const char *emsg)
427 FAIL_TEST (cls == neighbour);
430 GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
433 GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
435 FAIL_TEST (NULL != peer1.operation);
436 FAIL_TEST (NULL != peer2.operation);
441 * Callback to signal successfull startup of the controller process
443 * @param cls the closure from GNUNET_TESTBED_controller_start()
444 * @param cfg the configuration with which the controller has been started;
445 * NULL if status is not GNUNET_OK
446 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
447 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
450 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg, int status)
454 FAIL_TEST (GNUNET_OK == status);
456 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
457 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
458 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
459 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
461 GNUNET_TESTBED_controller_connect (cfg, host, event_mask, &controller_cb,
463 FAIL_TEST (NULL != controller);
464 neighbour = GNUNET_TESTBED_host_create ("localhost", NULL, 0);
465 FAIL_TEST (NULL != neighbour);
467 GNUNET_TESTBED_register_host (controller, neighbour, ®istration_comp,
469 FAIL_TEST (NULL != reg_handle);
478 * @param args arguments passed to GNUNET_PROGRAM_run
479 * @param cfgfile the path to configuration file
480 * @param cfg the configuration file handle
483 run (void *cls, char *const *args, const char *cfgfile,
484 const struct GNUNET_CONFIGURATION_Handle *config)
486 host = GNUNET_TESTBED_host_create (NULL, NULL, 0);
487 FAIL_TEST (NULL != host);
488 cfg = GNUNET_CONFIGURATION_dup (config);
489 cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host, cfg, status_cb,
492 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
493 (GNUNET_TIME_UNIT_MINUTES, 3), &do_abort,
502 main (int argc, char **argv)
506 char *const argv2[] = { "test_testbed_api_2peers_1controller",
507 "-c", "test_testbed_api.conf",
510 struct GNUNET_GETOPT_CommandLineOption options[] = {
511 GNUNET_GETOPT_OPTION_END
515 GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
516 "test_testbed_api_2peers_1controller", "nohelp",
517 options, &run, NULL);
518 if ((GNUNET_OK != ret) || (SUCCESS != result))
523 /* end of test_testbed_api_2peers_1controller.c */