2 This file is part of GNUnet.
3 Copyright (C) 2009, 2018 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @file transport/test_plugin_transport.c
20 * @brief testcase for transport_api.c
21 * @author Sailor Siraj
22 * @author Christian Grothoff
26 #include "gnunet_util_lib.h"
27 #include "gnunet_hello_lib.h"
28 #include "gnunet_peerinfo_service.h"
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_transport_plugin.h"
32 #include "transport.h"
35 * How long until we give up on transmitting the message?
37 #define WAIT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
38 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
40 #define HOSTKEY_FILE "test_plugin_hostkey.ecc"
45 static struct GNUNET_PeerIdentity my_identity;
50 static struct GNUNET_CRYPTO_EddsaPrivateKey *my_private_key;
55 const struct GNUNET_CONFIGURATION_Handle *cfg;
60 struct GNUNET_STATISTICS_Handle *stats;
65 struct GNUNET_HELLO_Message *hello;
68 * Number of neighbours we'd like to have.
70 static uint32_t max_connect_per_transport;
73 * Environment for this plugin.
75 struct GNUNET_TRANSPORT_PluginEnvironment env;
78 *handle for the api provided by this plugin
80 struct GNUNET_TRANSPORT_PluginFunctions *api;
85 struct GNUNET_HELPER_Handle *suid_helper;
90 static struct GNUNET_SCHEDULER_Task * timeout_endbadly;
95 static struct GNUNET_SCHEDULER_Task * timeout_wait;
100 static char *libname;
103 * Plugin addresses head
105 struct AddressWrapper *head;
108 * Plugin addresses tail
110 struct AddressWrapper *tail;
112 unsigned int addresses_reported;
114 unsigned int pretty_printers_running;
117 * Did the test pass or fail?
121 struct AddressWrapper
123 struct AddressWrapper *next;
125 struct AddressWrapper *prev;
127 struct GNUNET_HELLO_Address *address;
131 struct GNUNET_SCHEDULER_Task *test_task;
139 struct AddressWrapper *w;
143 if (NULL != timeout_endbadly)
145 GNUNET_SCHEDULER_cancel (timeout_endbadly);
146 timeout_endbadly = NULL;
149 GNUNET_PLUGIN_unload (libname, api);
154 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
155 "Plugin did not remove address `%s'\n",
157 GNUNET_CONTAINER_DLL_remove(head, tail, w);
159 GNUNET_HELLO_address_free(w->address);
160 GNUNET_free(w->addrstring);
166 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses \n",
171 GNUNET_free(libname);
173 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
176 if (NULL != suid_helper)
178 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
185 end_badly (void *cls)
187 struct AddressWrapper *w;
190 timeout_endbadly = NULL;
191 if (NULL != timeout_wait)
193 GNUNET_SCHEDULER_cancel (timeout_wait);
197 if (pretty_printers_running > 0)
199 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
201 GNUNET_log(GNUNET_ERROR_TYPE_INFO,
202 "Have pending calls to pretty_printer ... deferring shutdown\n");
208 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
209 "Test took too long to execute, timeout .... \n");
215 GNUNET_PLUGIN_unload (libname, api);
216 GNUNET_free(libname);
223 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove address `%s'\n",
225 GNUNET_CONTAINER_DLL_remove(head, tail, w);
227 GNUNET_HELLO_address_free(w->address);
228 if (NULL != w->test_task)
229 GNUNET_SCHEDULER_cancel (w->test_task);
230 GNUNET_free(w->addrstring);
236 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses\n",
242 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
246 if (NULL != suid_helper)
248 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
259 if (0 == addresses_reported)
260 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
261 "Plugin did not report any addresses, could not check address conversion functions\n");
269 if (NULL != timeout_wait)
271 GNUNET_SCHEDULER_cancel (timeout_wait);
274 if (NULL != timeout_endbadly)
276 GNUNET_SCHEDULER_cancel (timeout_endbadly);
277 timeout_endbadly = NULL;
279 timeout_endbadly = GNUNET_SCHEDULER_add_now (&end_badly, NULL );
283 static struct GNUNET_TIME_Relative
284 env_receive (void *cls,
285 const struct GNUNET_HELLO_Address *address,
286 struct GNUNET_ATS_Session *session,
287 const struct GNUNET_MessageHeader *message)
290 return GNUNET_TIME_relative_get_zero_ ();
293 static int got_reply;
297 * Take the given address and append it to the set of results sent back to
301 * @param address the address to print
302 * @param res result code
305 address_pretty_printer_cb (void *cls, const char *address, int res)
309 got_reply = GNUNET_YES;
310 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Pretty address : `%s'\n", address);
311 pretty_printers_running--;
315 if (GNUNET_NO == got_reply)
317 pretty_printers_running--;
326 test_addr_string (void *cls)
328 struct AddressWrapper *w = cls;
334 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
335 "Testing: address_to_string \n");
336 w->addrstring = GNUNET_strdup (api->address_to_string (api,
338 w->address->address_length));
339 if (NULL == w->addrstring)
342 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
343 "Plugin cannot convert address to string!\n");
347 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
348 "Plugin added address `%s'\n",
350 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
351 "Testing address_to_string: OK\n");
352 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
353 "Testing: string_to_address \n");
357 api->string_to_address (api, w->addrstring,
358 strlen (w->addrstring) + 1,
363 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
364 "Plugin cannot convert string to address!\n");
370 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
371 "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
374 for (c1 = 0; c1 < s2a_len; c1++ )
375 fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
377 if (s2a_len != w->address->address_length)
379 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
380 "Plugin creates different address length when converting address->string->address: %u != %u\n",
381 (unsigned int) w->address->address_length,
382 (unsigned int) s2a_len);
384 else if (0 != memcmp (s2a, w->address->address, s2a_len))
386 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
387 "Plugin creates different address length when converting back and forth %i!\n",
394 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
395 "Testing string_to_address: OK\n");
399 pretty_printers_running++;
400 api->address_pretty_printer (api->cls,
401 w->address->transport_name,
403 w->address->address_length,
405 GNUNET_TIME_UNIT_MINUTES,
406 &address_pretty_printer_cb, w);
409 api->check_address (api->cls,
411 w->address->address_length))
414 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
415 "Plugin refuses added address!\n");
419 if (NULL != timeout_wait)
421 GNUNET_SCHEDULER_cancel (timeout_wait);
424 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
429 env_notify_address (void *cls,
431 const struct GNUNET_HELLO_Address *address)
433 struct AddressWrapper *w;
434 struct AddressWrapper *wtmp;
436 if (GNUNET_YES == add_remove)
438 addresses_reported++;
439 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
440 "Adding address of length %u\n",
441 (unsigned int) address->address_length);
443 for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
445 if ((address->address_length == wtmp->address->address_length) &&
446 (0 == memcmp (address->address, wtmp->address->address, address->address_length)))
448 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
449 "Duplicate address notification .... \n");
454 w = GNUNET_new (struct AddressWrapper);
455 w->address = GNUNET_HELLO_address_copy (address);
456 GNUNET_CONTAINER_DLL_insert (head, tail, w);
457 got_reply = GNUNET_NO;
458 w->test_task = GNUNET_SCHEDULER_add_now (&test_addr_string,
463 if (GNUNET_NO == add_remove)
465 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
466 "Removing address of length %u\n",
467 (unsigned int) address->address_length);
471 if ((address->address_length == w->address->address_length) &&
472 (0 == memcmp (w->address->address, address->address, address->address_length)))
482 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
483 "Plugin removes address never added!\n");
488 GNUNET_CONTAINER_DLL_remove(head, tail, w);
489 GNUNET_HELLO_address_free (w->address);
490 GNUNET_free(w->addrstring);
495 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
496 "Invalid operation: %u\n",
502 static enum GNUNET_ATS_Network_Type
503 env_get_address_type (void *cls,
504 const struct sockaddr *addr,
507 return GNUNET_ATS_NET_LOOPBACK;
511 static const struct GNUNET_MessageHeader *
514 return (const struct GNUNET_MessageHeader *) hello;
519 env_session_end (void *cls,
520 const struct GNUNET_HELLO_Address *address,
521 struct GNUNET_ATS_Session *session)
528 env_update_distance (void *cls,
529 const struct GNUNET_HELLO_Address *address,
536 setup_plugin_environment ()
540 env.my_identity = &my_identity;
541 env.max_connections = max_connect_per_transport;
543 env.receive = &env_receive;
544 env.notify_address = &env_notify_address;
545 env.get_address_type = &env_get_address_type;
546 env.update_address_distance = &env_update_distance;
547 env.get_our_hello = &env_get_our_hello;
548 env.session_end = &env_session_end;
553 handle_helper_message (void *cls,
554 const struct GNUNET_MessageHeader *hdr)
564 * @param c configuration to use
570 const struct GNUNET_CONFIGURATION_Handle *c)
572 char * const *argv = cls;
573 unsigned long long tneigh;
578 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
582 /* parse configuration */
584 GNUNET_CONFIGURATION_get_value_number (c,
589 GNUNET_CONFIGURATION_get_value_filename (c,
594 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
595 "Transport service is lacking key configuration settings. Exiting.\n");
599 if (NULL == (stats = GNUNET_STATISTICS_create ("transport",
602 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
603 "Could not create statistics. Exiting.\n");
604 GNUNET_free(keyfile);
609 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
611 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
612 "Hostkey `%s' missing. Exiting.\n",
614 GNUNET_free(keyfile);
620 GNUNET_DISK_directory_create_for_file (keyfile))
622 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
623 "Could not create a directory for hostkey `%s'. Exiting.\n",
625 GNUNET_free(keyfile);
631 GNUNET_DISK_file_copy (HOSTKEY_FILE,
634 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
635 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
638 GNUNET_free(keyfile);
643 max_connect_per_transport = (uint32_t) tneigh;
644 my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
645 GNUNET_free(keyfile);
646 if (NULL == my_private_key)
648 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
649 "Could not access hostkey. Exiting.\n");
653 GNUNET_CRYPTO_eddsa_key_get_public (my_private_key, &my_identity.public_key);
655 hello = GNUNET_HELLO_create (&my_identity.public_key, NULL, NULL, GNUNET_NO);
657 /* load plugins... */
658 setup_plugin_environment ();
660 GNUNET_assert(strlen (argv[0]) > strlen ("test_plugin_"));
661 plugin = strstr (argv[0], "test_plugin_");
662 sep = strrchr (argv[0], '.');
665 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
669 plugin += strlen ("test_plugin_");
673 /* Hack for WLAN: start a second helper */
674 if (0 == strcmp (plugin, "wlan"))
676 char * helper_argv[3];
677 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
678 helper_argv[1] = (char *) "2";
679 helper_argv[2] = NULL;
680 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
681 "gnunet-helper-transport-wlan-dummy", helper_argv,
682 &handle_helper_message, NULL, NULL );
686 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
687 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
688 api = GNUNET_PLUGIN_load (libname, &env);
691 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
692 "Failed to load transport plugin for %s\n", plugin);
697 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
699 /* Check if all functions are implemented */
700 if (NULL == api->address_pretty_printer)
706 if (NULL == api->address_to_string)
712 GNUNET_assert(NULL != api->check_address);
713 if (NULL == api->check_address)
719 GNUNET_assert(NULL != api->disconnect_peer);
720 if (NULL == api->disconnect_peer)
726 GNUNET_assert(NULL != api->get_session);
727 if (NULL == api->get_session)
733 if (NULL == api->address_pretty_printer)
739 if (NULL == api->string_to_address)
749 * The main function for the test
751 * @param argc number of arguments from the command line
752 * @param argv command line arguments
753 * @return 0 ok, 1 on error
759 static struct GNUNET_GETOPT_CommandLineOption options[] = {
760 GNUNET_GETOPT_OPTION_END
763 char * const argv_prog[] = {
764 "test_plugin_transport",
766 "test_plugin_transport_data.conf",
770 GNUNET_log_setup ("test-plugin-transport",
773 GNUNET_DISK_purge_cfg_dir ("test_plugin_transport_data.conf",
775 ok = 1; /* set to fail */
778 == GNUNET_PROGRAM_run (3, argv_prog, "test-plugin-transport",
779 "testcase", options, &run, (void *) argv)) ? ok : 1;
780 GNUNET_DISK_purge_cfg_dir ("test_plugin_transport_data.conf",
785 /* end of test_plugin_transport.c */