src/mesh/test_mesh_regex.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012 Christian Grothoff (and other contributing authors)
   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., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file mesh/test_mesh_regex.c
  22  *
  23  * @brief Test for regex announce / by_string connect.
  24  * based on the 2dtorus testcase
  25  */
  26 #include "platform.h"
  27 #include "gnunet_testing_lib.h"
  28 #include "gnunet_mesh_service.h"
  29
  30 #define VERBOSE GNUNET_YES
  31 #define REMOVE_DIR GNUNET_YES
  32
  33 /**
  34  * How long until we give up on connecting the peers?
  35  */
  36 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1500)
  37
  38 /**
  39  * Time to wait for stuff that should be rather fast
  40  */
  41 #define SHORT_TIME GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
  42
  43
  44 /**
  45  * How many events have happened
  46  */
  47 static int ok;
  48
  49 /**
  50  * Be verbose
  51  */
  52 static int verbose;
  53
  54 /**
  55  * Total number of peers in the test.
  56  */
  57 static unsigned long long num_peers;
  58
  59 /**
  60  * Global configuration file
  61  */
  62 static struct GNUNET_CONFIGURATION_Handle *testing_cfg;
  63
  64 /**
  65  * Total number of currently running peers.
  66  */
  67 static unsigned long long peers_running;
  68
  69 /**
  70  * Total number of successful connections in the whole network.
  71  */
  72 static unsigned int total_connections;
  73
  74 /**
  75  * Total number of failed connections in the whole network.
  76  */
  77 static unsigned int failed_connections;
  78
  79 /**
  80  * The currently running peer group.
  81  */
  82 static struct GNUNET_TESTING_PeerGroup *pg;
  83
  84 /**
  85  * Task called to disconnect peers
  86  */
  87 static GNUNET_SCHEDULER_TaskIdentifier disconnect_task;
  88
  89 /**
  90  * Task called to shutdown test.
  91  */
  92 static GNUNET_SCHEDULER_TaskIdentifier shutdown_handle;
  93
  94
  95 static struct GNUNET_TESTING_Daemon *d1;
  96
  97 static struct GNUNET_TESTING_Daemon *d2;
  98
  99 static struct GNUNET_MESH_Handle *h1;
 100
 101 static struct GNUNET_MESH_Handle *h2;
 102
 103 static struct GNUNET_MESH_Tunnel *t;
 104
 105 static struct GNUNET_MESH_Tunnel *incoming_t;
 106
 107 /**
 108  * Check whether peers successfully shut down.
 109  *
 110  * @param cls Closure (unused).
 111  * @param emsg Error message, NULL on success.
 112  */
 113 static void
 114 shutdown_callback (void *cls, const char *emsg)
 115 {
 116   if (emsg != NULL)
 117   {
 118     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 119                 "test: Shutdown of peers failed! (%s)\n", emsg);
 120     ok--;
 121   }
 122 #if VERBOSE
 123   else
 124   {
 125     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 126                 "test: All peers successfully shut down!\n");
 127   }
 128 #endif
 129   GNUNET_CONFIGURATION_destroy (testing_cfg);
 130 }
 131
 132
 133 /**
 134  * Task to run for shutdown: stops peers, ends test.
 135  *
 136  * @param cls Closure (not used).
 137  * @param tc TaskContext.
 138  *
 139  */
 140 static void
 141 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 142 {
 143 #if VERBOSE
 144   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Ending test.\n");
 145 #endif
 146   shutdown_handle = GNUNET_SCHEDULER_NO_TASK;
 147   GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 148 }
 149
 150
 151 /**
 152  * Ends test: Disconnects peers and calls shutdown.
 153  * @param cls Closure (not used).
 154  * @param tc TaskContext.
 155  */
 156 static void
 157 disconnect_peers (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 158 {
 159   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: disconnecting peers\n");
 160
 161   GNUNET_MESH_tunnel_destroy (t);
 162   GNUNET_MESH_disconnect (h1);
 163   GNUNET_MESH_disconnect (h2);
 164   if (GNUNET_SCHEDULER_NO_TASK != shutdown_handle)
 165   {
 166     GNUNET_SCHEDULER_cancel (shutdown_handle);
 167   }
 168   shutdown_handle = GNUNET_SCHEDULER_add_now (&shutdown_task, NULL);
 169 }
 170
 171 /**
 172  * Function called whenever an inbound tunnel is destroyed.  Should clean up
 173  * any associated state.
 174  *
 175  * @param cls closure (set from GNUNET_MESH_connect)
 176  * @param tunnel connection to the other end (henceforth invalid)
 177  * @param tunnel_ctx place where local state associated
 178  *                   with the tunnel is stored
 179  */
 180 static void
 181 tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel,
 182                 void *tunnel_ctx)
 183 {
 184   long i = (long) cls;
 185
 186   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 187               "Incoming tunnel disconnected at peer %d\n",
 188               i);
 189   return;
 190 }
 191
 192
 193 /**
 194  * Method called whenever a tunnel falls apart.
 195  *
 196  * @param cls closure
 197  * @param peer peer identity the tunnel stopped working with
 198  */
 199 static void
 200 dh (void *cls, const struct GNUNET_PeerIdentity *peer)
 201 {
 202   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 203               "peer %s disconnected\n",
 204               GNUNET_i2s (peer));
 205   return;
 206 }
 207
 208
 209 /**
 210  * Method called whenever a peer connects to a tunnel.
 211  *
 212  * @param cls closure
 213  * @param peer peer identity the tunnel was created to, NULL on timeout
 214  * @param atsi performance data for the connection
 215  */
 216 static void
 217 ch (void *cls, const struct GNUNET_PeerIdentity *peer,
 218     const struct GNUNET_ATS_Information *atsi)
 219 {
 220   long i = (long) cls;
 221
 222   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 223               "************************************************************\n");
 224   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 225               "Peer connected: %s\n",
 226               GNUNET_i2s (peer));
 227
 228   if (i != 1L || peer == NULL)
 229     ok = 0;
 230   else
 231     ok = 1;
 232   if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
 233   {
 234     GNUNET_SCHEDULER_cancel (disconnect_task);
 235     disconnect_task =
 236         GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
 237   }
 238 }
 239
 240 /**
 241  * Method called whenever another peer has added us to a tunnel
 242  * the other peer initiated.
 243  *
 244  * @param cls closure
 245  * @param tunnel new handle to the tunnel
 246  * @param initiator peer that started the tunnel
 247  * @param atsi performance information for the tunnel
 248  * @return initial tunnel context for the tunnel
 249  *         (can be NULL -- that's not an error)
 250  */
 251 static void *
 252 incoming_tunnel (void *cls, struct GNUNET_MESH_Tunnel *tunnel,
 253                  const struct GNUNET_PeerIdentity *initiator,
 254                  const struct GNUNET_ATS_Information *atsi)
 255 {
 256   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 257               "Incoming tunnel from %s to peer %d\n",
 258               GNUNET_i2s (initiator), (long) cls);
 259   ok++;
 260   GNUNET_log (GNUNET_ERROR_TYPE_INFO, " ok: %d\n", ok);
 261   if ((long) cls == 2L)
 262     incoming_t = tunnel;
 263   else
 264   {
 265     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 266                 "Incoming tunnel for unknown client %lu\n", (long) cls);
 267   }
 268   if (GNUNET_SCHEDULER_NO_TASK != disconnect_task)
 269   {
 270     GNUNET_SCHEDULER_cancel (disconnect_task);
 271     disconnect_task =
 272         GNUNET_SCHEDULER_add_delayed (SHORT_TIME, &disconnect_peers, NULL);
 273   }
 274   return NULL;
 275 }
 276
 277 /**
 278  * Function is called whenever a message is received.
 279  *
 280  * @param cls closure (set from GNUNET_MESH_connect)
 281  * @param tunnel connection to the other end
 282  * @param tunnel_ctx place to store local state associated with the tunnel
 283  * @param sender who sent the message
 284  * @param message the actual message
 285  * @param atsi performance data for the connection
 286  * @return GNUNET_OK to keep the connection open,
 287  *         GNUNET_SYSERR to close it (signal serious error)
 288  */
 289 int
 290 data_callback (void *cls, struct GNUNET_MESH_Tunnel *tunnel, void **tunnel_ctx,
 291                const struct GNUNET_PeerIdentity *sender,
 292                const struct GNUNET_MessageHeader *message,
 293                const struct GNUNET_ATS_Information *atsi)
 294 {
 295
 296     return GNUNET_OK;
 297 }
 298
 299 /**
 300  * Handlers, for diverse services
 301  */
 302 static struct GNUNET_MESH_MessageHandler handlers[] = {
 303   {&data_callback, 1, sizeof (struct GNUNET_MessageHeader)},
 304   {NULL, 0, 0}
 305 };
 306
 307
 308 /**
 309  * peergroup_ready: start test when all peers are connected
 310  * @param cls closure
 311  * @param emsg error message
 312  */
 313 static void
 314 peergroup_ready (void *cls, const char *emsg)
 315 {
 316   GNUNET_MESH_ApplicationType app;
 317
 318   if (emsg != NULL)
 319   {
 320     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 321                 "test: Peergroup callback called with error, aborting test!\n");
 322     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Error from testing: `%s'\n",
 323                 emsg);
 324     ok--;
 325     GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 326     return;
 327   }
 328 #if VERBOSE
 329   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 330               "************************************************************\n");
 331   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 332               "test: Peer Group started successfully!\n");
 333   GNUNET_log (GNUNET_ERROR_TYPE_INFO, "test: Have %u connections\n",
 334               total_connections);
 335 #endif
 336
 337   peers_running = GNUNET_TESTING_daemons_running (pg);
 338   if (0 < failed_connections)
 339   {
 340     ok = GNUNET_SYSERR;
 341     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "test: %u connections have FAILED!\n",
 342                 failed_connections);
 343     disconnect_task = GNUNET_SCHEDULER_add_now (&disconnect_peers, NULL);
 344     return;
 345   }
 346   ok = 0;
 347   disconnect_task =
 348     GNUNET_SCHEDULER_add_delayed (TIMEOUT, &disconnect_peers, NULL);
 349   d1 = GNUNET_TESTING_daemon_get (pg, 1);
 350   d2 = GNUNET_TESTING_daemon_get (pg, 10);
 351   app = (GNUNET_MESH_ApplicationType) 0;
 352
 353   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 354               "************************************************************\n");
 355   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 356               "Connect to mesh\n");
 357   h1 = GNUNET_MESH_connect (d1->cfg, 5, (void *) 1L,
 358                             NULL,
 359                             NULL,
 360                             handlers,
 361                             &app);
 362   h2 = GNUNET_MESH_connect (d2->cfg, 5, (void *) 2L,
 363                             &incoming_tunnel,
 364                             &tunnel_cleaner,
 365                             handlers,
 366                             &app);
 367   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 368               "************************************************************\n");
 369   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 370               "Announce REGEX\n");
 371   GNUNET_MESH_announce_regex (h2, "abc");
 372
 373   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 374               "************************************************************\n");
 375   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 376               "Create tunnel\n");
 377   t = GNUNET_MESH_tunnel_create (h1, NULL, &ch, &dh, NULL);
 378   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 379               "************************************************************\n");
 380   GNUNET_log (GNUNET_ERROR_TYPE_INFO,
 381               "Connect by string\n");
 382   GNUNET_MESH_peer_request_connect_by_string (t, "abc");
 383   /* connect handler = success, timeout = error */
 384
 385 }
 386
 387
 388 /**
 389  * Function that will be called whenever two daemons are connected by
 390  * the testing library.
 391  *
 392  * @param cls closure
 393  * @param first peer id for first daemon
 394  * @param second peer id for the second daemon
 395  * @param distance distance between the connected peers
 396  * @param first_cfg config for the first daemon
 397  * @param second_cfg config for the second daemon
 398  * @param first_daemon handle for the first daemon
 399  * @param second_daemon handle for the second daemon
 400  * @param emsg error message (NULL on success)
 401  */
 402 static void
 403 connect_cb (void *cls, const struct GNUNET_PeerIdentity *first,
 404             const struct GNUNET_PeerIdentity *second, uint32_t distance,
 405             const struct GNUNET_CONFIGURATION_Handle *first_cfg,
 406             const struct GNUNET_CONFIGURATION_Handle *second_cfg,
 407             struct GNUNET_TESTING_Daemon *first_daemon,
 408             struct GNUNET_TESTING_Daemon *second_daemon, const char *emsg)
 409 {
 410   if (emsg == NULL)
 411   {
 412     total_connections++;
 413   }
 414   else
 415   {
 416     failed_connections++;
 417     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 418                 "test: Problem with new connection (%s)\n", emsg);
 419     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:   (%s)\n", GNUNET_i2s (first));
 420     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test:   (%s)\n", GNUNET_i2s (second));
 421   }
 422 }
 423
 424
 425 /**
 426  * run: load configuration options and schedule test to run (start peergroup)
 427  * @param cls closure
 428  * @param args argv
 429  * @param cfgfile configuration file name (can be NULL)
 430  * @param cfg configuration handle
 431  */
 432 static void
 433 run (void *cls, char *const *args, const char *cfgfile,
 434      const struct GNUNET_CONFIGURATION_Handle *cfg)
 435 {
 436   struct GNUNET_TESTING_Host *hosts;
 437
 438   ok = GNUNET_NO;
 439   total_connections = 0;
 440   failed_connections = 0;
 441   testing_cfg = GNUNET_CONFIGURATION_dup (cfg);
 442
 443   GNUNET_log_setup ("test_mesh_regex",
 444 #if VERBOSE
 445                     "DEBUG",
 446 #else
 447                     "WARNING",
 448 #endif
 449                     NULL);
 450
 451 #if VERBOSE
 452   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Starting daemons.\n");
 453   GNUNET_CONFIGURATION_set_value_string (testing_cfg, "testing_old",
 454                                          "use_progressbars", "YES");
 455 #endif
 456
 457   if (GNUNET_OK !=
 458       GNUNET_CONFIGURATION_get_value_number (testing_cfg, "testing_old",
 459                                              "num_peers", &num_peers))
 460   {
 461     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 462                 "Option TESTING:NUM_PEERS is required!\n");
 463     return;
 464   }
 465
 466   hosts = GNUNET_TESTING_hosts_load (testing_cfg);
 467
 468   pg = GNUNET_TESTING_peergroup_start (testing_cfg, num_peers, TIMEOUT,
 469                                        &connect_cb, &peergroup_ready, NULL,
 470                                        hosts);
 471   GNUNET_assert (pg != NULL);
 472   shutdown_handle =
 473     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 474                                     &shutdown_task, NULL);
 475 }
 476
 477
 478 /**
 479  * test_mesh_regex command line options
 480  */
 481 static struct GNUNET_GETOPT_CommandLineOption options[] = {
 482   {'V', "verbose", NULL,
 483    gettext_noop ("be verbose (print progress information)"),
 484    0, &GNUNET_GETOPT_set_one, &verbose},
 485   GNUNET_GETOPT_OPTION_END
 486 };
 487
 488
 489 /**
 490  * Main: start test
 491  */
 492 int
 493 main (int argc, char *argv[])
 494 {
 495   char *const argv2[] = {
 496     argv[0],
 497     "-c",
 498     "test_mesh_2dtorus.conf",
 499 #if VERBOSE
 500     "-L",
 501     "DEBUG",
 502 #endif
 503     NULL
 504   };
 505
 506   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: Start\n");
 507
 508
 509   GNUNET_PROGRAM_run ((sizeof (argv2) / sizeof (char *)) - 1, argv2,
 510                       "test_mesh_regex",
 511                       gettext_noop ("Test mesh regex integration."),
 512                       options, &run, NULL);
 513 #if REMOVE_DIR
 514   GNUNET_DISK_directory_remove ("/tmp/test_mesh_2dtorus");
 515 #endif
 516   if (GNUNET_OK != ok)
 517   {
 518     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "test: FAILED!\n");
 519     return 1;
 520   }
 521   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "test: success\n");
 522   return 0;
 523 }
 524
 525 /* end of test_mesh_regex.c */