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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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 struct GNUNET_SCHEDULER_Task * timeout_endbadly;
97 static struct GNUNET_SCHEDULER_Task * 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;
133 struct GNUNET_SCHEDULER_Task *test_task;
141 struct AddressWrapper *w;
145 if (NULL != timeout_endbadly)
147 GNUNET_SCHEDULER_cancel (timeout_endbadly);
148 timeout_endbadly = NULL;
151 GNUNET_PLUGIN_unload (libname, api);
156 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
157 "Plugin did not remove address `%s'\n",
159 GNUNET_CONTAINER_DLL_remove(head, tail, w);
161 GNUNET_HELLO_address_free(w->address);
162 GNUNET_free(w->addrstring);
168 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses \n",
173 GNUNET_free(libname);
175 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
178 if (NULL != suid_helper)
180 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
187 end_badly (void *cls)
189 struct AddressWrapper *w;
192 timeout_endbadly = NULL;
193 if (NULL != timeout_wait)
195 GNUNET_SCHEDULER_cancel (timeout_wait);
199 if (pretty_printers_running > 0)
201 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
203 GNUNET_log(GNUNET_ERROR_TYPE_INFO,
204 "Have pending calls to pretty_printer ... deferring shutdown\n");
210 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
211 "Test took too long to execute, timeout .... \n");
217 GNUNET_PLUGIN_unload (libname, api);
218 GNUNET_free(libname);
225 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove address `%s'\n",
227 GNUNET_CONTAINER_DLL_remove(head, tail, w);
229 GNUNET_HELLO_address_free(w->address);
230 if (NULL != w->test_task)
231 GNUNET_SCHEDULER_cancel (w->test_task);
232 GNUNET_free(w->addrstring);
238 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Plugin did not remove %u addresses\n",
244 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
248 if (NULL != suid_helper)
250 GNUNET_HELPER_stop (suid_helper, GNUNET_NO);
261 if (0 == addresses_reported)
262 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
263 "Plugin did not report any addresses, could not check address conversion functions\n");
271 if (NULL != timeout_wait)
273 GNUNET_SCHEDULER_cancel (timeout_wait);
276 if (NULL != timeout_endbadly)
278 GNUNET_SCHEDULER_cancel (timeout_endbadly);
279 timeout_endbadly = NULL;
281 timeout_endbadly = GNUNET_SCHEDULER_add_now (&end_badly, NULL );
285 static struct GNUNET_TIME_Relative
286 env_receive (void *cls,
287 const struct GNUNET_HELLO_Address *address,
288 struct GNUNET_ATS_Session *session,
289 const struct GNUNET_MessageHeader *message)
292 return GNUNET_TIME_relative_get_zero_ ();
295 static int got_reply;
299 * Take the given address and append it to the set of results sent back to
303 * @param address the address to print
304 * @param res result code
307 address_pretty_printer_cb (void *cls, const char *address, int res)
311 got_reply = GNUNET_YES;
312 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Pretty address : `%s'\n", address);
313 pretty_printers_running--;
317 if (GNUNET_NO == got_reply)
319 pretty_printers_running--;
328 test_addr_string (void *cls)
330 struct AddressWrapper *w = cls;
336 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
337 "Testing: address_to_string \n");
338 w->addrstring = GNUNET_strdup (api->address_to_string (api,
340 w->address->address_length));
341 if (NULL == w->addrstring)
344 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
345 "Plugin cannot convert address to string!\n");
349 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
350 "Plugin added address `%s'\n",
352 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
353 "Testing address_to_string: OK\n");
354 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
355 "Testing: string_to_address \n");
359 api->string_to_address (api, w->addrstring,
360 strlen (w->addrstring) + 1,
365 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
366 "Plugin cannot convert string to address!\n");
372 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
373 "Plugin creates `%s' %u\n",api->address_to_string (api, s2a, s2a_len), s2a_len);
376 for (c1 = 0; c1 < s2a_len; c1++ )
377 fprintf (stderr, "%u == %u\n", ((char *) s2a)[c1], ((char *) w->addr)[c1]);
379 if (s2a_len != w->address->address_length)
381 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
382 "Plugin creates different address length when converting address->string->address: %u != %u\n",
383 (unsigned int) w->address->address_length,
384 (unsigned int) s2a_len);
386 else if (0 != memcmp (s2a, w->address->address, s2a_len))
388 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
389 "Plugin creates different address length when converting back and forth %i!\n",
396 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
397 "Testing string_to_address: OK\n");
401 pretty_printers_running++;
402 api->address_pretty_printer (api->cls,
403 w->address->transport_name,
405 w->address->address_length,
407 GNUNET_TIME_UNIT_MINUTES,
408 &address_pretty_printer_cb, w);
411 api->check_address (api->cls,
413 w->address->address_length))
416 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
417 "Plugin refuses added address!\n");
421 if (NULL != timeout_wait)
423 GNUNET_SCHEDULER_cancel (timeout_wait);
426 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL);
431 env_notify_address (void *cls,
433 const struct GNUNET_HELLO_Address *address)
435 struct AddressWrapper *w;
436 struct AddressWrapper *wtmp;
438 if (GNUNET_YES == add_remove)
440 addresses_reported++;
441 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
442 "Adding address of length %u\n",
443 (unsigned int) address->address_length);
445 for (wtmp = head; NULL != wtmp; wtmp = wtmp->next)
447 if ((address->address_length == wtmp->address->address_length) &&
448 (0 == memcmp (address->address, wtmp->address->address, address->address_length)))
450 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
451 "Duplicate address notification .... \n");
456 w = GNUNET_new (struct AddressWrapper);
457 w->address = GNUNET_HELLO_address_copy (address);
458 GNUNET_CONTAINER_DLL_insert (head, tail, w);
459 got_reply = GNUNET_NO;
460 w->test_task = GNUNET_SCHEDULER_add_now (&test_addr_string,
465 if (GNUNET_NO == add_remove)
467 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
468 "Removing address of length %u\n",
469 (unsigned int) address->address_length);
473 if ((address->address_length == w->address->address_length) &&
474 (0 == memcmp (w->address->address, address->address, address->address_length)))
484 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
485 "Plugin removes address never added!\n");
490 GNUNET_CONTAINER_DLL_remove(head, tail, w);
491 GNUNET_HELLO_address_free (w->address);
492 GNUNET_free(w->addrstring);
497 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
498 "Invalid operation: %u\n",
504 static enum GNUNET_NetworkType
505 env_get_address_type (void *cls,
506 const struct sockaddr *addr,
509 return GNUNET_NT_LOOPBACK;
513 static const struct GNUNET_MessageHeader *
516 return (const struct GNUNET_MessageHeader *) hello;
521 env_session_end (void *cls,
522 const struct GNUNET_HELLO_Address *address,
523 struct GNUNET_ATS_Session *session)
530 env_update_distance (void *cls,
531 const struct GNUNET_HELLO_Address *address,
538 setup_plugin_environment ()
542 env.my_identity = &my_identity;
543 env.max_connections = max_connect_per_transport;
545 env.receive = &env_receive;
546 env.notify_address = &env_notify_address;
547 env.get_address_type = &env_get_address_type;
548 env.update_address_distance = &env_update_distance;
549 env.get_our_hello = &env_get_our_hello;
550 env.session_end = &env_session_end;
555 handle_helper_message (void *cls,
556 const struct GNUNET_MessageHeader *hdr)
566 * @param c configuration to use
572 const struct GNUNET_CONFIGURATION_Handle *c)
574 char * const *argv = cls;
575 unsigned long long tneigh;
580 timeout_endbadly = GNUNET_SCHEDULER_add_delayed (TIMEOUT,
584 /* parse configuration */
586 GNUNET_CONFIGURATION_get_value_number (c,
591 GNUNET_CONFIGURATION_get_value_filename (c,
596 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
597 "Transport service is lacking key configuration settings. Exiting.\n");
601 if (NULL == (stats = GNUNET_STATISTICS_create ("transport",
604 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
605 "Could not create statistics. Exiting.\n");
606 GNUNET_free(keyfile);
611 if (GNUNET_OK != GNUNET_DISK_file_test (HOSTKEY_FILE))
613 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
614 "Hostkey `%s' missing. Exiting.\n",
616 GNUNET_free(keyfile);
622 GNUNET_DISK_directory_create_for_file (keyfile))
624 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
625 "Could not create a directory for hostkey `%s'. Exiting.\n",
627 GNUNET_free(keyfile);
633 GNUNET_DISK_file_copy (HOSTKEY_FILE,
636 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
637 "Could not copy hostkey `%s' to destination `%s'. Exiting.\n",
640 GNUNET_free(keyfile);
645 max_connect_per_transport = (uint32_t) tneigh;
646 my_private_key = GNUNET_CRYPTO_eddsa_key_create_from_file (keyfile);
647 GNUNET_free(keyfile);
648 if (NULL == my_private_key)
650 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
651 "Could not access hostkey. Exiting.\n");
655 GNUNET_CRYPTO_eddsa_key_get_public (my_private_key, &my_identity.public_key);
657 hello = GNUNET_HELLO_create (&my_identity.public_key, NULL, NULL, GNUNET_NO);
659 /* load plugins... */
660 setup_plugin_environment ();
662 GNUNET_assert(strlen (argv[0]) > strlen ("test_plugin_"));
663 plugin = strstr (argv[0], "test_plugin_");
664 sep = strrchr (argv[0], '.');
667 GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "Not a valid test name\n");
671 plugin += strlen ("test_plugin_");
675 /* Hack for WLAN: start a second helper */
676 if (0 == strcmp (plugin, "wlan"))
678 char * helper_argv[3];
679 helper_argv[0] = (char *) "gnunet-helper-transport-wlan-dummy";
680 helper_argv[1] = (char *) "2";
681 helper_argv[2] = NULL;
682 suid_helper = GNUNET_HELPER_start (GNUNET_NO,
683 "gnunet-helper-transport-wlan-dummy", helper_argv,
684 &handle_helper_message, NULL, NULL );
688 GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Loading transport plugin %s\n", plugin);
689 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", plugin);
690 api = GNUNET_PLUGIN_load (libname, &env);
693 GNUNET_log(GNUNET_ERROR_TYPE_ERROR,
694 "Failed to load transport plugin for %s\n", plugin);
699 timeout_wait = GNUNET_SCHEDULER_add_delayed (WAIT, &wait_end, NULL );
701 /* Check if all functions are implemented */
702 if (NULL == api->address_pretty_printer)
708 if (NULL == api->address_to_string)
714 GNUNET_assert(NULL != api->check_address);
715 if (NULL == api->check_address)
721 GNUNET_assert(NULL != api->disconnect_peer);
722 if (NULL == api->disconnect_peer)
728 GNUNET_assert(NULL != api->get_session);
729 if (NULL == api->get_session)
735 if (NULL == api->address_pretty_printer)
741 if (NULL == api->string_to_address)
751 * The main function for the test
753 * @param argc number of arguments from the command line
754 * @param argv command line arguments
755 * @return 0 ok, 1 on error
761 static struct GNUNET_GETOPT_CommandLineOption options[] = {
762 GNUNET_GETOPT_OPTION_END
765 char * const argv_prog[] = {
766 "test_plugin_transport",
768 "test_plugin_transport_data.conf",
772 GNUNET_log_setup ("test-plugin-transport",
775 GNUNET_DISK_purge_cfg_dir ("test_plugin_transport_data.conf",
777 ok = 1; /* set to fail */
780 == GNUNET_PROGRAM_run (3, argv_prog, "test-plugin-transport",
781 "testcase", options, &run, (void *) argv)) ? ok : 1;
782 GNUNET_DISK_purge_cfg_dir ("test_plugin_transport_data.conf",
787 /* end of test_plugin_transport.c */