GNUnet  0.10.x
transport-testing-main.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2016 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 */
25 #include "transport-testing.h"
26 
27 
32 {
37 
42 
47 
52 
57 
62 
63 };
64 
65 
71 static void
72 do_shutdown (void *cls)
73 {
76 
78  "Testcase shutting down\n");
79  if (NULL != ccc->shutdown_task)
80  ccc->shutdown_task (ccc->shutdown_task_cls);
81  if (NULL != ccc->timeout_task)
82  {
84  ccc->timeout_task = NULL;
85  }
86  if (NULL != ccc->connect_task)
87  {
89  ccc->connect_task = NULL;
90  }
91  while (NULL != (crl = ccc->crl_head))
92  {
94  ccc->crl_tail,
95  crl);
97  GNUNET_free (crl);
98  }
99  for (unsigned int i=0;i<ccc->num_peers;i++)
100  {
101  if (NULL != ccc->p[i])
102  {
104  ccc->p[i] = NULL;
105  }
106  }
107 }
108 
109 
115 static void
116 do_timeout (void *cls)
117 {
119 
120  ccc->timeout_task = NULL;
122  "Testcase timed out\n");
123  ccc->global_ret = GNUNET_SYSERR;
125 }
126 
127 
134 {
139 
143  unsigned int off;
144 };
145 
146 
151 {
156 
161 };
162 
163 
170 static void
171 connect_cb (void *cls)
172 {
175 
177  ccc->crl_tail,
178  crl);
179  {
180  char *p1_c = GNUNET_strdup (GNUNET_i2s (&crl->p1->id));
181 
183  "Peers connected: %u (%s) <-> %u (%s)\n",
184  crl->p1->no,
185  p1_c,
186  crl->p2->no,
187  GNUNET_i2s (&crl->p2->id));
188  GNUNET_free (p1_c);
189  GNUNET_free (crl);
190  }
191  if (NULL == ccc->crl_head)
192  {
194  "All connections UP, launching custom test logic.\n");
197  }
198 }
199 
200 
210  const struct GNUNET_PeerIdentity *peer)
211 {
212  for (unsigned int i=0;i<ccc->num_peers;i++)
213  if ( (NULL != ccc->p[i]) &&
214  (0 == memcmp (peer,
215  &ccc->p[i]->id,
216  sizeof (*peer))) )
217  return ccc->p[i];
218  return NULL;
219 }
220 
221 
230 static void *
231 my_nc (void *cls,
232  const struct GNUNET_PeerIdentity *peer,
233  struct GNUNET_MQ_Handle *mq)
234 {
237  struct ConnectPairInfo *cpi;
238 
239  if (NULL != ccc->nc)
240  ccc->nc (ccc->cls,
241  ccc->p[ipi->off],
242  peer);
243  cpi = GNUNET_new (struct ConnectPairInfo);
244  cpi->ipi = ipi;
245  cpi->sender = peer; /* valid until disconnect */
246  return cpi;
247 }
248 
249 
257 static void
258 my_nd (void *cls,
259  const struct GNUNET_PeerIdentity *peer,
260  void *custom_cls)
261 {
264  struct ConnectPairInfo *cpi = custom_cls;
265 
266  if (NULL != ccc->nd)
267  ccc->nd (ccc->cls,
268  ccc->p[ipi->off],
269  peer);
270  GNUNET_free (cpi);
271 }
272 
273 
281 static int
282 check_test (void *cls,
283  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
284 {
285  return GNUNET_OK;
286 }
287 
288 
295 static void
296 handle_test (void *cls,
297  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
298 {
299  struct ConnectPairInfo *cpi = cls;
302 
303  if (NULL != ccc->rec)
304  ccc->rec (ccc->cls,
305  ccc->p[ipi->off],
306  cpi->sender,
307  message);
308 }
309 
310 
318 static int
320  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
321 {
322  return GNUNET_OK;
323 }
324 
325 
332 static void
334  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
335 {
336  struct ConnectPairInfo *cpi = cls;
339 
340  if (NULL != ccc->rec)
341  ccc->rec (ccc->cls,
342  ccc->p[ipi->off],
343  cpi->sender,
344  message);
345 }
346 
347 
353 static void
355 {
357 
358  ccc->connect_task = NULL;
359  for (unsigned int i=0;i<ccc->num_peers;i++)
360  for (unsigned int j=(ccc->bi_directional ? 0 : i+1);j<ccc->num_peers;j++)
361  {
363 
364  if (i == j)
365  continue;
368  ccc->crl_tail,
369  crl);
370  crl->ccc = ccc;
371  crl->p1 = ccc->p[i];
372  crl->p2 = ccc->p[j];
373  {
374  char *sender_c = GNUNET_strdup (GNUNET_i2s (&ccc->p[0]->id));
375 
377  "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
378  ccc->p[0]->no,
379  sender_c,
380  ccc->p[1]->no,
381  GNUNET_i2s (&ccc->p[1]->id));
382  GNUNET_free (sender_c);
383  }
385  ccc->p[j],
386  &connect_cb,
387  crl);
388  }
389 }
390 
391 
399 static void
400 start_cb (void *cls)
401 {
404  struct GNUNET_TRANSPORT_TESTING_PeerContext *p = ccc->p[ipi->off];
405 
406  ccc->started++;
408  "Peer %u (`%s') started\n",
409  p->no,
410  GNUNET_i2s (&p->id));
411  if (ccc->started != ccc->num_peers)
412  return;
413  if (NULL != ccc->pre_connect_task)
414  {
415  /* Run the custom per-connect job, then give it a second to
416  go into effect before we continue connecting peers. */
419  &do_connect,
420  ccc);
421  }
422  else
423  {
424  do_connect (ccc);
425  }
426 }
427 
428 
439 static void
440 connect_check_run (void *cls,
441  char *const *args,
442  const char *cfgfile,
443  const struct GNUNET_CONFIGURATION_Handle *cfg)
444 {
446  int ok;
447 
448  ccc->cfg = cfg;
450  &do_timeout,
451  ccc);
453  ccc);
454  ok = GNUNET_OK;
455  for (unsigned int i=0;i<ccc->num_peers;i++)
456  {
457  struct GNUNET_MQ_MessageHandler handlers[] = {
458  GNUNET_MQ_hd_var_size (test,
461  NULL),
462  GNUNET_MQ_hd_var_size (test2,
465  NULL),
467  };
468  ccc->p[i] = GNUNET_TRANSPORT_TESTING_start_peer (ccc->tth,
469  ccc->cfg_files[i],
470  i + 1,
471  handlers,
472  &my_nc,
473  &my_nd,
474  &ccc->ip[i],
475  &start_cb,
476  &ccc->ip[i]);
477  if (NULL == ccc->p[i])
478  ok = GNUNET_SYSERR;
479  }
480  if (GNUNET_OK != ok)
481  {
483  "Fail! Could not start peers!\n");
485  }
486 }
487 
488 
504 int
506  struct GNUNET_TRANSPORT_TESTING_Handle *tth_,
507  const char *test_plugin_,
508  const char *test_name_,
509  unsigned int num_peers,
510  char *cfg_files[])
511 {
512  static struct GNUNET_GETOPT_CommandLineOption options[] = {
514  };
518  char * argv[] = {
519  (char *) test_name_,
520  "-c",
521  (char *) ccc->config_file,
522  NULL
523  };
524 
525  ccc->num_peers = num_peers;
526  ccc->cfg_files = cfg_files;
527  ccc->test_plugin = test_plugin_;
528  ccc->test_name = test_name_;
529  ccc->tth = tth_;
530  ccc->global_ret = GNUNET_OK;
531  ccc->p = p;
532  ccc->ip = ip;
533  for (unsigned int i=0;i<num_peers;i++)
534  {
535  ip[i].off = i;
536  ip[i].ccc = ccc;
537  }
538  if (GNUNET_OK !=
539  GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1,
540  argv,
541  test_name_,
542  "nohelp",
543  options,
545  ccc))
546  return GNUNET_SYSERR;
547  return ccc->global_ret;
548 }
549 
550 
561 int
563  const char *filename,
564  unsigned int num_peers,
566  void *check_cls)
567 {
569  char *test_name;
570  char *test_source;
571  char *test_plugin;
572  char *cfg_names[num_peers];
573  int ret;
574 
575  ret = GNUNET_OK;
576  test_name = GNUNET_TRANSPORT_TESTING_get_test_name (argv0);
577  GNUNET_log_setup (test_name,
578  "WARNING",
579  NULL);
580  test_source = GNUNET_TRANSPORT_TESTING_get_test_source_name (filename);
582  test_source);
583  for (unsigned int i=0;i<num_peers;i++)
584  cfg_names[i] = GNUNET_TRANSPORT_TESTING_get_config_name (argv0,
585  i+1);
587  if (NULL == tth)
588  {
589  ret = GNUNET_SYSERR;
590  }
591  else
592  {
593  ret = check (check_cls,
594  tth,
595  test_plugin,
596  test_name,
597  num_peers,
598  cfg_names);
600  }
601  for (unsigned int i=0;i<num_peers;i++)
602  GNUNET_free (cfg_names[i]);
603  GNUNET_free (test_source);
604  GNUNET_free_non_null (test_plugin);
605  GNUNET_free (test_name);
606  return ret;
607 }
608 
609 /* end of transport-testing-main.c */
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
struct GNUNET_TRANSPORT_TESTING_ConnectRequestList * prev
Stored in a DLL.
static void my_nd(void *cls, const struct GNUNET_PeerIdentity *peer, void *custom_cls)
Wrapper around peers disconnecting.
static int check_test(void *cls, const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
Wrapper around receiving data.
struct GNUNET_SCHEDULER_Task * connect_task
Task run to connect peers.
Handle for a request to connect two peers.
GNUNET_SCHEDULER_TaskCallback connect_continuation
How should we continue after the connect?
int(* GNUNET_TRANSPORT_TESTING_CheckCallback)(void *cls, struct GNUNET_TRANSPORT_TESTING_Handle *tth_, const char *test_plugin_, const char *test_name_, unsigned int num_peers, char *cfg_files[])
Main function of a testcase.
int global_ret
Result from the main function, set to GNUNET_OK on success.
struct GNUNET_TRANSPORT_TESTING_PeerContext ** p
Array with num_peers entries.
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1293
struct GNUNET_PeerIdentity id
Peer identity.
const char * test_name
Name of the testcase.
Closure that must be passed to GNUNET_TRANSPORT_TESTING_connect_check.
#define GNUNET_TIME_UNIT_SECONDS
One second.
unsigned int num_peers
Number of peers involved in the test.
struct GNUNET_TRANSPORT_TESTING_Handle * GNUNET_TRANSPORT_TESTING_init()
Initialize the transport testing.
static void do_shutdown(void *cls)
Shutdown function for the test.
struct GNUNET_TRANSPORT_TESTING_Handle * tth
Main testing handle.
Context for a single peer.
static void connect_cb(void *cls)
Function called when we connected two peers.
static int ok
Return value from &#39;main&#39; (0 == success)
const struct GNUNET_PeerIdentity * sender
Peer this is about.
char ** cfg_files
Configuration files we have, array with num_peers entries.
unsigned int off
Offset of the peer this is about.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:78
#define GNUNET_free_non_null(ptr)
Free the memory pointed to by ptr if ptr is not NULL.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition of a command line option.
char * GNUNET_TRANSPORT_TESTING_get_test_name(const char *file)
Extracts the test filename from an absolute file name and removes the extension.
struct GNUNET_TRANSPORT_TESTING_ConnectCheckContext * ccc
Overall context of the callback.
unsigned int no
An unique number to identify the peer.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:524
static int ret
Final status code.
Definition: gnunet-arm.c:89
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
static void do_connect(void *cls)
Connect the peers as a clique.
int GNUNET_TRANSPORT_TESTING_connect_check(void *cls, struct GNUNET_TRANSPORT_TESTING_Handle *tth_, const char *test_plugin_, const char *test_name_, unsigned int num_peers, char *cfg_files[])
Common implementation of the GNUNET_TRANSPORT_TESTING_CheckCallback.
void GNUNET_TRANSPORT_TESTING_done(struct GNUNET_TRANSPORT_TESTING_Handle *tth)
Clean up the transport testing.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
int GNUNET_TRANSPORT_TESTING_main_(const char *argv0, const char *filename, unsigned int num_peers, GNUNET_TRANSPORT_TESTING_CheckCallback check, void *check_cls)
Setup testcase.
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration object for the testcase.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1246
struct GNUNET_TRANSPORT_TESTING_PeerContext * p1
Peer being connected.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
void * cls
Closure for mv and cb.
#define GNUNET_MQ_hd_var_size(name, code, str, ctx)
void * cls
Closure for rec, nc and nd.
struct GNUNET_TRANSPORT_TESTING_ConnectRequestList * crl_tail
DLL of active connect requests.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1273
const char * config_file
Which configuration file should we pass to the GNUNET_PROGRAM_run() of the testcase?
static void handle_test(void *cls, const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
Wrapper around receiving data.
static void do_timeout(void *cls)
Testcase hit timeout, shut it down with error.
void * connect_continuation_cls
Closure for connect_continuation.
static char * filename
const char * test_plugin
Name of the plugin.
void * pre_connect_task_cls
Closure for shutdown_task.
Message handler for a specific message type.
struct GNUNET_TRANSPORT_TESTING_InternalPeerContext * ip
Array with num_peers entries.
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
#define GNUNET_TRANSPORT_TESTING_SIMPLE_MTYPE2
Alternative message type for tests.
char * GNUNET_TRANSPORT_TESTING_get_test_plugin_name(const char *file, const char *test)
Extracts the plugin name from an absolute file name and the test name.
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
#define GNUNET_SYSERR
Definition: gnunet_common.h:79
int bi_directional
Should we try to create connections in both directions?
void GNUNET_TRANSPORT_TESTING_connect_peers_cancel(struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc)
Cancel the request to connect two peers Tou MUST cancel the request if you stop the peers before the ...
struct GNUNET_TRANSPORT_TESTING_ConnectRequestList * next
Stored in a DLL.
struct GNUNET_TRANSPORT_TESTING_PeerContext * GNUNET_TRANSPORT_TESTING_find_peer(struct GNUNET_TRANSPORT_TESTING_ConnectCheckContext *ccc, const struct GNUNET_PeerIdentity *peer)
Find peer by peer ID.
static unsigned int num_peers
struct GNUNET_TRANSPORT_TESTING_ConnectRequest * GNUNET_TRANSPORT_TESTING_connect_peers(struct GNUNET_TRANSPORT_TESTING_PeerContext *p1, struct GNUNET_TRANSPORT_TESTING_PeerContext *p2, GNUNET_SCHEDULER_TaskCallback cb, void *cls)
Initiate a connection from p1 to p2 by offering p1 p2&#39;s HELLO message.
struct GNUNET_TIME_Relative timeout
When should the testcase time out?
Handle to a message queue.
Definition: mq.c:85
The identity of the host (wraps the signing key of the peer).
struct GNUNET_TRANSPORT_TESTING_PeerContext * p2
Peer being connected.
struct GNUNET_TRANSPORT_TESTING_ConnectRequest * cr
Connect request this is about.
configuration data
Definition: configuration.c:85
char * GNUNET_TRANSPORT_TESTING_get_test_source_name(const char *file)
Extracts the filename from an absolute file name and removes the extension.
static int check_test2(void *cls, const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
Wrapper around receiving data.
static void * my_nc(void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_MQ_Handle *mq)
Wrapper around peers connecting.
struct GNUNET_TRANSPORT_TESTING_InternalPeerContext * ipi
Information about the receiving peer.
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
#define GNUNET_log(kind,...)
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:361
GNUNET_SCHEDULER_TaskCallback shutdown_task
Custom task to run on shutdown.
GNUNET_SCHEDULER_TaskCallback pre_connect_task
Custom task to run after peers were started but before we try to connect them.
static void start_cb(void *cls)
Function called once we have successfully launched a peer.
GNUNET_TRANSPORT_TESTING_NotifyDisconnect nd
Notify disconnect argument to give for peers we start.
struct GNUNET_SCHEDULER_Task * timeout_task
Task run on timeout.
Information tracked per connected peer.
void GNUNET_TRANSPORT_TESTING_stop_peer(struct GNUNET_TRANSPORT_TESTING_PeerContext *p)
Shutdown the given peer.
int GNUNET_log_setup(const char *comp, const char *loglevel, const char *logfile)
Setup logging.
struct GNUNET_TRANSPORT_TESTING_ConnectCheckContext * ccc
Overall context we are in.
static void connect_check_run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Function run from GNUNET_TRANSPORT_TESTING_connect_check once the scheduler is up.
void * shutdown_task_cls
Closure for shutdown_task.
struct GNUNET_TRANSPORT_TESTING_PeerContext * GNUNET_TRANSPORT_TESTING_start_peer(struct GNUNET_TRANSPORT_TESTING_Handle *tth, const char *cfgname, int peer_id, const struct GNUNET_MQ_MessageHandler *handlers, GNUNET_TRANSPORT_NotifyConnect nc, GNUNET_TRANSPORT_NotifyDisconnect nd, void *cb_cls, GNUNET_SCHEDULER_TaskCallback start_cb, void *start_cb_cls)
Start a peer with the given configuration.
struct GNUNET_TRANSPORT_TESTING_ConnectRequestList * crl_head
DLL of active connect requests.
GNUNET_TRANSPORT_TESTING_ReceiveCallback rec
Receiver argument to give for peers we start.
#define GNUNET_TRANSPORT_TESTING_SIMPLE_MTYPE
Message type used by GNUNET_TRANSPORT_TESTING_simple_send().
testing lib for transport service
const char * GNUNET_i2s(const struct GNUNET_PeerIdentity *pid)
Convert a peer identity to a string (for printing debug messages).
#define GNUNET_MQ_handler_end()
End-marker for the handlers array.
unsigned int started
Number of peers that have been started.
static void handle_test2(void *cls, const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
Wrapper around receiving data.
GNUNET_TRANSPORT_TESTING_NotifyConnect nc
Notify connect argument to give for peers we start.
#define GNUNET_free(ptr)
Wrapper around free.
char * GNUNET_TRANSPORT_TESTING_get_config_name(const char *file, int count)
This function takes the filename (e.g.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:965