From e64b28a891c2366d4b599ea5b1d4308a5bba2a27 Mon Sep 17 00:00:00 2001 From: t3sserakt Date: Mon, 29 Mar 2021 10:01:00 +0200 Subject: - added testbed commands --- src/include/gnunet_testbed_ng_service.h | 247 ++++++++++++++++++++ src/include/gnunet_testbed_service.h | 2 +- src/testbed/Makefile.am | 3 + src/testbed/testbed_api_cmd_controller.c | 294 ++++++++++++++++++++++++ src/testbed/testbed_api_cmd_peer.c | 249 ++++++++++++++++++++ src/testing/testing_api_cmd_hello_world_birth.c | 6 +- 6 files changed, 796 insertions(+), 5 deletions(-) create mode 100644 src/include/gnunet_testbed_ng_service.h create mode 100644 src/testbed/testbed_api_cmd_controller.c create mode 100644 src/testbed/testbed_api_cmd_peer.c (limited to 'src') diff --git a/src/include/gnunet_testbed_ng_service.h b/src/include/gnunet_testbed_ng_service.h new file mode 100644 index 000000000..a6f30889f --- /dev/null +++ b/src/include/gnunet_testbed_ng_service.h @@ -0,0 +1,247 @@ +/* + This file is part of GNUnet + Copyright (C) 2021 GNUnet e.V. + + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + 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 + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + SPDX-License-Identifier: AGPL3.0-or-later + */ + +/** + * @author t3sserakt + * + * @file + * API for writing tests and creating large-scale emulation testbeds for GNUnet with command pattern. + * + * @defgroup testbed Testbed service + * Writing tests and creating large-scale emulation testbeds for GNUnet with command pattern. + * + * @see [Documentation](https://docs.gnunet.org/handbook/gnunet.html#TESTBED-NG-Subsystem) + * + * @{ + */ + +#ifndef GNUNET_TESTBED_NG_SERVICE_H +#define GNUNET_TESTBED_NG_SERVICE_H + +#include "gnunet_util_lib.h" +#include "gnunet_testing_ng_lib.h" + +struct ServiceState +{ + /** + * Handle to operation + */ + struct GNUNET_TESTBED_Operation *operation; + + /** + * Flag indicating if service is ready. + */ + int service_ready; + + /** + * Abort task identifier + */ + struct GNUNET_SCHEDULER_Task *abort_task; + + /** + * Label of peer command. + */ + const char *peer_label; + + /** + * Name of service to start. + */ + const char *servicename; +}; + +struct PeerCmdState +{ + /** + * The label of a controller command. + */ + const char *controller_label; + + /** + * Handle to operation + */ + struct GNUNET_TESTBED_Operation *operation; + + /** + * Name of the host, use "NULL" for localhost. + */ + const char *hostname; + + /** + * Username to use for the login; may be NULL. + */ + const char *username; + + /** + * Port number to use for ssh; use 0 to let ssh decide. + */ + uint16_t port; + + /** + * The configuration to use as a template while starting a controller + * on this host. Operation queue sizes specific to a host are also + * read from this configuration handle. + */ + struct GNUNET_CONFIGURATION_Handle *cfg; + + /** + * The host to run peers and controllers on + */ + struct GNUNET_TESTBED_Host *host; + + /** + * Abort task identifier + */ + struct GNUNET_SCHEDULER_Task *abort_task; + + /** + * Handle for host registration + */ + struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle; + + /** + * Flag indicating if peer is ready. + */ + int peer_ready; + + /** + * Flag indicating controller is going down. + */ + int peer_going_down; + + /** + * Interpreter state. + */ + struct GNUNET_TESTING_Interpreter *is; + + /** + * Peer to start + */ + struct GNUNET_TESTBED_Peer *peer; +}; + +struct ControllerState +{ + /** + * The ip address of the controller which will be set as TRUSTED + * HOST(all connections form this ip are permitted by the testbed) when + * starting testbed controller at host. This can either be a single ip + * address or a network address in CIDR notation. + */ + const char *trusted_ip; + + /** + * Name of the host, use "NULL" for localhost. + */ + const char *hostname; + + /** + * Username to use for the login; may be NULL. + */ + const char *username; + + /** + * Port number to use for ssh; use 0 to let ssh decide. + */ + uint16_t port; + + /** + * The configuration to use as a template while starting a controller + * on this host. Operation queue sizes specific to a host are also + * read from this configuration handle. + */ + struct GNUNET_CONFIGURATION_Handle *cfg; + + /** + * The host to run peers and controllers on + */ + struct GNUNET_TESTBED_Host *host; + + /** + * The controller process + */ + struct GNUNET_TESTBED_ControllerProc *cp; + + /** + * The controller handle + */ + struct GNUNET_TESTBED_Controller *controller; + + /** + * A bit mask with set of events to call the controller for. + */ + uint64_t event_mask; + + /** + * Abort task identifier + */ + struct GNUNET_SCHEDULER_Task *abort_task; + + /** + * Handle for host registration + */ + struct GNUNET_TESTBED_HostRegistrationHandle *reg_handle; + + /** + * Flag indicating if host create with controller is ready. + */ + int host_ready; + + /** + * Flag indicating controller is going down. + */ + int controller_going_down; + + /** + * Interpreter state. + */ + struct GNUNET_TESTING_Interpreter *is; +}; + +/** + * Offer data from trait + * + * @param cmd command to extract the controller from. + * @param pt pointer to controller. + * @return #GNUNET_OK on success. + */ +int +GNUNET_TESTBED_get_trait_controller (const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTBED_Controller ** + controller); + +struct GNUNET_TESTING_Command +GNUNET_TESTBED_cmd_controller (const char *label, + const char *trusted_ip, + const char *hostname, + const char *username, + uint16_t port, + struct GNUNET_CONFIGURATION_Handle *cfg, + uint64_t event_mask); + +void +GNUNET_TESTBED_shutdown_controller (struct ControllerState *cs); + +void +GNUNET_TESTBED_shutdown_peer (struct PeerCmdState *ps); + +void +GNUNET_TESTBED_shutdown_service (struct ServiceState *ss); + +#endif diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index 70cbfa90d..acdfb2034 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h @@ -27,7 +27,7 @@ * @defgroup testbed Testbed service * Writing tests and creating large-scale emulation testbeds for GNUnet. * - * @see [Documentation](https://gnunet.org/gnunet-testbed-subsystem) + * @see [Documentation](https://docs.gnunet.org/handbook/gnunet.html#TESTBED-Subsystem) * * @{ */ diff --git a/src/testbed/Makefile.am b/src/testbed/Makefile.am index 7c1e217bb..7a59670cb 100644 --- a/src/testbed/Makefile.am +++ b/src/testbed/Makefile.am @@ -94,6 +94,9 @@ lib_LTLIBRARIES = \ libgnunettestbed_la_SOURCES = \ testbed_api.c testbed_api.h testbed.h \ testbed_api_hosts.c testbed_api_hosts.h testbed_helper.h \ + testbed_api_cmd_controller.c \ + testbed_api_cmd_peer.c \ + testbed_api_cmd_service.c \ testbed_api_operations.c testbed_api_operations.h \ testbed_api_peers.c testbed_api_peers.h \ testbed_api_services.c \ diff --git a/src/testbed/testbed_api_cmd_controller.c b/src/testbed/testbed_api_cmd_controller.c new file mode 100644 index 000000000..d65f41760 --- /dev/null +++ b/src/testbed/testbed_api_cmd_controller.c @@ -0,0 +1,294 @@ +/* + This file is part of GNUnet + Copyright (C) 2021 GNUnet e.V. + + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + 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 + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + SPDX-License-Identifier: AGPL3.0-or-later + */ + +/** + * @file testbed/testbed_api_cmd_controller.c + * @brief Command to create a controller. + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_util_lib.h" +#include "gnunet_testing_ng_lib.h" +#include "gnunet-service-testbed.h" +#include "testbed_api_hosts.h" +#include "gnunet_testbed_ng_service.h" + + +/** + * Generic logging shortcut + */ +#define LOG(kind, ...) \ + GNUNET_log (kind, __VA_ARGS__) + + +/** + * abort task to run on test timed out + * + * @param cls NULL + * @param tc the task context + */ +static void +do_abort (void *cls) +{ + struct ControllerState *cs = cls; + + if (GNUNET_NO == cs->host_ready) + { + LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n"); + cs->abort_task = NULL; + GNUNET_TESTBED_shutdown_controller (cs); + } +} + + +/** +* +* +* @param cls closure +* @param cmd current CMD being cleaned up. +*/ +static void +controller_cleanup (void *cls, + const struct GNUNET_TESTING_Command *cmd) +{ + (void) cls; +} + + +/** + * Signature of the event handler function called by the + * respective event controller. + * + * @param cls closure + * @param event information about the event + */ +static void +controller_cb (void *cls, + const struct GNUNET_TESTBED_EventInformation *event) +{ + struct ControllerState *cs = cls; + + if (NULL != event->details.operation_finished.emsg) + { + LOG (GNUNET_ERROR_TYPE_ERROR, "There was an operation error: %s\n", + event->details.operation_finished.emsg); + GNUNET_TESTBED_shutdown_controller (cs); + } + else if (NULL == event->details.operation_finished.generic) + { + GNUNET_TESTBED_operation_done (event->op); + } +} + + +/** + * Callback which will be called to after a host registration succeeded or failed + * + * @param cls the host which has been registered + * @param emsg the error message; NULL if host registration is successful + */ +static void +registration_comp (void *cls, + const char *emsg) +{ + struct ControllerState *cs = cls; + + if (NULL != emsg) + { + LOG (GNUNET_ERROR_TYPE_ERROR, + "There was an error during host registration: %s\n", + emsg); + GNUNET_TESTBED_shutdown_controller (cs); + } + else + { + cs->reg_handle = NULL; + cs->host_ready = GNUNET_YES; + GNUNET_TESTING_interpreter_next (cs->is); + } +} + + +/** + * Callback to signal successfull startup of the controller process + * + * @param cls the closure from GNUNET_TESTBED_controller_start() + * @param cfg the configuration with which the controller has been started; + * NULL if status is not #GNUNET_OK + * @param status #GNUNET_OK if the startup is successfull; #GNUNET_SYSERR if not, + * GNUNET_TESTBED_controller_stop() shouldn't be called in this case + */ +static void +controller_status_cb (void *cls, + const struct GNUNET_CONFIGURATION_Handle *cfg_, + int status) +{ + struct ControllerState *cs = cls; + + if (GNUNET_OK != status) + { + cs->cp = NULL; + return; + } + + cs->controller = + GNUNET_TESTBED_controller_connect (cs->host, cs->event_mask, &controller_cb, + cs); + cs->reg_handle = + GNUNET_TESTBED_register_host (cs->controller, cs->host, ®istration_comp, + cs); +} + + +static void +controller_run (void *cls, + const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTING_Interpreter *is) +{ + struct ControllerState *cs = cls; + + cs->is = is; + cs->host = GNUNET_TESTBED_host_create (cs->hostname, cs->username, cs->cfg, + cs->port); + cs->cp = GNUNET_TESTBED_controller_start (cs->trusted_ip, + cs->host, + &controller_status_cb, + cs); + cs->abort_task = + GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply + (GNUNET_TIME_UNIT_MINUTES, 5), + &do_abort, + cs); +} + +/** +* +* +* @param cls closure. +* @param[out] ret result +* @param trait name of the trait. +* @param index index number of the object to offer. +* @return #GNUNET_OK on success. +*/ +static int +controller_traits (void *cls, + const void **ret, + const char *trait, + unsigned int index) +{ + (void) cls; + + struct ControllerState *cs = cls; + + + struct GNUNET_TESTING_Trait traits[] = { + { + .index = 0, + .trait_name = "controller", + .ptr = (const void *) cs->controller, + }, + GNUNET_TESTING_trait_end () + }; + + return GNUNET_TESTING_get_trait (traits, + ret, + trait, + index); + return GNUNET_OK; +} + + +/** + * Offer data from trait + * + * @param cmd command to extract the controller from. + * @param pt pointer to controller. + * @return #GNUNET_OK on success. + */ +int +GNUNET_TESTBED_get_trait_controller (const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTBED_Controller ** + controller) +{ + return cmd->traits (cmd->cls, + (const void **) controller, + "controller", + (unsigned int) 0); +} + + +/** + * Shutdown nicely + * + * @param cs controller state. + */ +void +GNUNET_TESTBED_shutdown_controller (struct ControllerState *cs) +{ + LOG (GNUNET_ERROR_TYPE_DEBUG, + "Shutting down...\n"); + + cs->controller_going_down = GNUNET_YES; + + if (NULL != cs->abort_task) + GNUNET_SCHEDULER_cancel (cs->abort_task); + if (NULL != cs->reg_handle) + GNUNET_TESTBED_cancel_registration (cs->reg_handle); + if (NULL != cs->controller) + GNUNET_TESTBED_controller_disconnect (cs->controller); + if (NULL != cs->cfg) + GNUNET_CONFIGURATION_destroy (cs->cfg); + if (NULL != cs->cp) + GNUNET_TESTBED_controller_stop (cs->cp); + if (NULL != cs->host) + GNUNET_TESTBED_host_destroy (cs->host); +} + + + +struct GNUNET_TESTING_Command +GNUNET_TESTBED_cmd_controller (const char *label, + const char *trusted_ip, + const char *hostname, + const char *username, + uint16_t port, + struct GNUNET_CONFIGURATION_Handle *cfg, + uint64_t event_mask) +{ + struct ControllerState *cs; + + cs = GNUNET_new (struct ControllerState); + cs->event_mask = event_mask; + cs->trusted_ip = trusted_ip; + cs->hostname = hostname; + cs->username = username; + cs->port = port; + cs->cfg = cfg; + + struct GNUNET_TESTING_Command cmd = { + .cls = cs, + .label = label, + .run = &controller_run, + .cleanup = &controller_cleanup, + .traits = &controller_traits + }; + + return cmd; +} diff --git a/src/testbed/testbed_api_cmd_peer.c b/src/testbed/testbed_api_cmd_peer.c new file mode 100644 index 000000000..4a727bc94 --- /dev/null +++ b/src/testbed/testbed_api_cmd_peer.c @@ -0,0 +1,249 @@ +/* + This file is part of GNUnet + Copyright (C) 2021 GNUnet e.V. + + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + 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 + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + SPDX-License-Identifier: AGPL3.0-or-later + */ + + +/** + * @file testbed/testbed_api_cmd_controller.c + * @brief Command to create a controller. + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_util_lib.h" +#include "gnunet_testing_ng_lib.h" +#include "gnunet_testbed_ng_service.h" +#include "gnunet-service-testbed.h" +#include "testbed_api_peers.h" + + +/** + * Generic logging shortcut + */ +#define LOG(kind, ...) \ + GNUNET_log (kind, __VA_ARGS__) + + +/** +* +* +* @param cls closure. +* @param[out] ret result +* @param trait name of the trait. +* @param index index number of the object to offer. +* @return #GNUNET_OK on success. +*/ +static int +peer_traits (void *cls, + const void **ret, + const char *trait, + unsigned int index) +{ + (void) cls; + return GNUNET_OK; +} + + +/** +* +* +* @param cls closure +* @param cmd current CMD being cleaned up. +*/ +static void +peer_cleanup (void *cls, + const struct GNUNET_TESTING_Command *cmd) +{ + (void) cls; +} + + +/** + * abort task to run on test timed out + * + * @param cls NULL + * @param tc the task context + */ +static void +do_abort (void *cls) +{ + struct PeerCmdState *ps = cls; + + if (GNUNET_NO == ps->peer_ready) + { + LOG (GNUNET_ERROR_TYPE_WARNING, "Test timedout -- Aborting\n"); + ps->abort_task = NULL; + GNUNET_TESTBED_shutdown_peer (ps); + } +} + + +/** + * Functions of this signature are called when a peer has been successfully + * created + * + * @param cls the closure from GNUNET_TESTBED_peer_create() + * @param emsg MAY contain an error description, if starting peer failed. + */ +static void +peer_started_cb (void *cls, + const char *emsg) +{ + struct PeerCmdState *ps = cls; + + GNUNET_TESTBED_operation_done (ps->operation); + if (NULL == emsg) + { + ps->peer_ready = GNUNET_YES; + GNUNET_TESTING_interpreter_next (ps->is); + } + else + { + LOG (GNUNET_ERROR_TYPE_ERROR, "There was an error starting a peer: %s\n", + emsg); + } + +} + + +/** + * Functions of this signature are called when a peer has been successfully + * created + * + * @param cls the closure from GNUNET_TESTBED_peer_create() + * @param peer the handle for the created peer; NULL on any error during + * creation + * @param emsg NULL if peer is not NULL; else MAY contain the error description + */ +static void +peer_create_cb (void *cls, + struct GNUNET_TESTBED_Peer *peer, + const char *emsg) +{ + struct PeerCmdState *ps = cls; + + ps->peer = peer; + GNUNET_TESTBED_operation_done (ps->operation); + ps->operation = GNUNET_TESTBED_peer_start (NULL, + peer, + &peer_started_cb, + ps); +} + + +static void +peer_run (void *cls, + const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTING_Interpreter *is) +{ + struct PeerCmdState *ps = cls; + const struct GNUNET_TESTING_Command *controller_cmd; + struct GNUNET_TESTBED_Controller *controller; + + ps->is = is; + controller_cmd = GNUNET_TESTING_interpreter_lookup_command ( + ps->controller_label); + GNUNET_TESTBED_get_trait_controller (controller_cmd, + &controller); + ps->host = GNUNET_TESTBED_host_create (ps->hostname, ps->username, ps->cfg, + ps->port); + ps->operation = + GNUNET_TESTBED_peer_create (controller, + ps->host, + ps->cfg, + &peer_create_cb, + ps); + + ps->abort_task = + GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_relative_multiply + (GNUNET_TIME_UNIT_MINUTES, 5), + &do_abort, + ps); +} + + +void +peer_stopped_cb (void *cls, + const char *emsg) +{ + struct PeerCmdState *ps = cls; + + if (NULL != emsg) + { + LOG (GNUNET_ERROR_TYPE_ERROR, "There was an error stopping a peer: %s\n", + emsg); + } + GNUNET_TESTBED_operation_done (ps->operation); + GNUNET_TESTBED_peer_destroy (ps->peer); +} + + +/** + * Shutdown nicely + * + * @param cs controller state. + */ +void +GNUNET_TESTBED_shutdown_peer (struct PeerCmdState *ps) +{ + LOG (GNUNET_ERROR_TYPE_DEBUG, + "Shutting down...\n"); + + ps->peer_going_down = GNUNET_YES; + + if (NULL != ps->abort_task) + GNUNET_SCHEDULER_cancel (ps->abort_task); + if (NULL != ps->cfg) + GNUNET_CONFIGURATION_destroy (ps->cfg); + if (NULL != ps->host) + GNUNET_TESTBED_host_destroy (ps->host); + + GNUNET_TESTBED_operation_done (ps->operation); + ps->operation = GNUNET_TESTBED_peer_stop (NULL, ps->peer, peer_stopped_cb, + ps); + +} + + +struct GNUNET_TESTING_Command +GNUNET_TESTBED_cmd_peer (const char *label, + const char *controller_label, + const char *hostname, + const char *username, + uint16_t port, + struct GNUNET_CONFIGURATION_Handle *cfg) +{ + struct PeerCmdState *ps; + + ps = GNUNET_new (struct PeerCmdState); + ps->hostname = hostname; + ps->username = username; + ps->port = port; + ps->cfg = cfg; + ps->controller_label = controller_label; + + struct GNUNET_TESTING_Command cmd = { + .cls = ps, + .label = label, + .run = &peer_run, + .cleanup = &peer_cleanup, + .traits = &peer_traits + }; + + return cmd; +} diff --git a/src/testing/testing_api_cmd_hello_world_birth.c b/src/testing/testing_api_cmd_hello_world_birth.c index 546b30212..0faf93cd8 100644 --- a/src/testing/testing_api_cmd_hello_world_birth.c +++ b/src/testing/testing_api_cmd_hello_world_birth.c @@ -118,10 +118,8 @@ hello_world_birth_run (void *cls, /** * Offer data from trait * - * @param cmd command to extract the url from. - * @param pt which url is to be picked, in case - * multiple are offered. - * @param[out] url where to write the url. + * @param cmd command to extract the message from. + * @param pt pointer to message. * @return #GNUNET_OK on success. */ int -- cgit v1.2.3