src/testing/test_testing_topology_churn.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 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 testing/test_testing_topology_churn.c
  22  * @brief base testcase for testing simple churn functionality
  23  */
  24 #include "platform.h"
  25 #include "gnunet_testing_lib.h"
  26 #include "gnunet_core_service.h"
  27
  28 #define VERBOSE GNUNET_YES
  29
  30 /**
  31  * How long until we fail the whole testcase?
  32  */
  33 #define TEST_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 600)
  34
  35 /**
  36  * How long until we give up on starting the peers? (Must be longer than the connect timeout!)
  37  */
  38 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 300)
  39
  40 #define DEFAULT_NUM_PEERS 4
  41
  42 static int ok;
  43
  44 static unsigned long long num_peers;
  45
  46 static unsigned int expected_connections;
  47
  48 static unsigned int expected_failed_connections;
  49
  50 static unsigned long long peers_left;
  51
  52 static struct GNUNET_TESTING_PeerGroup *pg;
  53
  54 const struct GNUNET_CONFIGURATION_Handle *main_cfg;
  55
  56 GNUNET_SCHEDULER_TaskIdentifier die_task;
  57
  58 static char *test_directory;
  59
  60 #define MTYPE 12345
  61
  62 struct GNUNET_TestMessage
  63 {
  64   /**
  65    * Header of the message
  66    */
  67   struct GNUNET_MessageHeader header;
  68
  69   /**
  70    * Unique identifier for this message.
  71    */
  72   uint32_t uid;
  73 };
  74
  75 /**
  76  * Check whether peers successfully shut down.
  77  */
  78 void
  79 shutdown_callback (void *cls, const char *emsg)
  80 {
  81   if (emsg != NULL)
  82     {
  83 #if VERBOSE
  84       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Shutdown of peers failed!\n");
  85 #endif
  86       if (ok == 0)
  87         ok = 666;
  88     }
  89   else
  90     {
  91 #if VERBOSE
  92       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  93                   "All peers successfully shut down!\n");
  94 #endif
  95     }
  96 }
  97
  98 static void
  99 finish_testing ()
 100 {
 101   GNUNET_assert (pg != NULL);
 102
 103   if (die_task != GNUNET_SCHEDULER_NO_TASK)
 104     GNUNET_SCHEDULER_cancel (die_task);
 105
 106 #if VERBOSE
 107   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 108               "Called finish testing, stopping daemons.\n");
 109 #endif
 110
 111 #if VERBOSE
 112   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Calling daemons_stop\n");
 113 #endif
 114   GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 115 #if VERBOSE
 116   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "daemons_stop finished\n");
 117 #endif
 118
 119   ok = 0;
 120 }
 121
 122 static void
 123 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 124 {
 125   char *msg = cls;
 126   GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 127               "End badly was called (%s)... stopping daemons.\n", msg);
 128
 129   if (pg != NULL)
 130     {
 131       GNUNET_TESTING_daemons_stop (pg, TIMEOUT, &shutdown_callback, NULL);
 132       ok = 7331;                /* Opposite of leet */
 133     }
 134   else
 135     ok = 401;                   /* Never got peers started */
 136
 137 }
 138
 139 struct ChurnTestContext
 140 {
 141   GNUNET_SCHEDULER_Task next_task;
 142
 143 };
 144
 145 static struct ChurnTestContext churn_ctx;
 146
 147 /**
 148  * Churn callback, report on success or failure of churn operation.
 149  *
 150  * @param cls closure
 151  * @param emsg NULL on success
 152  */
 153 void
 154 churn_callback (void *cls, const char *emsg)
 155 {
 156   if (emsg == NULL)
 157     {
 158       GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Successfully churned peers!\n",
 159                   emsg);
 160       GNUNET_SCHEDULER_add_now (churn_ctx.next_task, NULL);
 161     }
 162   else
 163     {
 164       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 165                   "Failed to churn peers with error `%s'\n", emsg);
 166       GNUNET_SCHEDULER_cancel (die_task);
 167       die_task = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
 168     }
 169 }
 170
 171
 172 static void
 173 churn_peers_both ()
 174 {
 175   churn_ctx.next_task = &finish_testing;
 176   GNUNET_TESTING_daemons_churn (pg, 1, 1, TIMEOUT, &churn_callback, NULL);
 177 }
 178
 179 static void
 180 churn_peers_off_again ()
 181 {
 182   churn_ctx.next_task = &churn_peers_both;
 183   GNUNET_TESTING_daemons_churn (pg, 2, 0, TIMEOUT, &churn_callback, NULL);
 184 }
 185
 186 static void
 187 churn_peers_on ()
 188 {
 189   churn_ctx.next_task = &churn_peers_off_again;
 190   GNUNET_TESTING_daemons_churn (pg, 0, 2, TIMEOUT, &churn_callback, NULL);
 191 }
 192
 193 static void
 194 churn_peers_off ()
 195 {
 196   churn_ctx.next_task = &churn_peers_on;
 197   GNUNET_TESTING_daemons_churn (pg, 2, 0, TIMEOUT, &churn_callback, NULL);
 198 }
 199
 200 static void
 201 peers_started_callback (void *cls,
 202                         const struct GNUNET_PeerIdentity *id,
 203                         const struct GNUNET_CONFIGURATION_Handle *cfg,
 204                         struct GNUNET_TESTING_Daemon *d, const char *emsg)
 205 {
 206   if (emsg != NULL)
 207     {
 208       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 209                   "Failed to start daemon with error: `%s'\n", emsg);
 210       return;
 211     }
 212   GNUNET_assert (id != NULL);
 213 #if VERBOSE
 214   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Started daemon %llu out of %llu\n",
 215               (num_peers - peers_left) + 1, num_peers);
 216 #endif
 217   peers_left--;
 218   if (peers_left == 0)
 219     {
 220 #if VERBOSE
 221       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 222                   "All %d daemons started, now testing churn!\n", num_peers);
 223 #endif
 224       GNUNET_SCHEDULER_cancel (die_task);
 225       /* Set up task in case topology creation doesn't finish
 226        * within a reasonable amount of time */
 227       die_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 228                                                (GNUNET_TIME_UNIT_MINUTES, 5),
 229                                                &end_badly,
 230                                                "from peers_started_callback");
 231       churn_peers_off ();
 232       ok = 0;
 233     }
 234 }
 235
 236
 237 static void
 238 run (void *cls,
 239      char *const *args,
 240      const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
 241 {
 242   ok = 1;
 243
 244 #if VERBOSE
 245   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 246               "Starting daemons based on config file %s\n", cfgfile);
 247 #endif
 248
 249   if (GNUNET_YES !=
 250       GNUNET_CONFIGURATION_get_value_string (cfg, "paths", "servicehome",
 251                                              &test_directory))
 252     {
 253       ok = 404;
 254       return;
 255     }
 256
 257   if (GNUNET_SYSERR ==
 258       GNUNET_CONFIGURATION_get_value_number (cfg, "testing", "num_peers",
 259                                              &num_peers))
 260     num_peers = DEFAULT_NUM_PEERS;
 261
 262   main_cfg = cfg;
 263
 264   peers_left = num_peers;
 265   GNUNET_assert (num_peers > 0 && num_peers < (unsigned int) -1);
 266
 267   /* For this specific test we only really want a CLIQUE topology as the
 268    * overlay allowed topology, and a RING topology as the underlying connection
 269    * allowed topology.  So we will expect only num_peers * 2 connections to
 270    * work, and (num_peers * (num_peers - 1)) - (num_peers * 2) to fail.
 271    */
 272   expected_connections = num_peers * (num_peers - 1);
 273   expected_failed_connections = expected_connections - (num_peers * 2);
 274
 275
 276   /* Set up a task to end testing if peer start fails */
 277   die_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 278                                            (GNUNET_TIME_UNIT_MINUTES, 5),
 279                                            &end_badly,
 280                                            "didn't start all daemons in reasonable amount of time!!!");
 281
 282   pg = GNUNET_TESTING_daemons_start (cfg,
 283                                      peers_left, TIMEOUT, NULL, NULL,
 284                                      &peers_started_callback, NULL, NULL,
 285                                      NULL, NULL);
 286
 287 }
 288
 289 static int
 290 check ()
 291 {
 292   int ret;
 293   char *const argv[] = { "test-testing-topology-churn",
 294     "-c",
 295     "test_testing_data_topology_churn.conf",
 296 #if VERBOSE
 297     "-L", "DEBUG",
 298 #endif
 299     NULL
 300   };
 301   struct GNUNET_GETOPT_CommandLineOption options[] = {
 302     GNUNET_GETOPT_OPTION_END
 303   };
 304   ret = GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
 305                             argv, "test-testing-topology-churn", "nohelp",
 306                             options, &run, &ok);
 307   if (ret != GNUNET_OK)
 308     {
 309       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 310                   "`test-testing-topology-churn': Failed with error code %d\n",
 311                   ret);
 312     }
 313
 314   return ok;
 315 }
 316
 317 int
 318 main (int argc, char *argv[])
 319 {
 320   int ret;
 321
 322   GNUNET_log_setup ("test_testing_topology_churn",
 323 #if VERBOSE
 324                     "DEBUG",
 325 #else
 326                     "WARNING",
 327 #endif
 328                     NULL);
 329   ret = check ();
 330
 331   /**
 332    * Need to remove base directory, subdirectories taken care
 333    * of by the testing framework.
 334    */
 335   if (test_directory != NULL)
 336     {
 337       if (GNUNET_DISK_directory_remove (test_directory) != GNUNET_OK)
 338         {
 339           GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 340                       "Failed to remove testing directory %s\n",
 341                       test_directory);
 342         }
 343     }
 344
 345   return ret;
 346 }
 347
 348 /* end of test_testing_topology_churn.c */