gnunet_testing_netjail_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_NETJAIL_LIB_H
#define GNUNET_TESTING_NETJAIL_LIB_H
 
#include "gnunet_testing_ng_lib.h"
#include "gnunet_testing_plugin.h"
 
struct GNUNET_TESTING_AsyncContext;
 
struct GNUNET_TESTING_NetjailRouter
{
  unsigned int tcp_port;
 
  unsigned int udp_port;
};
 
 
enum GNUNET_TESTING_NodeType
{
  GNUNET_TESTING_SUBNET_NODE,
 
  GNUNET_TESTING_GLOBAL_NODE
};
 
struct GNUNET_TESTING_AddressPrefix
{
  struct GNUNET_TESTING_AddressPrefix *prev;
 
  struct GNUNET_TESTING_AddressPrefix *next;
 
  char *address_prefix;
};
 
 
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_NodeType node_type;
 
  struct GNUNET_TESTING_NetjailNode *node;
 
  struct GNUNET_TESTING_AddressPrefix *address_prefixes_head;
 
  struct GNUNET_TESTING_AddressPrefix *address_prefixes_tail;
};
 
struct GNUNET_TESTING_NetjailNode
{
  struct GNUNET_TESTING_NodeConnection *node_connections_head;
 
  struct GNUNET_TESTING_NodeConnection *node_connections_tail;
 
  char *plugin;
 
  unsigned int is_global;
 
  unsigned int namespace_n;
 
  unsigned int node_n;
 
  unsigned int node_number;
 
  unsigned int additional_connects;
 
  unsigned int expected_reaches;
};
 
 
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;
 
  unsigned int additional_connects;
};
 
struct GNUNET_TESTING_NetjailTopology *
GNUNET_TESTING_get_topo_from_file (const char *filename);
 
 
struct GNUNET_TESTING_NetjailTopology *
GNUNET_TESTING_get_topo_from_string (const char *data);
 
 
unsigned int
GNUNET_TESTING_get_additional_connects (unsigned int num,
                                        struct GNUNET_TESTING_NetjailTopology *
                                        topology);
 
struct GNUNET_TESTING_NetjailNode *
GNUNET_TESTING_get_node (unsigned int num,
                         struct GNUNET_TESTING_NetjailTopology *topology);
 
 
struct GNUNET_TESTING_NodeConnection *
GNUNET_TESTING_get_connections (unsigned int num,
                                const struct GNUNET_TESTING_NetjailTopology *topology);
 
 
char *
GNUNET_TESTING_get_address (struct GNUNET_TESTING_NodeConnection *connection,
                            const char *prefix);
 
 
void
GNUNET_TESTING_free_topology (struct GNUNET_TESTING_NetjailTopology *topology);
 
 
unsigned int
GNUNET_TESTING_calculate_num (struct
                              GNUNET_TESTING_NodeConnection *node_connection,
                              struct GNUNET_TESTING_NetjailTopology *topology);
 
struct GNUNET_TESTING_BlockState
{
  struct GNUNET_TESTING_AsyncContext ac;
 
  const char *label;
 
  unsigned int asynchronous_finish;
};
 
struct GNUNET_TESTING_LocalPreparedState
{
  struct GNUNET_TESTING_AsyncContext ac;
 
  GNUNET_TESTING_cmd_helper_write_cb write_message;
};
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_system_destroy (const char *label,
                                   const char *create_label);
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_system_create (const char *label,
                                  const char *testdir);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_netjail_start (const char *label,
                                  char *topology_config,
                                  unsigned int *read_file);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_netjail_stop (const char *label,
                                 char *topology_config,
                                 unsigned int *read_file);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_netjail_start_cmds_helper (
  const char *label,
  struct GNUNET_TESTING_NetjailTopology *topology,
  unsigned int *read_file,
  char *topology_data,
  struct GNUNET_TIME_Relative timeout);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_stop_cmds_helper (
  const char *label,
  const char *helper_start_label,
  struct GNUNET_TESTING_NetjailTopology *topology);
 
 
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,
                                    GNUNET_TESTING_cmd_helper_write_cb write_message);
 
 
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_local_test_prepared (const char *label,
                                        GNUNET_TESTING_cmd_helper_write_cb
                                        write_message);
 
 
/* ***** Netjail trait support ***** */
 
 
#define GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS(op) \
  op (test_system, const struct GNUNET_TESTING_System) \
  op (async_context, const struct GNUNET_TESTING_AsyncContext) \
  op (helper_handles, const struct GNUNET_HELPER_Handle *) \
  op (local_prepared_state, const struct GNUNET_TESTING_LocalPreparedState) \
  op (block_state, const struct GNUNET_TESTING_BlockState)
 
GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS (GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT)
 
#endif