2 This file is part of GNUnet
3 (C) 2008, 2009, 2012 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.
22 * @file testing/testing.c
23 * @brief convenience API for writing testcases for GNUnet
24 * Many testcases need to start and stop a peer/service
25 * and this library is supposed to make that easier
26 * for TESTCASES. Normal programs should always
27 * use functions from gnunet_{util,arm}_lib.h. This API is
28 * ONLY for writing testcases (or internal use of the testbed).
29 * @author Christian Grothoff
33 #include "gnunet_util_lib.h"
34 #include "gnunet_testing_lib-new.h"
36 #define LOG(kind,...) \
37 GNUNET_log_from (kind, "testing-api", __VA_ARGS__)
40 * Lowest port used for GNUnet testing. Should be high enough to not
41 * conflict with other applications running on the hosts but be low
42 * enough to not conflict with client-ports (typically starting around
45 #define LOW_PORT 12000
48 * Highest port used for GNUnet testing. Should be low enough to not
49 * conflict with the port range for "local" ports (client apps; see
50 * /proc/sys/net/ipv4/ip_local_port_range on Linux for example).
52 #define HIGH_PORT 56000
56 * Handle for a system on which GNUnet peers are executed;
57 * a system is used for reserving unique paths and ports.
59 struct GNUNET_TESTING_System
62 * Prefix (i.e. "/tmp/gnunet-testing/") we prepend to each
67 * The hostname of the controller
77 * Hostkeys data, contains "GNUNET_TESTING_HOSTKEYFILESIZE * total_hostkeys" bytes.
82 * memory map for 'hostkeys_data'.
84 struct GNUNET_DISK_MapHandle *map;
87 * File descriptor for the map.
89 struct GNUNET_DISK_FileHandle *map_fd;
92 * Bitmap where each TCP port that has already been reserved for
93 * some GNUnet peer is recorded. Note that we additionally need to
94 * test if a port is already in use by non-GNUnet components before
95 * assigning it to a peer/service. If we detect that a port is
96 * already in use, we also mark it in this bitmap. So all the bits
97 * that are zero merely indicate ports that MIGHT be available for
100 uint32_t reserved_tcp_ports[65536 / 32];
103 * Bitmap where each UDP port that has already been reserved for
104 * some GNUnet peer is recorded. Note that we additionally need to
105 * test if a port is already in use by non-GNUnet components before
106 * assigning it to a peer/service. If we detect that a port is
107 * already in use, we also mark it in this bitmap. So all the bits
108 * that are zero merely indicate ports that MIGHT be available for
111 uint32_t reserved_udp_ports[65536 / 32];
114 * Counter we use to make service home paths unique on this system;
115 * the full path consists of the tmppath and this number. Each
116 * UNIXPATH for a peer is also modified to include the respective
117 * path counter to ensure uniqueness. This field is incremented
118 * by one for each configured peer. Even if peers are destroyed,
119 * we never re-use path counters.
121 uint32_t path_counter;
124 * The number of hostkeys
126 uint32_t total_hostkeys;
129 * Lowest port we are allowed to use.
134 * Highest port we are allowed to use.
141 * Handle for a GNUnet peer controlled by testing.
143 struct GNUNET_TESTING_Peer
146 * The TESTING system associated with this peer
148 struct GNUNET_TESTING_System *system;
151 * Path to the configuration file for this peer.
156 * Binary to be executed during 'GNUNET_TESTING_peer_start'.
157 * Typically 'gnunet-service-arm' (but can be set to a
158 * specific service by 'GNUNET_TESTING_service_run' if
164 * Handle to the running binary of the service, NULL if the
165 * peer/service is currently not running.
167 struct GNUNET_OS_Process *main_process;
170 * The keynumber of this peer's hostkey
177 * Testing includes a number of pre-created hostkeys for faster peer
178 * startup. This function loads such keys into memory from a file.
180 * @param system the testing system handle
181 * @return GNUNET_OK on success; GNUNET_SYSERR on error
184 hostkeys_load (struct GNUNET_TESTING_System *system)
190 GNUNET_assert (NULL == system->hostkeys_data);
191 data_dir = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
192 GNUNET_asprintf (&filename, "%s/testing_hostkeys.dat", data_dir);
193 GNUNET_free (data_dir);
195 if (GNUNET_YES != GNUNET_DISK_file_test (filename))
197 LOG (GNUNET_ERROR_TYPE_ERROR,
198 _("Hostkeys file not found: %s\n"), filename);
199 GNUNET_free (filename);
200 return GNUNET_SYSERR;
202 /* Check hostkey file size, read entire thing into memory */
204 GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
208 GNUNET_free (filename);
209 return GNUNET_SYSERR; /* File is empty */
211 if (0 != (fs % GNUNET_TESTING_HOSTKEYFILESIZE))
213 LOG (GNUNET_ERROR_TYPE_ERROR,
214 _("Incorrect hostkey file format: %s\n"), filename);
215 GNUNET_free (filename);
216 return GNUNET_SYSERR;
218 system->map_fd = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ,
219 GNUNET_DISK_PERM_NONE);
220 if (NULL == system->map_fd)
222 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", filename);
223 GNUNET_free (filename);
224 return GNUNET_SYSERR;
226 system->total_hostkeys = fs / GNUNET_TESTING_HOSTKEYFILESIZE;
227 system->hostkeys_data = GNUNET_DISK_file_map (system->map_fd,
229 GNUNET_DISK_MAP_TYPE_READ,
231 GNUNET_free (filename);
237 * Function to remove the loaded hostkeys
239 * @param system the testing system handle
242 hostkeys_unload (struct GNUNET_TESTING_System *system)
244 GNUNET_break (NULL != system->hostkeys_data);
245 system->hostkeys_data = NULL;
246 GNUNET_DISK_file_unmap (system->map);
248 GNUNET_DISK_file_close (system->map_fd);
249 system->map_fd = NULL;
250 system->hostkeys_data = NULL;
251 system->total_hostkeys = 0;
256 * Create a system handle. There must only be one system
257 * handle per operating system.
259 * @param testdir only the directory name without any path. This is used for
260 * all service homes; the directory will be created in a temporary
261 * location depending on the underlying OS
262 * @param controller hostname of the controlling host,
263 * service configurations are modified to allow
264 * control connections from this host; can be NULL
265 * @param hostname the hostname of the system we are using for testing; NULL for
267 * @param lowport lowest port number this system is allowed to allocate (inclusive)
268 * @param highport highest port number this system is allowed to allocate (exclusive)
269 * @return handle to this system, NULL on error
271 struct GNUNET_TESTING_System *
272 GNUNET_TESTING_system_create_with_portrange (const char *testdir,
273 const char *controller,
274 const char *hostname,
278 struct GNUNET_TESTING_System *system;
280 GNUNET_assert (NULL != testdir);
281 system = GNUNET_malloc (sizeof (struct GNUNET_TESTING_System));
282 system->tmppath = GNUNET_DISK_mkdtemp (testdir);
283 system->lowport = lowport;
284 system->highport = highport;
285 if (NULL == system->tmppath)
287 GNUNET_free (system);
290 if (NULL != controller)
291 system->controller = GNUNET_strdup (controller);
292 if (NULL != hostname)
293 system->hostname = GNUNET_strdup (hostname);
294 if (GNUNET_OK != hostkeys_load (system))
296 GNUNET_TESTING_system_destroy (system, GNUNET_YES);
304 * Create a system handle. There must only be one system handle per operating
305 * system. Uses a default range for allowed ports. Ports are still tested for
308 * @param testdir only the directory name without any path. This is used for all
309 * service homes; the directory will be created in a temporary location
310 * depending on the underlying OS
311 * @param controller hostname of the controlling host, service configurations
312 * are modified to allow control connections from this host; can be NULL
313 * @param hostname the hostname of the system we are using for testing; NULL for
315 * @return handle to this system, NULL on error
317 struct GNUNET_TESTING_System *
318 GNUNET_TESTING_system_create (const char *testdir,
319 const char *controller,
320 const char *hostname)
322 return GNUNET_TESTING_system_create_with_portrange (testdir,
331 * Free system resources.
333 * @param system system to be freed
334 * @param remove_paths should the 'testdir' and all subdirectories
335 * be removed (clean up on shutdown)?
338 GNUNET_TESTING_system_destroy (struct GNUNET_TESTING_System *system,
341 if (NULL != system->hostkeys_data)
342 hostkeys_unload (system);
343 if (GNUNET_YES == remove_paths)
344 GNUNET_DISK_directory_remove (system->tmppath);
345 GNUNET_free (system->tmppath);
346 GNUNET_free_non_null (system->controller);
347 GNUNET_free_non_null (system->hostname);
348 GNUNET_free (system);
353 * Reserve a TCP or UDP port for a peer.
355 * @param system system to use for reservation tracking
356 * @param is_tcp GNUNET_YES for TCP ports, GNUNET_NO for UDP
357 * @return 0 if no free port was available
360 GNUNET_TESTING_reserve_port (struct GNUNET_TESTING_System *system,
363 struct GNUNET_NETWORK_Handle *socket;
364 struct addrinfo hint;
365 struct addrinfo *ret;
367 uint32_t *port_buckets;
376 FIXME: Instead of using getaddrinfo we should try to determine the port
377 status by the following heurestics.
379 On systems which support both IPv4 and IPv6, only ports open on both
380 address families are considered open.
381 On system with either IPv4 or IPv6. A port is considered open if it's
382 open in the respective address family
384 hint.ai_family = AF_UNSPEC; /* IPv4 and IPv6 */
385 hint.ai_socktype = (GNUNET_YES == is_tcp)? SOCK_STREAM : SOCK_DGRAM;
386 hint.ai_protocol = 0;
389 hint.ai_canonname = NULL;
391 hint.ai_flags = AI_PASSIVE | AI_NUMERICSERV; /* Wild card address */
392 port_buckets = (GNUNET_YES == is_tcp) ?
393 system->reserved_tcp_ports : system->reserved_udp_ports;
394 for (index = (system->lowport / 32) + 1; index < (system->highport / 32); index++)
396 xor_image = (UINT32_MAX ^ port_buckets[index]);
397 if (0 == xor_image) /* Ports in the bucket are full */
399 pos = system->lowport % 32;
402 if (0 == ((xor_image >> pos) & 1U))
407 open_port = (index * 32) + pos;
408 if (open_port >= system->highport)
410 GNUNET_asprintf (&open_port_str, "%u", (unsigned int) open_port);
412 GNUNET_assert (0 == getaddrinfo (NULL, open_port_str, &hint, &ret));
413 GNUNET_free (open_port_str);
414 bind_status = GNUNET_NO;
415 for (ai = ret; NULL != ai; ai = ai->ai_next)
417 socket = GNUNET_NETWORK_socket_create (ai->ai_family,
418 (GNUNET_YES == is_tcp) ?
419 SOCK_STREAM : SOCK_DGRAM,
423 bind_status = GNUNET_NETWORK_socket_bind (socket,
426 GNUNET_NETWORK_socket_close (socket);
427 if (GNUNET_OK != bind_status)
430 port_buckets[index] |= (1U << pos); /* Set the port bit */
432 if (GNUNET_OK == bind_status)
434 LOG (GNUNET_ERROR_TYPE_DEBUG,
435 "Found a free port %u\n", (unsigned int) open_port);
446 * Release reservation of a TCP or UDP port for a peer
447 * (used during GNUNET_TESTING_peer_destroy).
449 * @param system system to use for reservation tracking
450 * @param is_tcp GNUNET_YES for TCP ports, GNUNET_NO for UDP
451 * @param port reserved port to release
454 GNUNET_TESTING_release_port (struct GNUNET_TESTING_System *system,
458 uint32_t *port_buckets;
462 port_buckets = (GNUNET_YES == is_tcp) ?
463 system->reserved_tcp_ports : system->reserved_udp_ports;
466 LOG (GNUNET_ERROR_TYPE_DEBUG, "Releasing port %u\n", port);
467 if (0 == (port_buckets[bucket] & (1U << pos)))
469 GNUNET_break(0); /* Port was not reserved by us using reserve_port() */
472 port_buckets[bucket] &= ~(1U << pos);
477 * Reserve a SERVICEHOME path for a peer.
479 * @param system system to use for reservation tracking
480 * @return NULL on error, otherwise fresh unique path to use
481 * as the servicehome for the peer; must be freed by the caller
485 reserve_path (struct GNUNET_TESTING_System *system)
489 GNUNET_asprintf (&reserved_path,
490 "%s/%u", system->tmppath, system->path_counter++);
491 return reserved_path;
496 * Testing includes a number of pre-created hostkeys for
497 * faster peer startup. This function can be used to
498 * access the n-th key of those pre-created hostkeys; note
499 * that these keys are ONLY useful for testing and not
500 * secure as the private keys are part of the public
501 * GNUnet source code.
503 * This is primarily a helper function used internally
504 * by 'GNUNET_TESTING_peer_configure'.
506 * @param system the testing system handle
507 * @param key_number desired pre-created hostkey to obtain
508 * @param id set to the peer's identity (hash of the public
509 * key; if NULL, GNUNET_SYSERR is returned immediately
510 * @return NULL on error (not enough keys)
512 struct GNUNET_CRYPTO_RsaPrivateKey *
513 GNUNET_TESTING_hostkey_get (const struct GNUNET_TESTING_System *system,
515 struct GNUNET_PeerIdentity *id)
517 struct GNUNET_CRYPTO_RsaPrivateKey *private_key;
518 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
520 if ((NULL == id) || (NULL == system->hostkeys_data))
522 if (key_number >= system->total_hostkeys)
524 LOG (GNUNET_ERROR_TYPE_ERROR,
525 _("Key number %u does not exist\n"), key_number);
528 private_key = GNUNET_CRYPTO_rsa_decode_key (system->hostkeys_data +
530 GNUNET_TESTING_HOSTKEYFILESIZE),
531 GNUNET_TESTING_HOSTKEYFILESIZE);
532 if (NULL == private_key)
534 LOG (GNUNET_ERROR_TYPE_ERROR,
535 _("Error while decoding key %u\n"), key_number);
538 GNUNET_CRYPTO_rsa_key_get_public (private_key, &public_key);
539 GNUNET_CRYPTO_hash (&public_key,
540 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
547 * Structure for holding data to build new configurations from a configuration
553 * The system for which we are building configurations
555 struct GNUNET_TESTING_System *system;
558 * The configuration we are building
560 struct GNUNET_CONFIGURATION_Handle *cfg;
563 * The customized service home path for this peer
568 * build status - to signal error while building a configuration
575 * Function to iterate over options. Copies
576 * the options to the target configuration,
577 * updating PORT values as needed.
579 * @param cls the UpdateContext
580 * @param section name of the section
581 * @param option name of the option
582 * @param value value of the option
585 update_config (void *cls, const char *section, const char *option,
588 struct UpdateContext *uc = cls;
592 char *single_variable;
593 char *per_host_variable;
594 unsigned long long num_per_host;
597 if (GNUNET_OK != uc->status)
599 if (! ((0 == strcmp (option, "PORT"))
600 || (0 == strcmp (option, "UNIXPATH"))
601 || (0 == strcmp (option, "HOSTNAME"))))
603 GNUNET_asprintf (&single_variable, "single_%s_per_host", section);
604 GNUNET_asprintf (&per_host_variable, "num_%s_per_host", section);
605 if ((0 == strcmp (option, "PORT")) && (1 == SSCANF (value, "%u", &ival)))
609 GNUNET_CONFIGURATION_get_value_yesno (uc->cfg, "testing",
612 /* FIXME: What about UDP? */
613 new_port = GNUNET_TESTING_reserve_port (uc->system, GNUNET_YES);
616 uc->status = GNUNET_SYSERR;
619 GNUNET_snprintf (cval, sizeof (cval), "%u", new_port);
622 else if ((ival != 0) &&
624 GNUNET_CONFIGURATION_get_value_yesno (uc->cfg, "testing",
626 GNUNET_CONFIGURATION_get_value_number (uc->cfg, "testing",
630 /* GNUNET_snprintf (cval, sizeof (cval), "%u", */
631 /* ival + ctx->fdnum % num_per_host); */
633 GNUNET_break (0); /* FIXME */
636 if (0 == strcmp (option, "UNIXPATH"))
639 GNUNET_CONFIGURATION_get_value_yesno (uc->cfg, "testing",
642 GNUNET_snprintf (uval, sizeof (uval), "%s/%s.sock",
643 uc->service_home, section);
646 else if ((GNUNET_YES ==
647 GNUNET_CONFIGURATION_get_value_number (uc->cfg, "testing",
652 GNUNET_break(0); /* FIXME */
655 if (0 == strcmp (option, "HOSTNAME"))
657 value = (NULL == uc->system->hostname) ? "localhost" : uc->system->hostname;
659 GNUNET_free (single_variable);
660 GNUNET_free (per_host_variable);
661 GNUNET_CONFIGURATION_set_value_string (uc->cfg, section, option, value);
666 * Section iterator to set ACCEPT_FROM/ACCEPT_FROM6 depending on the ip of the
667 * controller in all sections
669 * @param cls the UpdateContext
670 * @param section name of the section
673 update_config_sections (void *cls,
676 struct UpdateContext *uc = cls;
680 char *orig_allowed_hosts;
682 char *ACCEPT_FROM_key;
688 if (GNUNET_YES == GNUNET_CONFIGURATION_have_value (uc->cfg, section,
689 "TESTING_IGNORE_KEYS"))
693 GNUNET_CONFIGURATION_get_value_string (uc->cfg, section,
694 "TESTING_IGNORE_KEYS", &val));
696 for (ikeys_cnt = 0; NULL != (ptr = strstr (ptr, ";")); ikeys_cnt++)
702 ikeys = GNUNET_malloc ((sizeof (char *)) * ikeys_cnt);
704 for (key = 0; key < ikeys_cnt; key++)
707 ptr = strstr (ptr, ";");
715 for (key = 0; key < ikeys_cnt; key++)
717 if (NULL != strstr (ikeys[key], "ADVERTISED_PORT"))
720 if ((key == ikeys_cnt) &&
721 (GNUNET_YES == GNUNET_CONFIGURATION_have_value (uc->cfg, section,
725 GNUNET_CONFIGURATION_get_value_string (uc->cfg, section, "PORT", &ptr))
727 GNUNET_CONFIGURATION_set_value_string (uc->cfg, section,
728 "ADVERTISED_PORT", ptr);
732 for (key = 0; key < ikeys_cnt; key++)
734 if (NULL != strstr (ikeys[key], "ACCEPT_FROM"))
743 GNUNET_free_non_null (val);
744 ACCEPT_FROM_key = "ACCEPT_FROM";
745 if ((NULL != uc->system->controller) &&
746 (NULL != strstr (uc->system->controller, ":"))) /* IPv6 in use */
747 ACCEPT_FROM_key = "ACCEPT_FROM6";
749 GNUNET_CONFIGURATION_get_value_string (uc->cfg, section, ACCEPT_FROM_key,
750 &orig_allowed_hosts))
752 orig_allowed_hosts = GNUNET_strdup ("127.0.0.1;");
754 if (NULL == uc->system->controller)
755 allowed_hosts = GNUNET_strdup (orig_allowed_hosts);
757 GNUNET_asprintf (&allowed_hosts, "%s%s;", orig_allowed_hosts,
758 uc->system->controller);
759 GNUNET_free (orig_allowed_hosts);
760 GNUNET_CONFIGURATION_set_value_string (uc->cfg, section, ACCEPT_FROM_key,
762 GNUNET_free (allowed_hosts);
767 * Create a new configuration using the given configuration as a template;
768 * ports and paths will be modified to select available ports on the local
769 * system. The default configuration will be available in PATHS section under
770 * the option DEFAULTCONFIG after the call. SERVICE_HOME is also set in PATHS
771 * section to the temporary directory specific to this configuration. If we run
772 * out of "*port" numbers, return SYSERR.
774 * This is primarily a helper function used internally
775 * by 'GNUNET_TESTING_peer_configure'.
777 * @param system system to use to coordinate resource usage
778 * @param cfg template configuration to update
779 * @return GNUNET_OK on success, GNUNET_SYSERR on error - the configuration will
780 * be incomplete and should not be used there upon
783 GNUNET_TESTING_configuration_create (struct GNUNET_TESTING_System *system,
784 struct GNUNET_CONFIGURATION_Handle *cfg)
786 struct UpdateContext uc;
787 char *default_config;
791 uc.status = GNUNET_OK;
792 GNUNET_asprintf (&uc.service_home, "%s/%u", system->tmppath,
793 system->path_counter++);
794 GNUNET_asprintf (&default_config, "%s/config", uc.service_home);
795 GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "DEFAULTCONFIG",
797 GNUNET_free (default_config);
798 GNUNET_CONFIGURATION_set_value_string (cfg, "PATHS", "SERVICEHOME",
800 /* make PORTs and UNIXPATHs unique */
801 GNUNET_CONFIGURATION_iterate (cfg, &update_config, &uc);
802 /* allow connections to services from system controller host */
803 GNUNET_CONFIGURATION_iterate_sections (cfg, &update_config_sections, &uc);
804 /* enable loopback-based connections between peers */
805 GNUNET_CONFIGURATION_set_value_string (cfg,
807 "USE_LOCALADDR", "YES");
808 GNUNET_free (uc.service_home);
814 * Configure a GNUnet peer. GNUnet must be installed on the local
815 * system and available in the PATH.
817 * @param system system to use to coordinate resource usage
818 * @param cfg configuration to use; will be UPDATED (to reflect needed
819 * changes in port numbers and paths)
820 * @param key_number number of the hostkey to use for the peer
821 * @param id identifier for the daemon, will be set, can be NULL
822 * @param emsg set to freshly allocated error message (set to NULL on success),
824 * @return handle to the peer, NULL on error
826 struct GNUNET_TESTING_Peer *
827 GNUNET_TESTING_peer_configure (struct GNUNET_TESTING_System *system,
828 struct GNUNET_CONFIGURATION_Handle *cfg,
830 struct GNUNET_PeerIdentity *id,
833 struct GNUNET_TESTING_Peer *peer;
834 struct GNUNET_DISK_FileHandle *fd;
836 char hostkey_filename[128];
837 char *config_filename;
839 struct GNUNET_CRYPTO_RsaPrivateKey *pk;
843 if (GNUNET_OK != GNUNET_TESTING_configuration_create (system, cfg))
845 GNUNET_asprintf (&emsg_,
846 _("Failed to create configuration for peer (not enough free ports?)\n"));
847 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s", emsg_);
854 if (key_number >= system->total_hostkeys)
856 GNUNET_asprintf (&emsg_,
857 _("You attempted to create a testbed with more than %u hosts. Please precompute more hostkeys first.\n"),
858 (unsigned int) system->total_hostkeys);
859 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s", emsg_);
868 (NULL == (pk = GNUNET_TESTING_hostkey_get (system, key_number, id))))
870 GNUNET_asprintf (&emsg_,
871 _("Failed to initialize hostkey for peer %u\n"),
872 (unsigned int) key_number);
873 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s", emsg_);
881 GNUNET_CRYPTO_rsa_key_free (pk);
882 GNUNET_assert (GNUNET_OK ==
883 GNUNET_CONFIGURATION_get_value_string (cfg, "PATHS",
886 GNUNET_snprintf (hostkey_filename, sizeof (hostkey_filename), "%s/.hostkey",
888 GNUNET_free (service_home);
889 fd = GNUNET_DISK_file_open (hostkey_filename,
890 GNUNET_DISK_OPEN_CREATE | GNUNET_DISK_OPEN_WRITE,
891 GNUNET_DISK_PERM_USER_READ
892 | GNUNET_DISK_PERM_USER_WRITE);
898 if (GNUNET_TESTING_HOSTKEYFILESIZE !=
899 GNUNET_DISK_file_write (fd, system->hostkeys_data
900 + (key_number * GNUNET_TESTING_HOSTKEYFILESIZE),
901 GNUNET_TESTING_HOSTKEYFILESIZE))
903 GNUNET_asprintf (&emsg_,
904 _("Failed to write hostkey file for peer %u: %s\n"),
905 (unsigned int) key_number,
907 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s", emsg_);
912 GNUNET_DISK_file_close (fd);
915 GNUNET_DISK_file_close (fd);
916 GNUNET_assert (GNUNET_OK ==
917 GNUNET_CONFIGURATION_get_value_string
918 (cfg, "PATHS", "DEFAULTCONFIG", &config_filename));
919 if (GNUNET_OK != GNUNET_CONFIGURATION_write (cfg, config_filename))
921 GNUNET_asprintf (&emsg_,
922 _("Failed to write configuration file `%s' for peer %u: %s\n"),
924 (unsigned int) key_number,
926 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "%s", emsg_);
931 GNUNET_free (config_filename);
934 peer = GNUNET_malloc (sizeof (struct GNUNET_TESTING_Peer));
935 peer->cfgfile = config_filename; /* Free in peer_destroy */
936 peer->main_binary = GNUNET_OS_get_libexec_binary_path ("gnunet-service-arm");
937 peer->system = system;
938 peer->key_number = key_number;
944 * Obtain the peer identity from a peer handle.
946 * @param peer peer handle for which we want the peer's identity
947 * @param id identifier for the daemon, will be set
950 GNUNET_TESTING_peer_get_identity (const struct GNUNET_TESTING_Peer *peer,
951 struct GNUNET_PeerIdentity *id)
953 GNUNET_CRYPTO_rsa_key_free (GNUNET_TESTING_hostkey_get (peer->system,
962 * @param peer peer to start
963 * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer already running)
966 GNUNET_TESTING_peer_start (struct GNUNET_TESTING_Peer *peer)
968 if (NULL != peer->main_process)
971 return GNUNET_SYSERR;
973 GNUNET_assert (NULL != peer->cfgfile);
974 peer->main_process = GNUNET_OS_start_process (GNUNET_YES, GNUNET_OS_INHERIT_STD_OUT_AND_ERR, NULL, NULL,
980 if (NULL == peer->main_process)
982 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
983 _("Failed to start `%s': %s\n"),
986 return GNUNET_SYSERR;
988 return GNUNET_OS_set_process_priority (peer->main_process, GNUNET_SCHEDULER_PRIORITY_BACKGROUND);
995 * @param peer peer to stop
996 * @return GNUNET_OK on success, GNUNET_SYSERR on error (i.e. peer not running)
999 GNUNET_TESTING_peer_stop (struct GNUNET_TESTING_Peer *peer)
1001 if (NULL == peer->main_process)
1004 return GNUNET_SYSERR;
1006 (void) GNUNET_OS_process_kill (peer->main_process, SIGTERM);
1007 GNUNET_assert (GNUNET_OK == GNUNET_OS_process_wait (peer->main_process));
1008 GNUNET_OS_process_destroy (peer->main_process);
1009 peer->main_process = NULL;
1015 * Destroy the peer. Releases resources locked during peer configuration.
1016 * If the peer is still running, it will be stopped AND a warning will be
1017 * printed (users of the API should stop the peer explicitly first).
1019 * @param peer peer to destroy
1022 GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer *peer)
1024 if (NULL != peer->main_process)
1027 GNUNET_TESTING_peer_stop (peer);
1029 GNUNET_free (peer->cfgfile);
1030 GNUNET_free (peer->main_binary);
1036 * Start a single peer and run a test using the testing library.
1037 * Starts a peer using the given configuration and then invokes the
1038 * given callback. This function ALSO initializes the scheduler loop
1039 * and should thus be called directly from "main". The testcase
1040 * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
1042 * @param testdir only the directory name without any path. This is used for
1043 * all service homes; the directory will be created in a temporary
1044 * location depending on the underlying OS
1045 * @param cfgfilename name of the configuration file to use;
1046 * use NULL to only run with defaults
1047 * @param tm main function of the testcase
1048 * @param tm_cls closure for 'tm'
1049 * @return 0 on success, 1 on error
1052 GNUNET_TESTING_peer_run (const char *testdir,
1053 const char *cfgfilename,
1054 GNUNET_TESTING_TestMain tm,
1057 return GNUNET_TESTING_service_run (testdir, "arm",
1058 cfgfilename, tm, tm_cls);
1063 * Structure for holding service data
1065 struct ServiceContext
1068 * The configuration of the peer in which the service is run
1070 const struct GNUNET_CONFIGURATION_Handle *cfg;
1073 * Callback to signal service startup
1075 GNUNET_TESTING_TestMain tm;
1078 * The peer in which the service is run.
1080 struct GNUNET_TESTING_Peer *peer;
1083 * Closure for the above callback
1090 * Callback to be called when SCHEDULER has been started
1092 * @param cls the ServiceContext
1093 * @param tc the TaskContext
1096 service_run_main (void *cls,
1097 const struct GNUNET_SCHEDULER_TaskContext *tc)
1099 struct ServiceContext *sc = cls;
1101 sc->tm (sc->tm_cls, sc->cfg, sc->peer);
1106 * Start a single service (no ARM, except of course if the given
1107 * service name is 'arm') and run a test using the testing library.
1108 * Starts a service using the given configuration and then invokes the
1109 * given callback. This function ALSO initializes the scheduler loop
1110 * and should thus be called directly from "main". The testcase
1111 * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
1113 * This function is useful if the testcase is for a single service
1114 * and if that service doesn't itself depend on other services.
1116 * @param testdir only the directory name without any path. This is used for
1117 * all service homes; the directory will be created in a temporary
1118 * location depending on the underlying OS
1119 * @param service_name name of the service to run
1120 * @param cfgfilename name of the configuration file to use;
1121 * use NULL to only run with defaults
1122 * @param tm main function of the testcase
1123 * @param tm_cls closure for 'tm'
1124 * @return 0 on success, 1 on error
1127 GNUNET_TESTING_service_run (const char *testdir,
1128 const char *service_name,
1129 const char *cfgfilename,
1130 GNUNET_TESTING_TestMain tm,
1133 struct ServiceContext sc;
1134 struct GNUNET_TESTING_System *system;
1135 struct GNUNET_TESTING_Peer *peer;
1136 struct GNUNET_CONFIGURATION_Handle *cfg;
1139 GNUNET_log_setup (testdir, "WARNING", NULL);
1140 system = GNUNET_TESTING_system_create (testdir, "127.0.0.1", NULL);
1143 cfg = GNUNET_CONFIGURATION_create ();
1144 if (GNUNET_OK != GNUNET_CONFIGURATION_load (cfg, cfgfilename))
1146 LOG (GNUNET_ERROR_TYPE_ERROR,
1147 _("Failed to load configuration from %s\n"), cfgfilename);
1148 GNUNET_CONFIGURATION_destroy (cfg);
1149 GNUNET_TESTING_system_destroy (system, GNUNET_YES);
1152 peer = GNUNET_TESTING_peer_configure (system, cfg, 0, NULL, NULL);
1155 GNUNET_CONFIGURATION_destroy (cfg);
1156 hostkeys_unload (system);
1157 GNUNET_TESTING_system_destroy (system, GNUNET_YES);
1160 GNUNET_free (peer->main_binary);
1161 GNUNET_asprintf (&binary, "gnunet-service-%s", service_name);
1162 peer->main_binary = GNUNET_OS_get_libexec_binary_path (binary);
1163 GNUNET_free (binary);
1164 if (GNUNET_OK != GNUNET_TESTING_peer_start (peer))
1166 GNUNET_TESTING_peer_destroy (peer);
1167 GNUNET_CONFIGURATION_destroy (cfg);
1168 GNUNET_TESTING_system_destroy (system, GNUNET_YES);
1175 GNUNET_SCHEDULER_run (&service_run_main, &sc); /* Scheduler loop */
1176 if ((NULL != peer->main_process) &&
1177 (GNUNET_OK != GNUNET_TESTING_peer_stop (peer)))
1179 GNUNET_TESTING_peer_destroy (peer);
1180 GNUNET_CONFIGURATION_destroy (cfg);
1181 GNUNET_TESTING_system_destroy (system, GNUNET_YES);
1184 GNUNET_TESTING_peer_destroy (peer);
1185 GNUNET_CONFIGURATION_destroy (cfg);
1186 GNUNET_TESTING_system_destroy (system, GNUNET_YES);
1192 * Sometimes we use the binary name to determine which specific
1193 * test to run. In those cases, the string after the last "_"
1194 * in 'argv[0]' specifies a string that determines the configuration
1195 * file or plugin to use.
1197 * This function returns the respective substring, taking care
1198 * of issues such as binaries ending in '.exe' on W32.
1200 * @param argv0 the name of the binary
1201 * @return string between the last '_' and the '.exe' (or the end of the string),
1202 * NULL if argv0 has no '_'
1205 GNUNET_TESTING_get_testname_from_underscore (const char *argv0)
1207 size_t slen = strlen (argv0) + 1;
1212 memcpy (sbuf, argv0, slen);
1213 ret = strrchr (sbuf, '_');
1216 ret++; /* skip underscore */
1217 dot = strchr (ret, '.');
1220 return GNUNET_strdup (ret);
1224 /* end of testing.c */