TESTING: Fix TESTING-NG API to follow naming conventions

Rename structs and functions to follow GNUnet naming conventions.
Some structs may actually also be private, a review is necessary.
The barrier API was modified in order to untangle Barriers and
lists of Barriers.
This is a rough draft, it needs fixes wrt memory leaks.

4 files changed, 62 insertions, 106 deletions

diff --git a/src/include/gnunet_testing_barrier.h b/src/include/gnunet_testing_barrier.h
index 4a3d87ec7..ed4624e1b 100644
--- a/src/include/gnunet_testing_barrier.h
+++ b/src/include/gnunet_testing_barrier.h
@@ -27,74 +27,44 @@
 #ifndef GNUNET_TESTING_BARRIER_LIB_H
 #define GNUNET_TESTING_BARRIER_LIB_H
 
-#include "gnunet_testing_lib.h"
-#include "gnunet_testing_netjail_lib.h"
+#define GNUNET_TESTING_BARRIER_MAX 32
 
-struct GNUNET_TESTING_Barrier
-{
-  /**
-   * Pointer to the previous prefix in the DLL.
-   */
-  struct GNUNET_TESTING_Barrier *prev;
-
-  /**
-   * Pointer to the next prefix in the DLL.
-   */
-  struct GNUNET_TESTING_Barrier *next;
-
-  /**
-   * Head of the DLL with local commands the barrier is attached too.
-   */
-   struct GNUNET_TESTING_Command *cmds_head;
-
-  /**
-   * Tail of the DLL with local commands the barrier is attached too.
-   */
-   struct GNUNET_TESTING_Command *cmds_tail;
-
-  /**
-   * Hash map containing the global known nodes which are not natted.
-   */
-  struct GNUNET_CONTAINER_MultiShortmap *nodes;
+#include "gnunet_testing_plugin.h"
 
-  /**
-   * Name of the barrier.
-   */
-  const char *name;
-
-  /**
-   * Is this barrier running on the master.
-   */
-  unsigned int running_on_master;
+/**
+ * A testing barrier
+ * FIXME better description
+ */
+struct GNUNET_TESTING_Barrier;
 
-  /**
-   * Number of commands attached to this barrier.
-   */
-  unsigned int expected_reaches;
+/**
+ * An entry for a barrier list
+ */
+struct GNUNET_TESTING_BarrierListEntry
+{
+  /* DLL */
+  struct GNUNET_TESTING_BarrierListEntry *next;
 
-  /**
-   * Number of commands which reached this barrier.
-   */
-  unsigned int reached;
+  /* DLL */
+  struct GNUNET_TESTING_BarrierListEntry *prev;
 
-  /**
-   * Percentage of of commands which need to reach the barrier to change state.
-   * Can not be used together with to_be_reached;
-   */
-  double percentage_to_be_reached;
+  /* The barrier */
+  struct GNUNET_TESTING_Barrier *barrier;
+};
 
-  /**
-   * Number of commands which need to reach the barrier to change state.
-   * Can not be used together with percentage_to_be_reached;
-   */
-  unsigned int number_to_be_reached;
+/**
+ * A list to hold barriers provided by plugins
+ */
+struct GNUNET_TESTING_BarrierList
+{
+  /** List head **/
+  struct GNUNET_TESTING_BarrierListEntry *head;
 
-  /*
-   * No barrier locally. Shadow created. Real barrier created elsewhere.
-   */
-  unsigned int shadow;
+  /** List tail **/
+  struct GNUNET_TESTING_BarrierListEntry *tail;
 };
 
+
 /**
  * Message send to a child loop to inform the child loop about a barrier being advanced.
  */
@@ -112,7 +82,7 @@ struct GNUNET_TESTING_CommandBarrierAdvanced
 };
 
 /**
- * Message send by a child loop to inform the master loop how much 
+ * Message send by a child loop to inform the master loop how much
  * GNUNET_CMDS_BARRIER_REACHED messages the child will send.
  */
 struct GNUNET_TESTING_CommandBarrierAttached
@@ -162,17 +132,11 @@ struct GNUNET_TESTING_CommandBarrierReached
   unsigned int expected_number_of_reached_messages;
 };
 
-
 /**
- * Adding a node to the map of nodes of a barrier.
- *
- * @param nodes Map of nodes.
- * @param node The node to add.
+ * Create a new #GNUNET_TESTING_Barrier
  */
-void
-GNUNET_TESTING_barrier_add_node (struct GNUNET_CONTAINER_MultiShortmap *nodes,
-                                 struct GNUNET_TESTING_NetjailNode *node);
-
+struct GNUNET_TESTING_Barrier*
+GNUNET_TESTING_barrier_new (const char *testcase_name);
 
 struct GNUNET_TESTING_Command
 GNUNET_TESTING_cmd_barrier_create (
@@ -203,7 +167,7 @@ GNUNET_TESTING_cmd_barrier_reached (
   unsigned int asynchronous_finish,
   unsigned int node_number,
   unsigned int running_on_master,
-  TESTING_CMD_HELPER_write_cb write_message);
+  GNUNET_TESTING_cmd_helper_write_cb write_message);
 
 
 /**
@@ -253,7 +217,7 @@ GNUNET_TESTING_send_barrier_attach (struct GNUNET_TESTING_Interpreter *is,
                                      char *barrier_name,
                                     unsigned int global_node_number,
                                     unsigned int expected_reaches,
-                                    TESTING_CMD_HELPER_write_cb write_message);
+                                    GNUNET_TESTING_cmd_helper_write_cb write_message);
 
 
 /**
diff --git a/src/include/gnunet_testing_netjail_lib.h b/src/include/gnunet_testing_netjail_lib.h
index 8d1295c98..53cae38c6 100644
--- a/src/include/gnunet_testing_netjail_lib.h
+++ b/src/include/gnunet_testing_netjail_lib.h
@@ -27,11 +27,10 @@
 #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"
 
+struct GNUNET_TESTING_AsyncContext;
 
 /**
  * Router of a netjail subnet.
@@ -342,7 +341,10 @@ unsigned int
 GNUNET_TESTING_calculate_num (struct
                               GNUNET_TESTING_NodeConnection *node_connection,
                               struct GNUNET_TESTING_NetjailTopology *topology);
-struct TestState
+
+// FIXME this was not namespaced. Is this correct here? Why are the cmd_helpers
+// defined in _plugin??
+struct GNUNET_TESTING_TestState
 {
   /**
    * The head of the DLL with barriers of the test case.
@@ -358,12 +360,12 @@ struct TestState
    * Callback to write messages to the master loop.
    *
    */
-  TESTING_CMD_HELPER_write_cb write_message;
+  GNUNET_TESTING_cmd_helper_write_cb write_message;
 
   /**
    * Callback to notify the helper test case has finished.
    */
-  TESTING_CMD_HELPER_finish_cb finished_cb;
+  GNUNET_TESTING_cmd_helper_finish_cb finished_cb;
 
   /**
    * The name for a specific test environment directory.
@@ -387,12 +389,12 @@ struct TestState
  * Struct with information for callbacks.
  *
  */
-struct BlockState
+struct GNUNET_TESTING_BlockState
 {
   /**
    * Context for our asynchronous completion.
    */
-  struct GNUNET_TESTING_AsyncContext ac;
+  struct GNUNET_TESTING_AsyncContext *ac;
 
   /**
    * The label of this command.
@@ -409,7 +411,7 @@ struct BlockState
  * Struct to hold information for callbacks.
  *
  */
-struct LocalPreparedState
+struct GNUNET_TESTING_LocalPreparedState
 {
   /**
    * Context for our asynchronous completion.
@@ -420,7 +422,7 @@ 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;
 };
 
 /**
@@ -538,7 +540,7 @@ GNUNET_TESTING_cmd_block_until_external_trigger (
  */
 struct GNUNET_TESTING_Command
 GNUNET_TESTING_cmd_send_peer_ready (const char *label,
-                                    TESTING_CMD_HELPER_write_cb write_message);
+                                    GNUNET_TESTING_cmd_helper_write_cb write_message);
 
 
 /**
@@ -551,7 +553,7 @@ GNUNET_TESTING_cmd_send_peer_ready (const char *label,
 struct GNUNET_TESTING_Command
 GNUNET_TESTING_cmd_local_test_finished (
   const char *label,
-  TESTING_CMD_HELPER_write_cb write_message);
+  GNUNET_TESTING_cmd_helper_write_cb write_message);
 
 /**
  * Create command.
@@ -562,7 +564,7 @@ GNUNET_TESTING_cmd_local_test_finished (
  */
 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);
 
 
@@ -576,8 +578,8 @@ GNUNET_TESTING_cmd_local_test_prepared (const char *label,
   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 LocalPreparedState) \
-  op (block_state, const struct BlockState)
+  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)
 
diff --git a/src/include/gnunet_testing_ng_lib.h b/src/include/gnunet_testing_ng_lib.h
index 0b4c05a59..d218a65db 100644
--- a/src/include/gnunet_testing_ng_lib.h
+++ b/src/include/gnunet_testing_ng_lib.h
@@ -29,7 +29,6 @@
 
 
 #include "gnunet_util_lib.h"
-#include "gnunet_testing_plugin.h"
 #include "gnunet_testing_lib.h"
 
 /**
@@ -134,18 +133,6 @@ GNUNET_TESTING_command_new (void *cls,
  */
 struct GNUNET_TESTING_Command
 {
-  // FIXME: This should not be here. Looking at the code commands are used
-  // in arrays. Not lists.
-  /**
-   * Pointer to the previous command in the DLL.
-   */
-  struct GNUNET_TESTING_Command *prev;
-
-  /**
-   * Pointer to the next command in the DLL.
-   */
-  struct GNUNET_TESTING_Command *next;
-
   /**
    * Closure for all commands with command-specific context information.
    */
@@ -466,7 +453,7 @@ GNUNET_TESTING_get_barrier (struct GNUNET_TESTING_Interpreter *is,
  * @param barrier The barrier to add.
  */
 void
-GNUNET_TESTING_barrier_add (struct GNUNET_TESTING_Interpreter *is,
+GNUNET_TESTING_interpreter_add_barrier (struct GNUNET_TESTING_Interpreter *is,
                             struct GNUNET_TESTING_Barrier *barrier);
 
 
diff --git a/src/include/gnunet_testing_plugin.h b/src/include/gnunet_testing_plugin.h
index 312a7bfe5..d986fabcd 100644
--- a/src/include/gnunet_testing_plugin.h
+++ b/src/include/gnunet_testing_plugin.h
@@ -38,18 +38,21 @@ extern "C"
 #endif
 #endif
 
+struct GNUNET_TESTING_Barrier;
+
+//FIXME documentation for both functions
 typedef void
-(*TESTING_CMD_HELPER_write_cb) (struct GNUNET_MessageHeader *message,
+(*GNUNET_TESTING_cmd_helper_write_cb) (struct GNUNET_MessageHeader *message,
                                 size_t msg_length);
 
 typedef void
-(*TESTING_CMD_HELPER_finish_cb) ();
+(*GNUNET_TESTING_cmd_helper_finish_cb) ();
 
 // FIXME documentation
 // FIXME: Why are n, m, local_m strings?
 // FIXME: Why is topology_data a string and not a GNUNET_TESTING_NetworkTopology??
 typedef void
-(*GNUNET_TESTING_PLUGIN_StartTestCase) (TESTING_CMD_HELPER_write_cb
+(*GNUNET_TESTING_PLUGIN_StartTestCase) (GNUNET_TESTING_cmd_helper_write_cb
                                         write_message,
                                         const char *router_ip,
                                         const char *node_ip,
@@ -58,7 +61,7 @@ typedef void
                                         const char *local_m,
                                         const char *topology_data,
                                         unsigned int *read_file,
-                                        TESTING_CMD_HELPER_finish_cb finish_cb);
+                                        GNUNET_TESTING_cmd_helper_finish_cb finish_cb);
 
 
 typedef void
@@ -71,8 +74,8 @@ typedef void
 typedef void
 (*GNUNET_TESTING_PLUGIN_BARRIER_ADVANCED) (const char *barrier_name);
 
-typedef struct GNUNET_TESTING_Barrier *
-(*GNUNET_TESTING_PLUGIN_GET_WAITING_FOR_BARRIERS) ();
+typedef struct GNUNET_TESTING_BarrierList*
+(*GNUNET_TESTING_PLUGIN_GET_WAITING_FOR_BARRIERS) (void);
 
 
 // FIXME documentation