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;
200 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
201 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
203 GNUNET_SCHEDULER_cancel (timeout_wait);
204 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
207 if (pretty_printers_running > 0)
209 timeout_endbadly = GNUNET_SCHEDULER_add_delayed(GNUNET_TIME_UNIT_SECONDS, &end_badly, &ok);
210 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
211 "Have pending calls to pretty_printer ... deferring shutdown\n");
217 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
218 "Test took too long to execute, timeout .... \n");
224 GNUNET_PLUGIN_unload (libname, api);
225 GNUNET_free (libname);
232 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
233 "Plugin did not remove address `%s'\n", w->addrstring);
234 GNUNET_CONTAINER_DLL_remove (head, tail, w);
236 GNUNET_free (w->addr);
237 GNUNET_free (w->addrstring);
243 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
244 "Plugin did not remove %u addresses\n", c);
249 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
253 if (NULL != suid_helper)
255 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
264 wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
266 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
267 if (0 == addresses_reported)
268 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
269 "Plugin did not report any addresses, could not check address conversion functions\n");
277 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
279 GNUNET_SCHEDULER_cancel (timeout_wait);
280 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
282 if (GNUNET_SCHEDULER_NO_TASK != timeout_endbadly)
284 GNUNET_SCHEDULER_cancel (timeout_endbadly);
285 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
287 timeout_endbadly = GNUNET_SCHEDULER_add_now (&end_badly, NULL);
291 static struct GNUNET_TIME_Relative
292 env_receive (void *cls,
293 const struct GNUNET_PeerIdentity *peer,
294 const struct GNUNET_MessageHeader *message,
295 struct Session * session,
296 const char *sender_address,
297 uint16_t sender_address_len)
300 return GNUNET_TIME_relative_get_zero_();
304 static int got_reply;
308 * Take the given address and append it to the set of results sent back to
311 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
312 * @param buf text to transmit
315 address_pretty_printer_cb (void *cls, const char *buf)
319 got_reply = GNUNET_YES;
320 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
321 "Pretty address : `%s'\n", buf);
322 pretty_printers_running --;
326 if (GNUNET_NO == got_reply)
328 pretty_printers_running --;
337 env_notify_address (void *cls,
343 struct AddressWrapper *w;
347 if (GNUNET_YES == add_remove)
349 addresses_reported ++;
350 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
351 "Adding address of length %u\n", addrlen);
353 w = GNUNET_malloc (sizeof (struct AddressWrapper));
354 w->addr = GNUNET_malloc (addrlen);
355 w->addrlen = addrlen;
356 memcpy (w->addr, addr, addrlen);
357 GNUNET_CONTAINER_DLL_insert(head, tail, w);
358 got_reply = GNUNET_NO;
359 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
360 "Testing: address_to_string \n");
361 w->addrstring = strdup (api->address_to_string (api, w->addr, w->addrlen));
362 if (NULL == w->addrstring)
365 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
366 "Plugin cannot convert address to string!\n");
372 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
373 "Plugin added address `%s'\n", w->addrstring);
374 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
375 "Testing address_to_string: OK\n");
378 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
379 "Testing: string_to_address \n");
382 if ((GNUNET_OK != api->string_to_address (api, w->addrstring, strlen (w->addrstring)+1, &s2a, &s2a_len)) || (NULL == s2a))
385 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
386 "Plugin cannot convert string to address!\n");
392 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
393 "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
396 for (c1 = 0; c1 < s2a_len; c1++ )
397 fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
399 if (s2a_len != w->addrlen)
401 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
402 "Plugin creates different address length when converting address->string->address: %u != %u\n", w->addrlen, s2a_len);
404 else if (0 != memcmp (s2a, w->addr, s2a_len))
406 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
407 "Plugin creates different address length when converting back and forth %i!\n", memcmp (s2a, w->addr, s2a_len));
411 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
412 "Testing string_to_address: OK\n");
416 pretty_printers_running ++;
417 api->address_pretty_printer (api->cls, plugin, addr, addrlen,
418 GNUNET_YES, GNUNET_TIME_UNIT_MINUTES,
419 &address_pretty_printer_cb,
422 if (GNUNET_OK != api->check_address (api->cls, w->addr, w->addrlen))
425 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
426 "Plugin refuses added address!\n");
430 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
432 GNUNET_SCHEDULER_cancel (timeout_wait);
433 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
436 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
439 else if (GNUNET_NO == add_remove)
441 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
442 "Removing address of length %u\n", addrlen);
447 if ((addrlen == w->addrlen) && (0 == memcmp (w->addr, addr, addrlen)))
457 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
458 "Plugin removes address never added!\n");
463 GNUNET_CONTAINER_DLL_remove (head, tail, w);
464 GNUNET_free (w->addr);
465 GNUNET_free (w->addrstring);
471 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
472 "Invalid operation: %u\n", add_remove);
479 static struct GNUNET_ATS_Information
480 env_get_address_type (void *cls,
481 const struct sockaddr *addr,
484 struct GNUNET_ATS_Information ats;
485 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
486 ats.value = htonl (GNUNET_ATS_NET_LOOPBACK);
491 static const struct GNUNET_MessageHeader *
494 return (const struct GNUNET_MessageHeader *) hello;
499 env_session_end (void *cls,
500 const struct GNUNET_PeerIdentity *peer,
501 struct Session * session)
507 env_update_metrics (void *cls,
508 const struct GNUNET_PeerIdentity *peer,
510 uint16_t address_len,
511 struct Session *session,
512 const struct GNUNET_ATS_Information *ats,
519 setup_plugin_environment ()
523 env.my_identity = &my_identity;
524 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;
536 handle_helper_message (void *cls, void *client,
537 const struct GNUNET_MessageHeader *hdr)
547 * @param c configuration to use
550 run (void *cls, char *const *args, const char *cfgfile,
551 const struct GNUNET_CONFIGURATION_Handle *c)
553 char *const *argv = cls;
554 unsigned long long tneigh;
559 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
562 /* parse configuration */
563 if ( (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
567 (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
568 "PEER", "PRIVATE_KEY",
571 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
572 "Transport service is lacking key configuration settings. Exiting.\n");
576 if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
578 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
579 "Could not create statistics. Exiting.\n");
584 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
586 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
587 "Hostkey `%s' missing. Exiting.\n",
589 GNUNET_free (keyfile);
594 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
596 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
597 "Could not create a directory for hostkey `%s'. Exiting.\n",
599 GNUNET_free (keyfile);
604 if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
606 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
607 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
608 HOSTKEY_FILE, keyfile);
609 GNUNET_free (keyfile);
615 max_connect_per_transport = (uint32_t) tneigh;
616 my_private_key = GNUNET_CRYPTO_ecc_key_create_from_file (keyfile);
617 GNUNET_free (keyfile);
618 if (NULL == my_private_key)
620 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
621 "Could not access hostkey. Exiting.\n");
625 GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
626 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
627 &my_identity.hashPubKey);
630 hello = GNUNET_HELLO_create(&my_public_key, NULL, NULL, GNUNET_NO);
632 /* load plugins... */
633 setup_plugin_environment ();
635 GNUNET_assert (strlen (argv[0]) > strlen ("test_plugin_"));
636 plugin = strstr(argv[0],"test_plugin_");
637 sep = strrchr(argv[0],'.');
640 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
644 plugin += strlen ("test_plugin_");
648 /* Hack for WLAN: start a second helper */
649 if (0 == strcmp (plugin, "wlan"))
651 char * helper_argv[3];
652 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
653 helper_argv[1] = (char *) "2";
654 helper_argv[2] = NULL;
655 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
656 "gnunet-helper-transport-wlan-dummy",
658 &handle_helper_message,
664 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
665 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
666 api = GNUNET_PLUGIN_load (libname, &env);
669 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
670 "Failed to load transport plugin for %s\n", plugin);
675 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
677 /* Check if all functions are implemented */
678 if (NULL == api->address_pretty_printer)
684 if (NULL == api->address_to_string)
690 GNUNET_assert (NULL != api->check_address);
691 if (NULL == api->check_address)
697 GNUNET_assert (NULL != api->disconnect);
698 if (NULL == api->disconnect)
704 GNUNET_assert (NULL != api->get_session);
705 if (NULL == api->get_session)
711 if (NULL == api->address_pretty_printer)
717 if (NULL == api->string_to_address)
728 * The main function for the test
730 * @param argc number of arguments from the command line
731 * @param argv command line arguments
732 * @return 0 ok, 1 on error
735 main (int argc, char *const *argv)
737 static struct GNUNET_GETOPT_CommandLineOption options[] = {
738 GNUNET_GETOPT_OPTION_END
742 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
744 char *const argv_prog[] = {
745 "test_plugin_transport",
747 "test_plugin_transport_data.conf",
750 GNUNET_log_setup ("test-plugin-transport",
753 ok = 1; /* set to fail */
754 ret = (GNUNET_OK == GNUNET_PROGRAM_run (3,
756 "test-plugin-transport",
760 (void *) argv)) ? ok : 1;
761 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
765 /* end of test_plugin_transport.c */