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_EccPublicKeyBinaryEncoded 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;
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_malloc (sizeof (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 pretty_printers_running ++;
361 api->address_pretty_printer (api->cls, plugin, addr, addrlen,
362 GNUNET_YES, GNUNET_TIME_UNIT_MINUTES,
363 &address_pretty_printer_cb,
366 a2s = strdup (api->address_to_string (api, w->addr, w->addrlen));
370 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
371 "Plugin cannot convert address to string!\n");
375 w->addrstring = strdup (api->address_to_string (api, w->addr, w->addrlen));
376 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
377 "Plugin added address `%s'\n", a2s);
379 if ((GNUNET_OK != api->string_to_address (api, a2s, strlen (a2s)+1, &s2a, &s2a_len)) || (NULL == s2a))
382 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
383 "Plugin cannot convert string to address!\n");
388 if (s2a_len != w->addrlen)
390 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
391 "Plugin creates different address length when converting address->string->address: %u != %u\n", w->addrlen, s2a_len);
395 if (0 != memcmp (s2a, w->addr, s2a_len))
396 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
397 "Plugin creates different address length when connecting back and forth!\n");
401 if (GNUNET_OK != api->check_address (api->cls, w->addr, w->addrlen))
404 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
405 "Plugin refuses added address!\n");
409 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
411 GNUNET_SCHEDULER_cancel (timeout_wait);
412 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
415 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
418 else if (GNUNET_NO == add_remove)
420 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
421 "Removing address of length %u\n", addrlen);
426 if ((addrlen == w->addrlen) && (0 == memcmp (w->addr, addr, addrlen)))
436 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
437 "Plugin removes address never added!\n");
442 GNUNET_CONTAINER_DLL_remove (head, tail, w);
443 GNUNET_free (w->addr);
444 GNUNET_free (w->addrstring);
450 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
451 "Invalid operation: %u\n", add_remove);
458 static struct GNUNET_ATS_Information
459 env_get_address_type (void *cls,
460 const struct sockaddr *addr,
463 struct GNUNET_ATS_Information ats;
464 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
465 ats.value = htonl (GNUNET_ATS_NET_LOOPBACK);
470 static const struct GNUNET_MessageHeader *
473 return (const struct GNUNET_MessageHeader *) hello;
478 env_session_end (void *cls,
479 const struct GNUNET_PeerIdentity *peer,
480 struct Session * session)
486 env_update_metrics (void *cls,
487 const struct GNUNET_PeerIdentity *peer,
489 uint16_t address_len,
490 struct Session *session,
491 const struct GNUNET_ATS_Information *ats,
498 setup_plugin_environment ()
502 env.my_identity = &my_identity;
503 env.max_connections = max_connect_per_transport;
506 env.receive = &env_receive;
507 env.notify_address = &env_notify_address;
508 env.get_address_type = &env_get_address_type;
509 env.update_address_metrics = &env_update_metrics;
510 env.get_our_hello = &env_get_our_hello;
511 env.session_end = &env_session_end;
515 handle_helper_message (void *cls, void *client,
516 const struct GNUNET_MessageHeader *hdr)
526 * @param c configuration to use
529 run (void *cls, char *const *args, const char *cfgfile,
530 const struct GNUNET_CONFIGURATION_Handle *c)
532 char *const *argv = cls;
533 unsigned long long tneigh;
538 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
541 /* parse configuration */
542 if ( (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (c,
546 (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (c,
547 "PEER", "PRIVATE_KEY",
550 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
551 "Transport service is lacking key configuration settings. Exiting.\n");
555 if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
557 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
558 "Could not create statistics. Exiting.\n");
563 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
565 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
566 "Hostkey `%s' missing. Exiting.\n",
570 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
572 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
573 "Could not create a directory for hostkey `%s'. Exiting.\n",
579 if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
581 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
582 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
583 HOSTKEY_FILE, keyfile);
589 max_connect_per_transport = (uint32_t) tneigh;
590 my_private_key = GNUNET_CRYPTO_ecc_key_create_from_file (keyfile);
591 GNUNET_free (keyfile);
592 if (NULL == my_private_key)
594 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
595 "Could not access hostkey. Exiting.\n");
599 GNUNET_CRYPTO_ecc_key_get_public (my_private_key, &my_public_key);
600 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
601 &my_identity.hashPubKey);
604 hello = GNUNET_HELLO_create(&my_public_key, NULL, NULL, GNUNET_NO);
606 /* load plugins... */
607 setup_plugin_environment ();
609 GNUNET_assert (strlen (argv[0]) > strlen ("test_plugin_"));
610 plugin = strstr(argv[0],"test_plugin_");
611 sep = strrchr(argv[0],'.');
614 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
618 plugin += strlen ("test_plugin_");
622 /* Hack for WLAN: start a second helper */
623 if (0 == strcmp (plugin, "wlan"))
625 char * helper_argv[3];
626 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
627 helper_argv[1] = (char *) "2";
628 helper_argv[2] = NULL;
629 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
630 "gnunet-helper-transport-wlan-dummy",
632 &handle_helper_message,
638 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
639 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
640 api = GNUNET_PLUGIN_load (libname, &env);
643 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
644 "Failed to load transport plugin for %s\n", plugin);
649 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
651 /* Check if all functions are implemented */
652 if (NULL == api->address_pretty_printer)
658 if (NULL == api->address_to_string)
664 GNUNET_assert (NULL != api->check_address);
665 if (NULL == api->check_address)
671 GNUNET_assert (NULL != api->disconnect);
672 if (NULL == api->disconnect)
678 GNUNET_assert (NULL != api->get_session);
679 if (NULL == api->get_session)
685 if (NULL == api->address_pretty_printer)
691 if (NULL == api->string_to_address)
702 * The main function for the test
704 * @param argc number of arguments from the command line
705 * @param argv command line arguments
706 * @return 0 ok, 1 on error
709 main (int argc, char *const *argv)
711 static struct GNUNET_GETOPT_CommandLineOption options[] = {
712 GNUNET_GETOPT_OPTION_END
716 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
718 char *const argv_prog[] = {
719 "test_plugin_transport",
721 "test_plugin_transport_data.conf",
724 GNUNET_log_setup ("test-plugin-transport",
727 ok = 1; /* set to fail */
728 ret = (GNUNET_OK == GNUNET_PROGRAM_run (3,
730 "test-plugin-transport",
734 (void *) argv)) ? ok : 1;
735 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
739 /* end of test_plugin_transport.c */