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