transport-testing-cmds.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 TRANSPORT_TESTING_CMDS_H
#define TRANSPORT_TESTING_CMDS_H
#include "gnunet_testing_ng_lib.h"
#include "gnunet_testing_plugin.h"
 
typedef void *
(*GNUNET_TRANSPORT_notify_connect_cb) (struct GNUNET_TESTING_Interpreter *is,
                                       const struct GNUNET_PeerIdentity *peer);
 
struct ConnectPeersState
{
  struct GNUNET_TESTING_AsyncContext ac;
 
  GNUNET_TRANSPORT_notify_connect_cb notify_connect;
 
  const struct GNUNET_TESTING_System *tl_system;
 
  // Label of the cmd which started the test system.
  const char *create_label;
 
  uint32_t num;
 
  const char *start_peer_label;
 
  struct GNUNET_TESTING_NetjailTopology *topology;
 
  struct GNUNET_TESTING_NodeConnection *node_connections_head;
 
  struct GNUNET_TESTING_Interpreter *is;
 
  unsigned int con_num;
 
  unsigned int additional_connects;
 
  unsigned int con_num_notified;
 
  unsigned int additional_connects_notified;
};
 
struct StartPeerState
{
  struct GNUNET_TESTING_AsyncContext ac;
 
  char *node_ip;
 
  struct GNUNET_MQ_MessageHandler *handlers;
 
  char *cfgname;
 
  struct GNUNET_CONFIGURATION_Handle *cfg;
 
  struct GNUNET_TESTING_Peer *peer;
 
  struct GNUNET_PeerIdentity id;
 
  struct GNUNET_TRANSPORT_CoreHandle *th;
 
  struct GNUNET_TRANSPORT_ApplicationHandle *ah;
 
  struct GNUNET_PEERSTORE_Handle *ph;
 
  struct GNUNET_SCHEDULER_Task *rh_task;
 
  struct GNUNET_PEERSTORE_IterateContext *pic;
 
  char *hello;
 
  size_t hello_size;
 
  char *system_label;
 
  unsigned int no;
 
  struct GNUNET_CONTAINER_MultiShortmap *connected_peers_map;
 
  const struct GNUNET_TESTING_System *tl_system;
 
  GNUNET_TRANSPORT_notify_connect_cb notify_connect;
 
  enum GNUNET_GenericReturnValue broadcast;
};
 
struct TestState
{
  GNUNET_TESTING_cmd_helper_write_cb write_message;
 
  GNUNET_TESTING_cmd_helper_finish_cb finished_cb;
 
  char *testdir;
 
  char *cfgname;
 
  struct GNUNET_TESTING_NetjailTopology *topology;
};
 
 
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_start_peer (const char *label,
                                 const char *system_label,
                                 uint32_t no,
                                 const char *node_ip,
                                 struct GNUNET_MQ_MessageHandler *handlers,
                                 const char *cfgname,
                                 GNUNET_TRANSPORT_notify_connect_cb
                                 notify_connect,
                                 unsigned int broadcast);
 
 
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_stop_peer (const char *label,
                                const char *start_label);
 
 
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_connect_peers (
  const char *label,
  const char *start_peer_label,
  const char *create_label,
  uint32_t num,
  struct GNUNET_TESTING_NetjailTopology *topology,
  unsigned int additional_connects);
 
 
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_send_simple (const char *label,
                                  const char *start_peer_label,
                                  const char *create_label,
                                  uint32_t num,
                                  struct GNUNET_TESTING_NetjailTopology *
                                  topology);
 
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_send_simple_performance (const char *label,
                                  const char *start_peer_label,
                                  const char *create_label,
                                  uint32_t num,
                                  int size,
                                  int max_send,
                                  struct GNUNET_TESTING_NetjailTopology *
                                  topology);
 
 
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_backchannel_check (const char *label,
                                        const char *start_peer_label,
                                        const char *create_label,
                                        uint32_t num,
                                        unsigned int node_n,
                                        unsigned int namespace_n,
                                        struct GNUNET_TESTING_NetjailTopology *
                                        topology);
 
 
#define GNUNET_TRANSPORT_MAKE_DECL_SIMPLE_TRAIT(name,type)   \
  enum GNUNET_GenericReturnValue                          \
    GNUNET_TRANSPORT_get_trait_ ## name (                    \
    const struct GNUNET_TESTING_Command *cmd,              \
    type **ret);                                          \
  struct GNUNET_TESTING_Trait                              \
    GNUNET_TRANSPORT_make_trait_ ## name (                   \
    type * value);
 
 
#define GNUNET_TRANSPORT_MAKE_IMPL_SIMPLE_TRAIT(name,type)  \
  enum GNUNET_GenericReturnValue                         \
    GNUNET_TRANSPORT_get_trait_ ## name (                   \
    const struct GNUNET_TESTING_Command *cmd,             \
    type **ret)                                          \
  {                                                      \
    if (NULL == cmd->traits) return GNUNET_SYSERR;       \
    return cmd->traits (cmd->cls,                        \
                        (const void **) ret,             \
                        GNUNET_S (name),                  \
                        0);                              \
  }                                                      \
  struct GNUNET_TESTING_Trait                             \
    GNUNET_TRANSPORT_make_trait_ ## name (                  \
    type * value)                                        \
  {                                                      \
    struct GNUNET_TESTING_Trait ret = {                   \
      .trait_name = GNUNET_S (name),                      \
      .ptr = (const void *) value                        \
    };                                                   \
    return ret;                                          \
  }
 
 
#define GNUNET_TRANSPORT_SIMPLE_TRAITS(op) \
  op (peer_id, const struct GNUNET_PeerIdentity) \
  op (connected_peers_map, const struct GNUNET_CONTAINER_MultiShortmap) \
  op (hello_size, const size_t) \
  op (hello, const char) \
  op (application_handle, const struct GNUNET_TRANSPORT_ApplicationHandle) \
  op (connect_peer_state, const struct ConnectPeersState) \
  op (state, const struct StartPeerState) \
  op (broadcast, const enum GNUNET_GenericReturnValue)
 
GNUNET_TRANSPORT_SIMPLE_TRAITS (GNUNET_TRANSPORT_MAKE_DECL_SIMPLE_TRAIT)
 
 
#endif
/* end of transport_testing.h */