From e5d31aa52e4983bffce3eca6ca601bbb8f4a302a Mon Sep 17 00:00:00 2001 From: t3sserakt Date: Thu, 4 Mar 2021 10:41:01 +0100 Subject: - first try to integrate GNU Taler command style testing --- src/testing/Makefile.am | 25 +- src/testing/test_testing_hello_world.c | 61 +++ src/testing/testing_api_cmd_batch.c | 257 ++++++++++ src/testing/testing_api_cmd_hello_world.c | 113 ++++ src/testing/testing_api_cmd_hello_world_birth.c | 160 ++++++ src/testing/testing_api_loop.c | 652 ++++++++++++++++++++++++ src/testing/testing_api_trait_cmd.c | 79 +++ src/testing/testing_api_trait_process.c | 81 +++ src/testing/testing_api_traits.c | 81 +++ 9 files changed, 1508 insertions(+), 1 deletion(-) create mode 100644 src/testing/test_testing_hello_world.c create mode 100644 src/testing/testing_api_cmd_batch.c create mode 100644 src/testing/testing_api_cmd_hello_world.c create mode 100644 src/testing/testing_api_cmd_hello_world_birth.c create mode 100644 src/testing/testing_api_loop.c create mode 100644 src/testing/testing_api_trait_cmd.c create mode 100644 src/testing/testing_api_trait_process.c create mode 100644 src/testing/testing_api_traits.c (limited to 'src/testing') diff --git a/src/testing/Makefile.am b/src/testing/Makefile.am index 2b599f55b..f7aa1f896 100644 --- a/src/testing/Makefile.am +++ b/src/testing/Makefile.am @@ -15,7 +15,14 @@ lib_LTLIBRARIES = \ libgnunettesting.la libgnunettesting_la_SOURCES = \ - testing.c + testing.c \ + testing_api_cmd_batch.c \ + testing_api_cmd_hello_world.c \ + testing_api_cmd_hello_world_birth.c \ + testing_api_loop.c \ + testing_api_trait_cmd.c \ + testing_api_trait_process.c \ + testing_api_traits.c libgnunettesting_la_LIBADD = \ $(top_builddir)/src/arm/libgnunetarm.la \ $(top_builddir)/src/util/libgnunetutil.la \ @@ -48,8 +55,10 @@ list_keys_LDADD = \ check_PROGRAMS = \ + test_testing_hello_world \ test_testing_portreservation \ test_testing_servicestartup \ + test_testing_ng_peerstartup \ test_testing_peerstartup \ test_testing_peerstartup2 \ test_testing_sharedservices @@ -57,18 +66,32 @@ check_PROGRAMS = \ if ENABLE_TEST_RUN AM_TESTS_ENVIRONMENT=export GNUNET_PREFIX=$${GNUNET_PREFIX:-@libdir@};export PATH=$${GNUNET_PREFIX:-@prefix@}/bin:$$PATH;unset XDG_DATA_HOME;unset XDG_CONFIG_HOME; TESTS = \ + test_testing_hello_world \ test_testing_portreservation \ + test_testing_ng_peerstartup \ test_testing_peerstartup \ test_testing_peerstartup2 \ test_testing_servicestartup endif +test_testing_helloworld_SOURCES = \ + test_testing_hello_world +test_testing_portreservation_LDADD = \ + libgnunettesting.la \ + $(top_builddir)/src/util/libgnunetutil.la + test_testing_portreservation_SOURCES = \ test_testing_portreservation.c test_testing_portreservation_LDADD = \ libgnunettesting.la \ $(top_builddir)/src/util/libgnunetutil.la +test_testing_ng_peerstartup_SOURCES = \ + test_testing_ng_peerstartup.c +test_testing_ng_peerstartup_LDADD = \ + libgnunettesting.la \ + $(top_builddir)/src/util/libgnunetutil.la + test_testing_peerstartup_SOURCES = \ test_testing_peerstartup.c test_testing_peerstartup_LDADD = \ diff --git a/src/testing/test_testing_hello_world.c b/src/testing/test_testing_hello_world.c new file mode 100644 index 000000000..689d04ed3 --- /dev/null +++ b/src/testing/test_testing_hello_world.c @@ -0,0 +1,61 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/test_testing_hello_world.c + * @brief hello world test case + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + +/** + * Main function that will tell the interpreter what commands to + * run. + * + * @param cls closure + */ +static void +run (void *cls, + struct GNUNET_TESTING_Interpreter *is) +{ + struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get (); + + struct GNUNET_TESTING_Command commands[] = { + GNUNET_TESTING_cmd_hello_world_birth ("hello-world-birth-0", + &now), + GNUNET_TESTING_cmd_hello_world ("hello-world-0",""), + GNUNET_TESTING_cmd_end () + }; + + GNUNET_TESTING_run (is, + commands); +} + +int +main (int argc, + char *const *argv) +{ + return GNUNET_TESTING_setup (&run, + NULL, + NULL, + NULL, + GNUNET_NO); +} diff --git a/src/testing/testing_api_cmd_batch.c b/src/testing/testing_api_cmd_batch.c new file mode 100644 index 000000000..74a763718 --- /dev/null +++ b/src/testing/testing_api_cmd_batch.c @@ -0,0 +1,257 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_cmd_batch.c + * @brief Implement batch-execution of CMDs. + * @author Marcello Stanisci (GNU Taler testing) + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + + +/** + * State for a "batch" CMD. + */ +struct BatchState +{ + /** + * CMDs batch. + */ + struct GNUNET_TESTING_Command *batch; + + /** + * Internal command pointer. + */ + unsigned int batch_ip; +}; + + +/** + * Run the command. + * + * @param cls closure. + * @param cmd the command being executed. + * @param is the interpreter state. + */ +static void +batch_run (void *cls, + const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTING_Interpreter *is) +{ + struct BatchState *bs = cls; + + if (NULL != bs->batch[bs->batch_ip].label) + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Running batched command: %s\n", + bs->batch[bs->batch_ip].label); + + /* hit end command, leap to next top-level command. */ + if (NULL == bs->batch[bs->batch_ip].label) + { + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Exiting from batch: %s\n", + cmd->label); + GNUNET_TESTING_interpreter_next (is); + return; + } + bs->batch[bs->batch_ip].start_time + = bs->batch[bs->batch_ip].last_req_time + = GNUNET_TIME_absolute_get (); + bs->batch[bs->batch_ip].num_tries = 1; + bs->batch[bs->batch_ip].run (bs->batch[bs->batch_ip].cls, + &bs->batch[bs->batch_ip], + is); +} + + +/** + * Cleanup the state from a "reserve status" CMD, and possibly + * cancel a pending operation thereof. + * + * @param cls closure. + * @param cmd the command which is being cleaned up. + */ +static void +batch_cleanup (void *cls, + const struct GNUNET_TESTING_Command *cmd) +{ + struct BatchState *bs = cls; + + (void) cmd; + for (unsigned int i = 0; + NULL != bs->batch[i].label; + i++) + bs->batch[i].cleanup (bs->batch[i].cls, + &bs->batch[i]); + GNUNET_free (bs->batch); + GNUNET_free (bs); +} + + +/** + * Offer internal data from a "batch" CMD, to other commands. + * + * @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 +batch_traits (void *cls, + const void **ret, + const char *trait, + unsigned int index) +{ +#define CURRENT_CMD_INDEX 0 +#define BATCH_INDEX 1 + + struct BatchState *bs = cls; + + struct GNUNET_TESTING_Trait traits[] = { + GNUNET_TESTING_make_trait_cmd + (CURRENT_CMD_INDEX, &bs->batch[bs->batch_ip]), + GNUNET_TESTING_make_trait_cmd + (BATCH_INDEX, bs->batch), + GNUNET_TESTING_trait_end () + }; + + /* Always return current command. */ + return GNUNET_TESTING_get_trait (traits, + ret, + trait, + index); +} + + +/** + * Create a "batch" command. Such command takes a + * end_CMD-terminated array of CMDs and executed them. + * Once it hits the end CMD, it passes the control + * to the next top-level CMD, regardless of it being + * another batch or ordinary CMD. + * + * @param label the command label. + * @param batch array of CMDs to execute. + * + * @return the command. + */ +struct GNUNET_TESTING_Command +GNUNET_TESTING_cmd_batch (const char *label, + struct GNUNET_TESTING_Command *batch) +{ + struct BatchState *bs; + unsigned int i; + + bs = GNUNET_new (struct BatchState); + + /* Get number of commands. */ + for (i = 0; NULL != batch[i].label; i++) + /* noop */ + ; + + bs->batch = GNUNET_new_array (i + 1, + struct GNUNET_TESTING_Command); + memcpy (bs->batch, + batch, + sizeof (struct GNUNET_TESTING_Command) * i); + { + struct GNUNET_TESTING_Command cmd = { + .cls = bs, + .label = label, + .run = &batch_run, + .cleanup = &batch_cleanup, + .traits = &batch_traits + }; + + return cmd; + } +} + + +/** + * Advance internal pointer to next command. + * + * @param is interpreter state. + */ +void +GNUNET_TESTING_cmd_batch_next (struct GNUNET_TESTING_Interpreter *is) +{ + struct BatchState *bs = is->commands[is->ip].cls; + + if (NULL == bs->batch[bs->batch_ip].label) + { + is->commands[is->ip].finish_time = GNUNET_TIME_absolute_get (); + is->ip++; + return; + } + bs->batch[bs->batch_ip].finish_time = GNUNET_TIME_absolute_get (); + bs->batch_ip++; +} + + +/** + * Test if this command is a batch command. + * + * @return false if not, true if it is a batch command + */ +int +GNUNET_TESTING_cmd_is_batch (const struct GNUNET_TESTING_Command *cmd) +{ + return cmd->run == &batch_run; +} + + +/** + * Obtain what command the batch is at. + * + * @return cmd current batch command + */ +struct GNUNET_TESTING_Command * +GNUNET_TESTING_cmd_batch_get_current (const struct GNUNET_TESTING_Command *cmd) +{ + struct BatchState *bs = cmd->cls; + + GNUNET_assert (cmd->run == &batch_run); + return &bs->batch[bs->batch_ip]; +} + + +/** + * Set what command the batch should be at. + * + * @param cmd current batch command + * @param new_ip where to move the IP + */ +void +GNUNET_TESTING_cmd_batch_set_current (const struct GNUNET_TESTING_Command *cmd, + unsigned int new_ip) +{ + struct BatchState *bs = cmd->cls; + + /* sanity checks */ + GNUNET_assert (cmd->run == &batch_run); + for (unsigned int i = 0; i < new_ip; i++) + GNUNET_assert (NULL != bs->batch[i].label); + /* actual logic */ + bs->batch_ip = new_ip; +} diff --git a/src/testing/testing_api_cmd_hello_world.c b/src/testing/testing_api_cmd_hello_world.c new file mode 100644 index 000000000..1915f7da7 --- /dev/null +++ b/src/testing/testing_api_cmd_hello_world.c @@ -0,0 +1,113 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_cmd_hello_world.c + * @brief implementation of a hello world command. + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + +struct HelloWorldState +{ + char *message; +}; + +/** +* +* +* @param cls closure +* @param cmd current CMD being cleaned up. +*/ +static void +hello_world_cleanup (void *cls, + const struct GNUNET_TESTING_Command *cmd) +{ + struct HelloWorldState *hs = cls; + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Cleaning up message %s", + hs->message); +} + +/** +* +* +* @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 +hello_world_traits (void *cls, + const void **ret, + const char *trait, + unsigned int index) +{ + return GNUNET_OK; +} + +/** +* Run the "hello world" CMD. +* +* @param cls closure. +* @param cmd CMD being run. +* @param is interpreter state. +*/ +static void +hello_world_run (void *cls, + const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTING_Interpreter *is) +{ + struct HelloWorldState *hs = cls; + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "%s", + hs->message); + GNUNET_TESTING_get_trait_what_am_i (cmd, + hs->message); +} + +/** + * Create command. + * + * @param label name for command. + * @param message initial message. + * @return command. + */ +struct GNUNET_TESTING_Command +GNUNET_TESTING_cmd_hello_world (const char *label, + char *message) +{ + struct HelloWorldState *hs; + + hs = GNUNET_new (struct HelloWorldState); + hs->message = "Hello World, I am nobody!"; + + struct GNUNET_TESTING_Command cmd = { + .cls = hs, + .label = label, + .run = &hello_world_run, + .cleanup = &hello_world_cleanup, + .traits = &hello_world_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 new file mode 100644 index 000000000..a3157b6de --- /dev/null +++ b/src/testing/testing_api_cmd_hello_world_birth.c @@ -0,0 +1,160 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_cmd_hello_world.c + * @brief implementation of a hello world command. + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_util_lib.h" +#include "gnunet_testing_ng_lib.h" + +struct HelloWorldBirthState +{ + struct GNUNET_TIME_Absolute *date; + char *what_am_i; +}; + +/** +* +* +* @param cls closure +* @param cmd current CMD being cleaned up. +*/ +static void +hello_world_birth_cleanup (void *cls, + const struct GNUNET_TESTING_Command *cmd) +{ + struct HelloWorldBirthState *hbs = cls; + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Finished birth of %s", + hbs->what_am_i); +} + +/** +* +* +* @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 +hello_world_birth_traits (void *cls, + const void **ret, + const char *trait, + unsigned int index) +{ + struct HelloWorldBirthState *hbs = cls; + struct GNUNET_TESTING_Trait traits[] = { + { + .index = 0, + .trait_name = "what_am_i", + .ptr = (const void *) hbs->what_am_i, + }, + GNUNET_TESTING_trait_end () + }; + + return GNUNET_TESTING_get_trait (traits, + ret, + trait, + index); +} + +/** +* Run the "hello world" CMD. +* +* @param cls closure. +* @param cmd CMD being run. +* @param is interpreter state. +*/ +static void +hello_world_birth_run (void *cls, + const struct GNUNET_TESTING_Command *cmd, + struct GNUNET_TESTING_Interpreter *is) +{ + struct HelloWorldBirthState *hbs = cls; + struct GNUNET_TIME_Relative relativ; + + relativ = GNUNET_TIME_absolute_get_difference (*hbs->date, + GNUNET_TIME_absolute_get ()); + + if (0 == relativ.rel_value_us % 10) + { + hbs->what_am_i = "Hello World, I am a creature!"; + } + else if (0 == relativ.rel_value_us % 2) + { + hbs->what_am_i = "Hello World, I am a girl!"; + } + else + { + hbs->what_am_i = "Hello World, I am a boy!"; + } +} + +/** + * 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. + * @return #GNUNET_OK on success. + */ +int +GNUNET_TESTING_get_trait_what_am_i (const struct + GNUNET_TESTING_Command *cmd, + char *what_am_i) +{ + return cmd->traits (cmd->cls, + (const void **) what_am_i, + "what_am_i", + (unsigned int) 0); +} + +/** + * Create command. + * + * @param label name for command. + * @param now when the command was started. + * @return command. + */ +struct GNUNET_TESTING_Command +GNUNET_TESTING_cmd_hello_world_birth (const char *label, + struct GNUNET_TIME_Absolute *now) +{ + struct HelloWorldBirthState *hbs; + + hbs = GNUNET_new (struct HelloWorldBirthState); + hbs->date = now; + + struct GNUNET_TESTING_Command cmd = { + .cls = hbs, + .label = label, + .run = &hello_world_birth_run, + .cleanup = &hello_world_birth_cleanup, + .traits = &hello_world_birth_traits + }; + + return cmd; +} diff --git a/src/testing/testing_api_loop.c b/src/testing/testing_api_loop.c new file mode 100644 index 000000000..f32f4061e --- /dev/null +++ b/src/testing/testing_api_loop.c @@ -0,0 +1,652 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_loop.c + * @brief main interpreter loop for testcases + * @author Christian Grothoff (GNU Taler testing) + * @author Marcello Stanisci (GNU Taler testing) + * @author t3sserakt +*/ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + +/** + * Pipe used to communicate child death via signal. + * Must be global, as used in signal handler! + */ +static struct GNUNET_DISK_PipeHandle *sigpipe; + +/** + * Lookup command by label. + * + * @param is interpreter state to search + * @param label label to look for + * @return NULL if command was not found + */ +const struct GNUNET_TESTING_Command * +GNUNET_TESTING_interpreter_lookup_command (struct + GNUNET_TESTING_Interpreter *is, + const char *label) +{ + if (NULL == label) + { + GNUNET_log (GNUNET_ERROR_TYPE_WARNING, + "Attempt to lookup command for empty label\n"); + return NULL; + } + /* Search backwards as we most likely reference recent commands */ + for (int i = is->ip; i >= 0; i--) + { + const struct GNUNET_TESTING_Command *cmd = &is->commands[i]; + + /* Give precedence to top-level commands. */ + if ( (NULL != cmd->label) && + (0 == strcmp (cmd->label, + label)) ) + return cmd; + + if (GNUNET_TESTING_cmd_is_batch (cmd)) + { +#define BATCH_INDEX 1 + struct GNUNET_TESTING_Command *batch; + struct GNUNET_TESTING_Command *current; + struct GNUNET_TESTING_Command *icmd; + const struct GNUNET_TESTING_Command *match; + + current = GNUNET_TESTING_cmd_batch_get_current (cmd); + GNUNET_assert (GNUNET_OK == + GNUNET_TESTING_get_trait_cmd (cmd, + BATCH_INDEX, + &batch)); + /* We must do the loop forward, but we can find the last match */ + match = NULL; + for (unsigned int j = 0; + NULL != (icmd = &batch[j])->label; + j++) + { + if (current == icmd) + break; /* do not go past current command */ + if ( (NULL != icmd->label) && + (0 == strcmp (icmd->label, + label)) ) + match = icmd; + } + if (NULL != match) + return match; + } + } + GNUNET_log (GNUNET_ERROR_TYPE_ERROR, + "Command not found: %s\n", + label); + return NULL; + +} + + +/** + * Run the main interpreter loop that performs exchange operations. + * + * @param cls contains the `struct InterpreterState` + */ +static void +interpreter_run (void *cls); + + +/** + * Current command is done, run the next one. + */ +void +GNUNET_TESTING_interpreter_next (struct GNUNET_TESTING_Interpreter *is) +{ + static unsigned long long ipc; + static struct GNUNET_TIME_Absolute last_report; + struct GNUNET_TESTING_Command *cmd = &is->commands[is->ip]; + + if (GNUNET_SYSERR == is->result) + return; /* ignore, we already failed! */ + if (GNUNET_TESTING_cmd_is_batch (cmd)) + { + GNUNET_TESTING_cmd_batch_next (is); + } + else + { + cmd->finish_time = GNUNET_TIME_absolute_get (); + is->ip++; + } + if (0 == (ipc % 1000)) + { + if (0 != ipc) + GNUNET_log (GNUNET_ERROR_TYPE_MESSAGE, + "Interpreter executed 1000 instructions in %s\n", + GNUNET_STRINGS_relative_time_to_string ( + GNUNET_TIME_absolute_get_duration (last_report), + GNUNET_YES)); + last_report = GNUNET_TIME_absolute_get (); + } + ipc++; + is->task = GNUNET_SCHEDULER_add_now (&interpreter_run, + is); +} + + +/** + * Current command failed, clean up and fail the test case. + * + * @param is interpreter of the test + */ +void +GNUNET_TESTING_interpreter_fail (struct GNUNET_TESTING_Interpreter *is) +{ + struct GNUNET_TESTING_Command *cmd = &is->commands[is->ip]; + + GNUNET_log (GNUNET_ERROR_TYPE_ERROR, + "Failed at command `%s'\n", + cmd->label); + while (GNUNET_TESTING_cmd_is_batch (cmd)) + { + cmd = GNUNET_TESTING_cmd_batch_get_current (cmd); + GNUNET_log (GNUNET_ERROR_TYPE_ERROR, + "Batch is at command `%s'\n", + cmd->label); + } + is->result = GNUNET_SYSERR; + GNUNET_SCHEDULER_shutdown (); +} + + +/** + * Create command array terminator. + * + * @return a end-command. + */ +struct GNUNET_TESTING_Command +GNUNET_TESTING_cmd_end (void) +{ + static struct GNUNET_TESTING_Command cmd; + cmd.label = NULL; + + return cmd; +} + + +/** + * Obtain current label. + */ +const char * +GNUNET_TESTING_interpreter_get_current_label (struct + GNUNET_TESTING_Interpreter *is) +{ + struct GNUNET_TESTING_Command *cmd = &is->commands[is->ip]; + + return cmd->label; +} + + +/** + * Run the main interpreter loop that performs exchange operations. + * + * @param cls contains the `struct GNUNET_TESTING_Interpreter` + */ +static void +interpreter_run (void *cls) +{ + struct GNUNET_TESTING_Interpreter *is = cls; + struct GNUNET_TESTING_Command *cmd = &is->commands[is->ip]; + + is->task = NULL; + + if (NULL == cmd->label) + { + + GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, + "Running command END\n"); + is->result = GNUNET_OK; + GNUNET_SCHEDULER_shutdown (); + return; + } + + GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, + "Running command `%s'\n", + cmd->label); + cmd->start_time + = cmd->last_req_time + = GNUNET_TIME_absolute_get (); + cmd->num_tries = 1; + cmd->run (cmd->cls, + cmd, + is); +} + + +/** + * Function run when the test terminates (good or bad). + * Cleans up our state. + * + * @param cls the interpreter state. + */ +static void +do_shutdown (void *cls) +{ + struct GNUNET_TESTING_Interpreter *is = cls; + struct GNUNET_TESTING_Command *cmd; + const char *label; + + label = is->commands[is->ip].label; + if (NULL == label) + label = "END"; + + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Executing shutdown at `%s'\n", + label); + + for (unsigned int j = 0; + NULL != (cmd = &is->commands[j])->label; + j++) + cmd->cleanup (cmd->cls, + cmd); + + if (NULL != is->task) + { + GNUNET_SCHEDULER_cancel (is->task); + is->task = NULL; + } + if (NULL != is->timeout_task) + { + GNUNET_SCHEDULER_cancel (is->timeout_task); + is->timeout_task = NULL; + } + if (NULL != is->child_death_task) + { + GNUNET_SCHEDULER_cancel (is->child_death_task); + is->child_death_task = NULL; + } + GNUNET_free (is->commands); +} + + +/** + * Function run when the test terminates (good or bad) with timeout. + * + * @param cls NULL + */ +static void +do_timeout (void *cls) +{ + struct GNUNET_TESTING_Interpreter *is = cls; + + is->timeout_task = NULL; + GNUNET_log (GNUNET_ERROR_TYPE_ERROR, + "Terminating test due to timeout\n"); + GNUNET_SCHEDULER_shutdown (); +} + + +/** + * Task triggered whenever we receive a SIGCHLD (child + * process died). + * + * @param cls closure + */ +static void +maint_child_death (void *cls) +{ + struct GNUNET_TESTING_Interpreter *is = cls; + struct GNUNET_TESTING_Command *cmd = &is->commands[is->ip]; + const struct GNUNET_DISK_FileHandle *pr; + struct GNUNET_OS_Process **processp; + char c[16]; + enum GNUNET_OS_ProcessStatusType type; + unsigned long code; + + if (GNUNET_TESTING_cmd_is_batch (cmd)) + { + struct GNUNET_TESTING_Command *batch_cmd; + + GNUNET_assert (GNUNET_OK == + GNUNET_TESTING_get_trait_cmd (cmd, + 0, + &batch_cmd)); + cmd = batch_cmd; + } + + GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, + "Got SIGCHLD for `%s'.\n", + cmd->label); + is->child_death_task = NULL; + pr = GNUNET_DISK_pipe_handle (sigpipe, + GNUNET_DISK_PIPE_END_READ); + GNUNET_break (0 < + GNUNET_DISK_file_read (pr, + &c, + sizeof (c))); + if (GNUNET_OK != + GNUNET_TESTING_get_trait_process (cmd, + 0, + &processp)) + { + GNUNET_break (0); + GNUNET_TESTING_interpreter_fail (is); + return; + } + + GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, + "Got the dead child process handle, waiting for termination ...\n"); + GNUNET_OS_process_wait_status (*processp, + &type, + &code); + GNUNET_OS_process_destroy (*processp); + *processp = NULL; + GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, + "... definitively terminated\n"); + switch (type) + { + case GNUNET_OS_PROCESS_UNKNOWN: + GNUNET_break (0); + GNUNET_TESTING_interpreter_fail (is); + return; + case GNUNET_OS_PROCESS_RUNNING: + GNUNET_break (0); + GNUNET_TESTING_interpreter_fail (is); + return; + case GNUNET_OS_PROCESS_STOPPED: + GNUNET_break (0); + GNUNET_TESTING_interpreter_fail (is); + return; + case GNUNET_OS_PROCESS_EXITED: + if (0 != code) + { + GNUNET_log (GNUNET_ERROR_TYPE_ERROR, + "Process exited with unexpected status %u\n", + (unsigned int) code); + GNUNET_TESTING_interpreter_fail (is); + return; + } + break; + case GNUNET_OS_PROCESS_SIGNALED: + GNUNET_break (0); + GNUNET_TESTING_interpreter_fail (is); + return; + } + + GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, + "Dead child, go on with next command.\n"); + GNUNET_TESTING_interpreter_next (is); +} + + +/** + * Wait until we receive SIGCHLD signal. + * Then obtain the process trait of the current + * command, wait on the the zombie and continue + * with the next command. + */ +void +GNUNET_TESTING_wait_for_sigchld (struct GNUNET_TESTING_Interpreter *is) +{ + const struct GNUNET_DISK_FileHandle *pr; + + GNUNET_assert (NULL == is->child_death_task); + pr = GNUNET_DISK_pipe_handle (sigpipe, + GNUNET_DISK_PIPE_END_READ); + is->child_death_task + = GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL, + pr, + &maint_child_death, + is); +} + + +/** + * Run the testsuite. Note, CMDs are copied into + * the interpreter state because they are _usually_ + * defined into the "run" method that returns after + * having scheduled the test interpreter. + * + * @param is the interpreter state + * @param commands the list of command to execute + * @param timeout how long to wait + */ +void +GNUNET_TESTING_run2 (struct GNUNET_TESTING_Interpreter *is, + struct GNUNET_TESTING_Command *commands, + struct GNUNET_TIME_Relative timeout) +{ + unsigned int i; + + if (NULL != is->timeout_task) + { + GNUNET_SCHEDULER_cancel (is->timeout_task); + is->timeout_task = NULL; + } + /* get the number of commands */ + for (i = 0; NULL != commands[i].label; i++) + ; + is->commands = GNUNET_new_array (i + 1, + struct GNUNET_TESTING_Command); + memcpy (is->commands, + commands, + sizeof (struct GNUNET_TESTING_Command) * i); + is->timeout_task = GNUNET_SCHEDULER_add_delayed + (timeout, + &do_timeout, + is); + GNUNET_SCHEDULER_add_shutdown (&do_shutdown, is); + is->task = GNUNET_SCHEDULER_add_now (&interpreter_run, is); +} + + +/** + * Run the testsuite. Note, CMDs are copied into + * the interpreter state because they are _usually_ + * defined into the "run" method that returns after + * having scheduled the test interpreter. + * + * @param is the interpreter state + * @param commands the list of command to execute + */ +void +GNUNET_TESTING_run (struct GNUNET_TESTING_Interpreter *is, + struct GNUNET_TESTING_Command *commands) +{ + GNUNET_TESTING_run2 (is, + commands, + GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, + 5)); +} + + +/** + * Information used by the wrapper around the main + * "run" method. + */ +struct MainContext +{ + /** + * Main "run" method. + */ + GNUNET_TESTING_Main main_cb; + + /** + * Closure for @e main_cb. + */ + void *main_cb_cls; + + /** + * Interpreter state. + */ + struct GNUNET_TESTING_Interpreter *is; +}; + + +/** + * Signal handler called for SIGCHLD. Triggers the + * respective handler by writing to the trigger pipe. + */ +static void +sighandler_child_death (void) +{ + static char c; + int old_errno = errno; /* back-up errno */ + + GNUNET_break (1 == GNUNET_DISK_file_write + (GNUNET_DISK_pipe_handle (sigpipe, + GNUNET_DISK_PIPE_END_WRITE), + &c, sizeof (c))); + errno = old_errno; /* restore errno */ +} + + +/** + * Initialize scheduler loop and curl context for the testcase, + * and responsible to run the "run" method. + * + * @param cls closure, typically the "run" method, the + * interpreter state and a closure for "run". + */ +static void +main_wrapper_exchange_agnostic (void *cls) +{ + struct MainContext *main_ctx = cls; + + main_ctx->main_cb (main_ctx->main_cb_cls, + main_ctx->is); +} + + +/** + * Function run when the test is aborted before we launch the actual + * interpreter. Cleans up our state. + * + * @param cls the main context + */ +static void +do_abort (void *cls) +{ + struct MainContext *main_ctx = cls; + struct GNUNET_TESTING_Interpreter *is = main_ctx->is; + + is->timeout_task = NULL; + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Executing abort prior to interpreter launch\n"); +} + + +/** + * Initialize scheduler loop and curl context for the testcase, + * and responsible to run the "run" method. + * + * @param cls a `struct MainContext *` + */ +static void +main_wrapper_exchange_connect (void *cls) +{ + struct MainContext *main_ctx = cls; + struct GNUNET_TESTING_Interpreter *is = main_ctx->is; + char *exchange_url; + + if (GNUNET_OK != + GNUNET_CONFIGURATION_get_value_string (is->cfg, + "exchange", + "BASE_URL", + &exchange_url)) + { + GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, + "exchange", + "BASE_URL"); + return; + } + is->timeout_task = GNUNET_SCHEDULER_add_shutdown (&do_abort, + main_ctx); + is->working = GNUNET_YES; + + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Starting main test loop\n"); + main_ctx->main_cb (main_ctx->main_cb_cls, + is); +} + + +/** + * Install signal handlers plus schedules the main wrapper + * around the "run" method. + * + * @param main_cb the "run" method which contains all the + * commands. + * @param main_cb_cls a closure for "run", typically NULL. + * @param cfg configuration to use + * @param exchanged exchange process handle: will be put in the + * state as some commands - e.g. revoke - need to send + * signal to it, for example to let it know to reload the + * key state.. if NULL, the interpreter will run without + * trying to connect to the exchange first. + * @param exchange_connect #GNUNET_YES if the test should connect + * to the exchange, #GNUNET_NO otherwise + * @return #GNUNET_OK if all is okay, != #GNUNET_OK otherwise. + * non-GNUNET_OK codes are #GNUNET_SYSERR most of the + * times. + */ +int +GNUNET_TESTING_setup (GNUNET_TESTING_Main main_cb, + void *main_cb_cls, + const struct GNUNET_CONFIGURATION_Handle *cfg, + struct GNUNET_OS_Process *exchanged, + int exchange_connect) +{ + struct GNUNET_TESTING_Interpreter is; + struct MainContext main_ctx = { + .main_cb = main_cb, + .main_cb_cls = main_cb_cls, + /* needed to init the curl ctx */ + .is = &is, + }; + struct GNUNET_SIGNAL_Context *shc_chld; + + memset (&is, + 0, + sizeof (is)); + is.exchanged = exchanged; + is.cfg = cfg; + sigpipe = GNUNET_DISK_pipe (GNUNET_DISK_PF_NONE); + GNUNET_assert (NULL != sigpipe); + shc_chld = GNUNET_SIGNAL_handler_install + (GNUNET_SIGCHLD, + &sighandler_child_death); + + + /* Blocking */ + if (GNUNET_YES == exchange_connect) + GNUNET_SCHEDULER_run (&main_wrapper_exchange_connect, + &main_ctx); + else + GNUNET_SCHEDULER_run (&main_wrapper_exchange_agnostic, + &main_ctx); + if (NULL != is.final_cleanup_cb) + is.final_cleanup_cb (is.final_cleanup_cb_cls); + GNUNET_SIGNAL_handler_uninstall (shc_chld); + GNUNET_DISK_pipe_close (sigpipe); + sigpipe = NULL; + GNUNET_free (is.auditor_url); + GNUNET_free (is.exchange_url); + return is.result; +} + + +/* end of testing_api_loop.c */ diff --git a/src/testing/testing_api_trait_cmd.c b/src/testing/testing_api_trait_cmd.c new file mode 100644 index 000000000..67b26cb3e --- /dev/null +++ b/src/testing/testing_api_trait_cmd.c @@ -0,0 +1,79 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_trait_cmd.c + * @brief offers CMDs as traits. + * @author Marcello Stanisci (GNU Taler testing) + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + +#define GNUNET_TESTING_TRAIT_CMD "cmd" + + +/** + * Obtain a command from @a cmd. + * + * @param cmd command to extract the command from. + * @param index always zero. Commands offering this + * kind of traits do not need this index. For + * example, a "batch" CMD returns always the + * CMD currently being executed. + * @param[out] _cmd where to write the wire details. + * @return #GNUNET_OK on success. + */ +int +GNUNET_TESTING_get_trait_cmd (const struct GNUNET_TESTING_Command *cmd, + unsigned int index, + struct GNUNET_TESTING_Command **_cmd) +{ + return cmd->traits (cmd->cls, + (const void **) _cmd, + GNUNET_TESTING_TRAIT_CMD, + index); +} + + +/** + * Offer a command in a trait. + * + * @param index always zero. Commands offering this + * kind of traits do not need this index. For + * example, a "meta" CMD returns always the + * CMD currently being executed. + * @param cmd wire details to offer. + * @return the trait. + */ +struct GNUNET_TESTING_Trait +GNUNET_TESTING_make_trait_cmd (unsigned int index, + const struct GNUNET_TESTING_Command *cmd) +{ + struct GNUNET_TESTING_Trait ret = { + .index = index, + .trait_name = GNUNET_TESTING_TRAIT_CMD, + .ptr = (const struct GNUNET_TESTING_Command *) cmd + }; + return ret; +} + + +/* end of testing_api_trait_cmd.c */ diff --git a/src/testing/testing_api_trait_process.c b/src/testing/testing_api_trait_process.c new file mode 100644 index 000000000..7d694e35d --- /dev/null +++ b/src/testing/testing_api_trait_process.c @@ -0,0 +1,81 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_trait_process.c + * @brief trait offering process handles. + * @author Christian Grothoff (GNU Taler testing) + * @author Marcello Stanisci (GNU Taler testing) + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + +#define GNUNET_TESTING_TRAIT_PROCESS "process" + + +/** + * Obtain location where a command stores a pointer to a process. + * + * @param cmd command to extract trait from. + * @param index which process to pick if @a cmd + * has multiple on offer. + * @param[out] processp set to the address of the pointer to the + * process. + * @return #GNUNET_OK on success. + */ +int +GNUNET_TESTING_get_trait_process + (const struct GNUNET_TESTING_Command *cmd, + unsigned int index, + struct GNUNET_OS_Process ***processp) +{ + return cmd->traits (cmd->cls, + (const void **) processp, + GNUNET_TESTING_TRAIT_PROCESS, + index); +} + + +/** + * Offer location where a command stores a pointer to a process. + * + * @param index offered location index number, in case there are + * multiple on offer. + * @param processp process location to offer. + * + * @return the trait. + */ +struct GNUNET_TESTING_Trait +GNUNET_TESTING_make_trait_process + (unsigned int index, + struct GNUNET_OS_Process **processp) +{ + struct GNUNET_TESTING_Trait ret = { + .index = index, + .trait_name = GNUNET_TESTING_TRAIT_PROCESS, + .ptr = (const void *) processp + }; + + return ret; +} + + +/* end of testing_api_trait_process.c */ diff --git a/src/testing/testing_api_traits.c b/src/testing/testing_api_traits.c new file mode 100644 index 000000000..3af839b78 --- /dev/null +++ b/src/testing/testing_api_traits.c @@ -0,0 +1,81 @@ +/* + This file is part of GNUnet + Copyright (C) 2008, 2009, 2012 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 testing/testing_api_traits.c + * @brief loop for trait resolution + * @author Christian Grothoff (GNU Taler testing) + * @author Marcello Stanisci (GNU Taler testing) + * @author t3sserakt + */ +#include "platform.h" +#include "gnunet_testing_ng_lib.h" + + +/** + * End a trait array. Usually, commands offer several traits, + * and put them in arrays. + */ +struct GNUNET_TESTING_Trait +GNUNET_TESTING_trait_end () +{ + struct GNUNET_TESTING_Trait end = { + .index = 0, + .trait_name = NULL, + .ptr = NULL + }; + + return end; +} + + +/** + * Pick the chosen trait from the traits array. + * + * @param traits the traits array. + * @param ret where to store the result. + * @param trait type of the trait to extract. + * @param index index number of the object to extract. + * @return #GNUNET_OK if no error occurred, #GNUNET_SYSERR otherwise. + */ +int +GNUNET_TESTING_get_trait (const struct GNUNET_TESTING_Trait *traits, + const void **ret, + const char *trait, + unsigned int index) +{ + for (unsigned int i = 0; NULL != traits[i].trait_name; i++) + { + if ( (0 == strcmp (trait, traits[i].trait_name)) && + (index == traits[i].index) ) + { + *ret = (void *) traits[i].ptr; + return GNUNET_OK; + } + } + GNUNET_log (GNUNET_ERROR_TYPE_INFO, + "Trait %s/%u not found.\n", + trait, index); + + return GNUNET_SYSERR; +} + + +/* end of testing_api_traits.c */ -- cgit v1.2.3