src/ats/test_ats2_lib.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010-2015 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 /**
  19  * @file ats/test_ats2_lib.c
  20  * @brief test ATS library with a generic interpreter for running ATS tests
  21  * @author Julius Bünger
  22  */
  23 #include "platform.h"
  24 #include "gnunet_util_lib.h"
  25 #include "gnunet_ats_application_service.h"
  26 #include "gnunet_ats_transport_service.h"
  27 #include "gnunet_testing_lib.h"
  28
  29 /**
  30  * @brief Indicates the success of the whole test
  31  */
  32 static int ret;
  33
  34 /**
  35  * @brief The time available until the test shuts down
  36  */
  37 static struct GNUNET_TIME_Relative timeout;
  38
  39 /**
  40  * @brief ATS Application Handle
  41  *
  42  * Handle to the application-side of ATS.
  43  */
  44 static struct GNUNET_ATS_ApplicationHandle *ah;
  45
  46 /**
  47  * @brief ATS Transport Handle
  48  *
  49  * Handle to the transport-side of ATS.
  50  */
  51 static struct GNUNET_ATS_TransportHandle *th;
  52
  53 /**
  54  * @brief Another (dummy) peer.
  55  *
  56  * Used as the peer ATS shall allocate bandwidth to.
  57  */
  58 static struct GNUNET_PeerIdentity other_peer;
  59
  60 /**
  61  * @brief Handle to the session record
  62  */
  63 static struct GNUNET_ATS_SessionRecord *sr;
  64
  65
  66 /**
  67  * @brief Called whenever allocation changed
  68  *
  69  * Implements #GNUNET_ATS_AllocationCallback
  70  *
  71  * @param cls
  72  * @param session
  73  * @param bandwidth_out
  74  * @param bandwidth_in
  75  *
  76  * @return
  77  */
  78 static void
  79 allocation_cb (void *cls,
  80                struct GNUNET_ATS_Session *session,
  81                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
  82                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
  83 {
  84   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  85               "allocation_cb() called\n");
  86 }
  87
  88
  89 /**
  90  * @brief Called whenever suggestion is made
  91  *
  92  * Implements #GNUNET_ATS_SuggestionCallback
  93  *
  94  * @param cls
  95  * @param pid
  96  * @param address
  97  */
  98 static void
  99 suggestion_cb (void *cls,
 100                const struct GNUNET_PeerIdentity *pid,
 101                const char *address)
 102 {
 103   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 104               "suggestion_cb() called\n");
 105   ret = 0;
 106 }
 107
 108
 109 /**
 110  * @brief Initialise both 'sides' of ATS
 111  *
 112  * Initialises the application and transportation side of ATS.
 113  */
 114 static void
 115 init_both (const struct GNUNET_CONFIGURATION_Handle *cfg)
 116 {
 117   ah = GNUNET_ATS_application_init (cfg);
 118   GNUNET_assert (NULL != ah);
 119   th = GNUNET_ATS_transport_init (cfg,
 120                                   &allocation_cb,
 121                                   NULL,
 122                                   &suggestion_cb,
 123                                   NULL);
 124   GNUNET_assert (NULL != ah);
 125 }
 126
 127
 128 /**
 129  * @brief Disconnect both 'sides' of ATS
 130  */
 131 static void
 132 finish_both (void)
 133 {
 134   GNUNET_ATS_application_done (ah);
 135   ah = NULL;
 136   GNUNET_ATS_transport_done (th);
 137   th = NULL;
 138 }
 139
 140
 141 /**
 142  * @brief Provide information about the start of an imaginary connection
 143  */
 144 static void
 145 provide_info_start (void)
 146 {
 147   struct GNUNET_ATS_Properties prop =
 148   {
 149     .delay = GNUNET_TIME_UNIT_FOREVER_REL,
 150     .goodput_out = 1048576,
 151     .goodput_in = 1048576,
 152     .utilization_out = 0,
 153     .utilization_in = 0,
 154     .distance = 0,
 155     .mtu = UINT32_MAX,
 156     .nt = GNUNET_NT_UNSPECIFIED,
 157     .cc = GNUNET_TRANSPORT_CC_UNKNOWN,
 158   };
 159
 160   sr = GNUNET_ATS_session_add (th,
 161                                &other_peer,
 162                                "test-address",
 163                                NULL,
 164                                &prop);
 165   GNUNET_assert (NULL != sr);
 166 }
 167
 168
 169 /**
 170  * @brief Provide information about the end of an imaginary connection
 171  */
 172 static void
 173 provide_info_end (void)
 174 {
 175   GNUNET_ATS_session_del (sr);
 176 }
 177
 178
 179 /**
 180  * @brief Inform ATS about the need of a connection towards a peer
 181  */
 182 static void
 183 get_suggestion (void)
 184 {
 185   struct GNUNET_ATS_ApplicationSuggestHandle *ash;
 186
 187   ash = GNUNET_ATS_application_suggest (ah,
 188                                         &other_peer,
 189                                         GNUNET_MQ_PREFERENCE_NONE,
 190                                         GNUNET_BANDWIDTH_VALUE_MAX);
 191   GNUNET_assert (NULL != ash);
 192 }
 193
 194
 195 static void
 196 on_shutdown (void *cls)
 197 {
 198   provide_info_end ();
 199   finish_both ();
 200   GNUNET_SCHEDULER_shutdown ();
 201 }
 202
 203
 204 /**
 205  * Function run once the ATS service has been started.
 206  *
 207  * @param cls NULL
 208  * @param cfg configuration for the testcase
 209  * @param peer handle to the peer
 210  */
 211 static void
 212 run (void *cls,
 213      const struct GNUNET_CONFIGURATION_Handle *cfg,
 214      struct GNUNET_TESTING_Peer *peer)
 215 {
 216   init_both (cfg);
 217   provide_info_start ();
 218   get_suggestion ();
 219   (void) GNUNET_SCHEDULER_add_delayed (timeout,
 220                                        &on_shutdown,
 221                                        NULL);
 222 }
 223
 224
 225 /**
 226  * @brief Starts the gnunet-testing peer
 227  *
 228  * @param argc
 229  * @param argv[]
 230  *
 231  * @return
 232  */
 233 int
 234 main (int argc,
 235       char *argv[])
 236 {
 237   ret = 1;
 238   memset (&other_peer, 0, sizeof (struct GNUNET_PeerIdentity));
 239   timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS,
 240                                            2);
 241   if (0 != GNUNET_TESTING_peer_run ("test-ats2-lib",
 242                                     "test_ats2_lib.conf",
 243                                     &run, NULL))
 244   {
 245     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 246                 "Running the testing peer failed.\n");
 247     return 1;
 248   }
 249   if (0 != ret)
 250   {
 251     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 252                 "Global status indicates unsuccessful testrun - probably allocation_cb was not called.\n");
 253     ret = 77; // SKIP test, test not yet right!
 254   }
 255   return ret;
 256 }
 257
 258
 259
 260 /* end of test_ats2_lib.c */