GNUnet  0.11.x
Data Structures | Macros | Functions
testing.c File Reference

convenience API for writing testcases for GNUnet Many testcases need to start and stop a peer/service and this library is supposed to make that easier for TESTCASES. More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_arm_service.h"
#include "gnunet_testing_lib.h"
Include dependency graph for testing.c:

Go to the source code of this file.

Data Structures

struct  SharedServiceInstance
 
struct  SharedService
 The structure for identifying a shared service. More...
 
struct  GNUNET_TESTING_System
 Handle for a system on which GNUnet peers are executed; a system is used for reserving unique paths and ports. More...
 
struct  GNUNET_TESTING_Peer
 Handle for a GNUnet peer controlled by testing. More...
 
struct  UpdateContext
 Closure for update_rel_sum() and update_abs_sum(). More...
 
struct  ServiceContext
 Structure for holding service data. More...
 

Macros

#define LOG(kind, ...)   GNUNET_log_from (kind, "testing-api", __VA_ARGS__)
 
#define LOW_PORT   12000
 Lowest port used for GNUnet testing. More...
 
#define HIGH_PORT   56000
 Highest port used for GNUnet testing. More...
 

Functions

static int hostkeys_load (struct GNUNET_TESTING_System *system)
 Testing includes a number of pre-created hostkeys for faster peer startup. More...
 
static void hostkeys_unload (struct GNUNET_TESTING_System *system)
 Function to remove the loaded hostkeys. More...
 
static void cfg_copy_iterator (void *cls, const char *section, const char *option, const char *value)
 Function to iterate over options. More...
 
struct GNUNET_TESTING_SystemGNUNET_TESTING_system_create_with_portrange (const char *testdir, const char *trusted_ip, const char *hostname, const struct GNUNET_TESTING_SharedService *shared_services, uint16_t lowport, uint16_t highport)
 Create a system handle. More...
 
struct GNUNET_TESTING_SystemGNUNET_TESTING_system_create (const char *testdir, const char *trusted_ip, const char *hostname, const struct GNUNET_TESTING_SharedService *shared_services)
 Create a system handle. More...
 
static void cleanup_shared_service_instance (struct SharedServiceInstance *i)
 
static int start_shared_service_instance (struct SharedServiceInstance *i)
 
static void stop_shared_service_instance (struct SharedServiceInstance *i)
 
void GNUNET_TESTING_system_destroy (struct GNUNET_TESTING_System *system, int remove_paths)
 Free system resources. More...
 
uint16_t GNUNET_TESTING_reserve_port (struct GNUNET_TESTING_System *system)
 Reserve a TCP or UDP port for a peer. More...
 
void GNUNET_TESTING_release_port (struct GNUNET_TESTING_System *system, uint16_t port)
 Release reservation of a TCP or UDP port for a peer (used during GNUNET_TESTING_peer_destroy()). More...
 
struct GNUNET_CRYPTO_EddsaPrivateKeyGNUNET_TESTING_hostkey_get (const struct GNUNET_TESTING_System *system, uint32_t key_number, struct GNUNET_PeerIdentity *id)
 Testing includes a number of pre-created hostkeys for faster peer startup. More...
 
static void update_config (void *cls, const char *section, const char *option, const char *value)
 Function to iterate over options. More...
 
static void update_config_sections (void *cls, const char *section)
 Section iterator to set ACCEPT_FROM/ACCEPT_FROM6 to include the address of 'trusted_hosts' in all sections. More...
 
static struct SharedServiceInstanceassociate_shared_service (struct GNUNET_TESTING_System *system, struct SharedService *ss, struct GNUNET_CONFIGURATION_Handle *cfg)
 
static int GNUNET_TESTING_configuration_create_ (struct GNUNET_TESTING_System *system, struct GNUNET_CONFIGURATION_Handle *cfg, uint16_t **ports, unsigned int *nports)
 Create a new configuration using the given configuration as a template; ports and paths will be modified to select available ports on the local system. More...
 
int GNUNET_TESTING_configuration_create (struct GNUNET_TESTING_System *system, struct GNUNET_CONFIGURATION_Handle *cfg)
 Create a new configuration using the given configuration as a template; ports and paths will be modified to select available ports on the local system. More...
 
struct GNUNET_TESTING_PeerGNUNET_TESTING_peer_configure (struct GNUNET_TESTING_System *system, struct GNUNET_CONFIGURATION_Handle *cfg, uint32_t key_number, struct GNUNET_PeerIdentity *id, char **emsg)
 Configure a GNUnet peer. More...
 
void GNUNET_TESTING_peer_get_identity (struct GNUNET_TESTING_Peer *peer, struct GNUNET_PeerIdentity *id)
 Obtain the peer identity from a peer handle. More...
 
int GNUNET_TESTING_peer_start (struct GNUNET_TESTING_Peer *peer)
 Start the peer. More...
 
int GNUNET_TESTING_peer_kill (struct GNUNET_TESTING_Peer *peer)
 Sends SIGTERM to the peer's main process. More...
 
int GNUNET_TESTING_peer_wait (struct GNUNET_TESTING_Peer *peer)
 Waits for a peer to terminate. More...
 
int GNUNET_TESTING_peer_stop (struct GNUNET_TESTING_Peer *peer)
 Stop the peer. More...
 
static void disconn_status (void *cls, int connected)
 Function called whenever we connect to or disconnect from ARM. More...
 
int GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer, GNUNET_TESTING_PeerStopCallback cb, void *cb_cls)
 Stop a peer asynchronously using ARM API. More...
 
void GNUNET_TESTING_peer_stop_async_cancel (struct GNUNET_TESTING_Peer *peer)
 Cancel a previous asynchronous peer stop request. More...
 
void GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer *peer)
 Destroy the peer. More...
 
int GNUNET_TESTING_peer_run (const char *testdir, const char *cfgfilename, GNUNET_TESTING_TestMain tm, void *tm_cls)
 Start a single peer and run a test using the testing library. More...
 
static void service_run_main (void *cls)
 Callback to be called when SCHEDULER has been started. More...
 
int GNUNET_TESTING_service_run (const char *testdir, const char *service_name, const char *cfgfilename, GNUNET_TESTING_TestMain tm, void *tm_cls)
 Start a single service (no ARM, except of course if the given service name is 'arm') and run a test using the testing library. More...
 
char * GNUNET_TESTING_get_testname_from_underscore (const char *argv0)
 Sometimes we use the binary name to determine which specific test to run. More...
 

Detailed Description

convenience API for writing testcases for GNUnet Many testcases need to start and stop a peer/service and this library is supposed to make that easier for TESTCASES.

Normal programs should always use functions from gnunet_{util,arm}_lib.h. This API is ONLY for writing testcases (or internal use of the testbed).

Author
Christian Grothoff

Definition in file testing.c.

Macro Definition Documentation

◆ LOG

#define LOG (   kind,
  ... 
)    GNUNET_log_from (kind, "testing-api", __VA_ARGS__)

◆ LOW_PORT

#define LOW_PORT   12000

Lowest port used for GNUnet testing.

Should be high enough to not conflict with other applications running on the hosts but be low enough to not conflict with client-ports (typically starting around 32k).

Definition at line 46 of file testing.c.

Referenced by GNUNET_TESTING_system_create().

◆ HIGH_PORT

#define HIGH_PORT   56000

Highest port used for GNUnet testing.

Should be low enough to not conflict with the port range for "local" ports (client apps; see /proc/sys/net/ipv4/ip_local_port_range on Linux for example).

Definition at line 53 of file testing.c.

Referenced by GNUNET_TESTING_system_create().

Function Documentation

◆ hostkeys_load()

static int hostkeys_load ( struct GNUNET_TESTING_System system)
static

Testing includes a number of pre-created hostkeys for faster peer startup.

This function loads such keys into memory from a file.

Parameters
systemthe testing system handle
Returns
GNUNET_OK on success; GNUNET_SYSERR on error

Definition at line 246 of file testing.c.

References _, GNUNET_DISK_FileHandle::fd, filename, fs, GNUNET_asprintf(), GNUNET_assert, GNUNET_DISK_file_close(), GNUNET_DISK_file_map(), GNUNET_DISK_file_open(), GNUNET_DISK_file_size(), GNUNET_DISK_file_test(), GNUNET_DISK_MAP_TYPE_READ, GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_NONE, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_log_strerror_file, GNUNET_OK, GNUNET_OS_installation_get_path(), GNUNET_OS_IPK_DATADIR, GNUNET_SYSERR, GNUNET_TESTING_HOSTKEYFILESIZE, GNUNET_YES, GNUNET_TESTING_System::hostkeys_data, LOG, GNUNET_TESTING_System::map, and GNUNET_TESTING_System::total_hostkeys.

Referenced by GNUNET_TESTING_system_create_with_portrange().

247 {
248  uint64_t fs;
249  char *data_dir;
250  char *filename;
251  struct GNUNET_DISK_FileHandle *fd;
252 
253  GNUNET_assert (NULL == system->hostkeys_data);
255  GNUNET_asprintf (&filename, "%s/testing_hostkeys.ecc", data_dir);
256  GNUNET_free (data_dir);
257 
258  if (GNUNET_YES != GNUNET_DISK_file_test (filename))
259  {
261  _ ("Hostkeys file not found: %s\n"),
262  filename);
263  GNUNET_free (filename);
264  return GNUNET_SYSERR;
265  }
266  /* Check hostkey file size, read entire thing into memory */
267  if (GNUNET_OK !=
268  GNUNET_DISK_file_size (filename, &fs, GNUNET_YES, GNUNET_YES))
269  fs = 0;
270  if (0 == fs)
271  {
272  GNUNET_free (filename);
273  return GNUNET_SYSERR; /* File is empty */
274  }
275  if (0 != (fs % GNUNET_TESTING_HOSTKEYFILESIZE))
276  {
278  _ ("Incorrect hostkey file format: %s\n"),
279  filename);
280  GNUNET_free (filename);
281  return GNUNET_SYSERR;
282  }
283  fd = GNUNET_DISK_file_open (filename,
286  if (NULL == fd)
287  {
289  GNUNET_free (filename);
290  return GNUNET_SYSERR;
291  }
292  GNUNET_free (filename);
293  system->hostkeys_data =
296  if (NULL == system->hostkeys_data)
297  return GNUNET_SYSERR;
299  return GNUNET_OK;
300 }
int GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:544
Open the file for reading.
int GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1280
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define LOG(kind,...)
Definition: testing.c:37
void * GNUNET_DISK_file_map(const struct GNUNET_DISK_FileHandle *h, struct GNUNET_DISK_MapHandle **m, enum GNUNET_DISK_MapType access, size_t len)
Map a file into memory.
Definition: disk.c:1375
Nobody is allowed to do anything to the file.
#define GNUNET_TESTING_HOSTKEYFILESIZE
Size of each hostkey in the hostkey file (in BYTES).
uint32_t total_hostkeys
The number of hostkeys.
Definition: testing.c:147
#define _(String)
GNU gettext support macro.
Definition: platform.h:184
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
char * GNUNET_OS_installation_get_path(enum GNUNET_OS_InstallationPathKind dirkind)
Get the path to a specific GNUnet installation directory or, with GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation directory.
Read-only memory map.
static char * filename
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
static struct GNUNET_FS_Handle * fs
Handle to FS service.
Definition: gnunet-fs.c:36
int GNUNET_DISK_file_size(const char *filename, uint64_t *size, int include_symbolic_links, int single_file_mode)
Get the size of the file (or directory) of the given file (in bytes).
Definition: disk.c:257
struct GNUNET_DISK_MapHandle * map
memory map for hostkeys_data.
Definition: testing.c:118
char * hostkeys_data
Hostkeys data, contains "GNUNET_TESTING_HOSTKEYFILESIZE * total_hostkeys" bytes.
Definition: testing.c:113
int fd
File handle on Unix-like systems.
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1203
Handle used to access files (and pipes).
Return the directory where data is installed (share/gnunet/)
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ hostkeys_unload()

static void hostkeys_unload ( struct GNUNET_TESTING_System system)
static

Function to remove the loaded hostkeys.

Parameters
systemthe testing system handle

Definition at line 309 of file testing.c.

References GNUNET_break, GNUNET_DISK_file_unmap(), GNUNET_TESTING_System::hostkeys_data, GNUNET_TESTING_System::map, and GNUNET_TESTING_System::total_hostkeys.

Referenced by GNUNET_TESTING_service_run(), and GNUNET_TESTING_system_destroy().

310 {
311  GNUNET_break (NULL != system->hostkeys_data);
312  system->hostkeys_data = NULL;
313  GNUNET_DISK_file_unmap (system->map);
314  system->map = NULL;
315  system->hostkeys_data = NULL;
316  system->total_hostkeys = 0;
317 }
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
uint32_t total_hostkeys
The number of hostkeys.
Definition: testing.c:147
int GNUNET_DISK_file_unmap(struct GNUNET_DISK_MapHandle *h)
Unmap a file.
Definition: disk.c:1412
struct GNUNET_DISK_MapHandle * map
memory map for hostkeys_data.
Definition: testing.c:118
char * hostkeys_data
Hostkeys data, contains "GNUNET_TESTING_HOSTKEYFILESIZE * total_hostkeys" bytes.
Definition: testing.c:113
Here is the call graph for this function:
Here is the caller graph for this function:

◆ cfg_copy_iterator()

static void cfg_copy_iterator ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

Function to iterate over options.

Parameters
clsclosure
sectionname of the section
optionname of the option
valuevalue of the option

Definition at line 329 of file testing.c.

References GNUNET_CONFIGURATION_set_value_string().

Referenced by associate_shared_service(), and GNUNET_TESTING_system_create_with_portrange().

333 {
334  struct GNUNET_CONFIGURATION_Handle *cfg2 = cls;
335 
337 }
static char * section
Name of the section.
Definition: gnunet-config.c:33
static char * value
Value of the record to add/remove.
static char * option
Name of the option.
Definition: gnunet-config.c:38
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
configuration data
Definition: configuration.c:84
Here is the call graph for this function:
Here is the caller graph for this function:

◆ cleanup_shared_service_instance()

static void cleanup_shared_service_instance ( struct SharedServiceInstance i)
static

Definition at line 463 of file testing.c.

References SharedServiceInstance::cfg_fn, GNUNET_break, GNUNET_free, SharedServiceInstance::n_refs, SharedServiceInstance::port_str, SharedServiceInstance::proc, and SharedServiceInstance::unix_sock.

Referenced by associate_shared_service(), and GNUNET_TESTING_system_destroy().

464 {
465  if (NULL != i->cfg_fn)
466  {
467  (void) unlink (i->cfg_fn);
468  GNUNET_free (i->cfg_fn);
469  }
470  GNUNET_free (i->unix_sock);
471  GNUNET_free (i->port_str);
472  GNUNET_break (NULL == i->proc);
473  GNUNET_break (0 == i->n_refs);
474  GNUNET_free (i);
475 }
struct GNUNET_OS_Process * proc
Definition: testing.c:62
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
unsigned int n_refs
Definition: testing.c:68
#define GNUNET_free(ptr)
Wrapper around free.
Here is the caller graph for this function:

◆ start_shared_service_instance()

static int start_shared_service_instance ( struct SharedServiceInstance i)
static

Definition at line 479 of file testing.c.

References SharedServiceInstance::cfg_fn, GNUNET_asprintf(), GNUNET_assert, GNUNET_free, GNUNET_OK, GNUNET_OS_get_libexec_binary_path(), GNUNET_OS_INHERIT_STD_OUT_AND_ERR, GNUNET_OS_start_process(), GNUNET_SYSERR, SharedServiceInstance::proc, SharedService::sname, and SharedServiceInstance::ss.

Referenced by GNUNET_TESTING_peer_start().

480 {
481  char *binary;
482  char *libexec_binary;
483 
484  GNUNET_assert (NULL == i->proc);
485  GNUNET_assert (NULL != i->cfg_fn);
486  (void) GNUNET_asprintf (&binary, "gnunet-service-%s", i->ss->sname);
487  libexec_binary = GNUNET_OS_get_libexec_binary_path (binary);
488  GNUNET_free (binary);
490  NULL,
491  NULL,
492  NULL,
493  libexec_binary,
494  libexec_binary,
495  "-c",
496  i->cfg_fn,
497  NULL);
498  GNUNET_free (libexec_binary);
499  if (NULL == i->proc)
500  return GNUNET_SYSERR;
501  return GNUNET_OK;
502 }
struct GNUNET_OS_Process * GNUNET_OS_start_process(enum GNUNET_OS_InheritStdioFlags std_inheritance, struct GNUNET_DISK_PipeHandle *pipe_stdin, struct GNUNET_DISK_PipeHandle *pipe_stdout, struct GNUNET_DISK_PipeHandle *pipe_stderr, const char *filename,...)
Start a process.
Definition: os_priority.c:678
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_OS_Process * proc
Definition: testing.c:62
char * sname
Definition: testing.c:73
When these flags are set, the child process will inherit stdout and stderr of the parent...
Definition: gnunet_os_lib.h:97
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
struct SharedService * ss
Definition: testing.c:58
char * GNUNET_OS_get_libexec_binary_path(const char *progname)
Given the name of a gnunet-helper, gnunet-service or gnunet-daemon binary, try to prefix it with the ...
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ stop_shared_service_instance()

static void stop_shared_service_instance ( struct SharedServiceInstance i)
static

Definition at line 506 of file testing.c.

References GNUNET_break, GNUNET_ERROR_TYPE_WARNING, GNUNET_OS_process_destroy(), GNUNET_OS_process_kill(), GNUNET_OS_process_wait(), GNUNET_TERM_SIG, LOG, SharedServiceInstance::n_refs, SharedServiceInstance::proc, SharedService::sname, and SharedServiceInstance::ss.

Referenced by GNUNET_TESTING_peer_kill(), and GNUNET_TESTING_system_destroy().

507 {
508  GNUNET_break (0 == i->n_refs);
511  "Killing shared service instance (%s) failed\n",
512  i->ss->sname);
513  (void) GNUNET_OS_process_wait (i->proc);
515  i->proc = NULL;
516 }
void GNUNET_OS_process_destroy(struct GNUNET_OS_Process *proc)
Cleans up process structure contents (OS-dependent) and deallocates it.
Definition: os_priority.c:287
#define LOG(kind,...)
Definition: testing.c:37
struct GNUNET_OS_Process * proc
Definition: testing.c:62
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
char * sname
Definition: testing.c:73
unsigned int n_refs
Definition: testing.c:68
struct SharedService * ss
Definition: testing.c:58
int GNUNET_OS_process_wait(struct GNUNET_OS_Process *proc)
Wait for a process to terminate.
Definition: os_priority.c:983
#define GNUNET_TERM_SIG
The termination signal.
Definition: platform.h:246
int GNUNET_OS_process_kill(struct GNUNET_OS_Process *proc, int sig)
Sends a signal to the process.
Definition: os_priority.c:225
Here is the call graph for this function:
Here is the caller graph for this function:

◆ update_config()

static void update_config ( void *  cls,
const char *  section,
const char *  option,
const char *  value 
)
static

Function to iterate over options.

Copies the options to the target configuration, updating PORT values as needed.

Parameters
clsthe UpdateContext
sectionname of the section
optionname of the option
valuevalue of the option

Definition at line 779 of file testing.c.

References UpdateContext::cfg, GNUNET_array_append, GNUNET_asprintf(), GNUNET_break, GNUNET_CONFIGURATION_get_value_number(), GNUNET_CONFIGURATION_get_value_yesno(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_free, UpdateContext::gnunet_home, GNUNET_OK, GNUNET_snprintf(), GNUNET_SYSERR, GNUNET_TESTING_reserve_port(), GNUNET_YES, GNUNET_TESTING_System::hostname, UpdateContext::nports, PATH_MAX, UpdateContext::ports, UpdateContext::status, UpdateContext::system, and uc.

Referenced by GNUNET_TESTING_configuration_create_().

783 {
784  struct UpdateContext *uc = cls;
785  unsigned int ival;
786  char cval[12];
787  char uval[PATH_MAX];
788  char *single_variable;
789  char *per_host_variable;
790  unsigned long long num_per_host;
791  uint16_t new_port;
792 
793  if (GNUNET_OK != uc->status)
794  return;
795  if (! ((0 == strcmp (option, "PORT")) || (0 == strcmp (option, "UNIXPATH")) ||
796  (0 == strcmp (option, "HOSTNAME"))))
797  return;
798  GNUNET_asprintf (&single_variable, "single_%s_per_host", section);
799  GNUNET_asprintf (&per_host_variable, "num_%s_per_host", section);
800  if ((0 == strcmp (option, "PORT")) && (1 == sscanf (value, "%u", &ival)))
801  {
802  if ((ival != 0) &&
804  "testing",
805  single_variable)))
806  {
807  new_port = GNUNET_TESTING_reserve_port (uc->system);
808  if (0 == new_port)
809  {
810  uc->status = GNUNET_SYSERR;
811  GNUNET_free (single_variable);
812  GNUNET_free (per_host_variable);
813  return;
814  }
815  GNUNET_snprintf (cval, sizeof(cval), "%u", new_port);
816  value = cval;
817  GNUNET_array_append (uc->ports, uc->nports, new_port);
818  }
819  else if ((ival != 0) &&
820  (GNUNET_YES ==
822  "testing",
823  single_variable)) &&
825  "testing",
826  per_host_variable,
827  &num_per_host))
828  {
829  /* GNUNET_snprintf (cval, sizeof (cval), "%u", */
830  /* ival + ctx->fdnum % num_per_host); */
831  /* value = cval; */
832  GNUNET_break (0); /* FIXME */
833  }
834  }
835  if (0 == strcmp (option, "UNIXPATH"))
836  {
838  "testing",
839  single_variable))
840  {
841  GNUNET_snprintf (uval,
842  sizeof(uval),
843  "%s/%s.sock",
844  uc->gnunet_home,
845  section);
846  value = uval;
847  }
848  else if ((GNUNET_YES ==
850  "testing",
851  per_host_variable,
852  &num_per_host)) &&
853  (num_per_host > 0))
854  {
855  GNUNET_break (0); /* FIXME */
856  }
857  }
858  if (0 == strcmp (option, "HOSTNAME"))
859  {
860  value = (NULL == uc->system->hostname) ? "localhost" : uc->system->hostname;
861  }
862  GNUNET_free (single_variable);
863  GNUNET_free (per_host_variable);
865 }
struct GNUNET_CONFIGURATION_Handle * cfg
The configuration we are building.
Definition: testing.c:742
Closure for update_rel_sum() and update_abs_sum().
int GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
#define GNUNET_array_append(arr, len, element)
Append an element to an array (growing the array by one).
char * gnunet_home
The customized service home path for this peer.
Definition: testing.c:747
uint16_t * ports
Array of ports currently allocated to this peer.
Definition: testing.c:754
static struct GNUNET_FS_UnindexContext * uc
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static char * section
Name of the section.
Definition: gnunet-config.c:33
int GNUNET_snprintf(char *buf, size_t size, const char *format,...) __attribute__((format(printf
Like snprintf, just aborts if the buffer is of insufficient size.
static char * value
Value of the record to add/remove.
static char * option
Name of the option.
Definition: gnunet-config.c:38
#define PATH_MAX
Assumed maximum path length.
Definition: platform.h:253
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
unsigned int nports
The number of ports in the above array.
Definition: testing.c:759
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
uint16_t GNUNET_TESTING_reserve_port(struct GNUNET_TESTING_System *system)
Reserve a TCP or UDP port for a peer.
Definition: testing.c:569
char * hostname
our hostname
Definition: testing.c:108
struct GNUNET_TESTING_System * system
The system for which we are building configurations.
Definition: testing.c:737
int status
build status - to signal error while building a configuration
Definition: testing.c:764
int GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ update_config_sections()

static void update_config_sections ( void *  cls,
const char *  section 
)
static

Section iterator to set ACCEPT_FROM/ACCEPT_FROM6 to include the address of 'trusted_hosts' in all sections.

Parameters
clsthe UpdateContext
sectionname of the section

Definition at line 876 of file testing.c.

References UpdateContext::cfg, GNUNET_asprintf(), GNUNET_assert, GNUNET_break, GNUNET_CONFIGURATION_get_value_string(), GNUNET_CONFIGURATION_have_value(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_free, GNUNET_malloc, GNUNET_OK, GNUNET_strdup, GNUNET_YES, key, UpdateContext::system, GNUNET_TESTING_System::trusted_ip, and uc.

Referenced by GNUNET_TESTING_configuration_create_().

877 {
878  struct UpdateContext *uc = cls;
879  char **ikeys;
880  char *val;
881  char *ptr;
882  char *orig_allowed_hosts;
883  char *allowed_hosts;
884  char *ACCEPT_FROM_key;
885  uint16_t ikeys_cnt;
886  uint16_t key;
887 
888  ikeys_cnt = 0;
889  val = NULL;
890  /* Ignore certain options from sections. See
891  https://gnunet.org/bugs/view.php?id=2476 */
892  if (GNUNET_YES ==
893  GNUNET_CONFIGURATION_have_value (uc->cfg, section, "TESTING_IGNORE_KEYS"))
894  {
897  section,
898  "TESTING_IGNORE_KEYS",
899  &val));
900  ptr = val;
901  for (ikeys_cnt = 0; NULL != (ptr = strstr (ptr, ";")); ikeys_cnt++)
902  ptr++;
903  if (0 == ikeys_cnt)
904  GNUNET_break (0);
905  else
906  {
907  ikeys = GNUNET_malloc ((sizeof(char *)) * ikeys_cnt);
908  ptr = val;
909  for (key = 0; key < ikeys_cnt; key++)
910  {
911  ikeys[key] = ptr;
912  ptr = strstr (ptr, ";");
913  GNUNET_assert (NULL != ptr); /* worked just before... */
914  *ptr = '\0';
915  ptr++;
916  }
917  }
918  }
919  if (0 != ikeys_cnt)
920  {
921  for (key = 0; key < ikeys_cnt; key++)
922  {
923  if (NULL != strstr (ikeys[key], "ADVERTISED_PORT"))
924  break;
925  }
926  if ((key == ikeys_cnt) &&
927  (GNUNET_YES ==
928  GNUNET_CONFIGURATION_have_value (uc->cfg, section, "ADVERTISED_PORT")))
929  {
931  section,
932  "PORT",
933  &ptr))
934  {
936  section,
937  "ADVERTISED_PORT",
938  ptr);
939  GNUNET_free (ptr);
940  }
941  }
942  for (key = 0; key < ikeys_cnt; key++)
943  {
944  if (NULL != strstr (ikeys[key], "ACCEPT_FROM"))
945  {
946  GNUNET_free (ikeys);
947  GNUNET_free (val);
948  return;
949  }
950  }
951  GNUNET_free (ikeys);
952  }
953  GNUNET_free (val);
954  ACCEPT_FROM_key = "ACCEPT_FROM";
955  if ((NULL != uc->system->trusted_ip) &&
956  (NULL != strstr (uc->system->trusted_ip, ":"))) /* IPv6 in use */
957  ACCEPT_FROM_key = "ACCEPT_FROM6";
959  section,
960  ACCEPT_FROM_key,
961  &orig_allowed_hosts))
962  {
963  orig_allowed_hosts = GNUNET_strdup ("127.0.0.1;");
964  }
965  if (NULL == uc->system->trusted_ip)
966  allowed_hosts = GNUNET_strdup (orig_allowed_hosts);
967  else
968  GNUNET_asprintf (&allowed_hosts,
969  "%s%s;",
970  orig_allowed_hosts,
971  uc->system->trusted_ip);
972  GNUNET_free (orig_allowed_hosts);
974  section,
975  ACCEPT_FROM_key,
976  allowed_hosts);
977  GNUNET_free (allowed_hosts);
978 }
struct GNUNET_CONFIGURATION_Handle * cfg
The configuration we are building.
Definition: testing.c:742
Closure for update_rel_sum() and update_abs_sum().
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
static struct GNUNET_FS_UnindexContext * uc
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static char * section
Name of the section.
Definition: gnunet-config.c:33
int GNUNET_CONFIGURATION_have_value(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Test if we have a value for a particular option.
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
int GNUNET_CONFIGURATION_get_value_string(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be a string.
struct GNUNET_HashCode key
The key used in the DHT.
struct GNUNET_TESTING_System * system
The system for which we are building configurations.
Definition: testing.c:737
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
char * trusted_ip
The trusted ip.
Definition: testing.c:103
Here is the call graph for this function:
Here is the caller graph for this function:

◆ associate_shared_service()

static struct SharedServiceInstance* associate_shared_service ( struct GNUNET_TESTING_System system,
struct SharedService ss,
struct GNUNET_CONFIGURATION_Handle cfg 
)
static

Definition at line 982 of file testing.c.

References SharedService::cfg, cfg_copy_iterator(), SharedServiceInstance::cfg_fn, cleanup_shared_service_instance(), GNUNET_array_append, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONFIGURATION_destroy(), GNUNET_CONFIGURATION_dup(), GNUNET_CONFIGURATION_iterate_section_values(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_CONFIGURATION_write(), GNUNET_free, GNUNET_new, GNUNET_SYSERR, GNUNET_TESTING_reserve_port(), SharedService::instances, SharedService::n_instances, SharedService::n_peers, port, SharedServiceInstance::port_str, SharedService::share, SharedService::sname, SharedServiceInstance::ss, GNUNET_TESTING_System::tmppath, and SharedServiceInstance::unix_sock.

Referenced by GNUNET_TESTING_peer_configure().

985 {
986  struct SharedServiceInstance *i;
987  struct GNUNET_CONFIGURATION_Handle *temp;
988  char *gnunet_home;
989  uint32_t port;
990 
991  ss->n_peers++;
992  if (((0 == ss->share) && (NULL == ss->instances)) ||
993  ((0 != ss->share) &&
994  (ss->n_instances < ((ss->n_peers + ss->share - 1) / ss->share))))
995  {
996  i = GNUNET_new (struct SharedServiceInstance);
997  i->ss = ss;
998  (void) GNUNET_asprintf (&gnunet_home,
999  "%s/shared/%s/%u",
1000  system->tmppath,
1001  ss->sname,
1002  ss->n_instances);
1003  (void) GNUNET_asprintf (&i->unix_sock, "%s/sock", gnunet_home);
1004  port = GNUNET_TESTING_reserve_port (system);
1005  if (0 == port)
1006  {
1007  GNUNET_free (gnunet_home);
1009  return NULL;
1010  }
1012  temp = GNUNET_CONFIGURATION_dup (ss->cfg);
1013  (void) GNUNET_asprintf (&i->port_str, "%u", port);
1014  (void) GNUNET_asprintf (&i->cfg_fn, "%s/config", gnunet_home);
1016  "PATHS",
1017  "GNUNET_HOME",
1018  gnunet_home);
1019  GNUNET_free (gnunet_home);
1021  ss->sname,
1022  "UNIXPATH",
1023  i->unix_sock);
1025  ss->sname,
1026  "PORT",
1027  i->port_str);
1029  {
1032  return NULL;
1033  }
1035  }
1036  else
1037  {
1038  GNUNET_assert (NULL != ss->instances);
1039  GNUNET_assert (0 < ss->n_instances);
1040  i = ss->instances[ss->n_instances - 1];
1041  }
1043  ss->sname,
1045  cfg);
1047  ss->sname,
1048  "UNIXPATH",
1049  i->unix_sock);
1050  GNUNET_CONFIGURATION_set_value_string (cfg, ss->sname, "PORT", i->port_str);
1051  return i;
1052 }
struct GNUNET_CONFIGURATION_Handle * cfg
Definition: testing.c:77
#define GNUNET_array_append(arr, len, element)
Append an element to an array (growing the array by one).
void GNUNET_CONFIGURATION_iterate_section_values(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over values of a section in the configuration.
static void cleanup_shared_service_instance(struct SharedServiceInstance *i)
Definition: testing.c:463
int GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
unsigned int n_instances
Definition: testing.c:83
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
unsigned int share
Definition: testing.c:81
#define GNUNET_new(type)
Allocate a struct or union of the given type.
unsigned int n_peers
Definition: testing.c:79
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
char * sname
Definition: testing.c:73
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
struct SharedService * ss
Definition: testing.c:58
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
static void cfg_copy_iterator(void *cls, const char *section, const char *option, const char *value)
Function to iterate over options.
Definition: testing.c:329
static uint16_t port
Port number.
Definition: gnunet-bcd.c:82
configuration data
Definition: configuration.c:84
struct SharedServiceInstance ** instances
Definition: testing.c:75
uint16_t GNUNET_TESTING_reserve_port(struct GNUNET_TESTING_System *system)
Reserve a TCP or UDP port for a peer.
Definition: testing.c:569
char * tmppath
Prefix (i.e.
Definition: testing.c:97
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_TESTING_configuration_create_()

static int GNUNET_TESTING_configuration_create_ ( struct GNUNET_TESTING_System system,
struct GNUNET_CONFIGURATION_Handle cfg,
uint16_t **  ports,
unsigned int *  nports 
)
static

Create a new configuration using the given configuration as a template; ports and paths will be modified to select available ports on the local system.

The default configuration will be available in PATHS section under the option DEFAULTCONFIG after the call. GNUNET_HOME is also set in PATHS section to the temporary directory specific to this configuration. If we run out of "*port" numbers, return GNUNET_SYSERR.

This is primarily a helper function used internally by 'GNUNET_TESTING_peer_configure'.

Parameters
systemsystem to use to coordinate resource usage
cfgtemplate configuration to update
portsarray with port numbers used in the created configuration. Will be updated upon successful return. Can be NULL
nportsthe size of the `ports' array. Will be updated.
Returns
GNUNET_OK on success, GNUNET_SYSERR on error - the configuration will be incomplete and should not be used there upon

Definition at line 1075 of file testing.c.

References cfg, UpdateContext::cfg, GNUNET_asprintf(), GNUNET_CONFIGURATION_iterate(), GNUNET_CONFIGURATION_iterate_sections(), GNUNET_CONFIGURATION_set_value_string(), GNUNET_free, UpdateContext::gnunet_home, GNUNET_OK, UpdateContext::nports, GNUNET_TESTING_System::path_counter, UpdateContext::ports, UpdateContext::status, UpdateContext::system, GNUNET_TESTING_System::tmppath, update_config(), and update_config_sections().

Referenced by GNUNET_TESTING_configuration_create(), and GNUNET_TESTING_peer_configure().

1079 {
1080  struct UpdateContext uc;
1081  char *default_config;
1082 
1083  uc.system = system;
1084  uc.cfg = cfg;
1085  uc.status = GNUNET_OK;
1086  uc.ports = NULL;
1087  uc.nports = 0;
1088  GNUNET_asprintf (&uc.gnunet_home,
1089  "%s/%u",
1090  system->tmppath,
1091  system->path_counter++);
1092  GNUNET_asprintf (&default_config, "%s/config", uc.gnunet_home);
1094  "PATHS",
1095  "DEFAULTCONFIG",
1096  default_config);
1097  GNUNET_CONFIGURATION_set_value_string (cfg, "arm", "CONFIG", default_config);
1098  GNUNET_free (default_config);
1100  "PATHS",
1101  "GNUNET_HOME",
1102  uc.gnunet_home);
1103  /* make PORTs and UNIXPATHs unique */
1105  /* allow connections to services from system trusted_ip host */
1107  /* enable loopback-based connections between peers */
1108  GNUNET_CONFIGURATION_set_value_string (cfg, "nat", "USE_LOCALADDR", "YES");
1109  GNUNET_free (uc.gnunet_home);
1110  if ((NULL != ports) && (NULL != nports))
1111  {
1112  *ports = uc.ports;
1113  *nports = uc.nports;
1114  }
1115  else
1116  GNUNET_free (uc.ports);
1117  return uc.status;
1118 }
static void update_config(void *cls, const char *section, const char *option, const char *value)
Function to iterate over options.
Definition: testing.c:779
Closure for update_rel_sum() and update_abs_sum().
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
void GNUNET_CONFIGURATION_iterate(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over all options in the configuration.
uint16_t * ports
Array of ports currently allocated to this peer.
Definition: testing.c:754
static struct GNUNET_FS_UnindexContext * uc
uint32_t path_counter
Counter we use to make service home paths unique on this system; the full path consists of the tmppat...
Definition: testing.c:142
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
unsigned int nports
The number of ports in the above array.
Definition: testing.c:759
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
static void update_config_sections(void *cls, const char *section)
Section iterator to set ACCEPT_FROM/ACCEPT_FROM6 to include the address of &#39;trusted_hosts&#39; in all sec...
Definition: testing.c:876
void GNUNET_CONFIGURATION_iterate_sections(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Section_Iterator iter, void *iter_cls)
Iterate over all sections in the configuration.
struct GNUNET_TESTING_System * system
The system for which we are building configurations.
Definition: testing.c:737
char * tmppath
Prefix (i.e.
Definition: testing.c:97
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ disconn_status()

static void disconn_status ( void *  cls,
int  connected 
)
static

Function called whenever we connect to or disconnect from ARM.

Parameters
clsclosure
connectedGNUNET_YES if connected, GNUNET_NO if disconnected, GNUNET_SYSERR on error.

Definition at line 1474 of file testing.c.

References GNUNET_TESTING_Peer::ah, GNUNET_TESTING_Peer::cb, GNUNET_TESTING_Peer::cb_cls, GNUNET_ARM_disconnect(), GNUNET_break, GNUNET_OK, GNUNET_SYSERR, GNUNET_TESTING_peer_kill(), GNUNET_TESTING_peer_wait(), GNUNET_YES, and peer.

Referenced by GNUNET_TESTING_peer_stop_async().

1475 {
1476  struct GNUNET_TESTING_Peer *peer = cls;
1477 
1478  if (GNUNET_SYSERR == connected)
1479  {
1480  peer->cb (peer->cb_cls, peer, connected);
1481  return;
1482  }
1483  if (GNUNET_YES == connected)
1484  {
1486  return;
1487  }
1489  GNUNET_ARM_disconnect (peer->ah);
1490  peer->ah = NULL;
1491  peer->cb (peer->cb_cls, peer, GNUNET_YES);
1492 }
Handle for a GNUnet peer controlled by testing.
Definition: testing.c:164
struct GNUNET_ARM_Handle * ah
The handle to the peer&#39;s ARM service.
Definition: testing.c:194
void GNUNET_ARM_disconnect(struct GNUNET_ARM_Handle *h)
Disconnect from the ARM service (if connected) and destroy the context.
Definition: arm_api.c:604
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
int GNUNET_TESTING_peer_kill(struct GNUNET_TESTING_Peer *peer)
Sends SIGTERM to the peer&#39;s main process.
Definition: testing.c:1401
void * cb_cls
The closure for the above callback.
Definition: testing.c:209
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
GNUNET_TESTING_PeerStopCallback cb
The callback to call asynchronously when a peer is stopped.
Definition: testing.c:204
int GNUNET_TESTING_peer_wait(struct GNUNET_TESTING_Peer *peer)
Waits for a peer to terminate.
Definition: testing.c:1433
Here is the call graph for this function:
Here is the caller graph for this function:

◆ service_run_main()

static void service_run_main ( void *  cls)
static

Callback to be called when SCHEDULER has been started.

Parameters
clsthe ServiceContext

Definition at line 1632 of file testing.c.

References ServiceContext::cfg, ServiceContext::peer, sc, ServiceContext::tm, and ServiceContext::tm_cls.

Referenced by GNUNET_TESTING_service_run().

1633 {
1634  struct ServiceContext *sc = cls;
1635 
1636  sc->tm (sc->tm_cls, sc->cfg, sc->peer);
1637 }
const struct GNUNET_CONFIGURATION_Handle * cfg
The configuration of the peer in which the service is run.
Definition: testing.c:1607
void * tm_cls
Closure for the above callback.
Definition: testing.c:1622
Structure for holding service data.
Definition: testing.c:1602
GNUNET_TESTING_TestMain tm
Callback to signal service startup.
Definition: testing.c:1612
static struct GNUNET_FS_SearchContext * sc
Definition: gnunet-search.c:37
struct GNUNET_TESTING_Peer * peer
The peer in which the service is run.
Definition: testing.c:1617
Here is the caller graph for this function: