1 files changed, 546 insertions, 0 deletions

diff --git a/src/include/gnunet_testing_netjail_lib.h b/src/include/gnunet_testing_netjail_lib.h
new file mode 100644
index 000000000..843fce0d5
--- /dev/null
+++ b/src/include/gnunet_testing_netjail_lib.h
@@ -0,0 +1,546 @@
+/*
+      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
+ */
+
+/**
+ * @brief API for writing an interpreter to test GNUnet components
+ * @author Christian Grothoff <christian@grothoff.org>
+ * @author Marcello Stanisci
+ * @author t3sserakt
+ */
+#ifndef GNUNET_TESTING_NETJAIL_LIB_H
+#define GNUNET_TESTING_NETJAIL_LIB_H
+
+#include "gnunet_testing_ng_lib.h"
+#include "gnunet_testing_plugin.h"
+
+
+/**
+ * Router of a netjail subnet.
+ */
+struct GNUNET_TESTING_NetjailRouter
+{
+  /**
+   * Will tcp be forwarded?
+   */
+  unsigned int tcp_port;
+
+  /**
+   * Will udp be forwarded?
+   */
+  unsigned int udp_port;
+};
+
+
+/**
+ * Enum for the different types of nodes.
+ */
+enum GNUNET_TESTING_NodeType
+{
+  /**
+   * Node in a subnet.
+   */
+  GNUNET_TESTING_SUBNET_NODE,
+
+  /**
+   * Global known node.
+   */
+  GNUNET_TESTING_GLOBAL_NODE
+};
+
+/**
+ * Protocol address prefix für a connection between nodes.
+ */
+struct GNUNET_TESTING_AddressPrefix
+{
+  /**
+   * Pointer to the previous prefix in the DLL.
+   */
+  struct GNUNET_TESTING_AddressPrefix *prev;
+
+  /**
+   * Pointer to the next prefix in the DLL.
+   */
+  struct GNUNET_TESTING_AddressPrefix *next;
+
+  /**
+   * The address prefix.
+   */
+  char *address_prefix;
+};
+
+
+/**
+ * Node in a netjail topology.
+ */
+struct GNUNET_TESTING_NetjailNode;
+
+/**
+ * Connection to another node.
+ */
+struct GNUNET_TESTING_NodeConnection
+{
+  /**
+   * Pointer to the previous connection in the DLL.
+   */
+  struct GNUNET_TESTING_NodeConnection *prev;
+
+  /**
+   * Pointer to the next connection in the DLL.
+   */
+  struct GNUNET_TESTING_NodeConnection *next;
+
+  /**
+   * The number of the subnet of the node this connection points to. This is 0,
+   * if the node is a global known node.
+   */
+  unsigned int namespace_n;
+
+  /**
+   * The number of the node this connection points to.
+   */
+  unsigned int node_n;
+
+  /**
+   * The type of the node this connection points to.
+   */
+  enum GNUNET_TESTING_NodeType node_type;
+
+  /**
+   * The node which establish the connection
+   */
+  struct GNUNET_TESTING_NetjailNode *node;
+
+  /**
+   * Head of the DLL with the address prefixes for the protocolls this node is reachable.
+   */
+  struct GNUNET_TESTING_AddressPrefix *address_prefixes_head;
+
+  /**
+   * Tail of the DLL with the address prefixes for the protocolls this node is reachable.
+   */
+  struct GNUNET_TESTING_AddressPrefix *address_prefixes_tail;
+};
+
+/**
+ * Node in the netjail topology.
+ */
+struct GNUNET_TESTING_NetjailNode
+{
+  /**
+   * Head of the DLL with the connections which shall be established to other nodes.
+   */
+  struct GNUNET_TESTING_NodeConnection *node_connections_head;
+
+  /**
+   * Tail of the DLL with the connections which shall be established to other nodes.
+   */
+  struct GNUNET_TESTING_NodeConnection *node_connections_tail;
+
+  /**
+   * Plugin for the test case to be run on this node.
+   */
+  char *plugin;
+
+  /**
+   * Flag indicating if this node is a global known node.
+   */
+  unsigned int is_global;
+
+  /**
+   * The number of the subnet this node is running in.
+   */
+  unsigned int namespace_n;
+
+  /**
+   * The number of this node in the subnet.
+   */
+  unsigned int node_n;
+
+  /**
+   * The overall number of the node in the whole test system.
+   */
+  unsigned int node_number;
+
+  /**
+   * The number of unintentional additional connections this node waits for. This overwrites the global additional_connects value.
+   */
+  unsigned int additional_connects;
+
+  /**
+   * The number of cmds waiting for a specific barrier.
+   */
+  unsigned int expected_reaches;
+};
+
+
+/**
+ * Subnet in a topology.
+ */
+struct GNUNET_TESTING_NetjailNamespace
+{
+  /**
+   * The number of the subnet.
+   */
+  unsigned int namespace_n;
+
+  /**
+   * Router of the subnet.
+   */
+  struct GNUNET_TESTING_NetjailRouter *router;
+
+  /**
+   * Hash map containing the nodes in this subnet.
+   */
+  struct GNUNET_CONTAINER_MultiShortmap *nodes;
+};
+
+/**
+ * Toplogy of our netjail setup.
+ */
+struct GNUNET_TESTING_NetjailTopology
+{
+
+  /**
+   * Default plugin for the test case to be run on nodes.
+   */
+  char *plugin;
+
+  /**
+   * Number of subnets.
+   */
+  unsigned int namespaces_n;
+
+  /**
+   * Number of nodes per subnet.
+   */
+  unsigned int nodes_m;
+
+  /**
+   * Number of global known nodes.
+   */
+  unsigned int nodes_x;
+
+  /**
+   * Hash map containing the subnets (for natted nodes) of the topology.
+   */
+  struct GNUNET_CONTAINER_MultiShortmap *map_namespaces;
+
+  /**
+   * Hash map containing the global known nodes which are not natted.
+   */
+  struct GNUNET_CONTAINER_MultiShortmap *map_globals;
+
+  /**
+   * Additional connects we do expect, beside the connects which are configured in the topology.
+   */
+  unsigned int additional_connects;
+};
+
+/**
+ * Getting the topology from file.
+ *
+ * @param filename The name of the topology file.
+ * @return The GNUNET_TESTING_NetjailTopology
+ */
+struct GNUNET_TESTING_NetjailTopology *
+GNUNET_TESTING_get_topo_from_file (const char *filename);
+
+
+/**
+ * FIXME: this could use a "to_string".
+ * Parse the topology data.
+ *
+ * @param data The topology data.
+ * @return The GNUNET_TESTING_NetjailTopology
+ */
+struct GNUNET_TESTING_NetjailTopology *
+GNUNET_TESTING_get_topo_from_string (const char *data);
+
+
+/**
+ * Get the number of unintentional additional connections the node waits for.
+ *
+ * @param num The specific node we want the additional connects for.
+ * @return The number of additional connects
+ */
+unsigned int
+GNUNET_TESTING_get_additional_connects (unsigned int num,
+                                        struct GNUNET_TESTING_NetjailTopology *
+                                        topology);
+
+/**
+ * Get a node from the topology.
+ *
+ * @param num The specific node we want the connections for.
+ * @param topology The topology we get the connections from.
+ * @return The connections of the node.
+ */
+struct GNUNET_TESTING_NetjailNode *
+GNUNET_TESTING_get_node (unsigned int num,
+                         struct GNUNET_TESTING_NetjailTopology *topology);
+
+
+/**
+ * Get the connections to other nodes for a specific node.
+ *
+ * @param num The specific node we want the connections for.
+ * @param topology The topology we get the connections from.
+ * @return The connections of the node.
+ */
+struct GNUNET_TESTING_NodeConnection *
+GNUNET_TESTING_get_connections (unsigned int num,
+                                const struct GNUNET_TESTING_NetjailTopology *topology);
+
+
+/**
+ * Get the address for a specific communicator from a connection.
+ *
+ * @param connection The connection we like to have the address from.
+ * @param prefix The communicator protocol prefix.
+ * @return The address of the communicator.
+ */
+char *
+GNUNET_TESTING_get_address (struct GNUNET_TESTING_NodeConnection *connection,
+                            const char *prefix);
+
+
+/**
+ * Deallocate memory of the struct GNUNET_TESTING_NetjailTopology.
+ *
+ * @param topology The GNUNET_TESTING_NetjailTopology to be deallocated.
+ */
+void
+GNUNET_TESTING_free_topology (struct GNUNET_TESTING_NetjailTopology *topology);
+
+
+/**
+ * Calculate the unique id identifying a node from a given connection.
+ *
+ * @param node_connection The connection we calculate the id from.
+ * @param topology The topology we get all needed information from.
+ * @return The unique id of the node from the connection.
+ */
+unsigned int
+GNUNET_TESTING_calculate_num (struct
+                              GNUNET_TESTING_NodeConnection *node_connection,
+                              struct GNUNET_TESTING_NetjailTopology *topology);
+
+
+/**
+ * Struct with information for callbacks.
+ *
+ */
+struct GNUNET_TESTING_BlockState
+{
+  /**
+   * Context for our asynchronous completion.
+   */
+  struct GNUNET_TESTING_AsyncContext ac;
+
+  /**
+   * The label of this command.
+   */
+  const char *label;
+
+  /**
+   * If this command will block.
+   */
+  unsigned int asynchronous_finish;
+};
+
+/**
+ * Struct to hold information for callbacks.
+ *
+ */
+struct GNUNET_TESTING_LocalPreparedState
+{
+  /**
+   * Context for our asynchronous completion.
+   */
+  struct GNUNET_TESTING_AsyncContext ac;
+
+  /**
+   * Callback to write messages to the master loop.
+   *
+   */
+  GNUNET_TESTING_cmd_helper_write_cb write_message;
+};
+
+/**
+ * This command destroys the ressources allocated for the test system setup.
+ *
+ * @param label Name for command.
+ * @param create_label Label of the cmd which started the test system.
+ * @param write_message Callback to write messages to the master loop.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_system_destroy (const char *label,
+                                   const char *create_label);
+
+/**
+ * This command is setting up a test environment for a peer to start.
+ *
+ * @param label Name for command.
+ * @param testdir Only the directory name without any path. Temporary
+ *                directory used for all service homes.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_system_create (const char *label,
+                                  const char *testdir);
+
+
+/**
+ * This command executes a shell script to setup the netjail environment.
+ *
+ * @param label name for command.
+ * @param topology_config Configuration file for the test topology.
+ * @param read_file Flag indicating if the the name of the topology file is send to the helper, or a string with the topology data.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_netjail_start (const char *label,
+                                  char *topology_config,
+                                  unsigned int *read_file);
+
+
+/**
+ * This command executes a shell script to remove the netjail environment.
+ *
+ * @param label name for command.
+ * @param topology_config Configuration file for the test topology.
+ * @param read_file Flag indicating if the the name of the topology file is send to the helper, or a string with the topology data.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_netjail_stop (const char *label,
+                                 char *topology_config,
+                                 unsigned int *read_file);
+
+
+/**
+ * This command executes a shell script which starts a helper process. 
+ * This process is running on a netjail node, executing a defined test case.
+ *
+ * @param label Name for the command.
+ * @param topology The complete topology information.
+ * @param read_file Flag indicating if the the name of the topology file is send to the helper, or a string with the topology data.
+ * @param topology_data If read_file is GNUNET_NO, topology_data holds the string with the topology.
+ * @param timeout Before this timeout is reached this cmd MUST finish.
+ * @return command.
+ */
+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);
+
+
+/**
+ * Create command.
+ *
+ * @param label name for command.
+ * @param helper_start_label label of the cmd to start the test system.
+ * @param topology The complete topology information.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_stop_cmds_helper (
+  const char *label,
+  const char *helper_start_label,
+  struct GNUNET_TESTING_NetjailTopology *topology);
+
+
+/**
+ * This command is used to block the loop, until the command is finished by other commands, 
+ * using a trait to get this commands  struct GNUNET_TESTING_AsyncContext.
+ *
+ * @param label name for command.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_block_until_external_trigger (
+  const char *label);
+
+/**
+ * DEPRECATED
+ * This command sends a GNUNET_MESSAGE_TYPE_CMDS_HELPER_PEER_STARTED message to the master loop.
+ *
+ * @param label name for command.
+ * @param write_message Callback to write messages to the master loop.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_send_peer_ready (const char *label,
+                                    GNUNET_TESTING_cmd_helper_write_cb write_message);
+
+
+/**
+ * This command sends a GNUNET_MESSAGE_TYPE_CMDS_HELPER_LOCAL_TESTS_PREPARED message to the master loop.
+ *
+ * @param label name for command.
+ * @param write_message Callback to write messages to the master loop.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_local_test_prepared (const char *label,
+                                        GNUNET_TESTING_cmd_helper_write_cb
+                                        write_message);
+
+
+/**
+ * Create command.
+ *
+ * @param label name for command.
+ * @param system_label Label of the cmd to setup a test environment.
+ * @param no Decimal number representing the last byte of the IP address of this peer.
+ * @param node_ip The IP address of this node.
+ * @param cfgname Configuration file name for this peer.
+ * @param broadcast Flag indicating, if broadcast should be switched on.
+ * @return command.
+ */
+struct GNUNET_TESTING_Command
+GNUNET_TESTING_cmd_start_peer (const char *label,
+                               const char *system_label,
+                               uint32_t no,
+                               const char *node_ip,
+                               const char *cfgname,
+                               unsigned int broadcast);
+
+
+/* ***** Netjail trait support ***** */
+
+
+/**
+ * Call #op on all simple traits.
+ */
+#define GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS(op, prefix)                            \
+  op (prefix, test_system, const struct GNUNET_TESTING_System)                      \
+  op (prefix, async_context, struct GNUNET_TESTING_AsyncContext)                    \
+  op (prefix, helper_handles, const struct GNUNET_HELPER_Handle *)                  \
+  op (prefix, local_prepared_state, const struct GNUNET_TESTING_LocalPreparedState) \
+  op (prefix, block_state, struct GNUNET_TESTING_BlockState)
+
+GNUNET_TESTING_SIMPLE_NETJAIL_TRAITS (GNUNET_TESTING_MAKE_DECL_SIMPLE_TRAIT, GNUNET_TESTING)
+
+
+#endif