From 57d66a199ad1a718e16c1f3719fd75835104845f Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Thu, 3 May 2012 15:20:08 +0000 Subject: [PATCH] -draft of new testing code --- src/testing/new_testing_api.c | 150 ++++++++++++ src/testing/new_testing_api_hosts.c | 200 +++++++++++++++ src/testing/new_testing_api_hosts.h | 105 ++++++++ src/testing/new_testing_api_operations.c | 74 ++++++ src/testing/new_testing_api_operations.h | 34 +++ src/testing/new_testing_api_peers.c | 297 +++++++++++++++++++++++ src/testing/new_testing_api_peers.h | 71 ++++++ src/testing/new_testing_api_services.c | 61 +++++ src/testing/new_testing_api_test.c | 67 +++++ src/testing/new_testing_api_testbed.c | 153 ++++++++++++ src/testing/new_testing_api_topology.c | 127 ++++++++++ 11 files changed, 1339 insertions(+) create mode 100644 src/testing/new_testing_api.c create mode 100644 src/testing/new_testing_api_hosts.c create mode 100644 src/testing/new_testing_api_hosts.h create mode 100644 src/testing/new_testing_api_operations.c create mode 100644 src/testing/new_testing_api_operations.h create mode 100644 src/testing/new_testing_api_peers.c create mode 100644 src/testing/new_testing_api_peers.h create mode 100644 src/testing/new_testing_api_services.c create mode 100644 src/testing/new_testing_api_test.c create mode 100644 src/testing/new_testing_api_testbed.c create mode 100644 src/testing/new_testing_api_topology.c diff --git a/src/testing/new_testing_api.c b/src/testing/new_testing_api.c new file mode 100644 index 000000000..bc65476ee --- /dev/null +++ b/src/testing/new_testing_api.c @@ -0,0 +1,150 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api.c + * @brief API for accessing the GNUnet testing service. + * This library is supposed to make it easier to write + * testcases and script large-scale benchmarks. + * @author Christian Grothoff + */ +#include "platform.h" +#include "gnunet_testing_service.h" +#include "gnunet_core_service.h" +#include "gnunet_constants.h" +#include "gnunet_transport_service.h" +#include "gnunet_hello_lib.h" + + + + +/** + * Start a controller process using the given configuration at the + * given host. + * + * @param cfg configuration to use + * @param host host to run the controller on, NULL for 'localhost' + * @param event_mask bit mask with set of events to call 'cc' for; + * or-ed values of "1LL" shifted by the + * respective 'enum GNUNET_TESTING_EventType' + * (i.e. "(1LL << GNUNET_TESTING_ET_CONNECT) | ...") + * @param cc controller callback to invoke on events + * @param cc_cls closure for cc + * @return handle to the controller + */ +struct GNUNET_TESTING_Controller * +GNUNET_TESTING_controller_start (const struct GNUNET_CONFIGURATION_Handle *cfg, + struct GNUNET_TESTING_Host *host, + uint64_t event_mask, + GNUNET_TESTING_ControllerCallback cc, + void *cc_cls) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Configure shared services at a controller. Using this function, + * you can specify that certain services (such as "resolver") + * should not be run for each peer but instead be shared + * across N peers on the specified host. This function + * must be called before any peers are created at the host. + * + * @param controller controller to configure + * @param service_name name of the service to share + * @param num_peers number of peers that should share one instance + * of the specified service (1 for no sharing is the default), + * use 0 to disable the service + */ +void +GNUNET_TESTING_controller_configure_sharing (struct GNUNET_TESTING_Controller *controller, + const char *service_name, + uint32_t num_peers) +{ + GNUNET_break (0); +} + + +/** + * Stop the given controller (also will terminate all peers and + * controllers dependent on this controller). This function + * blocks until the testbed has been fully terminated (!). + * + * @param controller handle to controller to stop + */ +void +GNUNET_TESTING_controller_stop (struct GNUNET_TESTING_Controller *controller) +{ + GNUNET_break (0); +} + + +/** + * Create a link from a 'master' controller to a slave controller. + * Whenever the master controller is asked to start a peer at the + * given 'delegated_host', it will delegate the request to the + * specified slave controller. Note that the slave controller runs at + * the 'slave_host', which may or may not be the same host as the + * 'delegated_host' (for hierarchical delegations). The configuration + * of the slave controller is given and to be used to either create + * the slave controller or to connect to an existing slave controller + * process. 'is_subordinate' specifies if the given slave controller + * should be started and managed by the master controller, or if the + * slave already has a master and this is just a secondary master that + * is also allowed to use the existing slave. + * + * @param master handle to the master controller who creates the association + * @param delegated_host requests to which host should be delegated + * @param slave_host which host is used to run the slave controller + * @param slave_cfg configuration to use for the slave controller + * @param is_subordinate GNUNET_YES if the slave should be started (and stopped) + * by the master controller; GNUNET_NO if we are just + * allowed to use the slave via TCP/IP + */ +void +GNUNET_TESTING_controller_link (struct GNUNET_TESTING_Controller *master, + struct GNUNET_TESTING_Host *delegated_host, + struct GNUNET_TESTING_Host *slave_host, + const struct GNUNET_CONFIGURATION_Handle *slave_cfg, + int is_subordinate) +{ + GNUNET_break (0); +} + + +/** + * Ask the testbed controller to write the current overlay topology to + * a file. Naturally, the file will only contain a snapshot as the + * topology may evolve all the time. + * + * @param controller overlay controller to inspect + * @param filename name of the file the topology should + * be written to. + */ +void +GNUNET_TESTING_overlay_write_topology_to_file (struct GNUNET_TESTING_Controller *controller, + const char *filename) +{ +} + + + +/* end of new_testing_api.c */ diff --git a/src/testing/new_testing_api_hosts.c b/src/testing/new_testing_api_hosts.c new file mode 100644 index 000000000..ed409d99d --- /dev/null +++ b/src/testing/new_testing_api_hosts.c @@ -0,0 +1,200 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_hosts.c + * @brief API for manipulating 'hosts' controlled by the GNUnet testing service; + * allows parsing hosts files, starting, stopping and communicating (via + * SSH/stdin/stdout) with the remote (or local) processes + * @author Christian Grothoff + */ +#include "platform.h" +#include "gnunet_testing_service.h" +#include "gnunet_core_service.h" +#include "gnunet_constants.h" +#include "gnunet_transport_service.h" +#include "gnunet_hello_lib.h" + + + +/** + * Opaque handle to a host running experiments managed by the testing framework. + * The master process must be able to SSH to this host without password (via + * ssh-agent). + */ +struct GNUNET_TESTING_Host +{ + + + const char *hostname; + + const char *username; + + /** + * Global ID we use to refer to a host on the network + */ + uint32_t unique_id; + + uint16_t port; +}; + + +/** + * Lookup a host by ID. + * + * @param id global host ID assigned to the host; 0 is + * reserved to always mean 'localhost' + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_lookup_by_id_ (uint32_t id) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Create a host by ID; given this host handle, we could not + * run peers at the host, but we can talk about the host + * internally. + * + * @param id global host ID assigned to the host; 0 is + * reserved to always mean 'localhost' + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_create_by_id_ (uint32_t id) +{ + return NULL; +} + + +/** + * Obtain a host's unique global ID. + * + * @param host handle to the host, NULL means 'localhost' + * @return id global host ID assigned to the host (0 is + * 'localhost', but then obviously not globally unique) + */ +uint32_t +GNUNET_TESTING_host_get_id_ (struct GNUNET_TESTING_Host *host) +{ + GNUNET_break (0); + return 0; +} + + +/** + * Create a host to run peers and controllers on. + * + * @param id global host ID assigned to the host; 0 is + * reserved to always mean 'localhost' + * @param hostname name of the host, use "NULL" for localhost + * @param username username to use for the login; may be NULL + * @param port port number to use for ssh; use 0 to let ssh decide + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_create_with_id_ (uint32_t id, + const char *hostname, + const char *username, + uint16_t port) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Create a host to run peers and controllers on. + * + * @param hostname name of the host, use "NULL" for localhost + * @param username username to use for the login; may be NULL + * @param port port number to use for ssh; use 0 to let ssh decide + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_create (const char *hostname, + const char *username, + uint16_t port) +{ + static uint32_t uid_generator; + + return GNUNET_TESTING_host_create_with_id_ (++uid_generator, + hostname, username, + port); +} + + +/** + * Load a set of hosts from a configuration file. + * + * @param filename file with the host specification + * @param hosts set to the hosts found in the file + * @return number of hosts returned in 'hosts', 0 on error + */ +unsigned int +GNUNET_TESTING_hosts_load_from_file (const char *filename, + struct GNUNET_TESTING_Host **hosts) +{ + GNUNET_break (0); + return 0; +} + + +/** + * Destroy a host handle. Must only be called once everything + * running on that host has been stopped. + * + * @param host handle to destroy + */ +void +GNUNET_TESTING_host_destroy (struct GNUNET_TESTING_Host *host) +{ + GNUNET_break (0); +} + + +/** + * Run a given helper process at the given host. Communication + * with the helper will be via GNUnet messages on stdin/stdout. + * Runs the process via 'ssh' at the specified host, or locally. + * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API. + * + * @param host host to use, use "NULL" for localhost + * @param shell_command command line to execute (binary name with arguments) + * @param + * @return handle to terminate the command, NULL on error + */ +struct GNUNET_HELPER_Handle * +GNUNET_TESTING_host_run_ (struct GNUNET_TESTING_Host *host, + const char *binary_name, + char *const binary_argv[], + GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls) +{ + /* FIXME: decide on the SSH command line, prepend it and + run GNUNET_HELPER_start with the modified binary_name and binary_argv! */ + GNUNET_break (0); + return NULL; +} + + +/* end of new_testing_api_hosts.c */ diff --git a/src/testing/new_testing_api_hosts.h b/src/testing/new_testing_api_hosts.h new file mode 100644 index 000000000..dcde7aadf --- /dev/null +++ b/src/testing/new_testing_api_hosts.h @@ -0,0 +1,105 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_hosts.h + * @brief internal API to access the 'hosts' subsystem + * @author Christian Grothoff + */ +#ifndef NEW_TESTING_API_HOSTS_H +#define NEW_TESTING_API_HOSTS_H + +#include "gnunet_testing_service.h" +#include "gnunet_helper_lib.h" + + +/** + * Lookup a host by ID. + * + * @param id global host ID assigned to the host; 0 is + * reserved to always mean 'localhost' + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_lookup_by_id_ (uint32_t id); + + +/** + * Create a host by ID; given this host handle, we could not + * run peers at the host, but we can talk about the host + * internally. + * + * @param id global host ID assigned to the host; 0 is + * reserved to always mean 'localhost' + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_create_by_id_ (uint32_t id); + + +/** + * Create a host to run peers and controllers on. This function is used + * if a peer learns about a host via IPC between controllers (and thus + * some higher-level controller has already determined the unique IDs). + * + * @param id global host ID assigned to the host; 0 is + * reserved to always mean 'localhost' + * @param hostname name of the host, use "NULL" for localhost + * @param username username to use for the login; may be NULL + * @param port port number to use for ssh; use 0 to let ssh decide + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Host * +GNUNET_TESTING_host_create_with_id_ (uint32_t id, + const char *hostname, + const char *username, + uint16_t port); + + +/** + * Obtain a host's unique global ID. + * + * @param host handle to the host, NULL means 'localhost' + * @return id global host ID assigned to the host (0 is + * 'localhost', but then obviously not globally unique) + */ +uint32_t +GNUNET_TESTING_host_get_id_ (struct GNUNET_TESTING_Host *host); + + +/** + * Run a given helper process at the given host. Communication + * with the helper will be via GNUnet messages on stdin/stdout. + * Runs the process via 'ssh' at the specified host, or locally. + * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API. + * + * @param host host to use, use "NULL" for localhost + * @param shell_command command line to execute (binary name with arguments) + * @param + * @return handle to terminate the command, NULL on error + */ +struct GNUNET_HELPER_Handle * +GNUNET_TESTING_host_run_ (struct GNUNET_TESTING_Host *host, + const char *binary_name, + char *const binary_argv[], + GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls); + +#endif +/* end of new_testing_api_hosts.h */ diff --git a/src/testing/new_testing_api_operations.c b/src/testing/new_testing_api_operations.c new file mode 100644 index 000000000..533715b50 --- /dev/null +++ b/src/testing/new_testing_api_operations.c @@ -0,0 +1,74 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_operations.c + * @brief functions to manage operation queues + * @author Christian Grothoff + */ +#include "platform.h" +#include "new_testing_api_operations.h" + + +/** + * Opaque handle to an abstract operation to be executed by the testing framework. + */ +struct GNUNET_TESTING_Operation +{ + // FIXME! +}; + + + +/** + * Cancel a pending operation. Releases all resources + * of the operation and will ensure that no event + * is generated for the operation. Does NOT guarantee + * that the operation will be fully undone (or that + * nothing ever happened). + * + * @param operation operation to cancel + */ +void +GNUNET_TESTING_operation_cancel (struct GNUNET_TESTING_Operation *operation) +{ + GNUNET_break (0); + +} + + +/** + * Signal that the information from an operation has been fully + * processed. This function MUST be called for each event + * of type 'operation_finished' to fully remove the operation + * from the operation queue. After calling this function, the + * 'op_result' becomes invalid (!). + * + * @param operation operation to signal completion for + */ +void +GNUNET_TESTING_operation_done (struct GNUNET_TESTING_Operation *operation) +{ + GNUNET_break (0); +} + + + +/* end of new_testing_api_operations.c */ diff --git a/src/testing/new_testing_api_operations.h b/src/testing/new_testing_api_operations.h new file mode 100644 index 000000000..3636fa421 --- /dev/null +++ b/src/testing/new_testing_api_operations.h @@ -0,0 +1,34 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_operations.h + * @brief internal API to access the 'operations' subsystem + * @author Christian Grothoff + */ +#ifndef NEW_TESTING_API_OPERATIONS_H +#define NEW_TESTING_API_OPERATIONS_H + +#include "gnunet_testing_service.h" +#include "gnunet_helper_lib.h" + + +#endif +/* end of new_testing_api_operations.h */ diff --git a/src/testing/new_testing_api_peers.c b/src/testing/new_testing_api_peers.c new file mode 100644 index 000000000..fae38b3be --- /dev/null +++ b/src/testing/new_testing_api_peers.c @@ -0,0 +1,297 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_peers.c + * @brief management of the knowledge about peers in this library + * (we know the peer ID, its host, pending operations, etc.) + * @author Christian Grothoff + */ +#include "platform.h" +#include "new_testing_api_peers.h" + + +/** + * Details about a peer; kept in a separate struct to avoid bloating + * memory consumption everywhere... + */ +struct PeerDetails +{ + /** + * Configuration of the peer; NULL if we are not sure what the peer's correct + * configuration actually is; non-NULL if this peer is controlled by this + * process. + */ + struct GNUNET_CONFIGURATION_Handle *cfg; + + /** + * If this process has started this peer's ARM process, this is the handle + * to the 'gnunet-service-arm' process of the peer. + */ + struct GNUNET_OS_Process *arm; + + // ... + +}; + + +/** + * A peer controlled by the testing framework. A peer runs + * at a particular host. + */ +struct GNUNET_TESTING_Peer +{ + /** + * Our controller context (not necessarily the controller + * that is responsible for starting/running the peer!). + */ + struct GNUNET_TESTING_Controller *controller; + + /** + * Which host does this peer run on? + */ + struct GNUENT_TESTING_Host *host; + + /** + * Globally unique ID of the peer. + */ + uint32_t unique_id; + + /** + * Internals of the peer for the controlling process; NULL if + * this process is not controlling this peer. + */ + struct PeerDetails *details; + +}; + + +/** + * Lookup a peer by ID. + * + * @param id global peer ID assigned to the peer + * @return handle to the host, NULL on error + */ +struct GNUNET_TESTING_Peer * +GNUNET_TESTING_peer_lookup_by_id_ (uint32_t id) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Create the given peer at the specified host using the given + * controller. If the given controller is not running on the target + * host, it should find or create a controller at the target host and + * delegate creating the peer. Explicit delegation paths can be setup + * using 'GNUNET_TESTING_controller_link'. If no explicit delegation + * path exists, a direct link with a subordinate controller is setup + * for the first delegated peer to a particular host; the subordinate + * controller is then destroyed once the last peer that was delegated + * to the remote host is stopped. This function is used in particular + * if some other controller has already assigned a unique ID to the + * peer. + * + * Creating the peer only creates the handle to manipulate and further + * configure the peer; use "GNUNET_TESTING_peer_start" and + * "GNUNET_TESTING_peer_stop" to actually start/stop the peer's + * processes. + * + * Note that the given configuration will be adjusted by the + * controller to avoid port/path conflicts with other peers. + * The "final" configuration can be obtained using + * 'GNUNET_TESTING_peer_get_information'. + * + * @param unique_id unique ID for this peer + * @param controller controller process to use + * @param host host to run the peer on + * @param cfg configuration to use for the peer + * @return handle to the peer (actual startup will happen asynchronously) + */ +struct GNUNET_TESTING_Peer * +GNUNET_TESTING_peer_create_with_id_ (struct GNUNET_TESTING_Controller *controller, + uint32_t unique_id, + struct GNUNET_TESTING_Host *host, + const struct GNUNET_CONFIGURATION_Handle *cfg) +{ + // FIXME: create locally or delegate... + GNUNET_break (0); + return NULL; +} + + +/** + * Create the given peer at the specified host using the given + * controller. If the given controller is not running on the target + * host, it should find or create a controller at the target host and + * delegate creating the peer. Explicit delegation paths can be setup + * using 'GNUNET_TESTING_controller_link'. If no explicit delegation + * path exists, a direct link with a subordinate controller is setup + * for the first delegated peer to a particular host; the subordinate + * controller is then destroyed once the last peer that was delegated + * to the remote host is stopped. + * + * Creating the peer only creates the handle to manipulate and further + * configure the peer; use "GNUNET_TESTING_peer_start" and + * "GNUNET_TESTING_peer_stop" to actually start/stop the peer's + * processes. + * + * Note that the given configuration will be adjusted by the + * controller to avoid port/path conflicts with other peers. + * The "final" configuration can be obtained using + * 'GNUNET_TESTING_peer_get_information'. + * + * @param controller controller process to use + * @param host host to run the peer on + * @param cfg configuration to use for the peer + * @return handle to the peer (actual startup will happen asynchronously) + */ +struct GNUNET_TESTING_Peer * +GNUNET_TESTING_peer_create (struct GNUNET_TESTING_Controller *controller, + struct GNUNET_TESTING_Host *host, + const struct GNUNET_CONFIGURATION_Handle *cfg) +{ + static uint32_t id_gen; + + return GNUNET_TESTING_peer_create_with_id_ (++id_gen, + controller, + host, + cfg); +} + + +/** + * Start the given peer. + * + * @param peer peer to start + * @return handle to the operation + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_peer_start (struct GNUNET_TESTING_Peer *peer) +{ + // FIXME: start locally or delegate... + GNUNET_break (0); + return NULL; +} + + +/** + * Stop the given peer. The handle remains valid (use + * "GNUNET_TESTING_peer_destroy" to fully clean up the + * state of the peer). + * + * @param peer peer to stop + * @return handle to the operation + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_peer_stop (struct GNUNET_TESTING_Peer *peer) +{ + // FIXME: stop locally or delegate... + GNUNET_break (0); + return NULL; +} + + +/** + * Request information about a peer. + * + * @param peer peer to request information about + * @param pit desired information + * @return handle to the operation + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_peer_get_information (struct GNUNET_TESTING_Peer *peer, + enum GNUNET_TESTING_PeerInformationType pit) +{ + // FIXME: handle locally or delegate... + GNUNET_break (0); + return NULL; +} + + +/** + * Change peer configuration. Must only be called while the + * peer is stopped. Ports and paths cannot be changed this + * way. + * + * @param peer peer to change configuration for + * @param cfg new configuration (differences to existing + * configuration only) + * @return handle to the operation + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_peer_update_configuration (struct GNUNET_TESTING_Peer *peer, + const struct GNUNET_CONFIGURATION_Handle *cfg) +{ + // FIXME: handle locally or delegate... + GNUNET_break (0); + return NULL; +} + + +/** + * Manipulate the P2P underlay topology by configuring a link + * between two peers. + * + * @param op_cls closure argument to give with the operation event + * @param p1 first peer + * @param p2 second peer + * @param co option to change + * @param ... option-specific values + * @return handle to the operation, NULL if configuring the link at this + * time is not allowed + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_underlay_configure_link (void *op_cls, + struct GNUNET_TESTING_Peer *p1, + struct GNUNET_TESTING_Peer *p2, + enum GNUNET_TESTING_ConnectOption co, ...) +{ + GNUNET_break (0); + return NULL; +} + + + +/** + * Both peers must have been started before calling this function. + * This function then obtains a HELLO from 'p1', gives it to 'p2' + * and asks 'p2' to connect to 'p1'. + * + * @param op_cls closure argument to give with the operation event + * @param p1 first peer + * @param p2 second peer + * @return handle to the operation, NULL if connecting these two + * peers is fundamentally not possible at this time (peers + * not running or underlay disallows) + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_overlay_connect (void *op_cls, + struct GNUNET_TESTING_Peer *p1, + struct GNUNET_TESTING_Peer *p2) +{ + GNUNET_break (0); + return NULL; +} + + + +/* end of new_testing_api_peers.c */ diff --git a/src/testing/new_testing_api_peers.h b/src/testing/new_testing_api_peers.h new file mode 100644 index 000000000..a7987f6b2 --- /dev/null +++ b/src/testing/new_testing_api_peers.h @@ -0,0 +1,71 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_peers.h + * @brief internal API to access the 'peers' subsystem + * @author Christian Grothoff + */ +#ifndef NEW_TESTING_API_PEERS_H +#define NEW_TESTING_API_PEERS_H + +#include "gnunet_testing_service.h" +#include "gnunet_helper_lib.h" + + +/** + * Create the given peer at the specified host using the given + * controller. If the given controller is not running on the target + * host, it should find or create a controller at the target host and + * delegate creating the peer. Explicit delegation paths can be setup + * using 'GNUNET_TESTING_controller_link'. If no explicit delegation + * path exists, a direct link with a subordinate controller is setup + * for the first delegated peer to a particular host; the subordinate + * controller is then destroyed once the last peer that was delegated + * to the remote host is stopped. This function is used in particular + * if some other controller has already assigned a unique ID to the + * peer. + * + * Creating the peer only creates the handle to manipulate and further + * configure the peer; use "GNUNET_TESTING_peer_start" and + * "GNUNET_TESTING_peer_stop" to actually start/stop the peer's + * processes. + * + * Note that the given configuration will be adjusted by the + * controller to avoid port/path conflicts with other peers. + * The "final" configuration can be obtained using + * 'GNUNET_TESTING_peer_get_information'. + * + * @param unique_id unique ID for this peer + * @param controller controller process to use + * @param host host to run the peer on + * @param cfg configuration to use for the peer + * @return handle to the peer (actual startup will happen asynchronously) + */ +struct GNUNET_TESTING_Peer * +GNUNET_TESTING_peer_create_with_id_ (uint32_t unique_id, + struct GNUNET_TESTING_Controller *controller, + struct GNUNET_TESTING_Host *host, + const struct GNUNET_CONFIGURATION_Handle *cfg); + + + +#endif +/* end of new_testing_api_peers.h */ diff --git a/src/testing/new_testing_api_services.c b/src/testing/new_testing_api_services.c new file mode 100644 index 000000000..67bc497f8 --- /dev/null +++ b/src/testing/new_testing_api_services.c @@ -0,0 +1,61 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_services.c + * @brief convenience functions for accessing services + * @author Christian Grothoff + */ +#include "platform.h" +#include "new_testing_api_peers.h" + + +/** + * Connect to a service offered by the given peer. Will ensure that + * the request is queued to not overwhelm our ability to create and + * maintain connections with other systems. The actual service + * handle is then returned via the 'op_result' member in the event + * callback. The 'ca' callback is used to create the connection + * when the time is right; the 'da' callback will be used to + * destroy the connection (upon 'GNUNET_TESTING_operation_done'). + * 'GNUNET_TESTING_operation_cancel' can be used to abort this + * operation until the event callback has been called. + * + * @param op_cls closure to pass in operation event + * @param peer peer that runs the service + * @param service_name name of the service to connect to + * @param ca helper function to establish the connection + * @param da helper function to close the connection + * @param cada_cls closure for ca and da + * @return handle for the operation + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_service_connect (void *op_cls, + struct GNUNET_TESTING_Peer *peer, + const char *service_name, + GNUNET_TESTING_ConnectAdapter ca, + GNUNET_TESTING_DisconnectAdapter da, + void *cada_cls) +{ + GNUNET_break (0); + return NULL; +} + +/* end of new_testing_api_services.c */ diff --git a/src/testing/new_testing_api_test.c b/src/testing/new_testing_api_test.c new file mode 100644 index 000000000..7fa51af40 --- /dev/null +++ b/src/testing/new_testing_api_test.c @@ -0,0 +1,67 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_test.c + * @brief high-level test function + * @author Christian Grothoff + */ +#include "platform.h" +#include "gnunet_testing_service.h" + + + + +/** + * Convenience method for running a "simple" test on the local system + * with a single call from 'main'. Underlay and overlay topology are + * configured using the "UNDERLAY" and "OVERLAY" options in the + * "[testbed]" section of the configuration (with possible options + * given in "UNDERLAY_XXX" and/or "OVERLAY_XXX"). + * + * The test is to be terminated using a call to + * "GNUNET_SCHEDULER_shutdown". If starting the test fails, + * the program is stopped without 'master' ever being run. + * + * NOTE: this function should be called from 'main', NOT from + * within a GNUNET_SCHEDULER-loop. This function will initialze + * the scheduler loop, the testbed and then pass control to + * 'master'. + * + * @param testname name of the testcase (to configure logging, etc.) + * @param cfg_filename configuration filename to use + * (for testbed, controller and peers) + * @param num_peers number of peers to start + * @param test_master task to run once the test is ready + * @param test_master_cls closure for 'task'. + */ +void +GNUNET_TESTING_test_run (const char *testname, + const char *cfg_filename, + unsigned int num_peers, + GNUNET_TESTING_TestMaster test_master, + void *test_master_cls) +{ + GNUNET_break (0); +} + + + +/* end of new_testing_api_test.c */ diff --git a/src/testing/new_testing_api_testbed.c b/src/testing/new_testing_api_testbed.c new file mode 100644 index 000000000..a86b8a237 --- /dev/null +++ b/src/testing/new_testing_api_testbed.c @@ -0,0 +1,153 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_testbed.c + * @brief high-level testbed management + * @author Christian Grothoff + */ +#include "platform.h" +#include "gnunet_testing_service.h" + + +/** + * Opaque handle to an abstract operation to be executed by the testing framework. + */ +struct GNUNET_TESTING_Testbed +{ + // FIXME! +}; + + +/** + * Configure and run a testbed using the given + * master controller on 'num_hosts' starting + * 'num_peers' using the given peer configuration. + * + * @param controller master controller for the testbed + * (must not be destroyed until after the + * testbed is destroyed). + * @param num_hosts number of hosts in 'hosts', 0 to only + * use 'localhost' + * @param hosts list of hosts to use for the testbed + * @param num_peers number of peers to start + * @param peer_cfg peer configuration template to use + * @param underlay_topology underlay topology to create + * @param va topology-specific options + * @return handle to the testbed + */ +struct GNUNET_TESTING_Testbed * +GNUNET_TESTING_testbed_create_va (struct GNUNET_TESTING_Controller *controller, + unsigned int num_hosts, + struct GNUNET_TESTING_Host **hosts, + unsigned int num_peers, + const struct GNUNET_CONFIGURATION_Handle *peer_cfg, + enum GNUNET_TESTING_Topology underlay_topology, + va_list va) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Configure and run a testbed using the given + * master controller on 'num_hosts' starting + * 'num_peers' using the given peer configuration. + * + * @param controller master controller for the testbed + * (must not be destroyed until after the + * testbed is destroyed). + * @param num_hosts number of hosts in 'hosts', 0 to only + * use 'localhost' + * @param hosts list of hosts to use for the testbed + * @param num_peers number of peers to start + * @param peer_cfg peer configuration template to use + * @param underlay_topology underlay topology to create + * @param ... topology-specific options + */ +struct GNUNET_TESTING_Testbed * +GNUNET_TESTING_testbed_create (struct GNUNET_TESTING_Controller *controller, + unsigned int num_hosts, + struct GNUNET_TESTING_Host **hosts, + unsigned int num_peers, + const struct GNUNET_CONFIGURATION_Handle *peer_cfg, + enum GNUNET_TESTING_Topology underlay_topology, + ...) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Destroy a testbed. Stops all running peers and then + * destroys all peers. Does NOT destroy the master controller. + * + * @param testbed testbed to destroy + */ +void +GNUNET_TESTING_testbed_destroy (struct GNUNET_TESTING_Testbed *testbed) +{ + GNUNET_break (0); +} + + + +/** + * Convenience method for running a testbed with + * a single call. Underlay and overlay topology + * are configured using the "UNDERLAY" and "OVERLAY" + * options in the "[testbed]" section of the configuration\ + * (with possible options given in "UNDERLAY_XXX" and/or + * "OVERLAY_XXX"). + * + * The testbed is to be terminated using a call to + * "GNUNET_SCHEDULER_shutdown". + * + * @param host_filename name of the file with the 'hosts', NULL + * to run everything on 'localhost' + * @param cfg configuration to use (for testbed, controller and peers) + * @param num_peers number of peers to start; FIXME: maybe put that ALSO into cfg? + * @param event_mask bit mask with set of events to call 'cc' for; + * or-ed values of "1LL" shifted by the + * respective 'enum GNUNET_TESTING_EventType' + * (i.e. "(1LL << GNUNET_TESTING_ET_CONNECT) || ...") + * @param cc controller callback to invoke on events + * @param cc_cls closure for cc + * @param master task to run once the testbed is ready + * @param master_cls closure for 'task'. + */ +void +GNUNET_TESTING_testbed_run (const char *host_filename, + const struct GNUNET_CONFIGURATION_Handle *cfg, + unsigned int num_peers, + uint64_t event_mask, + GNUNET_TESTING_ControllerCallback cc, + void *cc_cls, + GNUNET_SCHEDULER_Task master, + void *master_cls) +{ + GNUNET_break (0); +} + + + +/* end of new_testing_api_testbed.c */ diff --git a/src/testing/new_testing_api_topology.c b/src/testing/new_testing_api_topology.c new file mode 100644 index 000000000..877e6733e --- /dev/null +++ b/src/testing/new_testing_api_topology.c @@ -0,0 +1,127 @@ +/* + This file is part of GNUnet + (C) 2008--2012 Christian Grothoff (and other contributing authors) + + GNUnet is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published + by the Free Software Foundation; either version 3, or (at your + option) any later version. + + GNUnet is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNUnet; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + */ + +/** + * @file testing/new_testing_api_topology.c + * @brief topology-generation functions + * @author Christian Grothoff + */ +#include "platform.h" +#include "gnunet_testing_service.h" + + +/** + * Configure overall network topology to have a particular shape. + * + * @param op_cls closure argument to give with the operation event + * @param num_peers number of peers in 'peers' + * @param peers array of 'num_peers' with the peers to configure + * @param topo desired underlay topology to use + * @param ap topology-specific options + * @return handle to the operation, NULL if configuring the topology + * is not allowed at this time + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_underlay_configure_topology_va (void *op_cls, + unsigned int num_peers, + struct GNUNET_TESTING_Peer **peers, + enum GNUNET_TESTING_TopologyOption topo, + va_list ap) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * Configure overall network topology to have a particular shape. + * + * @param op_cls closure argument to give with the operation event + * @param num_peers number of peers in 'peers' + * @param peers array of 'num_peers' with the peers to configure + * @param topo desired underlay topology to use + * @param ... topology-specific options + * @return handle to the operation, NULL if configuring the topology + * is not allowed at this time + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_underlay_configure_topology (void *op_cls, + unsigned int num_peers, + struct GNUNET_TESTING_Peer **peers, + enum GNUNET_TESTING_TopologyOption topo, + ...) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * All peers must have been started before calling this function. + * This function then connects the given peers in the P2P overlay + * using the given topology. + * + * @param op_cls closure argument to give with the operation event + * @param num_peers number of peers in 'peers' + * @param peers array of 'num_peers' with the peers to configure + * @param topo desired underlay topology to use + * @param va topology-specific options + * @return handle to the operation, NULL if connecting these + * peers is fundamentally not possible at this time (peers + * not running or underlay disallows) + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_overlay_configure_topology_va (void *op_cls, + unsigned int num_peers, + struct GNUNET_TESTING_Peer *peers, + enum GNUNET_TESTING_TopologyOption topo, + va_list va) +{ + GNUNET_break (0); + return NULL; +} + + +/** + * All peers must have been started before calling this function. + * This function then connects the given peers in the P2P overlay + * using the given topology. + * + * @param op_cls closure argument to give with the operation event + * @param num_peers number of peers in 'peers' + * @param peers array of 'num_peers' with the peers to configure + * @param topo desired underlay topology to use + * @param ... topology-specific options + * @return handle to the operation, NULL if connecting these + * peers is fundamentally not possible at this time (peers + * not running or underlay disallows) + */ +struct GNUNET_TESTING_Operation * +GNUNET_TESTING_overlay_configure_topology (void *op_cls, + unsigned int num_peers, + struct GNUNET_TESTING_Peer *peers, + enum GNUNET_TESTING_TopologyOption topo, + ...) +{ + GNUNET_break (0); + return NULL; +} + +/* end of new_testing_api_topology.c */ -- 2.25.1