2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
21 * @file transport/test_plugin_transport.c
22 * @brief testcase for transport_api.c
23 * @author Sailor Siraj
24 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_util_lib.h"
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_peerinfo_service.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_signatures.h"
36 #include "gnunet_transport_plugin.h"
38 #include "transport.h"
41 * How long until we give up on transmitting the message?
43 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
46 #define HOSTKEY_FILE "test_plugin_hostkey.ecc"
51 static struct GNUNET_CRYPTO_EccPublicKey my_public_key;
56 static struct GNUNET_PeerIdentity my_identity;
61 static struct GNUNET_CRYPTO_EccPrivateKey *my_private_key;
66 const struct GNUNET_CONFIGURATION_Handle *cfg;
71 struct GNUNET_STATISTICS_Handle *stats;
76 struct GNUNET_HELLO_Message *hello;
79 * Number of neighbours we'd like to have.
81 static uint32_t max_connect_per_transport;
84 * Environment for this plugin.
86 struct GNUNET_TRANSPORT_PluginEnvironment env;
89 *handle for the api provided by this plugin
91 struct GNUNET_TRANSPORT_PluginFunctions *api;
96 struct GNUNET_HELPER_Handle *suid_helper;
101 static GNUNET_SCHEDULER_TaskIdentifier timeout_endbadly;
106 static GNUNET_SCHEDULER_TaskIdentifier timeout_wait;
111 static char *libname;
114 * Plugin addresses head
116 struct AddressWrapper *head;
119 * Plugin addresses tail
121 struct AddressWrapper *tail;
123 unsigned int addresses_reported;
125 unsigned int pretty_printers_running;
128 * Did the test pass or fail?
133 struct AddressWrapper
135 struct AddressWrapper *next;
137 struct AddressWrapper *prev;
150 struct AddressWrapper *w;
154 if (GNUNET_SCHEDULER_NO_TASK != timeout_endbadly)
156 GNUNET_SCHEDULER_cancel (timeout_endbadly);
157 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
160 GNUNET_PLUGIN_unload (libname, api);
165 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
166 "Plugin did not remove address `%s'\n", w->addrstring);
167 GNUNET_CONTAINER_DLL_remove (head, tail, w);
169 GNUNET_free (w->addr);
170 GNUNET_free (w->addrstring);
176 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
177 "Plugin did not remove %u addresses \n", c);
182 GNUNET_free (libname);
184 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
187 if (NULL != suid_helper)
189 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
196 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
198 struct AddressWrapper *w;
201 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
202 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
204 GNUNET_SCHEDULER_cancel (timeout_wait);
205 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
208 if (pretty_printers_running > 0)
210 timeout_endbadly = GNUNET_SCHEDULER_add_delayed(GNUNET_TIME_UNIT_SECONDS, &end_badly, &ok);
211 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
212 "Have pending calls to pretty_printer ... deferring shutdown\n");
218 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
219 "Test took too long to execute, timeout .... \n");
225 GNUNET_PLUGIN_unload (libname, api);
226 GNUNET_free (libname);
233 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
234 "Plugin did not remove address `%s'\n", w->addrstring);
235 GNUNET_CONTAINER_DLL_remove (head, tail, w);
237 GNUNET_free (w->addr);
238 GNUNET_free (w->addrstring);
244 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
245 "Plugin did not remove %u addresses\n", c);
250 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
254 if (NULL != suid_helper)
256 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
265 wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
267 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
268 if (0 == addresses_reported)
269 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
270 "Plugin did not report any addresses, could not check address conversion functions\n");
278 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
280 GNUNET_SCHEDULER_cancel (timeout_wait);
281 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
283 if (GNUNET_SCHEDULER_NO_TASK != timeout_endbadly)
285 GNUNET_SCHEDULER_cancel (timeout_endbadly);
286 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
288 timeout_endbadly = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
292 static struct GNUNET_TIME_Relative
293 env_receive (void *cls,
294 const struct GNUNET_PeerIdentity *peer,
295 const struct GNUNET_MessageHeader *message,
296 struct Session * session,
297 const char *sender_address,
298 uint16_t sender_address_len)
301 return GNUNET_TIME_relative_get_zero_();
305 static int got_reply;
309 * Take the given address and append it to the set of results sent back to
312 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
313 * @param buf text to transmit
316 address_pretty_printer_cb (void *cls, const char *buf)
320 got_reply = GNUNET_YES;
321 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
322 "Pretty address : `%s'\n", buf);
323 pretty_printers_running --;
327 if (GNUNET_NO == got_reply)
329 pretty_printers_running --;
338 env_notify_address (void *cls,
344 struct AddressWrapper *w;
348 if (GNUNET_YES == add_remove)
350 addresses_reported ++;
351 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
352 "Adding address of length %u\n", addrlen);
354 w = GNUNET_new (struct AddressWrapper);
355 w->addr = GNUNET_malloc (addrlen);
356 w->addrlen = addrlen;
357 memcpy (w->addr, addr, addrlen);
358 GNUNET_CONTAINER_DLL_insert(head, tail, w);
359 got_reply = GNUNET_NO;
360 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
361 "Testing: address_to_string \n");
362 w->addrstring = strdup (api->address_to_string (api, w->addr, w->addrlen));
363 if (NULL == w->addrstring)
366 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
367 "Plugin cannot convert address to string!\n");
373 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
374 "Plugin added address `%s'\n", w->addrstring);
375 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
376 "Testing address_to_string: OK\n");
379 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
380 "Testing: string_to_address \n");
383 if ((GNUNET_OK != api->string_to_address (api, w->addrstring, strlen (w->addrstring)+1, &s2a, &s2a_len)) || (NULL == s2a))
386 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
387 "Plugin cannot convert string to address!\n");
393 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
394 "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
397 for (c1 = 0; c1 < s2a_len; c1++ )
398 fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
400 if (s2a_len != w->addrlen)
402 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
403 "Plugin creates different address length when converting address->string->address: %u != %u\n", w->addrlen, s2a_len);
405 else if (0 != memcmp (s2a, w->addr, s2a_len))
407 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
408 "Plugin creates different address length when converting back and forth %i!\n", memcmp (s2a, w->addr, s2a_len));
412 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
413 "Testing string_to_address: OK\n");
417 pretty_printers_running ++;
418 api->address_pretty_printer (api->cls, plugin, addr, addrlen,
419 GNUNET_YES, GNUNET_TIME_UNIT_MINUTES,
420 &address_pretty_printer_cb,
423 if (GNUNET_OK != api->check_address (api->cls, w->addr, w->addrlen))
426 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
427 "Plugin refuses added address!\n");
431 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
433 GNUNET_SCHEDULER_cancel (timeout_wait);
434 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
437 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
440 else if (GNUNET_NO == add_remove)
442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
443 "Removing address of length %u\n", addrlen);
448 if ((addrlen == w->addrlen) && (0 == memcmp (w->addr, addr, addrlen)))
458 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
459 "Plugin removes address never added!\n");
464 GNUNET_CONTAINER_DLL_remove (head, tail, w);
465 GNUNET_free (w->addr);
466 GNUNET_free (w->addrstring);
472 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
473 "Invalid operation: %u\n", add_remove);
480 static struct GNUNET_ATS_Information
481 env_get_address_type (void *cls,
482 const struct sockaddr *addr,
485 struct GNUNET_ATS_Information ats;
486 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
487 ats.value = htonl (GNUNET_ATS_NET_LOOPBACK);
492 static const struct GNUNET_MessageHeader *
495 return (const struct GNUNET_MessageHeader *) hello;
500 env_session_end (void *cls,
501 const struct GNUNET_PeerIdentity *peer,
502 struct Session * session)
508 env_update_metrics (void *cls,
509 const struct GNUNET_PeerIdentity *peer,
511 uint16_t address_len,
512 struct Session *session,
513 const struct GNUNET_ATS_Information *ats,
520 setup_plugin_environment ()
524 env.my_identity = &my_identity;
525 env.max_connections = max_connect_per_transport;
527 env.receive = &env_receive;
528 env.notify_address = &env_notify_address;
529 env.get_address_type = &env_get_address_type;
530 env.update_address_metrics = &env_update_metrics;
531 env.get_our_hello = &env_get_our_hello;
532 env.session_end = &env_session_end;
537 handle_helper_message (void *cls, void *client,
538 const struct GNUNET_MessageHeader *hdr)
548 * @param c configuration to use
551 run (void *cls, char *const *args, const char *cfgfile,
552 const struct GNUNET_CONFIGURATION_Handle *c)
554 char *const *argv = cls;
555 unsigned long long tneigh;
560 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
563 /* parse configuration */
564 if ( (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
568 (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
569 "PEER", "PRIVATE_KEY",
572 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
573 "Transport service is lacking key configuration settings. Exiting.\n");
577 if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
579 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
580 "Could not create statistics. Exiting.\n");
585 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
587 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
588 "Hostkey `%s' missing. Exiting.\n",
590 GNUNET_free (keyfile);
595 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
597 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
598 "Could not create a directory for hostkey `%s'. Exiting.\n",
600 GNUNET_free (keyfile);
605 if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
607 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
608 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
609 HOSTKEY_FILE, keyfile);
610 GNUNET_free (keyfile);
616 max_connect_per_transport = (uint32_t) tneigh;
617 my_private_key = GNUNET_CRYPTO_ecc_key_create_from_file (keyfile);
618 GNUNET_free (keyfile);
619 if (NULL == my_private_key)
621 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
622 "Could not access hostkey. Exiting.\n");
626 GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
627 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
628 &my_identity.hashPubKey);
631 hello = GNUNET_HELLO_create(&my_public_key, NULL, NULL, GNUNET_NO);
633 /* load plugins... */
634 setup_plugin_environment ();
636 GNUNET_assert (strlen (argv[0]) > strlen ("test_plugin_"));
637 plugin = strstr(argv[0],"test_plugin_");
638 sep = strrchr(argv[0],'.');
641 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
645 plugin += strlen ("test_plugin_");
649 /* Hack for WLAN: start a second helper */
650 if (0 == strcmp (plugin, "wlan"))
652 char * helper_argv[3];
653 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
654 helper_argv[1] = (char *) "2";
655 helper_argv[2] = NULL;
656 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
657 "gnunet-helper-transport-wlan-dummy",
659 &handle_helper_message,
665 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
666 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
667 api = GNUNET_PLUGIN_load (libname, &env);
670 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
671 "Failed to load transport plugin for %s\n", plugin);
676 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
678 /* Check if all functions are implemented */
679 if (NULL == api->address_pretty_printer)
685 if (NULL == api->address_to_string)
691 GNUNET_assert (NULL != api->check_address);
692 if (NULL == api->check_address)
698 GNUNET_assert (NULL != api->disconnect);
699 if (NULL == api->disconnect)
705 GNUNET_assert (NULL != api->get_session);
706 if (NULL == api->get_session)
712 if (NULL == api->address_pretty_printer)
718 if (NULL == api->string_to_address)
729 * The main function for the test
731 * @param argc number of arguments from the command line
732 * @param argv command line arguments
733 * @return 0 ok, 1 on error
736 main (int argc, char *const *argv)
738 static struct GNUNET_GETOPT_CommandLineOption options[] = {
739 GNUNET_GETOPT_OPTION_END
743 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
745 char *const argv_prog[] = {
746 "test_plugin_transport",
748 "test_plugin_transport_data.conf",
751 GNUNET_log_setup ("test-plugin-transport",
754 ok = 1; /* set to fail */
755 ret = (GNUNET_OK == GNUNET_PROGRAM_run (3,
757 "test-plugin-transport",
761 (void *) argv)) ? ok : 1;
762 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
766 /* end of test_plugin_transport.c */