src/testbed/test_testbed_api_2peers_1controller.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2008--2013 GNUnet e.V.
   4
   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.
   9
  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.
  14
  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.
  19  */
  20
  21 /**
  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
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_testing_lib.h"
  31 #include "gnunet_testbed_service.h"
  32
  33
  34 /**
  35  * Generic logging shortcut
  36  */
  37 #define LOG(kind,...)                           \
  38   GNUNET_log (kind, __VA_ARGS__)
  39
  40 /**
  41  * Relative time seconds shorthand
  42  */
  43 #define TIME_REL_SECS(sec) \
  44   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, sec)
  45
  46 /**
  47  * Peer context
  48  */
  49 struct PeerContext
  50 {
  51   /**
  52    * The peer handle
  53    */
  54   struct GNUNET_TESTBED_Peer *peer;
  55
  56   /**
  57    * Operations involving this peer
  58    */
  59   struct GNUNET_TESTBED_Operation *operation;
  60
  61   /**
  62    * set to GNUNET_YES when peer is started
  63    */
  64   int is_running;
  65 };
  66
  67 /**
  68  * Our localhost
  69  */
  70 static struct GNUNET_TESTBED_Host *host;
  71
  72 /**
  73  * The controller process
  74  */
  75 static struct GNUNET_TESTBED_ControllerProc *cp;
  76
  77 /**
  78  * The controller handle
  79  */
  80 static struct GNUNET_TESTBED_Controller *controller;
  81
  82 /**
  83  * A neighbouring host
  84  */
  85 static struct GNUNET_TESTBED_Host *neighbour;
  86
  87 /**
  88  * Handle for neighbour registration
  89  */
  90 static struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle;
  91
  92 /**
  93  * peer 1
  94  */
  95 static struct PeerContext peer1;
  96
  97 /**
  98  * peer2
  99  */
 100 static struct PeerContext peer2;
 101
 102 /**
 103  * Handle to configuration
 104  */
 105 static struct GNUNET_CONFIGURATION_Handle *cfg;
 106
 107 /**
 108  * Handle to operations involving both peers
 109  */
 110 static struct GNUNET_TESTBED_Operation *common_operation;
 111
 112 /**
 113  * Abort task identifier
 114  */
 115 static struct GNUNET_SCHEDULER_Task * abort_task;
 116
 117 /**
 118  * Delayed connect job identifier
 119  */
 120 static struct GNUNET_SCHEDULER_Task * delayed_connect_task;
 121
 122 /**
 123  * Different stages in testing
 124  */
 125 enum Stage
 126 {
 127
 128   /**
 129    * Initial stage
 130    */
 131   INIT,
 132
 133   /**
 134    * peers are created
 135    */
 136   PEERS_CREATED,
 137
 138   /**
 139    * peers are started
 140    */
 141   PEERS_STARTED,
 142
 143   /**
 144    * peers are connected
 145    */
 146   PEERS_CONNECTED,
 147
 148   /**
 149    * Peers are connected once again (this should not fail as they are already connected)
 150    */
 151   PEERS_CONNECTED_2,
 152
 153   /**
 154    * peers are stopped
 155    */
 156   PEERS_STOPPED,
 157
 158   /**
 159    * Final success stage
 160    */
 161   SUCCESS
 162 };
 163
 164 /**
 165  * The testing result
 166  */
 167 static enum Stage result;
 168
 169
 170 /**
 171  * shortcut to exit during failure
 172  */
 173 #define FAIL_TEST(cond) do {                                    \
 174     if (!(cond)) {                                              \
 175       GNUNET_break(0);                                          \
 176       if (NULL != abort_task)               \
 177         GNUNET_SCHEDULER_cancel (abort_task);                   \
 178       abort_task = NULL;                    \
 179       GNUNET_SCHEDULER_add_now (do_shutdown, NULL);             \
 180       return;                                                   \
 181     }                                                          \
 182   } while (0)
 183
 184
 185 /**
 186  * Shutdown nicely
 187  *
 188  * @param cls NULL
 189  */
 190 static void
 191 do_shutdown (void *cls)
 192 {
 193   if (NULL != abort_task)
 194     GNUNET_SCHEDULER_cancel (abort_task);
 195   if (NULL != delayed_connect_task)
 196     GNUNET_SCHEDULER_cancel (delayed_connect_task);
 197   if (NULL != reg_handle)
 198     GNUNET_TESTBED_cancel_registration (reg_handle);
 199   GNUNET_TESTBED_controller_disconnect (controller);
 200   GNUNET_CONFIGURATION_destroy (cfg);
 201   if (NULL != cp)
 202     GNUNET_TESTBED_controller_stop (cp);
 203   GNUNET_TESTBED_host_destroy (neighbour);
 204   GNUNET_TESTBED_host_destroy (host);
 205 }
 206
 207
 208 /**
 209  * abort task to run on test timed out
 210  *
 211  * @param cls NULL
 212  */
 213 static void
 214 do_abort (void *cls)
 215 {
 216   LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
 217   abort_task = NULL;
 218   do_shutdown (cls);
 219 }
 220
 221
 222 /**
 223  * Callback to be called when an operation is completed
 224  *
 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.
 229  */
 230 static void
 231 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg);
 232
 233
 234 /**
 235  * task for delaying a connect
 236  *
 237  * @param cls NULL
 238  */
 239 static void
 240 do_delayed_connect (void *cls)
 241 {
 242   delayed_connect_task = NULL;
 243   FAIL_TEST (NULL == common_operation);
 244   common_operation =
 245       GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peer1.peer,
 246                                       peer2.peer);
 247 }
 248
 249
 250 /**
 251  * Callback to be called when an operation is completed
 252  *
 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.
 257  */
 258 static void
 259 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op, const char *emsg)
 260 {
 261   FAIL_TEST (common_operation == op);
 262   switch (result)
 263   {
 264   case PEERS_STARTED:
 265     FAIL_TEST (NULL == peer1.operation);
 266     FAIL_TEST (NULL == peer2.operation);
 267     FAIL_TEST (NULL != common_operation);
 268     break;
 269   case PEERS_CONNECTED:
 270     FAIL_TEST (NULL == peer1.operation);
 271     FAIL_TEST (NULL == peer2.operation);
 272     FAIL_TEST (NULL != common_operation);
 273     break;
 274   default:
 275     FAIL_TEST (0);
 276   }
 277 }
 278
 279
 280 /**
 281  * Signature of the event handler function called by the
 282  * respective event controller.
 283  *
 284  * @param cls closure
 285  * @param event information about the event
 286  */
 287 static void
 288 controller_cb (void *cls, const struct GNUNET_TESTBED_EventInformation *event)
 289 {
 290   switch (event->type)
 291   {
 292   case GNUNET_TESTBED_ET_OPERATION_FINISHED:   /* Will be reached when we destroy peers */
 293     FAIL_TEST (PEERS_STOPPED == result);
 294     FAIL_TEST (NULL == event->op_cls);
 295     FAIL_TEST (NULL == event->details.operation_finished.emsg);
 296     FAIL_TEST (NULL == event->details.operation_finished.generic);
 297     if (event->op == peer1.operation)
 298     {
 299       GNUNET_TESTBED_operation_done (peer1.operation);
 300       peer1.operation = NULL;
 301       peer1.peer = NULL;
 302     }
 303     else if (event->op == peer2.operation)
 304     {
 305       GNUNET_TESTBED_operation_done (peer2.operation);
 306       peer2.operation = NULL;
 307       peer2.peer = NULL;
 308     }
 309     else
 310       FAIL_TEST (0);
 311     if ((NULL == peer1.peer) && (NULL == peer2.peer))
 312     {
 313       result = SUCCESS;
 314       GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 315     }
 316     break;
 317   case GNUNET_TESTBED_ET_PEER_START:
 318     FAIL_TEST (INIT == result);
 319     FAIL_TEST (event->details.peer_start.host == host);
 320     if (event->details.peer_start.peer == peer1.peer)
 321     {
 322       peer1.is_running = GNUNET_YES;
 323       GNUNET_TESTBED_operation_done (peer1.operation);
 324       peer1.operation = NULL;
 325     }
 326     else if (event->details.peer_start.peer == peer2.peer)
 327     {
 328       peer2.is_running = GNUNET_YES;
 329       GNUNET_TESTBED_operation_done (peer2.operation);
 330       peer2.operation = NULL;
 331     }
 332     else
 333       FAIL_TEST (0);
 334     if ((GNUNET_YES == peer1.is_running) && (GNUNET_YES == peer2.is_running))
 335     {
 336       result = PEERS_STARTED;
 337       common_operation =
 338           GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peer1.peer,
 339                                           peer2.peer);
 340     }
 341     break;
 342   case GNUNET_TESTBED_ET_PEER_STOP:
 343     FAIL_TEST (PEERS_CONNECTED_2 == result);
 344     if (event->details.peer_stop.peer == peer1.peer)
 345     {
 346       peer1.is_running = GNUNET_NO;
 347       GNUNET_TESTBED_operation_done (peer1.operation);
 348       peer1.operation = GNUNET_TESTBED_peer_destroy (peer1.peer);
 349     }
 350     else if (event->details.peer_stop.peer == peer2.peer)
 351     {
 352       peer2.is_running = GNUNET_NO;
 353       GNUNET_TESTBED_operation_done (peer2.operation);
 354       peer2.operation = GNUNET_TESTBED_peer_destroy (peer2.peer);
 355     }
 356     else
 357       FAIL_TEST (0);
 358     if ((GNUNET_NO == peer1.is_running) && (GNUNET_NO == peer2.is_running))
 359       result = PEERS_STOPPED;
 360     break;
 361   case GNUNET_TESTBED_ET_CONNECT:
 362     switch (result)
 363     {
 364     case PEERS_STARTED:
 365       FAIL_TEST (NULL == peer1.operation);
 366       FAIL_TEST (NULL == peer2.operation);
 367       FAIL_TEST (NULL != common_operation);
 368       FAIL_TEST ((event->details.peer_connect.peer1 == peer1.peer) &&
 369                  (event->details.peer_connect.peer2 == peer2.peer));
 370       GNUNET_TESTBED_operation_done (common_operation);
 371       common_operation = NULL;
 372       result = PEERS_CONNECTED;
 373       LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected\n");
 374       delayed_connect_task =
 375           GNUNET_SCHEDULER_add_delayed (TIME_REL_SECS (3), &do_delayed_connect,
 376                                         NULL);
 377       break;
 378     case PEERS_CONNECTED:
 379       FAIL_TEST (NULL == peer1.operation);
 380       FAIL_TEST (NULL == peer2.operation);
 381       FAIL_TEST (NULL != common_operation);
 382       GNUNET_TESTBED_operation_done (common_operation);
 383       common_operation = NULL;
 384       result = PEERS_CONNECTED_2;
 385       LOG (GNUNET_ERROR_TYPE_DEBUG, "Peers connected again\n");
 386       peer1.operation = GNUNET_TESTBED_peer_stop (NULL, peer1.peer, NULL, NULL);
 387       peer2.operation = GNUNET_TESTBED_peer_stop (NULL, peer2.peer, NULL, NULL);
 388       break;
 389     default:
 390       FAIL_TEST (0);
 391     }
 392     break;
 393   default:
 394     FAIL_TEST (0);
 395   };
 396 }
 397
 398
 399 /**
 400  * Functions of this signature are called when a peer has been successfully
 401  * created
 402  *
 403  * @param cls the closure from GNUNET_TESTBED_peer_create()
 404  * @param peer the handle for the created peer; NULL on any error during
 405  *          creation
 406  * @param emsg NULL if peer is not NULL; else MAY contain the error description
 407  */
 408 static void
 409 peer_create_cb (void *cls, struct GNUNET_TESTBED_Peer *peer, const char *emsg)
 410 {
 411   struct PeerContext *pc = cls;
 412
 413   FAIL_TEST (NULL != pc->operation);
 414   FAIL_TEST (NULL != peer);
 415   FAIL_TEST (NULL == pc->peer);
 416   pc->peer = peer;
 417   GNUNET_TESTBED_operation_done (pc->operation);
 418   pc->operation = GNUNET_TESTBED_peer_start (NULL, pc->peer, NULL, NULL);
 419 }
 420
 421
 422 /**
 423  * Callback which will be called to after a host registration succeeded or failed
 424  *
 425  * @param cls the host which has been registered
 426  * @param emsg the error message; NULL if host registration is successful
 427  */
 428 static void
 429 registration_comp (void *cls, const char *emsg)
 430 {
 431   FAIL_TEST (cls == neighbour);
 432   reg_handle = NULL;
 433   peer1.operation =
 434       GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
 435                                   &peer1);
 436   peer2.operation =
 437       GNUNET_TESTBED_peer_create (controller, host, cfg, &peer_create_cb,
 438                                   &peer2);
 439   FAIL_TEST (NULL != peer1.operation);
 440   FAIL_TEST (NULL != peer2.operation);
 441 }
 442
 443
 444 /**
 445  * Callback to signal successfull startup of the controller process
 446  *
 447  * @param cls the closure from GNUNET_TESTBED_controller_start()
 448  * @param cfg the configuration with which the controller has been started;
 449  *          NULL if status is not GNUNET_OK
 450  * @param status GNUNET_OK if the startup is successfull; GNUNET_SYSERR if not,
 451  *          GNUNET_TESTBED_controller_stop() shouldn't be called in this case
 452  */
 453 static void
 454 status_cb (void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg_, int status)
 455 {
 456   uint64_t event_mask;
 457
 458   if (GNUNET_OK != status)
 459   {
 460     cp = NULL;
 461     FAIL_TEST (0);
 462   }
 463   event_mask = 0;
 464   event_mask |= (1L << GNUNET_TESTBED_ET_PEER_START);
 465   event_mask |= (1L << GNUNET_TESTBED_ET_PEER_STOP);
 466   event_mask |= (1L << GNUNET_TESTBED_ET_CONNECT);
 467   event_mask |= (1L << GNUNET_TESTBED_ET_OPERATION_FINISHED);
 468   controller =
 469       GNUNET_TESTBED_controller_connect (host, event_mask, &controller_cb,
 470                                          NULL);
 471   FAIL_TEST (NULL != controller);
 472   neighbour = GNUNET_TESTBED_host_create ("localhost", NULL, cfg, 0);
 473   FAIL_TEST (NULL != neighbour);
 474   reg_handle =
 475       GNUNET_TESTBED_register_host (controller, neighbour, &registration_comp,
 476                                     neighbour);
 477   FAIL_TEST (NULL != reg_handle);
 478 }
 479
 480
 481
 482 /**
 483  * Main run function.
 484  *
 485  * @param cls NULL
 486  * @param args arguments passed to GNUNET_PROGRAM_run
 487  * @param cfgfile the path to configuration file
 488  * @param cfg the configuration file handle
 489  */
 490 static void
 491 run (void *cls, char *const *args, const char *cfgfile,
 492      const struct GNUNET_CONFIGURATION_Handle *config)
 493 {
 494   cfg = GNUNET_CONFIGURATION_dup (config);
 495   host = GNUNET_TESTBED_host_create (NULL, NULL, cfg, 0);
 496   FAIL_TEST (NULL != host);
 497   cp = GNUNET_TESTBED_controller_start ("127.0.0.1", host, status_cb,
 498                                         NULL);
 499   abort_task =
 500       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 501                                     (GNUNET_TIME_UNIT_MINUTES, 3), &do_abort,
 502                                     NULL);
 503 }
 504
 505
 506 /**
 507  * Main function
 508  */
 509 int
 510 main (int argc, char **argv)
 511 {
 512   int ret;
 513
 514   char *const argv2[] = { "test_testbed_api_2peers_1controller",
 515     "-c", "test_testbed_api.conf",
 516     NULL
 517   };
 518   struct GNUNET_GETOPT_CommandLineOption options[] = {
 519     GNUNET_GETOPT_OPTION_END
 520   };
 521   result = INIT;
 522   ret =
 523       GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
 524                           "test_testbed_api_2peers_1controller", "nohelp",
 525                           options, &run, NULL);
 526   if ((GNUNET_OK != ret) || (SUCCESS != result))
 527     return 1;
 528   return 0;
 529 }
 530
 531 /* end of test_testbed_api_2peers_1controller.c */