GNUnet  0.11.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 
70 static void
71 do_shutdown (void *cls)
72 {
75 
77  "Testcase shutting down\n");
78  if (NULL != ccc->shutdown_task)
79  ccc->shutdown_task (ccc->shutdown_task_cls);
80  if (NULL != ccc->timeout_task)
81  {
83  ccc->timeout_task = NULL;
84  }
85  if (NULL != ccc->connect_task)
86  {
88  ccc->connect_task = NULL;
89  }
90  while (NULL != (crl = ccc->crl_head))
91  {
93  ccc->crl_tail,
94  crl);
96  GNUNET_free (crl);
97  }
98  for (unsigned int i = 0; i < ccc->num_peers; i++)
99  {
100  if (NULL != ccc->p[i])
101  {
103  ccc->p[i] = NULL;
104  }
105  }
106 }
107 
108 
114 static void
115 do_timeout (void *cls)
116 {
118 
119  ccc->timeout_task = NULL;
121  "Testcase timed out\n");
122  ccc->global_ret = GNUNET_SYSERR;
124 }
125 
126 
133 {
138 
142  unsigned int off;
143 };
144 
145 
150 {
155 
160 };
161 
162 
169 static void
170 connect_cb (void *cls)
171 {
174 
176  ccc->crl_tail,
177  crl);
178  {
179  char *p1_c = GNUNET_strdup (GNUNET_i2s (&crl->p1->id));
180 
182  "Peers connected: %u (%s) <-> %u (%s)\n",
183  crl->p1->no,
184  p1_c,
185  crl->p2->no,
186  GNUNET_i2s (&crl->p2->id));
187  GNUNET_free (p1_c);
188  GNUNET_free (crl);
189  }
190  if (NULL == ccc->crl_head)
191  {
193  "All connections UP, launching custom test logic.\n");
196  }
197 }
198 
199 
210  *ccc,
211  const struct GNUNET_PeerIdentity *peer)
212 {
213  for (unsigned int i = 0; i < ccc->num_peers; i++)
214  if ((NULL != ccc->p[i]) &&
215  (0 == memcmp (peer,
216  &ccc->p[i]->id,
217  sizeof(*peer))))
218  return ccc->p[i];
219  return NULL;
220 }
221 
222 
231 static void *
232 my_nc (void *cls,
233  const struct GNUNET_PeerIdentity *peer,
234  struct GNUNET_MQ_Handle *mq)
235 {
238  struct ConnectPairInfo *cpi;
239 
240  if (NULL != ccc->nc)
241  ccc->nc (ccc->cls,
242  ccc->p[ipi->off],
243  peer);
244  cpi = GNUNET_new (struct ConnectPairInfo);
245  cpi->ipi = ipi;
246  cpi->sender = peer; /* valid until disconnect */
247  return cpi;
248 }
249 
250 
258 static void
259 my_nd (void *cls,
260  const struct GNUNET_PeerIdentity *peer,
261  void *custom_cls)
262 {
265  struct ConnectPairInfo *cpi = custom_cls;
266 
267  if (NULL != ccc->nd)
268  ccc->nd (ccc->cls,
269  ccc->p[ipi->off],
270  peer);
271  GNUNET_free (cpi);
272 }
273 
274 
282 static int
283 check_test (void *cls,
284  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
285 {
286  return GNUNET_OK;
287 }
288 
289 
296 static void
297 handle_test (void *cls,
298  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
299 {
300  struct ConnectPairInfo *cpi = cls;
303 
304  if (NULL != ccc->rec)
305  ccc->rec (ccc->cls,
306  ccc->p[ipi->off],
307  cpi->sender,
308  message);
309 }
310 
311 
319 static int
321  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
322 {
323  return GNUNET_OK;
324 }
325 
326 
333 static void
335  const struct GNUNET_TRANSPORT_TESTING_TestMessage *message)
336 {
337  struct ConnectPairInfo *cpi = cls;
340 
341  if (NULL != ccc->rec)
342  ccc->rec (ccc->cls,
343  ccc->p[ipi->off],
344  cpi->sender,
345  message);
346 }
347 
348 
354 static void
356 {
358 
359  ccc->connect_task = NULL;
360  for (unsigned int i = 0; i < ccc->num_peers; i++)
361  for (unsigned int j = (ccc->bi_directional ? 0 : i + 1); j < ccc->num_peers;
362  j++)
363  {
365 
366  if (i == j)
367  continue;
370  ccc->crl_tail,
371  crl);
372  crl->ccc = ccc;
373  crl->p1 = ccc->p[i];
374  crl->p2 = ccc->p[j];
375  {
376  char *sender_c = GNUNET_strdup (GNUNET_i2s (&ccc->p[0]->id));
377 
379  "Test tries to connect peer %u (`%s') -> peer %u (`%s')\n",
380  ccc->p[0]->no,
381  sender_c,
382  ccc->p[1]->no,
383  GNUNET_i2s (&ccc->p[1]->id));
384  GNUNET_free (sender_c);
385  }
387  ccc->p[j],
388  &connect_cb,
389  crl);
390  }
391 }
392 
393 
401 static void
402 start_cb (void *cls)
403 {
406  struct GNUNET_TRANSPORT_TESTING_PeerContext *p = ccc->p[ipi->off];
407 
408  ccc->started++;
410  "Peer %u (`%s') started\n",
411  p->no,
412  GNUNET_i2s (&p->id));
413  if (ccc->started != ccc->num_peers)
414  return;
415  if (NULL != ccc->pre_connect_task)
416  {
417  /* Run the custom per-connect job, then give it a second to
418  go into effect before we continue connecting peers. */
421  &do_connect,
422  ccc);
423  }
424  else
425  {
426  do_connect (ccc);
427  }
428 }
429 
430 
441 static void
442 connect_check_run (void *cls,
443  char *const *args,
444  const char *cfgfile,
445  const struct GNUNET_CONFIGURATION_Handle *cfg)
446 {
448  int ok;
449 
450  ccc->cfg = cfg;
452  &do_timeout,
453  ccc);
455  ccc);
456  ok = GNUNET_OK;
457  for (unsigned int i = 0; i < ccc->num_peers; i++)
458  {
459  struct GNUNET_MQ_MessageHandler handlers[] = {
460  GNUNET_MQ_hd_var_size (test,
463  NULL),
464  GNUNET_MQ_hd_var_size (test2,
467  NULL),
469  };
470  ccc->p[i] = GNUNET_TRANSPORT_TESTING_start_peer (ccc->tth,
471  ccc->cfg_files[i],
472  i + 1,
473  handlers,
474  &my_nc,
475  &my_nd,
476  &ccc->ip[i],
477  &start_cb,
478  &ccc->ip[i]);
479  if (NULL == ccc->p[i])
480  ok = GNUNET_SYSERR;
481  }
482  if (GNUNET_OK != ok)
483  {
485  "Fail! Could not start peers!\n");
487  }
488 }
489 
490 
506 int
509  tth_,
510  const char *test_plugin_,
511  const char *test_name_,
512  unsigned int num_peers,
513  char *cfg_files[])
514 {
515  static struct GNUNET_GETOPT_CommandLineOption options[] = {
517  };
521  char *argv[] = {
522  (char *) test_name_,
523  "-c",
524  (char *) ccc->config_file,
525  NULL
526  };
527 
528  ccc->num_peers = num_peers;
529  ccc->cfg_files = cfg_files;
530  ccc->test_plugin = test_plugin_;
531  ccc->test_name = test_name_;
532  ccc->tth = tth_;
533  ccc->global_ret = GNUNET_OK;
534  ccc->p = p;
535  ccc->ip = ip;
536  for (unsigned int i = 0; i < num_peers; i++)
537  {
538  ip[i].off = i;
539  ip[i].ccc = ccc;
540  }
541  if (GNUNET_OK !=
542  GNUNET_PROGRAM_run ((sizeof(argv) / sizeof(char *)) - 1,
543  argv,
544  test_name_,
545  "nohelp",
546  options,
548  ccc))
549  return GNUNET_SYSERR;
550  return ccc->global_ret;
551 }
552 
553 
564 int
566  const char *filename,
567  unsigned int num_peers,
569  void *check_cls)
570 {
572  char *test_name;
573  char *test_source;
574  char *test_plugin;
575  char *cfg_names[num_peers];
576  int ret;
577 
578  ret = GNUNET_OK;
579  test_name = GNUNET_TRANSPORT_TESTING_get_test_name (argv0);
580  GNUNET_log_setup (test_name,
581  "WARNING",
582  NULL);
583  test_source = GNUNET_TRANSPORT_TESTING_get_test_source_name (filename);
585  test_source);
586  for (unsigned int i = 0; i < num_peers; i++)
587  cfg_names[i] = GNUNET_TRANSPORT_TESTING_get_config_name (argv0,
588  i + 1);
590  if (NULL == tth)
591  {
592  ret = GNUNET_SYSERR;
593  }
594  else
595  {
596  ret = check (check_cls,
597  tth,
598  test_plugin,
599  test_name,
600  num_peers,
601  cfg_names);
603  }
604  for (unsigned int i = 0; i < num_peers; i++)
605  GNUNET_free (cfg_names[i]);
606  GNUNET_free (test_source);
607  GNUNET_free_non_null (test_plugin);
608  GNUNET_free (test_name);
609  return ret;
610 }
611 
612 
613 /* 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.
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
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:1300
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)
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
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:75
#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:526
#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:1253
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:1280
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.
#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:76
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:367
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:966