src/testbed/test_testbed_api_test.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 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.
   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    Affero General Public License for more details.
  14
  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/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @file src/testbed/test_testbed_api_test.c
  23  * @brief testing cases for testing high level testbed api helper functions
  24  * @author Sree Harsha Totakura <sreeharsha@totakura.in>
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_util_lib.h"
  29 #include "gnunet_testbed_service.h"
  30
  31
  32 /**
  33  * Generic logging shortcut
  34  */
  35 #define LOG(kind, ...)                           \
  36   GNUNET_log (kind, __VA_ARGS__)
  37
  38 /**
  39  * Number of peers we want to start
  40  */
  41 #define NUM_PEERS 2
  42
  43 /**
  44  * Array of peers
  45  */
  46 static struct GNUNET_TESTBED_Peer **peers;
  47
  48 /**
  49  * Operation handle
  50  */
  51 static struct GNUNET_TESTBED_Operation *op;
  52
  53 /**
  54  * Abort task identifier
  55  */
  56 static struct GNUNET_SCHEDULER_Task *abort_task;
  57
  58 /**
  59  * shutdown task identifier
  60  */
  61 static struct GNUNET_SCHEDULER_Task *shutdown_task;
  62
  63 /**
  64  * Testing result
  65  */
  66 static int result;
  67
  68
  69 /**
  70  * Shutdown nicely
  71  *
  72  * @param cls NULL
  73  */
  74 static void
  75 do_shutdown (void *cls)
  76 {
  77   shutdown_task = NULL;
  78   if (NULL != abort_task)
  79     GNUNET_SCHEDULER_cancel (abort_task);
  80   if (NULL != op)
  81     GNUNET_TESTBED_operation_done (op);
  82   GNUNET_SCHEDULER_shutdown ();
  83 }
  84
  85
  86 /**
  87  * shortcut to exit during failure
  88  */
  89 #define FAIL_TEST(cond) do {                                            \
  90     if (! (cond)) {                                                      \
  91       GNUNET_break (0);                                                  \
  92       if (NULL != abort_task)                       \
  93         GNUNET_SCHEDULER_cancel (abort_task);                           \
  94       abort_task = NULL;                            \
  95       if (NULL == shutdown_task)                    \
  96         shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);   \
  97       return;                                                           \
  98     }                                                                   \
  99 } while (0)
 100
 101
 102 /**
 103  * abort task to run on test timed out
 104  *
 105  * @param cls NULL
 106  */
 107 static void
 108 do_abort (void *cls)
 109 {
 110   LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n");
 111   abort_task = NULL;
 112   if (NULL != shutdown_task)
 113     GNUNET_SCHEDULER_cancel (shutdown_task);
 114   do_shutdown (cls);
 115 }
 116
 117
 118 /**
 119  * Callback to be called when the requested peer information is available
 120  *
 121  * @param cb_cls the closure from GNUNET_TETSBED_peer_get_information()
 122  * @param op the operation this callback corresponds to
 123  * @param pinfo the result; will be NULL if the operation has failed
 124  * @param emsg error message if the operation has failed; will be NULL if the
 125  *          operation is successfull
 126  */
 127 static void
 128 peerinfo_cb (void *cb_cls, struct GNUNET_TESTBED_Operation *op_,
 129              const struct GNUNET_TESTBED_PeerInformation *pinfo,
 130              const char *emsg)
 131 {
 132   FAIL_TEST (op == op_);
 133   FAIL_TEST (NULL == cb_cls);
 134   FAIL_TEST (NULL == emsg);
 135   FAIL_TEST (GNUNET_TESTBED_PIT_IDENTITY == pinfo->pit);
 136   FAIL_TEST (NULL != pinfo->result.id);
 137   GNUNET_TESTBED_operation_done (op);
 138   op = NULL;
 139   result = GNUNET_OK;
 140   shutdown_task = GNUNET_SCHEDULER_add_now (&do_shutdown, NULL);
 141 }
 142
 143
 144 /**
 145  * Callback to be called when an operation is completed
 146  *
 147  * @param cls the callback closure from functions generating an operation
 148  * @param op the operation that has been finished
 149  * @param emsg error message in case the operation has failed; will be NULL if
 150  *          operation has executed successfully.
 151  */
 152 static void
 153 op_comp_cb (void *cls, struct GNUNET_TESTBED_Operation *op_, const char *emsg)
 154 {
 155   FAIL_TEST (NULL == cls);
 156   FAIL_TEST (op == op_);
 157   if (NULL != emsg)
 158   {
 159     LOG (GNUNET_ERROR_TYPE_WARNING, "%s\n", emsg);
 160     FAIL_TEST (0);
 161   }
 162   GNUNET_TESTBED_operation_done (op);
 163   op = GNUNET_TESTBED_peer_get_information (peers[0],
 164                                             GNUNET_TESTBED_PIT_IDENTITY,
 165                                             &peerinfo_cb, NULL);
 166 }
 167
 168
 169 /**
 170  * Controller event callback
 171  *
 172  * @param cls NULL
 173  * @param event the controller event
 174  */
 175 static void
 176 controller_event_cb (void *cls,
 177                      const struct GNUNET_TESTBED_EventInformation *event)
 178 {
 179   switch (event->type)
 180   {
 181   case GNUNET_TESTBED_ET_CONNECT:
 182     FAIL_TEST (event->details.peer_connect.peer1 == peers[0]);
 183     FAIL_TEST (event->details.peer_connect.peer2 == peers[1]);
 184     break;
 185
 186   default:
 187     FAIL_TEST (0);
 188   }
 189 }
 190
 191
 192 /**
 193  * Signature of a main function for a testcase.
 194  *
 195  * @param cls closure
 196  * @param h the run handle
 197  * @param num_peers number of peers in 'peers'
 198  * @param peers- handle to peers run in the testbed
 199  * @param links_succeeded the number of overlay link connection attempts that
 200  *          succeeded
 201  * @param links_failed the number of overlay link connection attempts that
 202  *          failed
 203  */
 204 static void
 205 test_master (void *cls,
 206              struct GNUNET_TESTBED_RunHandle *h,
 207              unsigned int num_peers,
 208              struct GNUNET_TESTBED_Peer **peers_,
 209              unsigned int links_succeeded,
 210              unsigned int links_failed)
 211 {
 212   unsigned int peer;
 213
 214   FAIL_TEST (NULL == cls);
 215   FAIL_TEST (NUM_PEERS == num_peers);
 216   FAIL_TEST (NULL != peers_);
 217   for (peer = 0; peer < num_peers; peer++)
 218     FAIL_TEST (NULL != peers_[peer]);
 219   peers = peers_;
 220   op = GNUNET_TESTBED_overlay_connect (NULL, &op_comp_cb, NULL, peers[0],
 221                                        peers[1]);
 222   abort_task =
 223     GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply
 224                                     (GNUNET_TIME_UNIT_MINUTES, 3), &do_abort,
 225                                   NULL);
 226 }
 227
 228
 229 /**
 230  * Main function
 231  */
 232 int
 233 main (int argc, char **argv)
 234 {
 235   uint64_t event_mask;
 236
 237   result = GNUNET_SYSERR;
 238   event_mask = 0;
 239   event_mask |= (1LL << GNUNET_TESTBED_ET_CONNECT);
 240   event_mask |= (1LL << GNUNET_TESTBED_ET_OPERATION_FINISHED);
 241   (void) GNUNET_TESTBED_test_run ("test_testbed_api_test",
 242                                   "test_testbed_api.conf", NUM_PEERS,
 243                                   event_mask, &controller_event_cb, NULL,
 244                                   &test_master, NULL);
 245   if (GNUNET_OK != result)
 246     return 1;
 247   return 0;
 248 }
 249
 250
 251 /* end of test_testbed_api_test.c */