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_util_lib.h"
29 #include "gnunet_hello_lib.h"
30 #include "gnunet_peerinfo_service.h"
31 #include "gnunet_statistics_service.h"
32 #include "gnunet_protocols.h"
33 #include "gnunet_transport_plugin.h"
34 #include "transport.h"
37 * How long until we give up on transmitting the message?
39 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
40 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
42 #define HOSTKEY_FILE "test_plugin_hostkey.ecc"
47 static struct GNUNET_PeerIdentity my_identity;
52 static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
57 const struct GNUNET_CONFIGURATION_Handle *cfg;
62 struct GNUNET_STATISTICS_Handle *stats;
67 struct GNUNET_HELLO_Message *hello;
70 * Number of neighbours we'd like to have.
72 static uint32_t max_connect_per_transport;
75 * Environment for this plugin.
77 struct GNUNET_TRANSPORT_PluginEnvironment env;
80 *handle for the api provided by this plugin
82 struct GNUNET_TRANSPORT_PluginFunctions *api;
87 struct GNUNET_HELPER_Handle *suid_helper;
92 static GNUNET_SCHEDULER_TaskIdentifier timeout_endbadly;
97 static GNUNET_SCHEDULER_TaskIdentifier timeout_wait;
102 static char *libname;
105 * Plugin addresses head
107 struct AddressWrapper *head;
110 * Plugin addresses tail
112 struct AddressWrapper *tail;
114 unsigned int addresses_reported;
116 unsigned int pretty_printers_running;
119 * Did the test pass or fail?
123 struct AddressWrapper
125 struct AddressWrapper *next;
127 struct AddressWrapper *prev;
129 struct GNUNET_HELLO_Address *address;
137 struct AddressWrapper *w;
141 if (GNUNET_SCHEDULER_NO_TASK != timeout_endbadly)
143 GNUNET_SCHEDULER_cancel (timeout_endbadly);
144 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
147 GNUNET_PLUGIN_unload (libname, api);
152 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove address `%s'\n",
154 GNUNET_CONTAINER_DLL_remove(head, tail, w);
156 GNUNET_HELLO_address_free(w->address);
157 GNUNET_free(w->addrstring);
163 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses \n",
168 GNUNET_free(libname);
170 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
173 if (NULL != suid_helper)
175 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
181 end_badly (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
183 struct AddressWrapper *w;
186 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
187 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
189 GNUNET_SCHEDULER_cancel (timeout_wait);
190 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
193 if (pretty_printers_running > 0)
195 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
197 GNUNET_log(GNUNET_ERROR_TYPE_INFO,
198 "Have pending calls to pretty_printer ... deferring shutdown\n");
204 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
205 "Test took too long to execute, timeout .... \n");
211 GNUNET_PLUGIN_unload (libname, api);
212 GNUNET_free(libname);
219 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove address `%s'\n",
221 GNUNET_CONTAINER_DLL_remove(head, tail, w);
223 GNUNET_HELLO_address_free(w->address);
224 GNUNET_free(w->addrstring);
230 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses\n",
236 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
240 if (NULL != suid_helper)
242 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
250 wait_end (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
252 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
253 if (0 == addresses_reported)
254 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
255 "Plugin did not report any addresses, could not check address conversion functions\n");
262 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
264 GNUNET_SCHEDULER_cancel (timeout_wait);
265 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
267 if (GNUNET_SCHEDULER_NO_TASK != timeout_endbadly)
269 GNUNET_SCHEDULER_cancel (timeout_endbadly);
270 timeout_endbadly = GNUNET_SCHEDULER_NO_TASK;
272 timeout_endbadly = GNUNET_SCHEDULER_add_now (&end_badly, NULL );
275 static struct GNUNET_TIME_Relative
276 env_receive (void *cls,
277 const struct GNUNET_HELLO_Address *address,
278 struct Session *session,
279 const struct GNUNET_MessageHeader *message)
282 return GNUNET_TIME_relative_get_zero_ ();
285 static int got_reply;
288 * Take the given address and append it to the set of results sent back to
291 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
292 * @param buf text to transmit
295 address_pretty_printer_cb (void *cls, const char *buf)
299 got_reply = GNUNET_YES;
300 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Pretty address : `%s'\n", buf);
301 pretty_printers_running--;
305 if (GNUNET_NO == got_reply)
307 pretty_printers_running--;
315 env_notify_address (void *cls, int add_remove,
316 const struct GNUNET_HELLO_Address *address)
318 struct AddressWrapper *w;
319 struct AddressWrapper *wtmp;
323 if (GNUNET_YES == add_remove)
325 addresses_reported++;
326 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Adding address of length %u\n",
327 address->address_length);
329 for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
331 if ((address->address_length == wtmp->address->address_length) &&
332 (0 == memcmp (address->address, wtmp->address->address, address->address_length)))
334 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
335 "Duplicate address notification .... \n");
340 w = GNUNET_new (struct AddressWrapper);
341 w->address = GNUNET_HELLO_address_copy (address);
342 GNUNET_CONTAINER_DLL_insert(head, tail, w);
343 got_reply = GNUNET_NO;
344 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing: address_to_string \n");
345 w->addrstring = strdup (
346 api->address_to_string (api, w->address->address,
347 w->address->address_length));
348 if (NULL == w->addrstring)
351 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
352 "Plugin cannot convert address to string!\n");
358 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Plugin added address `%s'\n",
360 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing address_to_string: OK\n");
363 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing: string_to_address \n");
367 != api->string_to_address (api, w->addrstring,
368 strlen (w->addrstring) + 1, &s2a, &s2a_len)) || (NULL == s2a))
371 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
372 "Plugin cannot convert string to address!\n");
378 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
379 "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
382 for (c1 = 0; c1 < s2a_len; c1++ )
383 fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
385 if (s2a_len != w->address->address_length)
387 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
388 "Plugin creates different address length when converting address->string->address: %u != %u\n",
389 w->address->address_length, s2a_len);
391 else if (0 != memcmp (s2a, w->address->address, s2a_len))
393 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
394 "Plugin creates different address length when converting back and forth %i!\n",
395 memcmp (s2a, w->address->address, s2a_len));
399 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Testing string_to_address: OK\n");
403 pretty_printers_running++;
404 api->address_pretty_printer (api->cls, address->transport_name, address->address, address->address_length, GNUNET_YES,
405 GNUNET_TIME_UNIT_MINUTES, &address_pretty_printer_cb, w);
407 if (GNUNET_OK != api->check_address (api->cls, w->address->address, w->address->address_length))
410 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin refuses added address!\n");
414 if (GNUNET_SCHEDULER_NO_TASK != timeout_wait)
416 GNUNET_SCHEDULER_cancel (timeout_wait);
417 timeout_wait = GNUNET_SCHEDULER_NO_TASK;
420 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
423 else if (GNUNET_NO == add_remove)
425 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Removing address of length %u\n",
426 address->address_length);
431 if ((address->address_length == w->address->address_length) &&
432 (0 == memcmp (w->address->address, address->address, address->address_length)))
442 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
443 "Plugin removes address never added!\n");
448 GNUNET_CONTAINER_DLL_remove(head, tail, w);
449 GNUNET_HELLO_address_free (w->address);
450 GNUNET_free(w->addrstring);
456 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Invalid operation: %u\n", add_remove);
462 static struct GNUNET_ATS_Information
463 env_get_address_type (void *cls, const struct sockaddr *addr, size_t addrlen)
465 struct GNUNET_ATS_Information ats;
466 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
467 ats.value = htonl (GNUNET_ATS_NET_LOOPBACK);
471 static const struct GNUNET_MessageHeader *
474 return (const struct GNUNET_MessageHeader *) hello;
478 env_session_end (void *cls,
479 const struct GNUNET_HELLO_Address *address,
480 struct Session *session)
486 env_update_metrics (void *cls,
487 const struct GNUNET_HELLO_Address *address,
488 struct Session *session,
489 const struct GNUNET_ATS_Information *ats,
495 setup_plugin_environment ()
499 env.my_identity = &my_identity;
500 env.max_connections = max_connect_per_transport;
502 env.receive = &env_receive;
503 env.notify_address = &env_notify_address;
504 env.get_address_type = &env_get_address_type;
505 env.update_address_metrics = &env_update_metrics;
506 env.get_our_hello = &env_get_our_hello;
507 env.session_end = &env_session_end;
511 handle_helper_message (void *cls, void *client,
512 const struct GNUNET_MessageHeader *hdr)
521 * @param c configuration to use
524 run (void *cls, char * const *args, const char *cfgfile,
525 const struct GNUNET_CONFIGURATION_Handle *c)
527 char * const *argv = cls;
528 unsigned long long tneigh;
533 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT, end_badly, &ok);
536 /* parse configuration */
538 != GNUNET_CONFIGURATION_get_value_number (c, "TRANSPORT",
539 "NEIGHBOUR_LIMIT", &tneigh))
541 != GNUNET_CONFIGURATION_get_value_filename (c, "PEER", "PRIVATE_KEY",
544 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
545 "Transport service is lacking key configuration settings. Exiting.\n");
549 if (NULL == (stats = GNUNET_STATISTICS_create ("transport", cfg)))
551 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
552 "Could not create statistics. Exiting.\n");
553 GNUNET_free(keyfile);
558 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
560 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Hostkey `%s' missing. Exiting.\n",
562 GNUNET_free(keyfile);
567 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (keyfile))
569 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
570 "Could not create a directory for hostkey `%s'. Exiting.\n", keyfile);
571 GNUNET_free(keyfile);
576 if (GNUNET_OK != GNUNET_DISK_file_copy (HOSTKEY_FILE, keyfile))
578 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
579 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
580 HOSTKEY_FILE, keyfile);
581 GNUNET_free(keyfile);
586 max_connect_per_transport = (uint32_t) tneigh;
587 my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
588 GNUNET_free(keyfile);
589 if (NULL == my_private_key)
591 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
592 "Could not access hostkey. Exiting.\n");
596 GNUNET_CRYPTO_eddsa_key_get_public (my_private_key, &my_identity.public_key);
598 hello = GNUNET_HELLO_create (&my_identity.public_key, NULL, NULL, GNUNET_NO);
600 /* load plugins... */
601 setup_plugin_environment ();
603 GNUNET_assert(strlen (argv[0]) > strlen ("test_plugin_"));
604 plugin = strstr (argv[0], "test_plugin_");
605 sep = strrchr (argv[0], '.');
608 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
612 plugin += strlen ("test_plugin_");
616 /* Hack for WLAN: start a second helper */
617 if (0 == strcmp (plugin, "wlan"))
619 char * helper_argv[3];
620 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
621 helper_argv[1] = (char *) "2";
622 helper_argv[2] = NULL;
623 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
624 "gnunet-helper-transport-wlan-dummy", helper_argv,
625 &handle_helper_message, NULL, NULL );
629 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
630 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
631 api = GNUNET_PLUGIN_load (libname, &env);
634 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
635 "Failed to load transport plugin for %s\n", plugin);
640 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
642 /* Check if all functions are implemented */
643 if (NULL == api->address_pretty_printer)
649 if (NULL == api->address_to_string)
655 GNUNET_assert(NULL != api->check_address);
656 if (NULL == api->check_address)
662 GNUNET_assert(NULL != api->disconnect_peer);
663 if (NULL == api->disconnect_peer)
669 GNUNET_assert(NULL != api->get_session);
670 if (NULL == api->get_session)
676 if (NULL == api->address_pretty_printer)
682 if (NULL == api->string_to_address)
692 * The main function for the test
694 * @param argc number of arguments from the command line
695 * @param argv command line arguments
696 * @return 0 ok, 1 on error
699 main (int argc, char * const *argv)
701 static struct GNUNET_GETOPT_CommandLineOption options[] = {
702 GNUNET_GETOPT_OPTION_END };
705 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
707 char * const argv_prog[] = { "test_plugin_transport", "-c",
708 "test_plugin_transport_data.conf", NULL };
709 GNUNET_log_setup ("test-plugin-transport", "WARNING", NULL );
710 ok = 1; /* set to fail */
713 == GNUNET_PROGRAM_run (3, argv_prog, "test-plugin-transport",
714 "testcase", options, &run, (void *) argv)) ? ok : 1;
715 GNUNET_DISK_directory_remove ("/tmp/test-gnunetd-plugin-transport");
719 /* end of test_plugin_transport.c */