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;
345 struct AddressWrapper *wtmp;
349 if (GNUNET_YES == add_remove)
351 addresses_reported ++;
352 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
353 "Adding address of length %u\n", addrlen);
355 for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
357 if ((addrlen == wtmp->addrlen) && (0 == memcmp (addr, wtmp->addr, addrlen)))
359 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
360 "Duplicate address notification .... \n");
365 w = GNUNET_new (struct AddressWrapper);
366 w->addr = GNUNET_malloc (addrlen);
367 w->addrlen = addrlen;
368 memcpy (w->addr, addr, addrlen);
369 GNUNET_CONTAINER_DLL_insert(head, tail, w);
370 got_reply = GNUNET_NO;
371 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
372 "Testing: address_to_string \n");
373 w->addrstring = strdup (api->address_to_string (api, w->addr, w->addrlen));
374 if (NULL == w->addrstring)
377 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
378 "Plugin cannot convert address to string!\n");
384 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
385 "Plugin added address `%s'\n", w->addrstring);
386 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
387 "Testing address_to_string: OK\n");
390 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
391 "Testing: string_to_address \n");
394 if ((GNUNET_OK != api->string_to_address (api, w->addrstring, strlen (w->addrstring)+1, &s2a, &s2a_len)) || (NULL == s2a))
397 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
398 "Plugin cannot convert string to address!\n");
404 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
405 "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
408 for (c1 = 0; c1 < s2a_len; c1++ )
409 fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
411 if (s2a_len != w->addrlen)
413 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
414 "Plugin creates different address length when converting address->string->address: %u != %u\n", w->addrlen, s2a_len);
416 else if (0 != memcmp (s2a, w->addr, s2a_len))
418 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
419 "Plugin creates different address length when converting back and forth %i!\n", memcmp (s2a, w->addr, s2a_len));
423 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
424 "Testing string_to_address: OK\n");
428 pretty_printers_running ++;
429 api->address_pretty_printer (api->cls, plugin, addr, addrlen,
430 GNUNET_YES, GNUNET_TIME_UNIT_MINUTES,
431 &address_pretty_printer_cb,
434 if (GNUNET_OK != api->check_address (api->cls, w->addr, w->addrlen))
437 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
438 "Plugin refuses added address!\n");
442 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
444 GNUNET_SCHEDULER_cancel (timeout_wait);
445 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
448 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
451 else if (GNUNET_NO == add_remove)
453 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
454 "Removing address of length %u\n", addrlen);
459 if ((addrlen == w->addrlen) && (0 == memcmp (w->addr, addr, addrlen)))
469 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
470 "Plugin removes address never added!\n");
475 GNUNET_CONTAINER_DLL_remove (head, tail, w);
476 GNUNET_free (w->addr);
477 GNUNET_free (w->addrstring);
483 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
484 "Invalid operation: %u\n", add_remove);
491 static struct GNUNET_ATS_Information
492 env_get_address_type (void *cls,
493 const struct sockaddr *addr,
496 struct GNUNET_ATS_Information ats;
497 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
498 ats.value = htonl (GNUNET_ATS_NET_LOOPBACK);
503 static const struct GNUNET_MessageHeader *
506 return (const struct GNUNET_MessageHeader *) hello;
511 env_session_end (void *cls,
512 const struct GNUNET_PeerIdentity *peer,
513 struct Session * session)
519 env_update_metrics (void *cls,
520 const struct GNUNET_PeerIdentity *peer,
522 uint16_t address_len,
523 struct Session *session,
524 const struct GNUNET_ATS_Information *ats,
531 setup_plugin_environment ()
535 env.my_identity = &my_identity;
536 env.max_connections = max_connect_per_transport;
538 env.receive = &env_receive;
539 env.notify_address = &env_notify_address;
540 env.get_address_type = &env_get_address_type;
541 env.update_address_metrics = &env_update_metrics;
542 env.get_our_hello = &env_get_our_hello;
543 env.session_end = &env_session_end;
548 handle_helper_message (void *cls, void *client,
549 const struct GNUNET_MessageHeader *hdr)
559 * @param c configuration to use
562 run (void *cls, char *const *args, const char *cfgfile,
563 const struct GNUNET_CONFIGURATION_Handle *c)
565 char *const *argv = cls;
566 unsigned long long tneigh;
571 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
574 /* parse configuration */
575 if ( (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
579 (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
580 "PEER", "PRIVATE_KEY",
583 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
584 "Transport service is lacking key configuration settings. Exiting.\n");
588 if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
590 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
591 "Could not create statistics. Exiting.\n");
596 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
598 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
599 "Hostkey `%s' missing. Exiting.\n",
601 GNUNET_free (keyfile);
606 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
608 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
609 "Could not create a directory for hostkey `%s'. Exiting.\n",
611 GNUNET_free (keyfile);
616 if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
618 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
619 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
620 HOSTKEY_FILE, keyfile);
621 GNUNET_free (keyfile);
627 max_connect_per_transport = (uint32_t) tneigh;
628 my_private_key = GNUNET_CRYPTO_ecc_key_create_from_file (keyfile);
629 GNUNET_free (keyfile);
630 if (NULL == my_private_key)
632 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
633 "Could not access hostkey. Exiting.\n");
637 GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
638 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
639 &my_identity.hashPubKey);
642 hello = GNUNET_HELLO_create(&my_public_key, NULL, NULL, GNUNET_NO);
644 /* load plugins... */
645 setup_plugin_environment ();
647 GNUNET_assert (strlen (argv[0]) > strlen ("test_plugin_"));
648 plugin = strstr(argv[0],"test_plugin_");
649 sep = strrchr(argv[0],'.');
652 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
656 plugin += strlen ("test_plugin_");
660 /* Hack for WLAN: start a second helper */
661 if (0 == strcmp (plugin, "wlan"))
663 char * helper_argv[3];
664 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
665 helper_argv[1] = (char *) "2";
666 helper_argv[2] = NULL;
667 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
668 "gnunet-helper-transport-wlan-dummy",
670 &handle_helper_message,
676 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
677 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
678 api = GNUNET_PLUGIN_load (libname, &env);
681 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
682 "Failed to load transport plugin for %s\n", plugin);
687 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
689 /* Check if all functions are implemented */
690 if (NULL == api->address_pretty_printer)
696 if (NULL == api->address_to_string)
702 GNUNET_assert (NULL != api->check_address);
703 if (NULL == api->check_address)
709 GNUNET_assert (NULL != api->disconnect);
710 if (NULL == api->disconnect)
716 GNUNET_assert (NULL != api->get_session);
717 if (NULL == api->get_session)
723 if (NULL == api->address_pretty_printer)
729 if (NULL == api->string_to_address)
740 * The main function for the test
742 * @param argc number of arguments from the command line
743 * @param argv command line arguments
744 * @return 0 ok, 1 on error
747 main (int argc, char *const *argv)
749 static struct GNUNET_GETOPT_CommandLineOption options[] = {
750 GNUNET_GETOPT_OPTION_END
754 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
756 char *const argv_prog[] = {
757 "test_plugin_transport",
759 "test_plugin_transport_data.conf",
762 GNUNET_log_setup ("test-plugin-transport",
765 ok = 1; /* set to fail */
766 ret = (GNUNET_OK == GNUNET_PROGRAM_run (3,
768 "test-plugin-transport",
772 (void *) argv)) ? ok : 1;
773 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
777 /* end of test_plugin_transport.c */