1 files changed, 232 insertions, 0 deletions

diff --git a/src/lib/testing/testing_api_cmd_batch.c b/src/lib/testing/testing_api_cmd_batch.c
new file mode 100644
index 000000000..f4e866b78
--- /dev/null
+++ b/src/lib/testing/testing_api_cmd_batch.c
@@ -0,0 +1,232 @@
+/*
+      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 <http://www.gnu.org/licenses/>.
+
+     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_lib.h"
+#include "testing_api_cmd_batch.h"
+#include "testing_api_loop.h"
+
+/**
+ * State for a "batch" CMD.
+ */
+struct BatchState
+{
+  /**
+   * CMDs batch.
+   */
+  struct GNUNET_TESTING_Command *batch;
+
+  /**
+   * Our label.
+   */
+  struct GNUNET_TESTING_CommandLabel label;
+
+  /**
+   * Internal command pointer.
+   */
+  unsigned int batch_ip;
+};
+
+
+/**
+ * Run the command.
+ *
+ * @param cls closure.
+ * @param is the interpreter state.
+ */
+static void
+batch_run (void *cls,
+           struct GNUNET_TESTING_Interpreter *is)
+{
+  struct BatchState *bs = cls;
+  struct GNUNET_TESTING_Command *cmd;
+
+  cmd = &bs->batch[bs->batch_ip];
+  if (NULL != cmd->run)
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                "Running batched command: %s\n",
+                cmd->label.value);
+
+  /* hit end command, leap to next top-level command.  */
+  if (NULL == cmd->run)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                "Exiting from batch: %s\n",
+                bs->label.value);
+    GNUNET_TESTING_interpreter_next_ (is);
+    return;
+  }
+  GNUNET_TESTING_interpreter_run_cmd_ (is,
+                                       cmd);
+}
+
+
+/**
+ * Cleanup the state from a "reserve status" CMD, and possibly
+ * cancel a pending operation thereof.
+ *
+ * @param cls closure.
+ */
+static void
+batch_cleanup (void *cls)
+{
+  struct BatchState *bs = cls;
+
+  for (unsigned int i = 0;
+       NULL != bs->batch[i].run;
+       i++)
+    bs->batch[i].cleanup (bs->batch[i].cls);
+  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 enum GNUNET_GenericReturnValue
+batch_traits (void *cls,
+              const void **ret,
+              const char *trait,
+              unsigned int index)
+{
+  struct BatchState *bs = cls;
+  struct GNUNET_TESTING_Trait traits[] = {
+    GNUNET_TESTING_make_trait_cmd (&bs->batch[bs->batch_ip]),
+    GNUNET_TESTING_make_trait_batch_cmds (&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);
+  GNUNET_TESTING_set_label (&bs->label,
+                            label);
+  /* Get number of commands.  */
+  for (i = 0; NULL != batch[i].run; i++)
+    /* noop */
+    ;
+
+  bs->batch = GNUNET_new_array (i + 1,
+                                struct GNUNET_TESTING_Command);
+  memcpy (bs->batch,
+          batch,
+          sizeof (struct GNUNET_TESTING_Command) * i);
+  return GNUNET_TESTING_command_new (bs,
+                                     label,
+                                     &batch_run,
+                                     &batch_cleanup,
+                                     &batch_traits);
+}
+
+
+bool
+GNUNET_TESTING_cmd_batch_next_ (void *cls)
+{
+  struct BatchState *bs = cls;
+  struct GNUNET_TESTING_Command *bcmd = &bs->batch[bs->batch_ip];
+
+  if (NULL == bcmd->run)
+    return true; /* this batch is done */
+  if (GNUNET_TESTING_cmd_is_batch_ (bcmd))
+  {
+    if (GNUNET_TESTING_cmd_batch_next_ (bcmd->cls))
+    {
+      /* sub-batch is done */
+      bcmd->finish_time = GNUNET_TIME_absolute_get ();
+      bs->batch_ip++;
+      return false;
+    }
+  }
+  /* Simple command is done */
+  bcmd->finish_time = GNUNET_TIME_absolute_get ();
+  bs->batch_ip++;
+  return false;
+}
+
+
+bool
+GNUNET_TESTING_cmd_is_batch_ (const struct GNUNET_TESTING_Command *cmd)
+{
+  return cmd->run == &batch_run;
+}
+
+
+struct GNUNET_TESTING_Command *
+GNUNET_TESTING_cmd_batch_get_current_ (const struct GNUNET_TESTING_Command *cmd)
+{
+  struct BatchState *bs = cmd->cls;
+
+  GNUNET_assert (GNUNET_TESTING_cmd_is_batch_ (cmd));
+  return &bs->batch[bs->batch_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].run);
+  /* actual logic */
+  bs->batch_ip = new_ip;
+}