1 files changed, 121 insertions, 103 deletions

diff --git a/src/include/gnunet_testing_netjail_lib.h b/src/include/gnunet_testing_netjail_lib.h
index 334f43c88..843fce0d5 100644
--- a/src/include/gnunet_testing_netjail_lib.h
+++ b/src/include/gnunet_testing_netjail_lib.h
@@ -27,9 +27,8 @@
 #ifndef GNUNET_TESTING_NETJAIL_LIB_H
 #define GNUNET_TESTING_NETJAIL_LIB_H
 
-#include "gnunet_util_lib.h"
-#include "gnunet_testing_plugin.h"
 #include "gnunet_testing_ng_lib.h"
+#include "gnunet_testing_plugin.h"
 
 
 /**
@@ -52,7 +51,7 @@ struct GNUNET_TESTING_NetjailRouter
 /**
  * Enum for the different types of nodes.
  */
-enum GNUNET_TESTING_NODE_TYPE
+enum GNUNET_TESTING_NodeType
 {
   /**
    * Node in a subnet.
@@ -121,7 +120,7 @@ struct GNUNET_TESTING_NodeConnection
   /**
    * The type of the node this connection points to.
    */
-  enum GNUNET_TESTING_NODE_TYPE node_type;
+  enum GNUNET_TESTING_NodeType node_type;
 
   /**
    * The node which establish the connection
@@ -145,6 +144,16 @@ struct GNUNET_TESTING_NodeConnection
 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;
@@ -165,14 +174,19 @@ struct GNUNET_TESTING_NetjailNode
   unsigned int node_n;
 
   /**
-   * Head of the DLL with the connections which shall be established to other nodes.
+   * The overall number of the node in the whole test system.
    */
-  struct GNUNET_TESTING_NodeConnection *node_connections_head;
+  unsigned int node_number;
 
   /**
-   * Tail of the DLL with the connections which shall be established to other nodes.
+   * The number of unintentional additional connections this node waits for. This overwrites the global additional_connects value.
    */
-  struct GNUNET_TESTING_NodeConnection *node_connections_tail;
+  unsigned int additional_connects;
+
+  /**
+   * The number of cmds waiting for a specific barrier.
+   */
+  unsigned int expected_reaches;
 };
 
 
@@ -232,6 +246,11 @@ struct GNUNET_TESTING_NetjailTopology
    * 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;
 };
 
 /**
@@ -245,13 +264,37 @@ 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 (char *data);
+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);
 
 
 /**
@@ -262,8 +305,8 @@ GNUNET_TESTING_get_topo_from_string (char *data);
  * @return The connections of the node.
  */
 struct GNUNET_TESTING_NodeConnection *
-GNUNET_TESTING_get_connections (unsigned int num, struct
-                                GNUNET_TESTING_NetjailTopology *topology);
+GNUNET_TESTING_get_connections (unsigned int num,
+                                const struct GNUNET_TESTING_NetjailTopology *topology);
 
 
 /**
@@ -275,7 +318,7 @@ GNUNET_TESTING_get_connections (unsigned int num, struct
  */
 char *
 GNUNET_TESTING_get_address (struct GNUNET_TESTING_NodeConnection *connection,
-                            char *prefix);
+                            const char *prefix);
 
 
 /**
@@ -288,7 +331,7 @@ GNUNET_TESTING_free_topology (struct GNUNET_TESTING_NetjailTopology *topology);
 
 
 /**
- * Calculate the unique id identifying a node from a given connction.
+ * 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.
@@ -304,7 +347,7 @@ GNUNET_TESTING_calculate_num (struct
  * Struct with information for callbacks.
  *
  */
-struct BlockState
+struct GNUNET_TESTING_BlockState
 {
   /**
    * Context for our asynchronous completion.
@@ -326,7 +369,7 @@ struct BlockState
  * Struct to hold information for callbacks.
  *
  */
-struct LocalPreparedState
+struct GNUNET_TESTING_LocalPreparedState
 {
   /**
    * Context for our asynchronous completion.
@@ -337,28 +380,35 @@ struct LocalPreparedState
    * Callback to write messages to the master loop.
    *
    */
-  TESTING_CMD_HELPER_write_cb write_message;
+  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);
 
 
-int
-GNUNET_TESTING_get_trait_test_system (const struct
-                                      GNUNET_TESTING_Command *cmd,
-                                      struct GNUNET_TESTING_System **test_system);
-
-
 /**
- * Create command.
+ * 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.
@@ -372,7 +422,7 @@ GNUNET_TESTING_cmd_netjail_start (const char *label,
 
 
 /**
- * Create command.
+ * 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.
@@ -386,20 +436,23 @@ GNUNET_TESTING_cmd_netjail_stop (const char *label,
 
 
 /**
- * Create command.
+ * 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_testing_system (
+GNUNET_TESTING_cmd_netjail_start_cmds_helper (
   const char *label,
   struct GNUNET_TESTING_NetjailTopology *topology,
   unsigned int *read_file,
-  char *topology_data);
+  char *topology_data,
+  struct GNUNET_TIME_Relative timeout);
 
 
 /**
@@ -411,118 +464,83 @@ GNUNET_TESTING_cmd_netjail_start_testing_system (
  * @return command.
  */
 struct GNUNET_TESTING_Command
-GNUNET_TESTING_cmd_stop_testing_system (
+GNUNET_TESTING_cmd_stop_cmds_helper (
   const char *label,
   const char *helper_start_label,
   struct GNUNET_TESTING_NetjailTopology *topology);
 
 
 /**
- * Create a GNUNET_CMDS_LOCAL_FINISHED message.
- *
- * @param rv The result of the local test as GNUNET_GenericReturnValue.
- * @return The GNUNET_CMDS_LOCAL_FINISHED message.
-*/
-struct GNUNET_MessageHeader *
-GNUNET_TESTING_send_local_test_finished_msg (enum GNUNET_GenericReturnValue rv);
-
-
-/**
- * Function to get the trait with the async context.
- *
- * @param[out] ac GNUNET_TESTING_AsyncContext.
- * @return #GNUNET_OK if no error occurred, #GNUNET_SYSERR otherwise.
- */
-int
-GNUNET_TESTING_get_trait_async_context (
-  const struct GNUNET_TESTING_Command *cmd,
-  struct GNUNET_TESTING_AsyncContext **ac);
-
-
-/**
- * Offer handles to testing cmd helper from trait
- *
- * @param cmd command to extract the message from.
- * @param pt pointer to message.
- * @return #GNUNET_OK on success.
- */
-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);
-
-
-/**
- * Create command.
+ * 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.
- * @param all_peers_started Flag which will be set from outside.
- * @param asynchronous_finish If GNUNET_YES this command will not block.
  * @return command.
  */
 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);
-
-
 /**
- * Create command.
+ * 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_local_test_finished (
-  const char *label,
-  TESTING_CMD_HELPER_write_cb write_message);
+GNUNET_TESTING_cmd_send_peer_ready (const char *label,
+                                    GNUNET_TESTING_cmd_helper_write_cb write_message);
+
 
 /**
- * Create command.
+ * 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.
- * @param all_local_tests_prepared Flag which will be set from outside.
  * @return command.
  */
 struct GNUNET_TESTING_Command
 GNUNET_TESTING_cmd_local_test_prepared (const char *label,
-                                        TESTING_CMD_HELPER_write_cb
+                                        GNUNET_TESTING_cmd_helper_write_cb
                                         write_message);
 
+
 /**
- * Function to get the trait with the struct LocalPreparedState.
- *
- * @param[out] lfs struct LocalPreparedState.
- * @return #GNUNET_OK if no error occurred, #GNUNET_SYSERR otherwise.
+ * 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.
  */
-enum GNUNET_GenericReturnValue
-GNUNET_TESTING_get_trait_local_prepared_state (
-  const struct GNUNET_TESTING_Command *cmd,
-  struct LocalPreparedState **lfs);
+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 ***** */
 
 
 /**
- * Function to get the trait with the internal command state BlockState.
- *
- * * @param[out] ac struct BlockState.
-* @return #GNUNET_OK if no error occurred, #GNUNET_SYSERR otherwise.
+ * Call #op on all simple traits.
  */
-int
-GNUNET_TESTING_get_trait_block_state (
-  const struct GNUNET_TESTING_Command *cmd,
-  struct BlockState **bs);
+#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