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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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 struct GNUNET_SCHEDULER_Task *abort_task;
118 * Delayed connect job identifier
120 static struct GNUNET_SCHEDULER_Task *delayed_connect_task;
123 * Different stages in testing
143 * peers are connected
148 * Peers are connected once again (this should not fail as they are already connected)
158 * Final success stage
166 static enum Stage result;
170 * shortcut to exit during failure
172 #define FAIL_TEST(cond) do { \
175 if (NULL != abort_task) \
176 GNUNET_SCHEDULER_cancel (abort_task); \
178 GNUNET_SCHEDULER_add_now (do_shutdown, NULL); \
190 do_shutdown (void *cls)
192 if (NULL != abort_task)
193 GNUNET_SCHEDULER_cancel (abort_task);
194 if (NULL != 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
215 LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
222 * Callback to be called when an operation is completed
224 * @param cls the callback closure from functions generating an operation
225 * @param op the operation that has been finished
226 * @param emsg error message in case the operation has failed; will be NULL if
227 * operation has executed successfully.
230 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg);
234 * task for delaying a connect
239 do_delayed_connect (void *cls)
241 delayed_connect_task = NULL;
242 FAIL_TEST (NULL == common_operation);
244 GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peer1.peer,
250 * Callback to be called when an operation is completed
252 * @param cls the callback closure from functions generating an operation
253 * @param op the operation that has been finished
254 * @param emsg error message in case the operation has failed; will be NULL if
255 * operation has executed successfully.
258 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg)
260 FAIL_TEST (common_operation == op);
264 FAIL_TEST (NULL == peer1.operation);
265 FAIL_TEST (NULL == peer2.operation);
266 FAIL_TEST (NULL != common_operation);
269 case PEERS_CONNECTED:
270 FAIL_TEST (NULL == peer1.operation);
271 FAIL_TEST (NULL == peer2.operation);
272 FAIL_TEST (NULL != common_operation);
282 * Signature of the event handler function called by the
283 * respective event controller.
286 * @param event information about the event
289 controller_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
293 case GNUNET_TESTBED_ET_OPERATION_FINISHED: /* Will be reached when we destroy peers */
294 FAIL_TEST (PEERS_STOPPED == result);
295 FAIL_TEST (NULL == event->op_cls);
296 FAIL_TEST (NULL == event->details.operation_finished.emsg);
297 FAIL_TEST (NULL == event->details.operation_finished.generic);
298 if (event->op == peer1.operation)
300 GNUNET_TESTBED_operation_done (peer1.operation);
301 peer1.operation = NULL;
304 else if (event->op == peer2.operation)
306 GNUNET_TESTBED_operation_done (peer2.operation);
307 peer2.operation = NULL;
312 if ((NULL == peer1.peer) && (NULL == peer2.peer))
315 GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
319 case GNUNET_TESTBED_ET_PEER_START:
320 FAIL_TEST (INIT == result);
321 FAIL_TEST (event->details.peer_start.host == host);
322 if (event->details.peer_start.peer == peer1.peer)
324 peer1.is_running = GNUNET_YES;
325 GNUNET_TESTBED_operation_done (peer1.operation);
326 peer1.operation = NULL;
328 else if (event->details.peer_start.peer == peer2.peer)
330 peer2.is_running = GNUNET_YES;
331 GNUNET_TESTBED_operation_done (peer2.operation);
332 peer2.operation = NULL;
336 if ((GNUNET_YES == peer1.is_running) && (GNUNET_YES == peer2.is_running))
338 result = PEERS_STARTED;
340 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;
365 case GNUNET_TESTBED_ET_CONNECT:
369 FAIL_TEST (NULL == peer1.operation);
370 FAIL_TEST (NULL == peer2.operation);
371 FAIL_TEST (NULL != common_operation);
372 FAIL_TEST ((event->details.peer_connect.peer1 == peer1.peer) &&
373 (event->details.peer_connect.peer2 == peer2.peer));
374 GNUNET_TESTBED_operation_done (common_operation);
375 common_operation = NULL;
376 result = PEERS_CONNECTED;
377 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected\n");
378 delayed_connect_task =
379 GNUNET_SCHEDULER_add_delayed (TIME_REL_SECS (3), &do_delayed_connect,
383 case PEERS_CONNECTED:
384 FAIL_TEST (NULL == peer1.operation);
385 FAIL_TEST (NULL == peer2.operation);
386 FAIL_TEST (NULL != common_operation);
387 GNUNET_TESTBED_operation_done (common_operation);
388 common_operation = NULL;
389 result = PEERS_CONNECTED_2;
390 LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected again\n");
391 peer1.operation = GNUNET_TESTBED_peer_stop (NULL, peer1.peer, NULL, NULL);
392 peer2.operation = GNUNET_TESTBED_peer_stop (NULL, peer2.peer, NULL, NULL);
408 * Functions of this signature are called when a peer has been successfully
411 * @param cls the closure from GNUNET_TESTBED_peer_create()
412 * @param peer the handle for the created peer; NULL on any error during
414 * @param emsg NULL if peer is not NULL; else MAY contain the error description
417 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
419 struct PeerContext *pc = cls;
421 FAIL_TEST (NULL != pc->operation);
422 FAIL_TEST (NULL != peer);
423 FAIL_TEST (NULL == pc->peer);
425 GNUNET_TESTBED_operation_done (pc->operation);
426 pc->operation = GNUNET_TESTBED_peer_start (NULL, pc->peer, NULL, NULL);
431 * Callback which will be called to after a host registration succeeded or failed
433 * @param cls the host which has been registered
434 * @param emsg the error message; NULL if host registration is successful
437 registration_comp (void *cls, const char *emsg)
439 FAIL_TEST (cls == neighbour);
442 GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
445 GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
447 FAIL_TEST (NULL != peer1.operation);
448 FAIL_TEST (NULL != peer2.operation);
453 * Callback to signal successfull startup of the controller process
455 * @param cls the closure from GNUNET_TESTBED_controller_start()
456 * @param cfg the configuration with which the controller has been started;
457 * NULL if status is not GNUNET_OK
458 * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
459 * GNUNET_TESTBED_controller_stop() shouldn't be called in this case
462 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg_, int
467 if (GNUNET_OK != status)
473 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
474 event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
475 event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
476 event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
478 GNUNET_TESTBED_controller_connect (host, event_mask, &controller_cb,
480 FAIL_TEST (NULL != controller);
481 neighbour = GNUNET_TESTBED_host_create ("localhost", NULL, cfg, 0);
482 FAIL_TEST (NULL != neighbour);
484 GNUNET_TESTBED_register_host (controller, neighbour, ®istration_comp,
486 FAIL_TEST (NULL != reg_handle);
495 * @param args arguments passed to GNUNET_PROGRAM_run
496 * @param cfgfile the path to configuration file
497 * @param cfg the configuration file handle
500 run (void *cls, char *const *args, const char *cfgfile,
501 const struct GNUNET_CONFIGURATION_Handle *config)
503 cfg = GNUNET_CONFIGURATION_dup (config);
504 host = GNUNET_TESTBED_host_create (NULL, NULL, cfg, 0);
505 FAIL_TEST (NULL != host);
506 cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host, status_cb,
509 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
510 (GNUNET_TIME_UNIT_MINUTES, 3), &do_abort,
519 main (int argc, char **argv)
523 char *const argv2[] = { "test_testbed_api_2peers_1controller",
524 "-c", "test_testbed_api.conf",
526 struct GNUNET_GETOPT_CommandLineOption options[] = {
527 GNUNET_GETOPT_OPTION_END
532 GNUNET_PROGRAM_run ((sizeof(argv2) / sizeof(char *)) - 1, argv2,
533 "test_testbed_api_2peers_1controller", "nohelp",
534 options, &run, NULL);
535 if ((GNUNET_OK != ret) || (SUCCESS != result))
540 /* end of test_testbed_api_2peers_1controller.c */