testing.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 TESTING_H
#define TESTING_H
#include "gnunet_util_lib.h"
#include "gnunet_testing_plugin.h"
 
GNUNET_NETWORK_STRUCT_BEGIN
 
struct CommandBarrierCrossable
{
  struct GNUNET_MessageHeader header;
 
  /* followed by 0-terminated barrier name */
};
 
struct CommandBarrierAttached
{
  struct GNUNET_MessageHeader header;
 
  uint32_t expected_reaches GNUNET_PACKED;
 
  uint32_t node_number GNUNET_PACKED;
 
  /* followed by 0-terminated barrier name */
};
 
struct GNUNET_TESTING_CommandBarrierReached
{
  struct GNUNET_MessageHeader header;
 
  uint32_t node_number GNUNET_PACKED;
 
  uint32_t expected_number_of_reached_messages GNUNET_PACKED;
 
  /* followed by 0-terminated barrier name */
};
 
GNUNET_NETWORK_STRUCT_END
 
struct TestcasePlugin
{
  char *library_name;
 
  struct GNUNET_TESTING_PluginFunctions *api;
 
  char *node_ip;
 
  char *plugin_name;
 
  char *global_n;
 
  char *local_m;
 
  char *n;
 
  char *m;
};
 
struct CommandListEntry
{
  struct CommandListEntry *next;
 
  struct CommandListEntry *prev;
 
  struct GNUNET_TESTING_Command *command;
};
 
 
struct GNUNET_TESTING_Barrier
{
  struct GNUNET_TESTING_Barrier *prev;
 
  struct GNUNET_TESTING_Barrier *next;
 
   struct CommandListEntry *cmds_head;
 
   struct CommandListEntry *cmds_tail;
 
  struct GNUNET_CONTAINER_MultiShortmap *nodes;
 
  const char *name;
 
  unsigned int running_on_master;
 
  unsigned int expected_reaches;
 
  unsigned int reached;
 
  double percentage_to_be_reached;
 
  unsigned int number_to_be_reached;
 
  /*
   * No barrier locally. Shadow created. Real barrier created elsewhere.
   */
  unsigned int shadow;
};
 
 
bool
GNUNET_TESTING_cmd_batch_next_ (void *cls);
 
 
bool
GNUNET_TESTING_cmd_is_batch_ (const struct GNUNET_TESTING_Command *cmd);
 
 
struct GNUNET_TESTING_Command *
GNUNET_TESTING_cmd_batch_get_current_ (const struct GNUNET_TESTING_Command *cmd);
 
 
void
GNUNET_TESTING_cmd_batch_set_current_ (const struct GNUNET_TESTING_Command *cmd,
                                       unsigned int new_ip);
 
 
unsigned int
GNUNET_TESTING_barrier_crossable (struct GNUNET_TESTING_Barrier *barrier);
 
 
void
TST_interpreter_send_barrier_crossable (struct GNUNET_TESTING_Interpreter *is,
                                     const char *barrier_name,
                                     unsigned int global_node_number);
 
 
void
TST_interpreter_finish_attached_cmds (struct GNUNET_TESTING_Interpreter *is,
                                     const char *barrier_name);
 
 
void
GNUNET_TESTING_send_barrier_attach (struct GNUNET_TESTING_Interpreter *is,
                                     char *barrier_name,
                                    unsigned int global_node_number,
                                    unsigned int expected_reaches,
                                    GNUNET_TESTING_cmd_helper_write_cb write_message);
 
 
struct GNUNET_TESTING_NetjailNode *
GNUNET_TESTING_barrier_get_node (struct GNUNET_TESTING_Barrier *barrier,
                                 unsigned int node_number);
 
 
struct GNUNET_TESTING_Barrier *
TST_interpreter_get_barrier (struct GNUNET_TESTING_Interpreter *is,
                            const char *barrier_name);
 
 
void
TST_interpreter_add_barrier (struct GNUNET_TESTING_Interpreter *is,
                                        struct GNUNET_TESTING_Barrier *barrier);
 
 
#endif