gnunet_testing_ng_lib.h

Go to the documentation of this file.

/*
      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
 */
#ifndef GNUNET_TESTING_NG_LIB_H
#define GNUNET_TESTING_NG_LIB_H
 
#include "gnunet_util_lib.h"
#include "gnunet_testing_plugin.h"
#include "gnunet_testing_lib.h"
 
 
/* ********************* Helper functions ********************* */
 
#define GNUNET_TESTING_FAIL(is) \
  do \
  { \
    GNUNET_break (0); \
    GNUNET_TESTING_interpreter_fail (is); \
    return; \
  } while (0)
 
 
struct GNUNET_TESTING_NetjailRouter
{
  unsigned int tcp_port;
 
  unsigned int udp_port;
};
 
 
enum GNUNET_TESTING_NODE_TYPE
{
  GNUNET_TESTING_SUBNET_NODE,
 
  GNUNET_TESTING_GLOBAL_NODE
};
 
 
// FIXME: this does not belong here!
struct GNUNET_TESTING_ADDRESS_PREFIX
{
  struct GNUNET_TESTING_ADDRESS_PREFIX *prev;
 
  struct GNUNET_TESTING_ADDRESS_PREFIX *next;
 
  char *address_prefix;
};
 
 
// FIXME: this does not belong here!
struct GNUNET_TESTING_NetjailNode;
 
struct GNUNET_TESTING_NodeConnection
{
  struct GNUNET_TESTING_NodeConnection *prev;
 
  struct GNUNET_TESTING_NodeConnection *next;
 
  unsigned int namespace_n;
 
  unsigned int node_n;
 
  enum GNUNET_TESTING_NODE_TYPE node_type;
 
  struct GNUNET_TESTING_NetjailNode *node;
 
  struct GNUNET_TESTING_ADDRESS_PREFIX *address_prefixes_head;
 
  struct GNUNET_TESTING_ADDRESS_PREFIX *address_prefixes_tail;
};
 
struct GNUNET_TESTING_NetjailNode
{
  char *plugin;
 
  unsigned int is_global;
 
  unsigned int namespace_n;
 
  unsigned int node_n;
 
  struct GNUNET_TESTING_NodeConnection *node_connections_head;
 
  struct GNUNET_TESTING_NodeConnection *node_connections_tail;
};
 
 
struct GNUNET_TESTING_NetjailNamespace
{
  unsigned int namespace_n;
 
  struct GNUNET_TESTING_NetjailRouter *router;
 
  struct GNUNET_CONTAINER_MultiShortmap *nodes;
};
 
struct GNUNET_TESTING_NetjailTopology
{
 
  char *plugin;
 
  unsigned int namespaces_n;
 
  unsigned int nodes_m;
 
  unsigned int nodes_x;
 
  struct GNUNET_CONTAINER_MultiShortmap *map_namespaces;
 
  struct GNUNET_CONTAINER_MultiShortmap *map_globals;
};
 
 
/* ******************* Generic interpreter logic ************ */
 
struct GNUNET_TESTING_Interpreter;
 
struct GNUNET_TESTING_AsyncContext
{
 
  struct GNUNET_TESTING_Interpreter *is;
 
  GNUNET_SCHEDULER_TaskCallback cont;
 
  void *cont_cls;
 
  enum GNUNET_GenericReturnValue finished;
};
 
 
struct GNUNET_TESTING_Command
{
 
  void *cls;
 
  const char *label;
 
  void
  (*run)(void *cls,
         struct GNUNET_TESTING_Interpreter *is);
 
  struct GNUNET_TESTING_AsyncContext *ac;
 
  void
  (*cleanup)(void *cls);
 
  enum GNUNET_GenericReturnValue
  (*traits)(void *cls,
            const void **ret,
            const char *trait,
            unsigned int index);
 
  struct GNUNET_TIME_Absolute start_time;
 
  struct GNUNET_TIME_Absolute finish_time;
 
  struct GNUNET_TIME_Absolute last_req_time;
 
  struct GNUNET_TIME_Relative default_timeout;
 
  unsigned int num_tries;
 
  bool asynchronous_finish;
 
};
 
 
const struct GNUNET_TESTING_Command *
GNUNET_TESTING_interpreter_lookup_command (
  struct GNUNET_TESTING_Interpreter *is,
  const char *label);
 
 
const char *
GNUNET_TESTING_interpreter_get_current_label (
  struct GNUNET_TESTING_Interpreter *is);
 
 
void
GNUNET_TESTING_interpreter_fail (struct GNUNET_TESTING_Interpreter *is);
 
 
void
GNUNET_TESTING_async_fail (struct GNUNET_TESTING_AsyncContext *ac);
 
 
void
GNUNET_TESTING_async_finish (struct GNUNET_TESTING_AsyncContext *ac);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_end (void);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_make_unblocking (struct GNUNET_TESTING_Command cmd);
 
 
const struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_finish (const char *finish_label,
                           const char *cmd_ref,
                           struct GNUNET_TIME_Relative timeout);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_rewind_ip (const char *label,
                              const char *target_label,
                              unsigned int counter);
 
 
typedef void
(*GNUNET_TESTING_ResultCallback)(void *cls,
                                 enum GNUNET_GenericReturnValue rv);
 
 
void
GNUNET_TESTING_run (struct GNUNET_TESTING_Command *commands,
                    struct GNUNET_TIME_Relative timeout,
                    GNUNET_TESTING_ResultCallback rc,
                    void *rc_cls);
 
 
int
GNUNET_TESTING_main (struct GNUNET_TESTING_Command *commands,
                     struct GNUNET_TIME_Relative timeout);
 
 
int
GNUNET_TESTING_has_in_name (const char *prog,
                            const char *marker);
 
 
/* ************** Specific interpreter commands ************ */
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_signal (const char *label,
                           const char *process_label,
                           unsigned int process_index,
                           int signal);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_sleep (const char *label,
                          struct GNUNET_TIME_Relative duration);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_batch (const char *label,
                          struct GNUNET_TESTING_Command *batch);
 
 
struct GNUNET_TESTING_Timer
{
  const char *prefix;
 
  struct GNUNET_TIME_Relative total_duration;
 
  struct GNUNET_TIME_Relative success_latency;
 
  unsigned int num_commands;
 
  unsigned int num_retries;
};
 
 
struct GNUNET_TESTING_NetjailTopology *
GNUNET_TESTING_get_topo_from_file (const char *filename);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_stat (struct GNUNET_TESTING_Timer *timers);
 
 
/* *** Generic trait logic for implementing traits ********* */
 
struct GNUNET_TESTING_Trait
{
  unsigned int index;
 
  const char *trait_name;
 
  const void *ptr;
};
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_trait_end (void);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait (const struct GNUNET_TESTING_Trait *traits,
                          const void **ret,
                          const char *trait,
                          unsigned int index);
 
 
/* ****** Specific traits supported by this component ******* */
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_process (const struct GNUNET_TESTING_Command *cmd,
                                  unsigned int index,
                                  struct GNUNET_OS_Process ***processp);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_process (unsigned int index,
                                   struct GNUNET_OS_Process **processp);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_uint32 (unsigned int index,
                                  const uint32_t *n);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_uint32 (const struct GNUNET_TESTING_Command *cmd,
                                 unsigned int index,
                                 const uint32_t **n);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_uint64 (unsigned int index,
                                  const uint64_t *n);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_uint64 (const struct GNUNET_TESTING_Command *cmd,
                                 unsigned int index,
                                 const uint64_t **n);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_int64 (unsigned int index,
                                 const int64_t *n);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_int64 (const struct GNUNET_TESTING_Command *cmd,
                                unsigned int index,
                                const int64_t **n);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_uint (unsigned int index,
                                const unsigned int *i);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_uint (const struct GNUNET_TESTING_Command *cmd,
                               unsigned int index,
                               const unsigned int **n);
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_string (
  const struct GNUNET_TESTING_Command *cmd,
  unsigned int index,
  const char **s);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_string (unsigned int index,
                                  const char *s);
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_cmd (unsigned int index,
                               const struct GNUNET_TESTING_Command *cmd);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_cmd (const struct GNUNET_TESTING_Command *cmd,
                              unsigned int index,
                              struct GNUNET_TESTING_Command **_cmd);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_uuid (const struct GNUNET_TESTING_Command *cmd,
                               unsigned int index,
                               struct GNUNET_Uuid **uuid);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_uuid (unsigned int index,
                                const struct GNUNET_Uuid *uuid);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_absolute_time (
  const struct GNUNET_TESTING_Command *cmd,
  unsigned int index,
  const struct GNUNET_TIME_Absolute **time);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_absolute_time (
  unsigned int index,
  const struct GNUNET_TIME_Absolute *time);
 
 
int
GNUNET_TESTING_get_trait_relative_time (
  const struct GNUNET_TESTING_Command *cmd,
  unsigned int index,
  const struct GNUNET_TIME_Relative **time);
 
 
struct GNUNET_TESTING_Trait
GNUNET_TESTING_make_trait_relative_time (
  unsigned int index,
  const struct GNUNET_TIME_Relative *time);
 
 
// FIXME: move these commands into a separate libgnunetestingnetjail lib or so!
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_hello_world_birth (const char *label,
                                      struct GNUNET_TIME_Absolute *now);
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_hello_world (const char *label,
                                const char *birthLabel,
                                char *message);
 
int
GNUNET_TESTING_get_trait_what_am_i (const struct GNUNET_TESTING_Command *cmd,
                                    char **what_am_i);
 
 
int
GNUNET_TESTING_get_trait_test_system (const struct
                                      GNUNET_TESTING_Command *cmd,
                                      struct GNUNET_TESTING_System **test_system);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_system_create (const char *label,
                                  const char *testdir);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_system_destroy (const char *label,
                                   const char *create_label);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_netjail_start (const char *label,
                                  char *topology_config);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_netjail_start_testing_system (const char *label,
                                                 const char *topology_config);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_netjail_stop (const char *label,
                                 char *topology_config);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_stop_testing_system (const char *label,
                                        const char *helper_start_label,
                                        const char *topology_config);
 
 
struct GNUNET_MessageHeader *
GNUNET_TESTING_send_local_test_finished_msg (enum GNUNET_GenericReturnValue rv);
 
 
int
GNUNET_TESTING_get_trait_async_context (
  const struct GNUNET_TESTING_Command *cmd,
  struct GNUNET_TESTING_AsyncContext **ac);
 
 
enum GNUNET_GenericReturnValue
GNUNET_TESTING_get_trait_helper_handles (
  const struct GNUNET_TESTING_Command *cmd,
  struct GNUNET_HELPER_Handle ***helper);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_block_until_all_peers_started (
  const char *label,
  unsigned int *all_peers_started);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_block_until_external_trigger (
  const char *label);
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_send_peer_ready (const char *label,
                                    TESTING_CMD_HELPER_write_cb write_message);
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_local_test_finished (
  const char *label,
  TESTING_CMD_HELPER_write_cb write_message);
 
#endif